diff --git a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/const.js b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/const.js index 109c85f68..b5092eb38 100644 --- a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/const.js +++ b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/const.js @@ -20,7 +20,7 @@ var CONST = { * @type {string} * @since 3.0.0 */ - VERSION: '3.23.0-beta1', + VERSION: '3.22.0', BlendModes: require('./renderer/BlendModes'), diff --git a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/components/PathFollower.js b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/components/PathFollower.js index 33c5b3822..f54f34541 100644 --- a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/components/PathFollower.js +++ b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/components/PathFollower.js @@ -346,7 +346,7 @@ var PathFollower = { var tweenData = tween.data[0]; var pathVector = this.pathVector; - if (tweenData.state === TWEEN_CONST.COMPLETE) + if (tweenData.state !== TWEEN_CONST.COMPLETE) { this.path.getPoint(1, pathVector); diff --git a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/index.js b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/index.js index cd6c90019..f87e9488a 100644 --- a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/index.js +++ b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/index.js @@ -35,7 +35,6 @@ var GameObjects = { PathFollower: require('./pathfollower/PathFollower'), RenderTexture: require('./rendertexture/RenderTexture'), RetroFont: require('./bitmaptext/RetroFont'), - Rope: require('./rope/Rope'), Sprite: require('./sprite/Sprite'), Text: require('./text/static/Text'), TileSprite: require('./tilesprite/TileSprite'), @@ -71,7 +70,6 @@ var GameObjects = { Particles: require('./particles/ParticleManagerFactory'), PathFollower: require('./pathfollower/PathFollowerFactory'), RenderTexture: require('./rendertexture/RenderTextureFactory'), - Rope: require('./rope/RopeFactory'), Sprite: require('./sprite/SpriteFactory'), StaticBitmapText: require('./bitmaptext/static/BitmapTextFactory'), Text: require('./text/static/TextFactory'), @@ -102,7 +100,6 @@ var GameObjects = { Image: require('./image/ImageCreator'), Particles: require('./particles/ParticleManagerCreator'), RenderTexture: require('./rendertexture/RenderTextureCreator'), - Rope: require('./rope/RopeCreator'), Sprite: require('./sprite/SpriteCreator'), StaticBitmapText: require('./bitmaptext/static/BitmapTextCreator'), Text: require('./text/static/TextCreator'), diff --git a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/Rope.js b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/Rope.js deleted file mode 100644 index 6d77a95f5..000000000 --- a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/Rope.js +++ /dev/null @@ -1,613 +0,0 @@ -/** - * @author Richard Davey - * @copyright 2020 Photon Storm Ltd. - * @license {@link https://opensource.org/licenses/MIT|MIT License} - */ - -var Class = require('../../utils/Class'); -var Components = require('../components'); -var GameObject = require('../GameObject'); -var RopeRender = require('./RopeRender'); -var NOOP = require('../../utils/NOOP'); -var Vector2 = require('../../math/Vector2'); - -/** - * @classdesc - * A Rope Game Object. - * - * @class Rope - * @extends Phaser.GameObjects.GameObject - * @memberof Phaser.GameObjects - * @constructor - * @webglOnly - * @since 3.23.0 - * - * @extends Phaser.GameObjects.Components.BlendMode - * @extends Phaser.GameObjects.Components.Depth - * @extends Phaser.GameObjects.Components.Mask - * @extends Phaser.GameObjects.Components.Pipeline - * @extends Phaser.GameObjects.Components.Size - * @extends Phaser.GameObjects.Components.Texture - * @extends Phaser.GameObjects.Components.Transform - * @extends Phaser.GameObjects.Components.Visible - * @extends Phaser.GameObjects.Components.ScrollFactor - * - * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time. - * @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. - * @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager. - * @param {(string|integer|null)} [frame] - An optional frame from the Texture this Game Object is rendering with. - * @param {Phaser.Types.Math.Vector2Like[]} [points] - An array containing the vertices data for this Rope. If none is provided a simple quad is created. See `setPoints` to set this post-creation. - * @param {number[]} [colors] - An optional array containing the color data for this Rope. You should provide one color value per pair of vertices. - * @param {number[]} [alphas] - An optional array containing the alpha data for this Rope. You should provide one alpha value per pair of vertices. - */ -var Rope = new Class({ - - Extends: GameObject, - - Mixins: [ - Components.BlendMode, - Components.Depth, - Components.Mask, - Components.Pipeline, - Components.Size, - Components.Texture, - Components.Transform, - Components.Visible, - Components.ScrollFactor, - RopeRender - ], - - initialize: - - function Rope (scene, x, y, texture, frame, points, colors, alphas) - { - if (points === undefined) - { - points = [ { x: 0, y: 0 } ]; - } - - GameObject.call(this, scene, 'Rope'); - - /** - * An array containing the points data for this Rope. - * - * Each point should be given as a Vector2Like object (i.e. a Vector2, Geom.Point or object with public x/y properties). - * - * The point coordinates are given in local space, where 0 x 0 is the start of the Rope strip. - * - * You can modify the contents of this array directly in real-time to create interesting effects. - * If you do so, be sure to call `setDirty` _after_ modifying this array, so that the vertices data is - * updated before the next render. Alternatively, you can use the `setPoints` method instead. - * - * Should you need to change the _size_ of this array, then you should always use the `setPoints` method. - * - * @name Phaser.GameObjects.Rope#points - * @type {Phaser.Math.Types.Vector2Like[]} - * @since 3.23.0 - */ - this.points = points; - - /** - * An array containing the vertices data for this Rope. - * - * This data is calculated automatically in the `updateVertices` method, based on the points provided. - * - * @name Phaser.GameObjects.Rope#vertices - * @type {Float32Array} - * @since 3.23.0 - */ - this.vertices; - - /** - * An array containing the uv data for this Rope. - * - * This data is calculated automatically in the `setPoints` method, based on the points provided. - * - * @name Phaser.GameObjects.Rope#uv - * @type {Float32Array} - * @since 3.23.0 - */ - this.uv; - - /** - * An array containing the color data for this Rope. - * - * Colors should be given as numeric RGB values, such as 0xff0000. - * You should provide _two_ color values for every point in the Rope, one for the top and one for the bottom of each quad. - * - * You can modify the contents of this array directly in real-time, however, should you need to change the _size_ - * of the array, then you should use the `setColors` method instead. - * - * @name Phaser.GameObjects.Rope#colors - * @type {Uint32Array} - * @since 3.23.0 - */ - this.colors; - - /** - * An array containing the alpha data for this Rope. - * - * Alphas should be given as float values, such as 0.5. - * You should provide _two_ alpha values for every point in the Rope, one for the top and one for the bottom of each quad. - * - * You can modify the contents of this array directly in real-time, however, should you need to change the _size_ - * of the array, then you should use the `setAlphas` method instead. - * - * @name Phaser.GameObjects.Rope#alphas - * @type {Float32Array} - * @since 3.23.0 - */ - this.alphas; - - /** - * Fill or additive mode used when blending the color values? - * - * @name Phaser.GameObjects.Rope#tintFill - * @type {boolean} - * @default false - * @since 3.23.0 - */ - this.tintFill = false; - - /** - * If the Rope is marked as `dirty` it will automatically recalculate its vertices - * the next time it renders. You can also force this by calling `updateVertices`. - * - * @name Phaser.GameObjects.Rope#dirty - * @type {boolean} - * @since 3.23.0 - */ - this.dirty = false; - - /** - * Internal Vector2 used for vertices updates. - * - * @name Phaser.GameObjects.Rope#_perp - * @type {Phaser.Math.Vector2} - * @private - * @since 3.23.0 - */ - this._perp = new Vector2(); - - this.setTexture(texture, frame); - this.setPosition(x, y); - this.setSizeToFrame(); - this.initPipeline('TextureTintStripPipeline'); - - this.resizeArrays(points.length); - - this.setPoints(points, colors, alphas); - - this.updateVertices(); - }, - - /** - * This method is left intentionally empty and does not do anything. - * It is retained to allow a Rope to be added to a Container. - * You should modify the alphas array values instead. See `setAlphas`. - * - * @method Phaser.GameObjects.Rope#setAlpha - * @since 3.23.0 - */ - setAlpha: NOOP, - - /** - * Flags this Rope as being dirty. A dirty rope will recalculate all of its vertices data - * the _next_ time it renders. You should set this rope as dirty if you update the points - * array directly. - * - * @method Phaser.GameObjects.Rope#setDirty - * @since 3.23.0 - * - * @return {this} This Game Object instance. - */ - setDirty: function () - { - this.dirty = true; - - return this; - }, - - /** - * Swap this Game Object from using a fill-tint to an additive tint. - * - * Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture - * with those in the tint. You can use this for effects such as making a player flash 'white' - * if hit by something. See the `setColors` method for details of tinting the vertices. - * - * @method Phaser.GameObjects.Rope#setTintFill - * @webglOnly - * @since 3.23.0 - * - * @param {boolean} [value=false] - Use tint fill (`true`) or an additive tint (`false`) - * - * @return {this} This Game Object instance. - */ - setTintFill: function (value) - { - if (value === undefined) { value = false; } - - this.tintFill = value; - - return this; - }, - - /** - * Set the alpha values used by the Rope during rendering. - * - * You can provide the values in a number of ways: - * - * 1) One single numeric value: `setAlphas(0.5)` - This will set a single alpha for the whole Rope. - * 2) Two numeric value: `setAlphas(1, 0.5)` - This will set a 'top' and 'bottom' alpha value across the whole Rope. - * 3) An array of values: `setAlphas([ 1, 0.5, 0.2 ])` - * - * If you provide an array of values and the array has exactly the same number of values as `points` in the Rope, it - * will use each alpha value per rope segment. - * - * If the provided array has a different number of values than `points` then it will use the values in order, from - * the first Rope segment and on, until it runs out of values. This allows you to control the alpha values at all - * vertices in the Rope. - * - * Note this method is called `setAlphas` (plural) and not `setAlpha`, which is a NOOP. - * - * @method Phaser.GameObjects.Rope#setAlphas - * @since 3.23.0 - * - * @param {(number|number[])} [alphas] - Either a single alpha value, or an array of values. If nothing is provided alpha is reset to 1. - * @param {number} [bottomAlpha] - An optional bottom alpha value. See the method description for details. - * - * @return {this} This Game Object instance. - */ - setAlphas: function (alphas, bottomAlpha) - { - var total = this.points.length; - - if (total < 1) - { - return this; - } - - var currentAlphas = this.alphas; - - if (alphas === undefined) - { - alphas = [ 1 ]; - } - else if (!Array.isArray(alphas) && bottomAlpha === undefined) - { - alphas = [ alphas ]; - } - - var i; - var index = 0; - - if (bottomAlpha !== undefined) - { - // Top / Bottom alpha pair - for (i = 0; i < total; i++) - { - index = i * 2; - - currentAlphas[index] = alphas; - currentAlphas[index + 1] = bottomAlpha; - } - } - else if (alphas.length === total) - { - // If there are exactly the same number of alphas as points, we'll combine the alphas - for (i = 0; i < total; i++) - { - index = i * 2; - - currentAlphas[index] = alphas[i]; - currentAlphas[index + 1] = alphas[i]; - } - } - else - { - var prevAlpha = alphas[0]; - - for (i = 0; i < total; i++) - { - index = i * 2; - - if (alphas.length > index) - { - prevAlpha = alphas[index]; - } - - currentAlphas[index] = prevAlpha; - - if (alphas.length > index + 1) - { - prevAlpha = alphas[index + 1]; - } - - currentAlphas[index + 1] = prevAlpha; - } - } - - return this; - - }, - - /** - * Set the color values used by the Rope during rendering. - * - * Colors are used to control the level of tint applied across the Rope texture. - * - * You can provide the values in a number of ways: - * - * 1) One single numeric value: `setColors(0xff0000)` - This will set a single color tint for the whole Rope. - * 3) An array of values: `setColors([ 0xff0000, 0x00ff00, 0x0000ff ])` - * - * If you provide an array of values and the array has exactly the same number of values as `points` in the Rope, it - * will use each color per rope segment. - * - * If the provided array has a different number of values than `points` then it will use the values in order, from - * the first Rope segment and on, until it runs out of values. This allows you to control the color values at all - * vertices in the Rope. - * - * @method Phaser.GameObjects.Rope#setColors - * @since 3.23.0 - * - * @param {(number|number[])} [colors] - Either a single color value, or an array of values. If nothing is provided color is reset to 0xffffff. - * - * @return {this} This Game Object instance. - */ - setColors: function (colors) - { - var total = this.points.length; - - if (total < 1) - { - return this; - } - - var currentColors = this.colors; - - if (colors === undefined) - { - colors = [ 0xffffff ]; - } - else if (!Array.isArray(colors)) - { - colors = [ colors ]; - } - - var i; - var index = 0; - - if (colors.length === total) - { - // If there are exactly the same number of colors as points, we'll combine the colors - for (i = 0; i < total; i++) - { - index = i * 2; - - currentColors[index] = colors[i]; - currentColors[index + 1] = colors[i]; - } - } - else - { - var prevColor = colors[0]; - - for (i = 0; i < total; i++) - { - index = i * 2; - - if (colors.length > index) - { - prevColor = colors[index]; - } - - currentColors[index] = prevColor; - - if (colors.length > index + 1) - { - prevColor = colors[index + 1]; - } - - currentColors[index + 1] = prevColor; - } - } - - return this; - }, - - /** - * Sets the points used by this Rope. - * - * The points should be provided as an array of Vector2, or vector2-like objects (i.e. those with public x/y properties). - * - * Each point corresponds to one segment of the Rope. The more points in the array, the more segments the rope has. - * - * Point coordinates are given in local-space, not world-space, and are directly related to the size of the texture - * this Rope object is using. - * - * For example, a Rope using a 512 px wide texture, split into 4 segments (128px each) would use the following points: - * - * ```javascript - * rope.setPoints([ - * { x: 0, y: 0 }, - * { x: 128, y: 0 }, - * { x: 256, y: 0 }, - * { x: 384, y: 0 } - * ]); - * ``` - * - * Note that calling this method with a different number of points than the Rope has currently will - * _reset_ the color and alpha values, unless you provide them as arguments to this method. - * - * See also `Rope.split`. - * - * @method Phaser.GameObjects.Rope#setPoints - * @since 3.23.0 - * - * @param {Phaser.Math.Types.Vector2Like[]} [points] - An array of points to split the Rope into. - * @param {(number|number[])} [colors] - Either a single color value, or an array of values. - * @param {(number|number[])} [alphas] - Either a single alpha value, or an array of values. - * - * @return {this} This Game Object instance. - */ - setPoints: function (points, colors, alphas) - { - var total = points.length; - - if (total < 1) - { - return this; - } - - var currentUVs = this.uv; - - if (this.points.length !== total) - { - this.resizeArrays(total); - } - - var index = 0; - var amount = 0; - - for (var i = 0; i < total; i++) - { - index = i * 4; - amount = i / (total - 1); - - currentUVs[index] = amount; - currentUVs[index + 1] = 0; - currentUVs[index + 2] = amount; - currentUVs[index + 3] = 1; - } - - this.points = points; - - if (colors !== undefined) - { - this.setColors(colors); - } - - if (alphas !== undefined) - { - this.setAlphas(alphas); - } - - return this; - }, - - /** - * Resizes all of the internal arrays: `vertices`, `uv`, `colors` and `alphas` to the new - * given Rope segment total. - * - * @method Phaser.GameObjects.Rope#resizeArrays - * @since 3.23.0 - * - * @param {integer} newSize - The amount of segments to split the Rope in to. - * - * @return {this} This Game Object instance. - */ - resizeArrays: function (newSize) - { - var colors = this.colors; - var alphas = this.alphas; - - this.vertices = new Float32Array(newSize * 4); - this.uv = new Float32Array(newSize * 4); - - colors = new Uint32Array(newSize * 2); - alphas = new Float32Array(newSize * 2); - - for (var i = 0; i < newSize * 2; i++) - { - colors[i] = 0xffffff; - alphas[i] = 1; - } - - this.colors = colors; - this.alphas = alphas; - - // updateVertices during next render - this.dirty = true; - - return this; - }, - - /** - * Updates the vertices based on the Rope points. - * - * This method is called automatically during rendering if `Rope.dirty` is `true`, which is set - * by the `setPoints` and `setDirty` methods. You should flag the Rope as being dirty if you modify - * the Rope points directly. - * - * @method Phaser.GameObjects.Rope#updateVertices - * @since 3.23.0 - * - * @return {this} This Game Object instance. - */ - updateVertices: function () - { - var perp = this._perp; - var points = this.points; - var vertices = this.vertices; - - var total = points.length; - - this.dirty = false; - - if (total < 1) - { - return; - } - - var lastPoint = points[0]; - var nextPoint; - - for (var i = 0; i < total; i++) - { - var point = points[i]; - var index = i * 4; - - if (i < total - 1) - { - nextPoint = points[i + 1]; - } - else - { - nextPoint = point; - } - - perp.x = nextPoint.y - lastPoint.y; - perp.y = -(nextPoint.x - lastPoint.x); - - var ratio = (1 - (i / (total - 1))) * 10; - - if (ratio > 1) - { - ratio = 1; - } - - var perpLength = perp.length(); - var num = this.frame.halfHeight; - - perp.x /= perpLength; - perp.y /= perpLength; - - perp.x *= num; - perp.y *= num; - - vertices[index] = point.x + perp.x; - vertices[index + 1] = point.y + perp.y; - vertices[index + 2] = point.x - perp.x; - vertices[index + 3] = point.y - perp.y; - - lastPoint = point; - } - - return this; - } - -}); - -module.exports = Rope; diff --git a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeCanvasRenderer.js b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeCanvasRenderer.js deleted file mode 100644 index 39273895b..000000000 --- a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeCanvasRenderer.js +++ /dev/null @@ -1,23 +0,0 @@ -/** - * @author Richard Davey - * @copyright 2020 Photon Storm Ltd. - * @license {@link https://opensource.org/licenses/MIT|MIT License} - */ - -/** - * This is a stub function for Rope.Render. There is no Canvas renderer for Rope objects. - * - * @method Phaser.GameObjects.Rope#renderCanvas - * @since 3.0.0 - * @private - * - * @param {Phaser.Renderer.Canvas.CanvasRenderer} renderer - A reference to the current active Canvas renderer. - * @param {Phaser.GameObjects.Rope} src - The Game Object being rendered in this call. - * @param {number} interpolationPercentage - Reserved for future use and custom pipelines. - * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that is rendering the Game Object. - */ -var RopeCanvasRenderer = function () -{ -}; - -module.exports = RopeCanvasRenderer; diff --git a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeCreator.js b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeCreator.js deleted file mode 100644 index bdf13d2e3..000000000 --- a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeCreator.js +++ /dev/null @@ -1,48 +0,0 @@ -/** - * @author Richard Davey - * @copyright 2020 Photon Storm Ltd. - * @license {@link https://opensource.org/licenses/MIT|MIT License} - */ - -var BuildGameObject = require('../BuildGameObject'); -var GameObjectCreator = require('../GameObjectCreator'); -var GetAdvancedValue = require('../../utils/object/GetAdvancedValue'); -var GetValue = require('../../utils/object/GetValue'); -var Rope = require('./Rope'); - -/** - * Creates a new Rope Game Object and returns it. - * - * Note: This method will only be available if the Rope Game Object and WebGL support have been built into Phaser. - * - * @method Phaser.GameObjects.GameObjectCreator#rope - * @since 3.23.0 - * - * @param {object} config - The configuration object this Game Object will use to create itself. - * @param {boolean} [addToScene] - Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object. - * - * @return {Phaser.GameObjects.Rope} The Game Object that was created. - */ -GameObjectCreator.register('rope', function (config, addToScene) -{ - if (config === undefined) { config = {}; } - - var key = GetAdvancedValue(config, 'key', null); - var frame = GetAdvancedValue(config, 'frame', null); - var points = GetValue(config, 'points', undefined); - var colors = GetValue(config, 'colors', undefined); - var alphas = GetValue(config, 'alphas', undefined); - - var rope = new Rope(this.scene, 0, 0, key, frame, points, colors, alphas); - - if (addToScene !== undefined) - { - config.add = addToScene; - } - - BuildGameObject(this.scene, rope, config); - - return rope; -}); - -// When registering a factory function 'this' refers to the GameObjectCreator context. diff --git a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeFactory.js b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeFactory.js deleted file mode 100644 index c15910d93..000000000 --- a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeFactory.js +++ /dev/null @@ -1,43 +0,0 @@ -/** - * @author Richard Davey - * @copyright 2020 Photon Storm Ltd. - * @license {@link https://opensource.org/licenses/MIT|MIT License} - */ - -var Rope = require('./Rope'); -var GameObjectFactory = require('../GameObjectFactory'); - -/** - * Creates a new Rope Game Object and adds it to the Scene. - * - * Note: This method will only be available if the Rope Game Object and WebGL support have been built into Phaser. - * - * @method Phaser.GameObjects.GameObjectFactory#mesh - * @webglOnly - * @since 3.23.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. - * @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager. - * @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with. - * @param {Phaser.Types.Math.Vector2Like[]} [points] - An array containing the vertices data for this Rope. If none is provided a simple quad is created. See `setPoints` to set this post-creation. - * @param {number[]} [colors] - An optional array containing the color data for this Rope. You should provide one color value per pair of vertices. - * @param {number[]} [alphas] - An optional array containing the alpha data for this Rope. You should provide one alpha value per pair of vertices. - * - * @return {Phaser.GameObjects.Rope} The Game Object that was created. - */ -if (typeof WEBGL_RENDERER) -{ - GameObjectFactory.register('rope', function (x, y, texture, frame, points, colors, alphas) - { - return this.displayList.add(new Rope(this.scene, x, y, texture, frame, points, colors, alphas)); - }); -} - -// When registering a factory function 'this' refers to the GameObjectFactory context. -// -// There are several properties available to use: -// -// 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 diff --git a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeRender.js b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeRender.js deleted file mode 100644 index b2ea4a41c..000000000 --- a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeRender.js +++ /dev/null @@ -1,25 +0,0 @@ -/** - * @author Richard Davey - * @copyright 2020 Photon Storm Ltd. - * @license {@link https://opensource.org/licenses/MIT|MIT License} - */ - -var renderWebGL = require('../../utils/NOOP'); -var renderCanvas = require('../../utils/NOOP'); - -if (typeof WEBGL_RENDERER) -{ - renderWebGL = require('./RopeWebGLRenderer'); -} - -if (typeof CANVAS_RENDERER) -{ - renderCanvas = require('./RopeCanvasRenderer'); -} - -module.exports = { - - renderWebGL: renderWebGL, - renderCanvas: renderCanvas - -}; diff --git a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeWebGLRenderer.js b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeWebGLRenderer.js deleted file mode 100644 index daadcf230..000000000 --- a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/gameobjects/rope/RopeWebGLRenderer.js +++ /dev/null @@ -1,116 +0,0 @@ -/** - * @author Richard Davey - * @copyright 2020 Photon Storm Ltd. - * @license {@link https://opensource.org/licenses/MIT|MIT License} - */ - -var Utils = require('../../renderer/webgl/Utils'); - -/** - * Renders this Game Object with the WebGL Renderer to the given Camera. - * The object will not render if any of its renderFlags are set or it is being actively filtered out by the Camera. - * This method should not be called directly. It is a utility function of the Render module. - * - * @method Phaser.GameObjects.Rope#renderWebGL - * @since 3.23.0 - * @private - * - * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - A reference to the current active WebGL renderer. - * @param {Phaser.GameObjects.Rope} src - The Game Object being rendered in this call. - * @param {number} interpolationPercentage - Reserved for future use and custom pipelines. - * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that is rendering the Game Object. - * @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - This transform matrix is defined if the game object is nested - */ -var RopeWebGLRenderer = function (renderer, src, interpolationPercentage, camera, parentMatrix) -{ - var pipeline = src.pipeline; - - renderer.setPipeline(pipeline, src); - - var camMatrix = pipeline._tempMatrix1; - var spriteMatrix = pipeline._tempMatrix2; - var calcMatrix = pipeline._tempMatrix3; - - spriteMatrix.applyITRS(src.x, src.y, src.rotation, src.scaleX, src.scaleY); - - camMatrix.copyFrom(camera.matrix); - - if (parentMatrix) - { - // Multiply the camera by the parent matrix - camMatrix.multiplyWithOffset(parentMatrix, -camera.scrollX * src.scrollFactorX, -camera.scrollY * src.scrollFactorY); - - // Undo the camera scroll - spriteMatrix.e = src.x; - spriteMatrix.f = src.y; - - // Multiply by the Sprite matrix, store result in calcMatrix - camMatrix.multiply(spriteMatrix, calcMatrix); - } - else - { - spriteMatrix.e -= camera.scrollX * src.scrollFactorX; - spriteMatrix.f -= camera.scrollY * src.scrollFactorY; - - // Multiply by the Sprite matrix, store result in calcMatrix - camMatrix.multiply(spriteMatrix, calcMatrix); - } - - var frame = src.frame; - var texture = frame.glTexture; - - var vertices = src.vertices; - var uvs = src.uv; - var colors = src.colors; - var alphas = src.alphas; - - var meshVerticesLength = vertices.length; - var vertexCount = Math.floor(meshVerticesLength * 0.5); - - // Because it's a triangle strip - pipeline.flush(); - - pipeline.setTexture2D(texture, 0); - - var vertexViewF32 = pipeline.vertexViewF32; - var vertexViewU32 = pipeline.vertexViewU32; - - var vertexOffset = (pipeline.vertexCount * pipeline.vertexComponentCount) - 1; - - var colorIndex = 0; - - var tintEffect = src.tintFill; - - if (src.dirty) - { - src.updateVertices(); - } - - for (var i = 0; i < meshVerticesLength; i += 2) - { - var x = vertices[i + 0]; - var y = vertices[i + 1]; - - var tx = x * calcMatrix.a + y * calcMatrix.c + calcMatrix.e; - var ty = x * calcMatrix.b + y * calcMatrix.d + calcMatrix.f; - - if (camera.roundPixels) - { - tx = Math.round(tx); - ty = Math.round(ty); - } - - vertexViewF32[++vertexOffset] = tx; - vertexViewF32[++vertexOffset] = ty; - vertexViewF32[++vertexOffset] = uvs[i + 0]; - vertexViewF32[++vertexOffset] = uvs[i + 1]; - vertexViewF32[++vertexOffset] = tintEffect; - vertexViewU32[++vertexOffset] = Utils.getTintAppendFloatAlphaAndSwap(colors[colorIndex], camera.alpha * alphas[colorIndex]); - - colorIndex++; - } - - pipeline.vertexCount += vertexCount; -}; - -module.exports = RopeWebGLRenderer; diff --git a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/renderer/webgl/WebGLRenderer.js b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/renderer/webgl/WebGLRenderer.js index 63afb65f4..cdd00152b 100644 --- a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/renderer/webgl/WebGLRenderer.js +++ b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/renderer/webgl/WebGLRenderer.js @@ -23,7 +23,6 @@ var WebGLSnapshot = require('../snapshot/WebGLSnapshot'); var BitmapMaskPipeline = require('./pipelines/BitmapMaskPipeline'); var ForwardDiffuseLightPipeline = require('./pipelines/ForwardDiffuseLightPipeline'); var TextureTintPipeline = require('./pipelines/TextureTintPipeline'); -var TextureTintStripPipeline = require('./pipelines/TextureTintStripPipeline'); /** * @callback WebGLContextCallback @@ -712,7 +711,6 @@ var WebGLRenderer = new Class({ this.pipelines = {}; this.addPipeline('TextureTintPipeline', new TextureTintPipeline({ game: game, renderer: this })); - this.addPipeline('TextureTintStripPipeline', new TextureTintStripPipeline({ game: game, renderer: this })); this.addPipeline('BitmapMaskPipeline', new BitmapMaskPipeline({ game: game, renderer: this })); this.addPipeline('Light2D', new ForwardDiffuseLightPipeline({ game: game, renderer: this, maxLights: config.maxLights })); diff --git a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/renderer/webgl/pipelines/TextureTintStripPipeline.js b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/renderer/webgl/pipelines/TextureTintStripPipeline.js deleted file mode 100644 index fe2f2febc..000000000 --- a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/renderer/webgl/pipelines/TextureTintStripPipeline.js +++ /dev/null @@ -1,404 +0,0 @@ -/** - * @author Richard Davey - * @author Felipe Alfonso <@bitnenfer> - * @copyright 2020 Photon Storm Ltd. - * @license {@link https://opensource.org/licenses/MIT|MIT License} - */ - -var Class = require('../../../utils/Class'); -var GetFastValue = require('../../../utils/object/GetFastValue'); -var ModelViewProjection = require('./components/ModelViewProjection'); -var ShaderSourceFS = require('../shaders/TextureTint-frag.js'); -var ShaderSourceVS = require('../shaders/TextureTint-vert.js'); -var TransformMatrix = require('../../../gameobjects/components/TransformMatrix'); -var WebGLPipeline = require('../WebGLPipeline'); - -/** - * @classdesc - * TextureTintStripPipeline implements the rendering infrastructure - * for displaying textured objects - * The config properties are: - * - game: Current game instance. - * - renderer: Current WebGL renderer. - * - vertShader: Source for vertex shader as a string. - * - fragShader: Source for fragment shader as a string. - * - vertexCapacity: The amount of vertices that shall be allocated - * - vertexSize: The size of a single vertex in bytes. - * - * @class TextureTintStripPipeline - * @extends Phaser.Renderer.WebGL.WebGLPipeline - * @memberof Phaser.Renderer.WebGL.Pipelines - * @constructor - * @since 3.23.0 - * - * @param {object} config - The configuration options for this Texture Tint Pipeline, as described above. - */ -var TextureTintStripPipeline = new Class({ - - Extends: WebGLPipeline, - - Mixins: [ - ModelViewProjection - ], - - initialize: - - function TextureTintStripPipeline (config) - { - var rendererConfig = config.renderer.config; - - // Vertex Size = attribute size added together (2 + 2 + 1 + 4) - - WebGLPipeline.call(this, { - game: config.game, - renderer: config.renderer, - gl: config.renderer.gl, - topology: config.renderer.gl.TRIANGLE_STRIP, - vertShader: GetFastValue(config, 'vertShader', ShaderSourceVS), - fragShader: GetFastValue(config, 'fragShader', ShaderSourceFS), - vertexCapacity: GetFastValue(config, 'vertexCapacity', 6 * rendererConfig.batchSize), - vertexSize: GetFastValue(config, 'vertexSize', Float32Array.BYTES_PER_ELEMENT * 5 + Uint8Array.BYTES_PER_ELEMENT * 4), - attributes: [ - { - name: 'inPosition', - size: 2, - type: config.renderer.gl.FLOAT, - normalized: false, - offset: 0 - }, - { - name: 'inTexCoord', - size: 2, - type: config.renderer.gl.FLOAT, - normalized: false, - offset: Float32Array.BYTES_PER_ELEMENT * 2 - }, - { - name: 'inTintEffect', - size: 1, - type: config.renderer.gl.FLOAT, - normalized: false, - offset: Float32Array.BYTES_PER_ELEMENT * 4 - }, - { - name: 'inTint', - size: 4, - type: config.renderer.gl.UNSIGNED_BYTE, - normalized: true, - offset: Float32Array.BYTES_PER_ELEMENT * 5 - } - ] - }); - - /** - * Float32 view of the array buffer containing the pipeline's vertices. - * - * @name Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#vertexViewF32 - * @type {Float32Array} - * @since 3.23.0 - */ - this.vertexViewF32 = new Float32Array(this.vertexData); - - /** - * Uint32 view of the array buffer containing the pipeline's vertices. - * - * @name Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#vertexViewU32 - * @type {Uint32Array} - * @since 3.23.0 - */ - this.vertexViewU32 = new Uint32Array(this.vertexData); - - /** - * Size of the batch. - * - * @name Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#maxQuads - * @type {integer} - * @since 3.23.0 - */ - this.maxQuads = rendererConfig.batchSize; - - /** - * Collection of batch information - * - * @name Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#batches - * @type {array} - * @since 3.23.0 - */ - this.batches = []; - - /** - * A temporary Transform Matrix, re-used internally during batching. - * - * @name Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#_tempMatrix1 - * @private - * @type {Phaser.GameObjects.Components.TransformMatrix} - * @since 3.23.0 - */ - this._tempMatrix1 = new TransformMatrix(); - - /** - * A temporary Transform Matrix, re-used internally during batching. - * - * @name Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#_tempMatrix2 - * @private - * @type {Phaser.GameObjects.Components.TransformMatrix} - * @since 3.23.0 - */ - this._tempMatrix2 = new TransformMatrix(); - - /** - * A temporary Transform Matrix, re-used internally during batching. - * - * @name Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#_tempMatrix3 - * @private - * @type {Phaser.GameObjects.Components.TransformMatrix} - * @since 3.23.0 - */ - this._tempMatrix3 = new TransformMatrix(); - - this.mvpInit(); - }, - - /** - * Called every time the pipeline needs to be used. - * It binds all necessary resources. - * - * @method Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#onBind - * @since 3.23.0 - * - * @return {this} This WebGLPipeline instance. - */ - onBind: function () - { - WebGLPipeline.prototype.onBind.call(this); - - this.mvpUpdate(); - - return this; - }, - - /** - * Resizes this pipeline and updates the projection. - * - * @method Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#resize - * @since 3.23.0 - * - * @param {number} width - The new width. - * @param {number} height - The new height. - * @param {number} resolution - The resolution. - * - * @return {this} This WebGLPipeline instance. - */ - resize: function (width, height, resolution) - { - WebGLPipeline.prototype.resize.call(this, width, height, resolution); - - this.projOrtho(0, this.width, this.height, 0, -1000.0, 1000.0); - - return this; - }, - - /** - * Assigns a texture to the current batch. If a different texture is already set it creates a new batch object. - * - * @method Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setTexture2D - * @since 3.23.0 - * - * @param {WebGLTexture} [texture] - WebGLTexture that will be assigned to the current batch. If not given uses blankTexture. - * @param {integer} [unit=0] - Texture unit to which the texture needs to be bound. - * - * @return {Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline} This pipeline instance. - */ - setTexture2D: function (texture, unit) - { - if (texture === undefined) { texture = this.renderer.blankTexture.glTexture; } - if (unit === undefined) { unit = 0; } - - if (this.requireTextureBatch(texture, unit)) - { - this.pushBatch(texture, unit); - } - - return this; - }, - - /** - * Checks if the current batch has the same texture and texture unit, or if we need to create a new batch. - * - * @method Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#requireTextureBatch - * @since 3.23.0 - * - * @param {WebGLTexture} texture - WebGLTexture that will be assigned to the current batch. If not given uses blankTexture. - * @param {integer} unit - Texture unit to which the texture needs to be bound. - * - * @return {boolean} `true` if the pipeline needs to create a new batch, otherwise `false`. - */ - requireTextureBatch: function (texture, unit) - { - var batches = this.batches; - var batchLength = batches.length; - - if (batchLength > 0) - { - // If Texture Unit specified, we get the texture from the textures array, otherwise we use the texture property - var currentTexture = (unit > 0) ? batches[batchLength - 1].textures[unit - 1] : batches[batchLength - 1].texture; - - return !(currentTexture === texture); - } - - return true; - }, - - /** - * Creates a new batch object and pushes it to a batch array. - * The batch object contains information relevant to the current - * vertex batch like the offset in the vertex buffer, vertex count and - * the textures used by that batch. - * - * @method Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#pushBatch - * @since 3.23.0 - * - * @param {WebGLTexture} texture - Optional WebGLTexture that will be assigned to the created batch. - * @param {integer} unit - Texture unit to which the texture needs to be bound. - */ - pushBatch: function (texture, unit) - { - if (unit === 0) - { - this.batches.push({ - first: this.vertexCount, - texture: texture, - textures: [] - }); - } - else - { - var textures = []; - - textures[unit - 1] = texture; - - this.batches.push({ - first: this.vertexCount, - texture: null, - textures: textures - }); - } - }, - - /** - * Uploads the vertex data and emits a draw call for the current batch of vertices. - * - * @method Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#flush - * @since 3.23.0 - * - * @return {this} This WebGLPipeline instance. - */ - flush: function () - { - if (this.flushLocked) - { - return this; - } - - this.flushLocked = true; - - var gl = this.gl; - var vertexCount = this.vertexCount; - var topology = this.topology; - var vertexSize = this.vertexSize; - var renderer = this.renderer; - - var batches = this.batches; - var batchCount = batches.length; - var batchVertexCount = 0; - var batch = null; - var batchNext; - var textureIndex; - var nTexture; - - if (batchCount === 0 || vertexCount === 0) - { - this.flushLocked = false; - - return this; - } - - gl.bufferSubData(gl.ARRAY_BUFFER, 0, this.bytes.subarray(0, vertexCount * vertexSize)); - - // Process the TEXTURE BATCHES - - for (var index = 0; index < batchCount - 1; index++) - { - batch = batches[index]; - batchNext = batches[index + 1]; - - // Multi-texture check (for non-zero texture units) - if (batch.textures.length > 0) - { - for (textureIndex = 0; textureIndex < batch.textures.length; ++textureIndex) - { - nTexture = batch.textures[textureIndex]; - - if (nTexture) - { - renderer.setTexture2D(nTexture, 1 + textureIndex, false); - } - } - - gl.activeTexture(gl.TEXTURE0); - } - - batchVertexCount = batchNext.first - batch.first; - - // Bail out if texture property is null (i.e. if a texture unit > 0) - if (batch.texture === null || batchVertexCount <= 0) - { - continue; - } - - renderer.setTexture2D(batch.texture, 0, false); - - gl.drawArrays(topology, batch.first, batchVertexCount); - } - - // Left over data - batch = batches[batchCount - 1]; - - // Multi-texture check (for non-zero texture units) - - if (batch.textures.length > 0) - { - for (textureIndex = 0; textureIndex < batch.textures.length; ++textureIndex) - { - nTexture = batch.textures[textureIndex]; - - if (nTexture) - { - renderer.setTexture2D(nTexture, 1 + textureIndex, false); - } - } - - gl.activeTexture(gl.TEXTURE0); - } - - batchVertexCount = vertexCount - batch.first; - - if (batch.texture && batchVertexCount > 0) - { - renderer.setTexture2D(batch.texture, 0, false); - - gl.drawArrays(topology, batch.first, batchVertexCount); - } - - this.vertexCount = 0; - - batches.length = 0; - - this.flushLocked = false; - - return this; - } - -}); - -module.exports = TextureTintStripPipeline; diff --git a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/renderer/webgl/pipelines/index.js b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/renderer/webgl/pipelines/index.js index 10bd15cb3..70bfe0b29 100644 --- a/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/renderer/webgl/pipelines/index.js +++ b/source/v2/phasereditor/phasereditor.resources.phaser.code/phaser-master/src/renderer/webgl/pipelines/index.js @@ -13,7 +13,6 @@ module.exports = { BitmapMaskPipeline: require('./BitmapMaskPipeline'), ForwardDiffuseLightPipeline: require('./ForwardDiffuseLightPipeline'), TextureTintPipeline: require('./TextureTintPipeline'), - TextureTintStripPipeline: require('./TextureTintStripPipeline'), ModelViewProjection: require('./components/ModelViewProjection') }; diff --git a/source/v2/phasereditor/phasereditor.resources.phaser.metadata/phaser-custom/phaser3-docs/json/phaser.json b/source/v2/phasereditor/phasereditor.resources.phaser.metadata/phaser-custom/phaser3-docs/json/phaser.json index 105c8a581..6c85e3340 100644 --- a/source/v2/phasereditor/phasereditor.resources.phaser.metadata/phaser-custom/phaser3-docs/json/phaser.json +++ b/source/v2/phasereditor/phasereditor.resources.phaser.metadata/phaser-custom/phaser3-docs/json/phaser.json @@ -1 +1 @@ -{"docs":[{"meta":{"range":[149,199],"filename":"AlignTo.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"QuickSet","longname":"QuickSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AlignTo.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have public `x` and `y` properties, and aligns them next to each other.\n\nThe first item isn't moved. The second item is aligned next to the first, then the third next to the second, and so on.","kind":"function","name":"AlignTo","since":"3.22.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["integer"]},"description":"The position to align the items with. This is an align constant, such as `Phaser.Display.Align.LEFT_CENTER`.","name":"position"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.AlignTo","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"Angle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Angle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `angle` property,\nand then adds the given value to each of their `angle` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `Angle(group.getChildren(), value, step)`","kind":"function","name":"Angle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `angle` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.Angle","scope":"static","___s":true},{"meta":{"filename":"Call.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of objects and passes each of them to the given callback.","kind":"function","name":"Call","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["Phaser.Types.Actions.CallCallback"]},"description":"The callback to be invoked. It will be passed just one argument: the item from the array.","name":"callback"},{"type":{"names":["*"]},"description":"The scope in which the callback will be invoked.","name":"context"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.Call","scope":"static","___s":true},{"meta":{"filename":"GetFirst.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of objects and returns the first element in the array that has properties which match\nall of those specified in the `compare` object. For example, if the compare object was: `{ scaleX: 0.5, alpha: 1 }`\nthen it would return the first item which had the property `scaleX` set to 0.5 and `alpha` set to 1.\n\nTo use this with a Group: `GetFirst(group.getChildren(), compare, index)`","kind":"function","name":"GetFirst","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be searched by this action.","name":"items"},{"type":{"names":["object"]},"description":"The comparison object. Each property in this object will be checked against the items of the array.","name":"compare"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"}],"returns":[{"type":{"names":["object","Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The first object in the array that matches the comparison object, or `null` if no match was found."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.GetFirst","scope":"static","___s":true},{"meta":{"filename":"GetLast.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of objects and returns the last element in the array that has properties which match\nall of those specified in the `compare` object. For example, if the compare object was: `{ scaleX: 0.5, alpha: 1 }`\nthen it would return the last item which had the property `scaleX` set to 0.5 and `alpha` set to 1.\n\nTo use this with a Group: `GetLast(group.getChildren(), compare, index)`","kind":"function","name":"GetLast","since":"3.3.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be searched by this action.","name":"items"},{"type":{"names":["object"]},"description":"The comparison object. Each property in this object will be checked against the items of the array.","name":"compare"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"}],"returns":[{"type":{"names":["object","Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The last object in the array that matches the comparison object, or `null` if no match was found."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.GetLast","scope":"static","___s":true},{"meta":{"range":[180,229],"filename":"GridAlign.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"AlignIn","longname":"AlignIn","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GridAlign.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have public `x` and `y` properties,\nand then aligns them based on the grid configuration given to this action.","kind":"function","name":"GridAlign","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["Phaser.Types.Actions.GridAlignConfig"]},"description":"The GridAlign Configuration object.","name":"options"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.GridAlign","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"IncAlpha.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IncAlpha.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `alpha` property,\nand then adds the given value to each of their `alpha` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `IncAlpha(group.getChildren(), value, step)`","kind":"function","name":"IncAlpha","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `alpha` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.IncAlpha","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"IncX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IncX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `x` property,\nand then adds the given value to each of their `x` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `IncX(group.getChildren(), value, step)`","kind":"function","name":"IncX","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.IncX","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"IncXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IncXY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have public `x` and `y` properties,\nand then adds the given value to each of them.\n\nThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `IncXY(group.getChildren(), x, y, stepX, stepY)`","kind":"function","name":"IncXY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to be added to the `y` property. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.IncXY","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"IncY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IncY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `y` property,\nand then adds the given value to each of their `y` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `IncY(group.getChildren(), value, step)`","kind":"function","name":"IncY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `y` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.IncY","scope":"static","___s":true},{"meta":{"filename":"PlaceOnCircle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them on evenly spaced points around the perimeter of a Circle.\n\nIf you wish to pass a `Phaser.GameObjects.Circle` Shape to this function, you should pass its `geom` property.","kind":"function","name":"PlaceOnCircle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to position the Game Objects on.","name":"circle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional angle to start position from, in radians.","name":"startAngle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":6.28,"description":"Optional angle to stop position at, in radians.","name":"endAngle"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PlaceOnCircle","scope":"static","___s":true},{"meta":{"filename":"PlaceOnEllipse.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them on evenly spaced points around the perimeter of an Ellipse.\n\nIf you wish to pass a `Phaser.GameObjects.Ellipse` Shape to this function, you should pass its `geom` property.","kind":"function","name":"PlaceOnEllipse","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to position the Game Objects on.","name":"ellipse"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional angle to start position from, in radians.","name":"startAngle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":6.28,"description":"Optional angle to stop position at, in radians.","name":"endAngle"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PlaceOnEllipse","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"PlaceOnLine.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"GetPoints","longname":"GetPoints","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PlaceOnLine.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Positions an array of Game Objects on evenly spaced points of a Line.","kind":"function","name":"PlaceOnLine","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to position the Game Objects on.","name":"line"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PlaceOnLine","scope":"static","___s":true},{"meta":{"range":[180,236],"filename":"PlaceOnRectangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"MarchingAnts","longname":"MarchingAnts","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PlaceOnRectangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them on evenly spaced points around the perimeter of a Rectangle.\n\nPlacement starts from the top-left of the rectangle, and proceeds in a clockwise direction.\nIf the `shift` parameter is given you can offset where placement begins.","kind":"function","name":"PlaceOnRectangle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to position the Game Objects on.","name":"rect"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"An optional positional offset.","name":"shift"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PlaceOnRectangle","scope":"static","___s":true},{"meta":{"range":[180,237],"filename":"PlaceOnTriangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"BresenhamPoints","longname":"BresenhamPoints","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PlaceOnTriangle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them on evenly spaced points around the edges of a Triangle.\n\nIf you wish to pass a `Phaser.GameObjects.Triangle` Shape to this function, you should pass its `geom` property.","kind":"function","name":"PlaceOnTriangle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to position the Game Objects on.","name":"triangle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"An optional step rate, to increase or decrease the packing of the Game Objects on the lines.","name":"stepRate"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PlaceOnTriangle","scope":"static","___s":true},{"meta":{"filename":"PlayAnimation.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Play an animation with the given key, starting at the given startFrame on all Game Objects in items.","kind":"function","name":"PlayAnimation","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["string"]},"description":"The name of the animation to play.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The starting frame of the animation with the given key.","name":"startFrame"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PlayAnimation","scope":"static","___s":true},{"meta":{"filename":"PropertyValueInc.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public property as defined in `key`,\nand then adds the given value to it.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `PropertyValueInc(group.getChildren(), key, value, step)`","kind":"function","name":"PropertyValueInc","since":"3.3.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to be added to the property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PropertyValueInc","scope":"static","___s":true},{"meta":{"filename":"PropertyValueSet.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public property as defined in `key`,\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `PropertyValueSet(group.getChildren(), key, value, step)`","kind":"function","name":"PropertyValueSet","since":"3.3.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PropertyValueSet","scope":"static","___s":true},{"meta":{"range":[180,221],"filename":"RandomCircle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Random","longname":"Random","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomCircle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them at random locations within the Circle.\n\nIf you wish to pass a `Phaser.GameObjects.Circle` Shape to this function, you should pass its `geom` property.","kind":"function","name":"RandomCircle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to position the Game Objects within.","name":"circle"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RandomCircle","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"RandomEllipse.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Random","longname":"Random","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomEllipse.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them at random locations within the Ellipse.\n\nIf you wish to pass a `Phaser.GameObjects.Ellipse` Shape to this function, you should pass its `geom` property.","kind":"function","name":"RandomEllipse","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to position the Game Objects within.","name":"ellipse"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RandomEllipse","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"RandomLine.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Random","longname":"Random","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomLine.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them at random locations on the Line.\n\nIf you wish to pass a `Phaser.GameObjects.Line` Shape to this function, you should pass its `geom` property.","kind":"function","name":"RandomLine","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to position the Game Objects randomly on.","name":"line"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RandomLine","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"RandomRectangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Random","longname":"Random","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomRectangle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them at random locations within the Rectangle.","kind":"function","name":"RandomRectangle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to position the Game Objects within.","name":"rect"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RandomRectangle","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"RandomTriangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Random","longname":"Random","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomTriangle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them at random locations within the Triangle.\n\nIf you wish to pass a `Phaser.GameObjects.Triangle` Shape to this function, you should pass its `geom` property.","kind":"function","name":"RandomTriangle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to position the Game Objects within.","name":"triangle"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RandomTriangle","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"Rotate.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Rotate.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `rotation` property,\nand then adds the given value to each of their `rotation` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `Rotate(group.getChildren(), value, step)`","kind":"function","name":"Rotate","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `rotation` property (in radians).","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.Rotate","scope":"static","___s":true},{"meta":{"range":[180,242],"filename":"RotateAround.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"RotateAroundDistance","longname":"RotateAroundDistance","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateAround.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Rotates each item around the given point by the given angle.","kind":"function","name":"RotateAround","since":"3.0.0","see":["Phaser.Math.RotateAroundDistance"],"params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["object"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RotateAround","scope":"static","___s":true},{"meta":{"range":[180,246],"filename":"RotateAroundDistance.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"MathRotateAroundDistance","longname":"MathRotateAroundDistance","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateAroundDistance.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Rotates an array of Game Objects around a point by the given angle and distance.","kind":"function","name":"RotateAroundDistance","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["object"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"},{"type":{"names":["number"]},"description":"The distance from the point of rotation in pixels.","name":"distance"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RotateAroundDistance","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"ScaleX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScaleX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `scaleX` property,\nand then adds the given value to each of their `scaleX` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `ScaleX(group.getChildren(), value, step)`","kind":"function","name":"ScaleX","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `scaleX` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.ScaleX","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"ScaleXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScaleXY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have public `scaleX` and `scaleY` properties,\nand then adds the given value to each of them.\n\nThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `ScaleXY(group.getChildren(), scaleX, scaleY, stepX, stepY)`","kind":"function","name":"ScaleXY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `scaleX` property.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to be added to the `scaleY` property. If `undefined` or `null` it uses the `scaleX` value.","name":"scaleY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleY` amount, multiplied by the iteration counter.","name":"stepY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.ScaleXY","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"ScaleY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScaleY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `scaleY` property,\nand then adds the given value to each of their `scaleY` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `ScaleY(group.getChildren(), value, step)`","kind":"function","name":"ScaleY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `scaleY` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.ScaleY","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetAlpha.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetAlpha.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `alpha`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetAlpha(group.getChildren(), value, step)`","kind":"function","name":"SetAlpha","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetAlpha","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetBlendMode.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetBlendMode.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `blendMode`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetBlendMode(group.getChildren(), value)`","kind":"function","name":"SetBlendMode","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetBlendMode","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetDepth.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetDepth.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `depth`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetDepth(group.getChildren(), value, step)`","kind":"function","name":"SetDepth","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetDepth","scope":"static","___s":true},{"meta":{"filename":"SetHitArea.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Passes all provided Game Objects to the Input Manager to enable them for input with identical areas and callbacks.","see":["{@link Phaser.GameObjects.GameObject#setInteractive}"],"kind":"function","name":"SetHitArea","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["*"]},"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"hitAreaCallback"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetHitArea","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetOrigin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetOrigin.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public properties `originX` and `originY`\nand then sets them to the given values.\n\nThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetOrigin(group.getChildren(), originX, originY, stepX, stepY)`","kind":"function","name":"SetOrigin","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the `originX` property to.","name":"originX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to set the `originY` property to. If `undefined` or `null` it uses the `originX` value.","name":"originY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originY` amount, multiplied by the iteration counter.","name":"stepY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetOrigin","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetRotation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetRotation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `rotation`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetRotation(group.getChildren(), value, step)`","kind":"function","name":"SetRotation","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetRotation","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetScale.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetScale.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public properties `scaleX` and `scaleY`\nand then sets them to the given values.\n\nThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetScale(group.getChildren(), scaleX, scaleY, stepX, stepY)`","kind":"function","name":"SetScale","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the `scaleX` property to.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to set the `scaleY` property to. If `undefined` or `null` it uses the `scaleX` value.","name":"scaleY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleY` amount, multiplied by the iteration counter.","name":"stepY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetScale","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetScaleX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetScaleX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `scaleX`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetScaleX(group.getChildren(), value, step)`","kind":"function","name":"SetScaleX","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetScaleX","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetScaleY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetScaleY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `scaleY`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetScaleY(group.getChildren(), value, step)`","kind":"function","name":"SetScaleY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetScaleY","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetScrollFactor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetScrollFactor.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public properties `scrollFactorX` and `scrollFactorY`\nand then sets them to the given values.\n\nThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetScrollFactor(group.getChildren(), scrollFactorX, scrollFactorY, stepX, stepY)`","kind":"function","name":"SetScrollFactor","since":"3.21.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the `scrollFactorX` property to.","name":"scrollFactorX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to set the `scrollFactorY` property to. If `undefined` or `null` it uses the `scrollFactorX` value.","name":"scrollFactorY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scrollFactorX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scrollFactorY` amount, multiplied by the iteration counter.","name":"stepY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetScrollFactor","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetScrollFactorX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetScrollFactorX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `scrollFactorX`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetScrollFactorX(group.getChildren(), value, step)`","kind":"function","name":"SetScrollFactorX","since":"3.21.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetScrollFactorX","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetScrollFactorY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetScrollFactorY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `scrollFactorY`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetScrollFactorY(group.getChildren(), value, step)`","kind":"function","name":"SetScrollFactorY","since":"3.21.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetScrollFactorY","scope":"static","___s":true},{"meta":{"filename":"SetTint.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public method setTint() and then updates it to the given value(s). You can specify tint color per corner or provide only one color value for `topLeft` parameter, in which case whole item will be tinted with that color.","kind":"function","name":"SetTint","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["number"]},"description":"The tint being applied to top-left corner of item. If other parameters are given no value, this tint will be applied to whole item.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to top-right corner of item.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-left corner of item.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-right corner of item.","name":"bottomRight"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetTint","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetVisible.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetVisible.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `visible`\nand then sets it to the given value.\n\nTo use this with a Group: `SetVisible(group.getChildren(), value)`","kind":"function","name":"SetVisible","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["boolean"]},"description":"The value to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetVisible","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `x`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetX(group.getChildren(), value, step)`","kind":"function","name":"SetX","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetX","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetXY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public properties `x` and `y`\nand then sets them to the given values.\n\nThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetXY(group.getChildren(), x, y, stepX, stepY)`","kind":"function","name":"SetXY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the `x` property to.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to set the `y` property to. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetXY","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `y`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetY(group.getChildren(), value, step)`","kind":"function","name":"SetY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetY","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"ShiftPosition.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Vector2","longname":"Vector2","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ShiftPosition.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Iterate through the items array changing the position of each element to be that of the element that came before\nit in the array (or after it if direction = 1)\n\nThe first items position is set to x/y.\n\nThe final x/y coords are returned","kind":"function","name":"ShiftPosition","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["number"]},"description":"The x coordinate to place the first item in the array at.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to place the first item in the array at.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The iteration direction. 0 = first to last and 1 = last to first.","name":"direction"},{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An optional objec to store the final objects position in.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The output vector."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.ShiftPosition","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"Shuffle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"ArrayShuffle","longname":"ArrayShuffle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Shuffle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Shuffles the array in place. The shuffled array is both modified and returned.","kind":"function","name":"Shuffle","since":"3.0.0","see":["Phaser.Utils.Array.Shuffle"],"params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.Shuffle","scope":"static","___s":true},{"meta":{"range":[180,226],"filename":"SmoothStep.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"MathSmoothStep","longname":"MathSmoothStep","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SmoothStep.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Smoothstep is a sigmoid-like interpolation and clamping function.\n\nThe function depends on three parameters, the input x, the \"left edge\" and the \"right edge\", with the left edge being assumed smaller than the right edge. The function receives a real number x as an argument and returns 0 if x is less than or equal to the left edge, 1 if x is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial, between 0 and 1 otherwise. The slope of the smoothstep function is zero at both edges. This is convenient for creating a sequence of transitions using smoothstep to interpolate each segment as an alternative to using more sophisticated or expensive interpolation techniques.","kind":"function","name":"SmoothStep","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["string"]},"description":"The property of the Game Object to interpolate.","name":"property"},{"type":{"names":["number"]},"description":"The minimum interpolation value.","name":"min"},{"type":{"names":["number"]},"description":"The maximum interpolation value.","name":"max"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the values be incremented? `true` or set (`false`)","name":"inc"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SmoothStep","scope":"static","___s":true},{"meta":{"range":[180,230],"filename":"SmootherStep.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"MathSmootherStep","longname":"MathSmootherStep","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SmootherStep.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Smootherstep is a sigmoid-like interpolation and clamping function.\n\nThe function depends on three parameters, the input x, the \"left edge\" and the \"right edge\", with the left edge being assumed smaller than the right edge. The function receives a real number x as an argument and returns 0 if x is less than or equal to the left edge, 1 if x is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial, between 0 and 1 otherwise. The slope of the smoothstep function is zero at both edges. This is convenient for creating a sequence of transitions using smoothstep to interpolate each segment as an alternative to using more sophisticated or expensive interpolation techniques.","kind":"function","name":"SmootherStep","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["string"]},"description":"The property of the Game Object to interpolate.","name":"property"},{"type":{"names":["number"]},"description":"The minimum interpolation value.","name":"min"},{"type":{"names":["number"]},"description":"The maximum interpolation value.","name":"max"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the values be incremented? `true` or set (`false`)","name":"inc"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SmootherStep","scope":"static","___s":true},{"meta":{"filename":"Spread.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and then modifies their `property` so the value equals, or is incremented, by the\ncalculated spread value.\n\nThe spread value is derived from the given `min` and `max` values and the total number of items in the array.\n\nFor example, to cause an array of Sprites to change in alpha from 0 to 1 you could call:\n\n```javascript\nPhaser.Actions.Spread(itemsArray, 'alpha', 0, 1);\n```","kind":"function","name":"Spread","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["string"]},"description":"The property of the Game Object to spread.","name":"property"},{"type":{"names":["number"]},"description":"The minimum value.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value.","name":"max"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the values be incremented? `true` or set (`false`)","name":"inc"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.Spread","scope":"static","___s":true},{"meta":{"filename":"ToggleVisible.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and toggles the visibility of each one.\nThose previously `visible = false` will become `visible = true`, and vice versa.","kind":"function","name":"ToggleVisible","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.ToggleVisible","scope":"static","___s":true},{"meta":{"range":[225,255],"filename":"WrapInRectangle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Wrap","longname":"Wrap","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WrapInRectangle.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Wrap each item's coordinates within a rectangle's area.","kind":"function","name":"WrapInRectangle","since":"3.0.0","see":["Phaser.Math.Wrap"],"params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle.","name":"rect"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"An amount added to each side of the rectangle during the operation.","name":"padding"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.WrapInRectangle","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"kind":"namespace","name":"Actions","memberof":"Phaser","longname":"Phaser.Actions","scope":"static","___s":true},{"meta":{"filename":"CallCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions/typedefs"},"kind":"typedef","name":"CallCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to run the callback on.","name":"item"}],"memberof":"Phaser.Types.Actions","longname":"Phaser.Types.Actions.CallCallback","scope":"static","___s":true},{"meta":{"filename":"GridAlignConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions/typedefs"},"kind":"typedef","name":"GridAlignConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":-1,"description":"The width of the grid in items (not pixels). -1 means lay all items out horizontally, regardless of quantity.\n If both this value and height are set to -1 then this value overrides it and the `height` value is ignored.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":-1,"description":"The height of the grid in items (not pixels). -1 means lay all items out vertically, regardless of quantity.\n If both this value and `width` are set to -1 then `width` overrides it and this value is ignored.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The width of the cell, in pixels, in which the item is positioned.","name":"cellWidth"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The height of the cell, in pixels, in which the item is positioned.","name":"cellHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The alignment position. One of the Phaser.Display.Align consts such as `TOP_LEFT` or `RIGHT_CENTER`.","name":"position"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optionally place the top-left of the final grid at this coordinate.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optionally place the top-left of the final grid at this coordinate.","name":"y"}],"memberof":"Phaser.Types.Actions","longname":"Phaser.Types.Actions.GridAlignConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions/typedefs"},"kind":"namespace","name":"Actions","memberof":"Phaser.Types","longname":"Phaser.Types.Actions","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"Animation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Animation.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"classdesc":"A Frame based Animation.\n\nThis consists of a key, some default values (like the frame rate) and a bunch of Frame objects.\n\nThe Animation Manager creates these. Game Objects don't own an instance of these directly.\nGame Objects have the Animation Component, which are like playheads to global Animations (these objects)\nSo multiple Game Objects can have playheads all pointing to this one Animation instance.","kind":"class","name":"Animation","memberof":"Phaser.Animations","augments":["Phaser.Events.EventEmitter"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"A reference to the global Animation Manager","name":"manager"},{"type":{"names":["string"]},"description":"The unique identifying string for this animation.","name":"key"},{"type":{"names":["Phaser.Types.Animations.Animation"]},"description":"The Animation configuration.","name":"config"}],"scope":"static","longname":"Phaser.Animations.Animation","___s":true},{"meta":{"filename":"Animation.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"A reference to the global Animation Manager.","name":"manager","type":{"names":["Phaser.Animations.AnimationManager"]},"since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The unique identifying string for this animation.","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":63,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"A frame based animation (as opposed to a bone based animation)","name":"type","type":{"names":["string"]},"defaultvalue":"frame","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Extract all the frame data into the frames array.","name":"frames","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#frames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The frame rate of playback in frames per second (default 24 if duration is null)","name":"frameRate","type":{"names":["integer"]},"defaultvalue":"24","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#frameRate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"How long the animation should play for, in milliseconds.\nIf the `frameRate` property has been set then it overrides this value,\notherwise the `frameRate` is derived from `duration`.","name":"duration","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"How many ms per frame, not including frame specific modifiers.","name":"msPerFrame","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#msPerFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Skip frames if the time lags, or always advanced anyway?","name":"skipMissedFrames","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#skipMissedFrames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The delay in ms before the playback will begin.","name":"delay","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#delay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Number of times to repeat the animation. Set to -1 to repeat forever.","name":"repeat","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#repeat","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The delay in ms before the a repeat play starts.","name":"repeatDelay","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#repeatDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Should the animation yoyo (reverse back down to the start) before repeating?","name":"yoyo","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#yoyo","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Should the GameObject's `visible` property be set to `true` when the animation starts to play?","name":"showOnStart","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#showOnStart","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":197,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Should the GameObject's `visible` property be set to `false` when the animation finishes?","name":"hideOnComplete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#hideOnComplete","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":207,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Global pause. All Game Objects using this Animation instance are impacted by this property.","name":"paused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#paused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Add frames to the end of the animation.","kind":"function","name":"addFrame","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"[description]","name":"config"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#addFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":236,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Add frame/s into the animation.","kind":"function","name":"addFrameAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index to insert the frame at within the animation.","name":"index"},{"type":{"names":["string","Array."]},"description":"[description]","name":"config"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#addFrameAt","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":275,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Check if the given frame index is valid.","kind":"function","name":"checkFrame","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index to be checked.","name":"index"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the index is valid, otherwise `false`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#checkFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"getFrames","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"[description]","name":"textureManager"},{"type":{"names":["string","Array."]},"description":"[description]","name":"frames"},{"type":{"names":["string"]},"optional":true,"description":"[description]","name":"defaultTextureKey"}],"returns":[{"type":{"names":["Array."]},"description":"[description]"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#getFrames","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"getNextTick","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Components.Animation"]},"description":"[description]","name":"component"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#getNextTick","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":512,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Returns the frame closest to the given progress value between 0 and 1.","kind":"function","name":"getFrameByProgress","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The frame closest to the given progress value."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#getFrameByProgress","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Advance the animation frame.","kind":"function","name":"nextFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Components.Animation"]},"description":"The Animation Component to advance.","name":"component"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#nextFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":613,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Returns the animation last frame.","kind":"function","name":"getLastFrame","since":"3.12.0","returns":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"component - The Animation Last Frame."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#getLastFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"previousFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Components.Animation"]},"description":"[description]","name":"component"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#previousFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":689,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"removeFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"[description]","name":"frame"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#removeFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":711,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Removes a frame from the AnimationFrame array at the provided index\nand updates the animation accordingly.","kind":"function","name":"removeFrameAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index in the AnimationFrame array","name":"index"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#removeFrameAt","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":731,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"repeatAnimation","fires":["Phaser.Animations.Events#event:ANIMATION_REPEAT","Phaser.Animations.Events#event:SPRITE_ANIMATION_REPEAT","Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_REPEAT"],"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Components.Animation"]},"description":"[description]","name":"component"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#repeatAnimation","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":779,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Sets the texture frame the animation uses for rendering.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Components.Animation"]},"description":"[description]","name":"component"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#setFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":800,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Converts the animation data to JSON.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Animations.JSONAnimation"]},"description":"[description]"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#toJSON","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":833,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"updateFrameSequence","since":"3.0.0","returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#updateFrameSequence","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":890,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#pause","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":905,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#resume","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":920,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"range":[180,213],"filename":"AnimationFrame.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"classdesc":"A single frame in an Animation sequence.\n\nAn AnimationFrame consists of a reference to the Texture it uses for rendering, references to other\nframes in the animation, and index data. It also has the ability to modify the animation timing.\n\nAnimationFrames are generated automatically by the Animation class.","kind":"class","name":"AnimationFrame","memberof":"Phaser.Animations","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture this AnimationFrame uses.","name":"textureKey"},{"type":{"names":["string","integer"]},"description":"The key of the Frame within the Texture that this AnimationFrame uses.","name":"textureFrame"},{"type":{"names":["integer"]},"description":"The index of this AnimationFrame within the Animation sequence.","name":"index"},{"type":{"names":["Phaser.Textures.Frame"]},"description":"A reference to the Texture Frame this AnimationFrame uses for rendering.","name":"frame"}],"scope":"static","longname":"Phaser.Animations.AnimationFrame","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The key of the Texture this AnimationFrame uses.","name":"textureKey","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#textureKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The key of the Frame within the Texture that this AnimationFrame uses.","name":"textureFrame","type":{"names":["string","integer"]},"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#textureFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The index of this AnimationFrame within the Animation sequence.","name":"index","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#index","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"A reference to the Texture Frame this AnimationFrame uses for rendering.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Is this the first frame in an animation sequence?","name":"isFirst","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#isFirst","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Is this the last frame in an animation sequence?","name":"isLast","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#isLast","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"A reference to the AnimationFrame that comes before this one in the animation, if any.","name":"prevFrame","type":{"names":["Phaser.Animations.AnimationFrame"]},"nullable":true,"defaultvalue":"null","readonly":true,"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#prevFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"A reference to the AnimationFrame that comes after this one in the animation, if any.","name":"nextFrame","type":{"names":["Phaser.Animations.AnimationFrame"]},"nullable":true,"defaultvalue":"null","readonly":true,"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#nextFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Additional time (in ms) that this frame should appear for during playback.\nThe value is added onto the msPerFrame set by the animation.","name":"duration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":125,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"What % through the animation does this frame come?\nThis value is generated when the animation is created and cached here.","name":"progress","type":{"names":["number"]},"defaultvalue":"0","readonly":true,"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":138,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Generates a JavaScript object suitable for converting to JSON.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Animations.JSONAnimationFrame"]},"description":"The AnimationFrame data."}],"memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#toJSON","scope":"instance","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Destroys this object by removing references to external resources and callbacks.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#destroy","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"AnimationManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"name":"Animation","longname":"Animation","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AnimationManager.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"classdesc":"The Animation Manager.\n\nAnimations are managed by the global Animation Manager. This is a singleton class that is\nresponsible for creating and delivering animations and their corresponding data to all Game Objects.\nUnlike plugins it is owned by the Game instance, not the Scene.\n\nSprites and other Game Objects get the data they need from the AnimationManager.","kind":"class","name":"AnimationManager","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Animations","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"A reference to the Phaser.Game instance.","name":"game"}],"scope":"static","longname":"Phaser.Animations.AnimationManager","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The global time scale of the Animation Manager.\n\nThis scales the time delta between two frames, thus influencing the speed of time for the Animation Manager.","name":"globalTimeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#globalTimeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Whether the Animation Manager is paused along with all of its Animations.","name":"paused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#paused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The name of this Animation Manager.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Registers event listeners after the Game boots.","kind":"function","name":"boot","listens":["Phaser.Core.Events#event:DESTROY"],"since":"3.0.0","memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#boot","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":124,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Adds an existing Animation to the Animation Manager.","kind":"function","name":"add","fires":["Phaser.Animations.Events#event:ADD_ANIMATION"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key under which the Animation should be added. The Animation will be updated with it. Must be unique.","name":"key"},{"type":{"names":["Phaser.Animations.Animation"]},"description":"The Animation which should be added to the Animation Manager.","name":"animation"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"This Animation Manager."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#add","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Checks to see if the given key is already in use within the Animation Manager or not.\n\nAnimations are global. Keys created in one scene can be used from any other Scene in your game. They are not Scene specific.","kind":"function","name":"exists","since":"3.16.0","params":[{"type":{"names":["string"]},"description":"The key of the Animation to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Animation already exists in the Animation Manager, or `false` if the key is available."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#exists","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":171,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Creates a new Animation and adds it to the Animation Manager.\n\nAnimations are global. Once created, you can use them in any Scene in your game. They are not Scene specific.\n\nIf an invalid key is given this method will return `false`.\n\nIf you pass the key of an animation that already exists in the Animation Manager, that animation will be returned.\n\nA brand new animation is only created if the key is valid and not already in use.\n\nIf you wish to re-use an existing key, call `AnimationManager.remove` first, then this method.","kind":"function","name":"create","fires":["Phaser.Animations.Events#event:ADD_ANIMATION"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Animations.Animation"]},"description":"The configuration settings for the Animation.","name":"config"}],"returns":[{"type":{"names":["Phaser.Animations.Animation","false"]},"description":"The Animation that was created, or `false` is the key is already in use."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#create","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Loads this Animation Manager's Animations and settings from a JSON object.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Animations.JSONAnimations","Phaser.Types.Animations.JSONAnimation"]},"description":"The JSON object to parse.","name":"data"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If set to `true`, the current animations will be removed (`anims.clear()`). If set to `false` (default), the animations in `data` will be added.","name":"clearCurrentAnimations"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing all of the Animation objects that were created as a result of this call."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#fromJSON","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":264,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"generateFrameNames","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key for the texture containing the animation frames.","name":"key"},{"type":{"names":["Phaser.Types.Animations.GenerateFrameNames"]},"optional":true,"description":"The configuration object for the animation frame names.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"The array of {@link Phaser.Types.Animations.AnimationFrame} objects."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#generateFrameNames","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":339,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Generate an array of {@link Phaser.Types.Animations.AnimationFrame} objects from a texture key and configuration object.\n\nGenerates objects with numbered frame names, as configured by the given {@link Phaser.Types.Animations.GenerateFrameNumbers}.","kind":"function","name":"generateFrameNumbers","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key for the texture containing the animation frames.","name":"key"},{"type":{"names":["Phaser.Types.Animations.GenerateFrameNumbers"]},"description":"The configuration object for the animation frames.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"The array of {@link Phaser.Types.Animations.AnimationFrame} objects."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#generateFrameNumbers","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Get an Animation.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Animation to retrieve.","name":"key"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"The Animation."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#get","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Load an Animation into a Game Object's Animation Component.","kind":"function","name":"load","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to load the animation into.","name":"child"},{"type":{"names":["string"]},"description":"The key of the animation to load.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name of a start frame to set on the loaded animation.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object with the animation loaded into it."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#load","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":453,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Pause all animations.","kind":"function","name":"pauseAll","fires":["Phaser.Animations.Events#event:PAUSE_ALL"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"This Animation Manager."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#pauseAll","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":474,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Play an animation on the given Game Objects that have an Animation Component.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the animation to play on the Game Object.","name":"key"},{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"The Game Objects to play the animation on.","name":"child"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"This Animation Manager."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#play","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":507,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Remove an animation.","kind":"function","name":"remove","fires":["Phaser.Animations.Events#event:REMOVE_ANIMATION"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the animation to remove.","name":"key"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"[description]"}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#remove","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":532,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Resume all paused animations.","kind":"function","name":"resumeAll","fires":["Phaser.Animations.Events#event:RESUME_ALL"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"This Animation Manager."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#resumeAll","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":553,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Takes an array of Game Objects that have an Animation Component and then\nstarts the given animation playing on them, each one offset by the\n`stagger` amount given to this method.","kind":"function","name":"staggerPlay","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the animation to play on the Game Objects.","name":"key"},{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to play the animation on. They must have an Animation Component.","name":"children"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The amount of time, in milliseconds, to offset each play time by.","name":"stagger"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"This Animation Manager."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#staggerPlay","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":593,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Get the animation data as javascript object by giving key, or get the data of all animations as array of objects, if key wasn't provided.","kind":"function","name":"toJSON","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"[description]","name":"key"}],"returns":[{"type":{"names":["Phaser.Types.Animations.JSONAnimations"]},"description":"[description]"}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#toJSON","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Destroy this Animation Manager and clean up animation definitions and references to other objects.\nThis method should not be called directly. It will be called automatically as a response to a `destroy` event from the Phaser.Game instance.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"ADD_ANIMATION_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Add Animation Event.\n\nThis event is dispatched when a new animation is added to the global Animation Manager.\n\nThis can happen either as a result of an animation instance being added to the Animation Manager,\nor the Animation Manager creating a new animation directly.","kind":"event","name":"ADD_ANIMATION","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Animation that was added to the global Animation Manager.","name":"key"},{"type":{"names":["Phaser.Animations.Animation"]},"description":"An instance of the newly created Animation.","name":"animation"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:ADD_ANIMATION","scope":"instance","___s":true},{"meta":{"filename":"ANIMATION_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Animation Complete Event.\n\nThis event is dispatched by an Animation instance when it completes, i.e. finishes playing or is manually stopped.\n\nBe careful with the volume of events this could generate. If a group of Sprites all complete the same\nanimation at the same time, this event will invoke its handler for each one of them.","kind":"event","name":"ANIMATION_COMPLETE","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that completed.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation completed on.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation completed.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:ANIMATION_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"ANIMATION_REPEAT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Animation Repeat Event.\n\nThis event is dispatched when a currently playing animation repeats.\n\nThe event is dispatched directly from the Animation object itself. Which means that listeners\nbound to this event will be invoked every time the Animation repeats, for every Game Object that may have it.","kind":"event","name":"ANIMATION_REPEAT","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that repeated.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation was on when it repeated.","name":"frame"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:ANIMATION_REPEAT","scope":"instance","___s":true},{"meta":{"filename":"ANIMATION_RESTART_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Animation Restart Event.\n\nThis event is dispatched by an Animation instance when it restarts.\n\nBe careful with the volume of events this could generate. If a group of Sprites all restart the same\nanimation at the same time, this event will invoke its handler for each one of them.","kind":"event","name":"ANIMATION_RESTART","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that restarted playing.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation restarted with.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation restarted playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:ANIMATION_RESTART","scope":"instance","___s":true},{"meta":{"filename":"ANIMATION_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Animation Start Event.\n\nThis event is dispatched by an Animation instance when it starts playing.\n\nBe careful with the volume of events this could generate. If a group of Sprites all play the same\nanimation at the same time, this event will invoke its handler for each one of them.","kind":"event","name":"ANIMATION_START","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that started playing.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation started with.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation started playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:ANIMATION_START","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_ALL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Pause All Animations Event.\n\nThis event is dispatched when the global Animation Manager is told to pause.\n\nWhen this happens all current animations will stop updating, although it doesn't necessarily mean\nthat the game has paused as well.","kind":"event","name":"PAUSE_ALL","since":"3.0.0","memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:PAUSE_ALL","scope":"instance","___s":true},{"meta":{"filename":"REMOVE_ANIMATION_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Remove Animation Event.\n\nThis event is dispatched when an animation is removed from the global Animation Manager.","kind":"event","name":"REMOVE_ANIMATION","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Animation that was removed from the global Animation Manager.","name":"key"},{"type":{"names":["Phaser.Animations.Animation"]},"description":"An instance of the removed Animation.","name":"animation"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:REMOVE_ANIMATION","scope":"instance","___s":true},{"meta":{"filename":"RESUME_ALL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Resume All Animations Event.\n\nThis event is dispatched when the global Animation Manager resumes, having been previously paused.\n\nWhen this happens all current animations will continue updating again.","kind":"event","name":"RESUME_ALL","since":"3.0.0","memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:RESUME_ALL","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Complete Event.\n\nThis event is dispatched by a Sprite when an animation finishes playing on it.\n\nListen for it on the Sprite using `sprite.on('animationcomplete', listener)`\n\nThis same event is dispatched for all animations. To listen for a specific animation, use the `SPRITE_ANIMATION_KEY_COMPLETE` event.","kind":"event","name":"SPRITE_ANIMATION_COMPLETE","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that completed.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation completed on.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation completed.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_KEY_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Key Complete Event.\n\nThis event is dispatched by a Sprite when a specific animation finishes playing on it.\n\nListen for it on the Sprite using `sprite.on('animationcomplete-key', listener)` where `key` is the key of\nthe animation. For example, if you had an animation with the key 'explode' you should listen for `animationcomplete-explode`.","kind":"event","name":"SPRITE_ANIMATION_KEY_COMPLETE","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that completed.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation completed on.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation completed.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_KEY_REPEAT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Key Repeat Event.\n\nThis event is dispatched by a Sprite when a specific animation repeats playing on it.\n\nListen for it on the Sprite using `sprite.on('animationrepeat-key', listener)` where `key` is the key of\nthe animation. For example, if you had an animation with the key 'explode' you should listen for `animationrepeat-explode`.","kind":"event","name":"SPRITE_ANIMATION_KEY_REPEAT","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that is repeating on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation started with.","name":"frame"},{"type":{"names":["integer"]},"description":"The number of times the Animation has repeated so far.","name":"repeatCount"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation repeated playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_REPEAT","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_KEY_RESTART_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Key Restart Event.\n\nThis event is dispatched by a Sprite when a specific animation restarts playing on it.\n\nListen for it on the Sprite using `sprite.on('animationrestart-key', listener)` where `key` is the key of\nthe animation. For example, if you had an animation with the key 'explode' you should listen for `animationrestart-explode`.","kind":"event","name":"SPRITE_ANIMATION_KEY_RESTART","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that was restarted on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation restarted with.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation restarted playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_RESTART","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_KEY_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Key Start Event.\n\nThis event is dispatched by a Sprite when a specific animation starts playing on it.\n\nListen for it on the Sprite using `sprite.on('animationstart-key', listener)` where `key` is the key of\nthe animation. For example, if you had an animation with the key 'explode' you should listen for `animationstart-explode`.","kind":"event","name":"SPRITE_ANIMATION_KEY_START","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that was started on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation started with.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation started playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_START","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_KEY_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Key Update Event.\n\nThis event is dispatched by a Sprite when a specific animation playing on it updates. This happens when the animation changes frame,\nbased on the animation frame rate and other factors like `timeScale` and `delay`.\n\nListen for it on the Sprite using `sprite.on('animationupdate-key', listener)` where `key` is the key of\nthe animation. For example, if you had an animation with the key 'explode' you should listen for `animationupdate-explode`.","kind":"event","name":"SPRITE_ANIMATION_KEY_UPDATE","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that has updated on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame of the Animation.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation updated.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_REPEAT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Repeat Event.\n\nThis event is dispatched by a Sprite when an animation repeats playing on it.\n\nListen for it on the Sprite using `sprite.on('animationrepeat', listener)`\n\nThis same event is dispatched for all animations. To listen for a specific animation, use the `SPRITE_ANIMATION_KEY_REPEAT` event.","kind":"event","name":"SPRITE_ANIMATION_REPEAT","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that is repeating on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation started with.","name":"frame"},{"type":{"names":["integer"]},"description":"The number of times the Animation has repeated so far.","name":"repeatCount"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation repeated playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_REPEAT","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_RESTART_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Restart Event.\n\nThis event is dispatched by a Sprite when an animation restarts playing on it.\n\nListen for it on the Sprite using `sprite.on('animationrestart', listener)`\n\nThis same event is dispatched for all animations. To listen for a specific animation, use the `SPRITE_ANIMATION_KEY_RESTART` event.","kind":"event","name":"SPRITE_ANIMATION_RESTART","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that was restarted on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation restarted with.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation restarted playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_RESTART","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Start Event.\n\nThis event is dispatched by a Sprite when an animation starts playing on it.\n\nListen for it on the Sprite using `sprite.on('animationstart', listener)`\n\nThis same event is dispatched for all animations. To listen for a specific animation, use the `SPRITE_ANIMATION_KEY_START` event.","kind":"event","name":"SPRITE_ANIMATION_START","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that was started on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation started with.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation started playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_START","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Update Event.\n\nThis event is dispatched by a Sprite when an animation playing on it updates. This happens when the animation changes frame,\nbased on the animation frame rate and other factors like `timeScale` and `delay`.\n\nListen for it on the Sprite using `sprite.on('animationupdate', listener)`\n\nThis same event is dispatched for all animations. To listen for a specific animation, use the `SPRITE_ANIMATION_KEY_UPDATE` event.","kind":"event","name":"SPRITE_ANIMATION_UPDATE","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that has updated on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame of the Animation.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation updated.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Animations","longname":"Phaser.Animations.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"kind":"namespace","name":"Animations","memberof":"Phaser","longname":"Phaser.Animations","scope":"static","___s":true},{"meta":{"filename":"Animation.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"Animation","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"The key that the animation will be associated with. i.e. sprite.animations.play(key)","name":"key"},{"type":{"names":["Array."]},"optional":true,"description":"An object containing data used to generate the frames for the animation","name":"frames"},{"type":{"names":["string"]},"optional":true,"defaultvalue":null,"description":"The key of the texture all frames of the animation will use. Can be overridden on a per frame basis.","name":"defaultTextureKey"},{"type":{"names":["integer"]},"optional":true,"description":"The frame rate of playback in frames per second (default 24 if duration is null)","name":"frameRate"},{"type":{"names":["integer"]},"optional":true,"description":"How long the animation should play for in milliseconds. If not given its derived from frameRate.","name":"duration"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Skip frames if the time lags, or always advanced anyway?","name":"skipMissedFrames"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Delay before starting playback. Value given in milliseconds.","name":"delay"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Number of times to repeat the animation (-1 for infinity)","name":"repeat"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Delay before the animation repeats. Value given in milliseconds.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the animation yoyo? (reverse back down to the start) before repeating?","name":"yoyo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should sprite.visible = true when the animation starts to play?","name":"showOnStart"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should sprite.visible = false when the animation finishes?","name":"hideOnComplete"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.Animation","scope":"static","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"AnimationFrame","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The key that the animation will be associated with. i.e. sprite.animations.play(key)","name":"key"},{"type":{"names":["string","number"]},"description":"[description]","name":"frame"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"[description]","name":"duration"},{"type":{"names":["boolean"]},"optional":true,"description":"[description]","name":"visible"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.AnimationFrame","scope":"static","___s":true},{"meta":{"filename":"GenerateFrameNames.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"GenerateFrameNames","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The string to append to every resulting frame name if using a range or an array of `frames`.","name":"prefix"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If `frames` is not provided, the number of the first frame to return.","name":"start"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If `frames` is not provided, the number of the last frame to return.","name":"end"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The string to append to every resulting frame name if using a range or an array of `frames`.","name":"suffix"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The minimum expected lengths of each resulting frame's number. Numbers will be left-padded with zeroes until they are this long, then prepended and appended to create the resulting frame name.","name":"zeroPad"},{"type":{"names":["Array."]},"optional":true,"defaultvalue":"[]","description":"The array to append the created configuration objects to.","name":"outputArray"},{"type":{"names":["boolean","Array."]},"optional":true,"defaultvalue":false,"description":"If provided as an array, the range defined by `start` and `end` will be ignored and these frame numbers will be used.","name":"frames"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.GenerateFrameNames","scope":"static","___s":true},{"meta":{"filename":"GenerateFrameNumbers.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"GenerateFrameNumbers","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The starting frame of the animation.","name":"start"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":-1,"description":"The ending frame of the animation.","name":"end"},{"type":{"names":["boolean","integer"]},"optional":true,"defaultvalue":false,"description":"A frame to put at the beginning of the animation, before `start` or `outputArray` or `frames`.","name":"first"},{"type":{"names":["Array."]},"optional":true,"defaultvalue":"[]","description":"An array to concatenate the output onto.","name":"outputArray"},{"type":{"names":["boolean","Array."]},"optional":true,"defaultvalue":false,"description":"A custom sequence of frames.","name":"frames"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.GenerateFrameNumbers","scope":"static","___s":true},{"meta":{"filename":"JSONAnimation.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"JSONAnimation","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The key that the animation will be associated with. i.e. sprite.animations.play(key)","name":"key"},{"type":{"names":["string"]},"description":"A frame based animation (as opposed to a bone based animation)","name":"type"},{"type":{"names":["Array."]},"description":"[description]","name":"frames"},{"type":{"names":["integer"]},"description":"The frame rate of playback in frames per second (default 24 if duration is null)","name":"frameRate"},{"type":{"names":["integer"]},"description":"How long the animation should play for in milliseconds. If not given its derived from frameRate.","name":"duration"},{"type":{"names":["boolean"]},"description":"Skip frames if the time lags, or always advanced anyway?","name":"skipMissedFrames"},{"type":{"names":["integer"]},"description":"Delay before starting playback. Value given in milliseconds.","name":"delay"},{"type":{"names":["integer"]},"description":"Number of times to repeat the animation (-1 for infinity)","name":"repeat"},{"type":{"names":["integer"]},"description":"Delay before the animation repeats. Value given in milliseconds.","name":"repeatDelay"},{"type":{"names":["boolean"]},"description":"Should the animation yoyo? (reverse back down to the start) before repeating?","name":"yoyo"},{"type":{"names":["boolean"]},"description":"Should sprite.visible = true when the animation starts to play?","name":"showOnStart"},{"type":{"names":["boolean"]},"description":"Should sprite.visible = false when the animation finishes?","name":"hideOnComplete"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.JSONAnimation","scope":"static","___s":true},{"meta":{"filename":"JSONAnimationFrame.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"JSONAnimationFrame","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The key of the Texture this AnimationFrame uses.","name":"key"},{"type":{"names":["string","integer"]},"description":"The key of the Frame within the Texture that this AnimationFrame uses.","name":"frame"},{"type":{"names":["number"]},"description":"Additional time (in ms) that this frame should appear for during playback.","name":"duration"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.JSONAnimationFrame","scope":"static","___s":true},{"meta":{"filename":"JSONAnimations.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"JSONAnimations","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Array."]},"description":"An array of all Animations added to the Animation Manager.","name":"anims"},{"type":{"names":["number"]},"description":"The global time scale of the Animation Manager.","name":"globalTimeScale"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.JSONAnimations","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"namespace","name":"Animations","memberof":"Phaser.Types","longname":"Phaser.Types.Animations","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"BaseCache.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BaseCache.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"classdesc":"The BaseCache is a base Cache class that can be used for storing references to any kind of data.\n\nData can be added, retrieved and removed based on the given keys.\n\nKeys are string-based.","kind":"class","name":"BaseCache","memberof":"Phaser.Cache","since":"3.0.0","scope":"static","longname":"Phaser.Cache.BaseCache","___s":true},{"meta":{"filename":"BaseCache.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"The Map in which the cache objects are stored.\n\nYou can query the Map directly or use the BaseCache methods.","name":"entries","type":{"names":["Phaser.Structs.Map."]},"since":"3.0.0","memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#entries","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCache.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"An instance of EventEmitter used by the cache to emit related events.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCache.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Adds an item to this cache. The item is referenced by a unique string, which you are responsible\nfor setting and keeping track of. The item can only be retrieved by using this string.","kind":"function","name":"add","fires":["Phaser.Cache.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique key by which the data added to the cache will be referenced.","name":"key"},{"type":{"names":["*"]},"description":"The data to be stored in the cache.","name":"data"}],"returns":[{"type":{"names":["Phaser.Cache.BaseCache"]},"description":"This BaseCache object."}],"memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#add","scope":"instance","___s":true},{"meta":{"filename":"BaseCache.js","lineno":74,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Checks if this cache contains an item matching the given key.\nThis performs the same action as `BaseCache.exists`.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique key of the item to be checked in this cache.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if the cache contains an item matching the given key, otherwise `false`."}],"memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#has","scope":"instance","___s":true},{"meta":{"filename":"BaseCache.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Checks if this cache contains an item matching the given key.\nThis performs the same action as `BaseCache.has` and is called directly by the Loader.","kind":"function","name":"exists","since":"3.7.0","params":[{"type":{"names":["string"]},"description":"The unique key of the item to be checked in this cache.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if the cache contains an item matching the given key, otherwise `false`."}],"memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#exists","scope":"instance","___s":true},{"meta":{"filename":"BaseCache.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Gets an item from this cache based on the given key.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique key of the item to be retrieved from this cache.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The item in the cache, or `null` if no item matching the given key was found."}],"memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#get","scope":"instance","___s":true},{"meta":{"filename":"BaseCache.js","lineno":121,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Removes and item from this cache based on the given key.\n\nIf an entry matching the key is found it is removed from the cache and a `remove` event emitted.\nNo additional checks are done on the item removed. If other systems or parts of your game code\nare relying on this item, it is up to you to sever those relationships prior to removing the item.","kind":"function","name":"remove","fires":["Phaser.Cache.Events#event:REMOVE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique key of the item to remove from the cache.","name":"key"}],"returns":[{"type":{"names":["Phaser.Cache.BaseCache"]},"description":"This BaseCache object."}],"memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#remove","scope":"instance","___s":true},{"meta":{"filename":"BaseCache.js","lineno":150,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Returns all keys in use in this cache.","kind":"function","name":"getKeys","since":"3.17.0","returns":[{"type":{"names":["Array."]},"description":"Array containing all the keys."}],"memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#getKeys","scope":"instance","___s":true},{"meta":{"filename":"BaseCache.js","lineno":163,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Destroys this cache and all items within it.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#destroy","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"CacheManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"name":"BaseCache","longname":"BaseCache","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CacheManager.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"classdesc":"The Cache Manager is the global cache owned and maintained by the Game instance.\n\nVarious systems, such as the file Loader, rely on this cache in order to store the files\nit has loaded. The manager itself doesn't store any files, but instead owns multiple BaseCache\ninstances, one per type of file. You can also add your own custom caches.","kind":"class","name":"CacheManager","memberof":"Phaser.Cache","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"A reference to the Phaser.Game instance that owns this CacheManager.","name":"game"}],"scope":"static","longname":"Phaser.Cache.CacheManager","___s":true},{"meta":{"filename":"CacheManager.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all binary files, typically added via the Loader.","name":"binary","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#binary","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all bitmap font data files, typically added via the Loader.\nOnly the font data is stored in this cache, the textures are part of the Texture Manager.","name":"bitmapFont","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#bitmapFont","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all JSON data files, typically added via the Loader.","name":"json","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#json","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all physics data files, typically added via the Loader.","name":"physics","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#physics","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all shader source files, typically added via the Loader.","name":"shader","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#shader","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all non-streaming audio files, typically added via the Loader.","name":"audio","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#audio","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all non-streaming video files, typically added via the Loader.","name":"video","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.20.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#video","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all text files, typically added via the Loader.","name":"text","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#text","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all html files, typically added via the Loader.","name":"html","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.12.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#html","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all WaveFront OBJ files, typically added via the Loader.","name":"obj","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#obj","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all tilemap data files, typically added via the Loader.\nOnly the data is stored in this cache, the textures are part of the Texture Manager.","name":"tilemap","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#tilemap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":143,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all xml data files, typically added via the Loader.","name":"xml","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#xml","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"An object that contains your own custom BaseCache entries.\nAdd to this via the `addCustom` method.","name":"custom","type":{"names":["Object."]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#custom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":165,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Add your own custom Cache for storing your own files.\nThe cache will be available under `Cache.custom.key`.\nThe cache will only be created if the key is not already in use.","kind":"function","name":"addCustom","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique key of your custom cache.","name":"key"}],"returns":[{"type":{"names":["Phaser.Cache.BaseCache"]},"description":"A reference to the BaseCache that was created. If the key was already in use, a reference to the existing cache is returned instead."}],"memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#addCustom","scope":"instance","___s":true},{"meta":{"filename":"CacheManager.js","lineno":187,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Removes all entries from all BaseCaches and destroys all custom caches.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#destroy","scope":"instance","___s":true},{"meta":{"filename":"ADD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cache/events"},"description":"The Cache Add Event.\n\nThis event is dispatched by any Cache that extends the BaseCache each time a new object is added to it.","kind":"event","name":"ADD","since":"3.0.0","params":[{"type":{"names":["Phaser.Cache.BaseCache"]},"description":"The cache to which the object was added.","name":"cache"},{"type":{"names":["string"]},"description":"The key of the object added to the cache.","name":"key"},{"type":{"names":["*"]},"description":"A reference to the object that was added to the cache.","name":"object"}],"memberof":"Phaser.Cache.Events","longname":"Phaser.Cache.Events#event:ADD","scope":"instance","___s":true},{"meta":{"filename":"REMOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cache/events"},"description":"The Cache Remove Event.\n\nThis event is dispatched by any Cache that extends the BaseCache each time an object is removed from it.","kind":"event","name":"REMOVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Cache.BaseCache"]},"description":"The cache from which the object was removed.","name":"cache"},{"type":{"names":["string"]},"description":"The key of the object removed from the cache.","name":"key"},{"type":{"names":["*"]},"description":"A reference to the object that was removed from the cache.","name":"object"}],"memberof":"Phaser.Cache.Events","longname":"Phaser.Cache.Events#event:REMOVE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cache/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Cache","longname":"Phaser.Cache.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"kind":"namespace","name":"Cache","memberof":"Phaser","longname":"Phaser.Cache","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"BaseCamera.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"classdesc":"A Base Camera class.\n\nThe Camera is the way in which all games are rendered in Phaser. They provide a view into your game world,\nand can be positioned, rotated, zoomed and scrolled accordingly.\n\nA Camera consists of two elements: The viewport and the scroll values.\n\nThe viewport is the physical position and size of the Camera within your game. Cameras, by default, are\ncreated the same size as your game, but their position and size can be set to anything. This means if you\nwanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game,\nyou'd adjust the viewport to do that (using methods like `setViewport` and `setSize`).\n\nIf you wish to change where the Camera is looking in your game, then you scroll it. You can do this\nvia the properties `scrollX` and `scrollY` or the method `setScroll`. Scrolling has no impact on the\nviewport, and changing the viewport has no impact on the scrolling.\n\nBy default a Camera will render all Game Objects it can see. You can change this using the `ignore` method,\nallowing you to filter Game Objects out on a per-Camera basis.\n\nThe Base Camera is extended by the Camera class, which adds in special effects including Fade,\nFlash and Camera Shake, as well as the ability to follow Game Objects.\n\nThe Base Camera was introduced in Phaser 3.12. It was split off from the Camera class, to allow\nyou to isolate special effects as needed. Therefore the 'since' values for properties of this class relate\nto when they were added to the Camera class.","kind":"class","name":"BaseCamera","memberof":"Phaser.Cameras.Scene2D","since":"3.12.0","augments":["Phaser.Events.EventEmitter","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.Visible"],"params":[{"type":{"names":["number"]},"description":"The x position of the Camera, relative to the top-left of the game canvas.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Camera, relative to the top-left of the game canvas.","name":"y"},{"type":{"names":["number"]},"description":"The width of the Camera, in pixels.","name":"width"},{"type":{"names":["number"]},"description":"The height of the Camera, in pixels.","name":"height"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.BaseCamera","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Scene this camera belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Game Scene Manager.","name":"sceneManager","type":{"names":["Phaser.Scenes.SceneManager"]},"since":"3.12.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#sceneManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Game Scale Manager.","name":"scaleManager","type":{"names":["Phaser.Scale.ScaleManager"]},"since":"3.16.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#scaleManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Scene's Camera Manager to which this Camera belongs.","name":"cameraManager","type":{"names":["Phaser.Cameras.Scene2D.CameraManager"]},"since":"3.17.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#cameraManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera ID. Assigned by the Camera Manager and used to handle camera exclusion.\nThis value is a bitmask.","name":"id","type":{"names":["integer"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#id","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The name of the Camera. This is left empty for your own use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"This property is un-used in v3.16.\n\nThe resolution of the Game, used in most Camera calculations.","name":"resolution","type":{"names":["number"]},"readonly":true,"deprecated":true,"since":"3.12.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#resolution","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":149,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Should this camera round its pixel values to integers?","name":"roundPixels","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#roundPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera visible or not?\n\nA visible camera will render and perform input tests.\nAn invisible camera will not render anything and will skip input tests.","name":"visible","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.10.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#visible","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":171,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera using a bounds to restrict scrolling movement?\n\nSet this property along with the bounds via `Camera.setBounds`.","name":"useBounds","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#useBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The World View is a Rectangle that defines the area of the 'world' the Camera is currently looking at.\nThis factors in the Camera viewport size, zoom and scroll position and is updated in the Camera preRender step.\nIf you have enabled Camera bounds the worldview will be clamped to those bounds accordingly.\nYou can use it for culling or intersection checks.","name":"worldView","type":{"names":["Phaser.Geom.Rectangle"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#worldView","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera dirty?\n\nA dirty Camera has had either its viewport size, bounds, scroll, rotation or zoom levels changed since the last frame.\n\nThis flag is cleared during the `postRenderCamera` method of the renderer.","name":"dirty","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":392,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Does this Camera have a transparent background?","name":"transparent","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#transparent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":402,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The background color of this Camera. Only used if `transparent` is `false`.","name":"backgroundColor","type":{"names":["Phaser.Display.Color"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#backgroundColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":411,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera alpha value. Setting this property impacts every single object that this Camera\nrenders. You can either set the property directly, i.e. via a Tween, to fade a Camera in or out,\nor via the chainable `setAlpha` method instead.","name":"alpha","type":{"names":["number"]},"defaultvalue":"1","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#alpha","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":422,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Should the camera cull Game Objects before checking them for input hit tests?\nIn some special cases it may be beneficial to disable this.","name":"disableCull","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#disableCull","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":444,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The mid-point of the Camera in 'world' coordinates.\n\nUse it to obtain exactly where in the world the center of the camera is currently looking.\n\nThis value is updated in the preRender method, after the scroll values and follower\nhave been processed.","name":"midPoint","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#midPoint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":459,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The horizontal origin of rotation for this Camera.\n\nBy default the camera rotates around the center of the viewport.\n\nChanging the origin allows you to adjust the point in the viewport from which rotation happens.\nA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.\n\nSee `setOrigin` to set both origins in a single, chainable call.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#originX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":476,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The vertical origin of rotation for this Camera.\n\nBy default the camera rotates around the center of the viewport.\n\nChanging the origin allows you to adjust the point in the viewport from which rotation happens.\nA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.\n\nSee `setOrigin` to set both origins in a single, chainable call.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#originY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":504,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Mask this Camera is using during render.\nSet the mask using the `setMask` method. Remove the mask using the `clearMask` method.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"nullable":true,"since":"3.17.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#mask","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the Alpha level of this Camera. The alpha controls the opacity of the Camera as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.11.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The Camera alpha value.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setAlpha","scope":"instance","overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the rotation origin of this Camera.\n\nThe values are given in the range 0 to 1 and are only used when calculating Camera rotation.\n\nBy default the camera rotates around the center of the viewport.\n\nChanging the origin allows you to adjust the point in the viewport from which rotation happens.\nA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.","kind":"function","name":"setOrigin","since":"3.11.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setOrigin","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":570,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Calculates what the Camera.scrollX and scrollY values would need to be in order to move\nthe Camera so it is centered on the given x and y coordinates, without actually moving\nthe Camera there. The results are clamped based on the Camera bounds, if set.","kind":"function","name":"getScroll","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the values in. If not given a new Vector2 is created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The scroll coordinates stored in the `x` and `y` properties."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#getScroll","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":603,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera horizontally so that it is centered on the given x coordinate, bounds allowing.\nCalling this does not change the scrollY value.","kind":"function","name":"centerOnX","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerOnX","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":630,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera vertically so that it is centered on the given y coordinate, bounds allowing.\nCalling this does not change the scrollX value.","kind":"function","name":"centerOnY","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerOnY","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":657,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera so that it is centered on the given coordinates, bounds allowing.","kind":"function","name":"centerOn","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerOn","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":676,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera so that it is looking at the center of the Camera Bounds, if enabled.","kind":"function","name":"centerToBounds","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerToBounds","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":701,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera so that it is re-centered based on its viewport size.","kind":"function","name":"centerToSize","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerToSize","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Takes an array of Game Objects and returns a new array featuring only those objects\nvisible by this camera.","kind":"function","name":"cull","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of Game Objects to cull.","name":"renderableObjects"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Game Objects visible to this Camera."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#cull","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":798,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Converts the given `x` and `y` coordinates into World space, based on this Cameras transform.\nYou can optionally provide a Vector2, or similar object, to store the results in.","kind":"function","name":"getWorldPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position to convert to world space.","name":"x"},{"type":{"names":["number"]},"description":"The y position to convert to world space.","name":"y"},{"type":{"names":["object","Phaser.Math.Vector2"]},"optional":true,"description":"An optional object to store the results in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"An object holding the converted values in its `x` and `y` properties."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#getWorldPoint","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":866,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Given a Game Object, or an array of Game Objects, it will update all of their camera filter settings\nso that they are ignored by this Camera. This means they will not be rendered by this Camera.","kind":"function","name":"ignore","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group"]},"description":"The Game Object, or array of Game Objects, to be ignored by this Camera.","name":"entries"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#ignore","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":970,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Takes an x value and checks it's within the range of the Camera bounds, adjusting if required.\nDo not call this method if you are not using camera bounds.","kind":"function","name":"clampX","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The value to horizontally scroll clamp.","name":"x"}],"returns":[{"type":{"names":["number"]},"description":"The adjusted value to use as scrollX."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#clampX","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1002,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Takes a y value and checks it's within the range of the Camera bounds, adjusting if required.\nDo not call this method if you are not using camera bounds.","kind":"function","name":"clampY","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The value to vertically scroll clamp.","name":"y"}],"returns":[{"type":{"names":["number"]},"description":"The adjusted value to use as scrollY."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#clampY","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1039,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has previously had movement bounds set on it, this will remove them.","kind":"function","name":"removeBounds","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#removeBounds","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1058,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the rotation of this Camera. This causes everything it renders to appear rotated.\n\nRotating a camera does not rotate the viewport itself, it is applied during rendering.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The cameras angle of rotation, given in degrees.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setAngle","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1079,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the background color for this Camera.\n\nBy default a Camera has a transparent background but it can be given a solid color, with any level\nof transparency, via this method.\n\nThe color value can be specified using CSS color notation, hex or numbers.","kind":"function","name":"setBackgroundColor","since":"3.0.0","params":[{"type":{"names":["string","number","Phaser.Types.Display.InputColorObject"]},"optional":true,"defaultvalue":"'rgba(0,0,0,0)'","description":"The color value. In CSS, hex or numeric color notation.","name":"color"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setBackgroundColor","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the bounds of the Camera. The bounds are an axis-aligned rectangle.\n\nThe Camera bounds controls where the Camera can scroll to, stopping it from scrolling off the\nedges and into blank space. It does not limit the placement of Game Objects, or where\nthe Camera viewport can be positioned.\n\nTemporarily disable the bounds by changing the boolean `Camera.useBounds`.\n\nClear the bounds entirely by calling `Camera.removeBounds`.\n\nIf you set bounds that are smaller than the viewport it will stop the Camera from being\nable to scroll. The bounds can be positioned where-ever you wish. By default they are from\n0x0 to the canvas width x height. This means that the coordinate 0x0 is the top left of\nthe Camera bounds. However, you can position them anywhere. So if you wanted a game world\nthat was 2048x2048 in size, with 0x0 being the center of it, you can set the bounds x/y\nto be -1024, -1024, with a width and height of 2048. Depending on your game you may find\nit easier for 0x0 to be the top-left of the bounds, or you may wish 0x0 to be the middle.","kind":"function","name":"setBounds","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The top-left x coordinate of the bounds.","name":"x"},{"type":{"names":["integer"]},"description":"The top-left y coordinate of the bounds.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the bounds, in pixels.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the bounds, in pixels.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the Camera will automatically be centered on the new bounds.","name":"centerOn"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setBounds","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Returns a rectangle containing the bounds of the Camera.\n\nIf the Camera does not have any bounds the rectangle will be empty.\n\nThe rectangle is a copy of the bounds, so is safe to modify.","kind":"function","name":"getBounds","since":"3.16.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"An optional Rectangle to store the bounds in. If not given, a new Rectangle will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A rectangle containing the bounds of this Camera."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#getBounds","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the name of this Camera.\nThis value is for your own use and isn't used internally.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The name of the Camera.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setName","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the position of the Camera viewport within the game.\n\nThis does not change where the camera is 'looking'. See `setScroll` to control that.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the Camera viewport.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The top-left y coordinate of the Camera viewport.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setPosition","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the rotation of this Camera. This causes everything it renders to appear rotated.\n\nRotating a camera does not rotate the viewport itself, it is applied during rendering.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of the Camera, in radians.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setRotation","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1246,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Should the Camera round pixel values to whole integers when rendering Game Objects?\n\nIn some types of game, especially with pixel art, this is required to prevent sub-pixel aliasing.","kind":"function","name":"setRoundPixels","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to round Camera pixels, `false` to not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setRoundPixels","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1265,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the Scene the Camera is bound to.\n\nAlso populates the `resolution` property and updates the internal size values.","kind":"function","name":"setScene","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene the camera is bound to.","name":"scene"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setScene","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1306,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the position of where the Camera is looking within the game.\nYou can also modify the properties `Camera.scrollX` and `Camera.scrollY` directly.\nUse this method, or the scroll properties, to move your camera around the game world.\n\nThis does not change where the camera viewport is placed. See `setPosition` to control that.","kind":"function","name":"setScroll","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the Camera in the game world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y coordinate of the Camera in the game world.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setScroll","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the size of the Camera viewport.\n\nBy default a Camera is the same size as the game, but can be made smaller via this method,\nallowing you to create mini-cam style effects by creating and positioning a smaller Camera\nviewport within your game.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The width of the Camera viewport.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"width","description":"The height of the Camera viewport.","name":"height"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setSize","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1356,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"This method sets the position and size of the Camera viewport in a single call.\n\nIf you're trying to change where the Camera is looking at in your game, then see\nthe method `Camera.setScroll` instead. This method is for changing the viewport\nitself, not what the camera can see.\n\nBy default a Camera is the same size as the game, but can be made smaller via this method,\nallowing you to create mini-cam style effects by creating and positioning a smaller Camera\nviewport within your game.","kind":"function","name":"setViewport","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the Camera viewport.","name":"x"},{"type":{"names":["number"]},"description":"The top-left y coordinate of the Camera viewport.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the Camera viewport.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"width","description":"The height of the Camera viewport.","name":"height"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setViewport","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1387,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the zoom value of the Camera.\n\nChanging to a smaller value, such as 0.5, will cause the camera to 'zoom out'.\nChanging to a larger value, such as 2, will cause the camera to 'zoom in'.\n\nA value of 1 means 'no zoom' and is the default.\n\nChanging the zoom does not impact the Camera viewport in any way, it is only applied during rendering.","kind":"function","name":"setZoom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The zoom value of the Camera. The minimum it can be is 0.001.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setZoom","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1418,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the mask to be applied to this Camera during rendering.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\n\nBitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Camera it will be immediately replaced.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.\n\nNote: You cannot mask a Camera that has `renderToTexture` set.","kind":"function","name":"setMask","since":"3.17.0","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Camera will use when rendering.","name":"mask"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the mask translate along with the Camera, or be fixed in place and not impacted by the Cameras transform?","name":"fixedPosition"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setMask","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Clears the mask that this Camera was using.","kind":"function","name":"clearMask","since":"3.17.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#clearMask","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1475,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the visibility of this Camera.\n\nAn invisible Camera will skip rendering and input tests of everything it can see.","kind":"function","name":"setVisible","since":"3.10.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Camera.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setVisible","scope":"instance","overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1488,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Returns an Object suitable for JSON storage containing all of the Camera viewport and rendering properties.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Cameras.Scene2D.JSONCamera"]},"description":"A well-formed object suitable for conversion to JSON."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#toJSON","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1573,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Destroys this Camera instance and its internal properties and references.\nOnce destroyed you cannot use this Camera again, even if re-added to a Camera Manager.\n\nThis method is called automatically by `CameraManager.remove` if that methods `runDestroy` argument is `true`, which is the default.\n\nUnless you have a specific reason otherwise, always use `CameraManager.remove` and allow it to handle the camera destruction,\nrather than calling this method directly.","kind":"function","name":"destroy","fires":["Phaser.Cameras.Scene2D.Events#event:DESTROY"],"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1610,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The x position of the Camera viewport, relative to the top-left of the game canvas.\nThe viewport is the area into which the camera renders.\nTo adjust the position the camera is looking at in the game world, see the `scrollX` value.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1635,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The y position of the Camera viewport, relative to the top-left of the game canvas.\nThe viewport is the area into which the camera renders.\nTo adjust the position the camera is looking at in the game world, see the `scrollY` value.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1660,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The width of the Camera viewport, in pixels.\n\nThe viewport is the area into which the Camera renders. Setting the viewport does\nnot restrict where the Camera can scroll to.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1686,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The height of the Camera viewport, in pixels.\n\nThe viewport is the area into which the Camera renders. Setting the viewport does\nnot restrict where the Camera can scroll to.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1712,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The horizontal scroll position of this Camera.\n\nChange this value to cause the Camera to scroll around your Scene.\n\nAlternatively, setting the Camera to follow a Game Object, via the `startFollow` method,\nwill automatically adjust the Camera scroll values accordingly.\n\nYou can set the bounds within which the Camera can scroll via the `setBounds` method.","name":"scrollX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#scrollX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The vertical scroll position of this Camera.\n\nChange this value to cause the Camera to scroll around your Scene.\n\nAlternatively, setting the Camera to follow a Game Object, via the `startFollow` method,\nwill automatically adjust the Camera scroll values accordingly.\n\nYou can set the bounds within which the Camera can scroll via the `setBounds` method.","name":"scrollY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#scrollY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1772,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera zoom value. Change this value to zoom in, or out of, a Scene.\n\nA value of 0.5 would zoom the Camera out, so you can now see twice as much\nof the Scene as before. A value of 2 would zoom the Camera in, so every pixel\nnow takes up 2 pixels when rendered.\n\nSet to 1 to return to the default zoom level.\n\nBe careful to never set this value to zero.","name":"zoom","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#zoom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1833,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The horizontal position of the center of the Camera's viewport, relative to the left of the game canvas.","name":"centerX","type":{"names":["number"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1850,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The vertical position of the center of the Camera's viewport, relative to the top of the game canvas.","name":"centerY","type":{"names":["number"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1867,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The displayed width of the camera viewport, factoring in the camera zoom level.\n\nIf a camera has a viewport width of 800 and a zoom of 0.5 then its display width\nwould be 1600, as it's displaying twice as many pixels as zoom level 1.\n\nEqually, a camera with a width of 800 and zoom of 2 would have a display width\nof 400 pixels.","name":"displayWidth","type":{"names":["number"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#displayWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1890,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The displayed height of the camera viewport, factoring in the camera zoom level.\n\nIf a camera has a viewport height of 600 and a zoom of 0.5 then its display height\nwould be 1200, as it's displaying twice as many pixels as zoom level 1.\n\nEqually, a camera with a height of 600 and zoom of 2 would have a display height\nof 300 pixels.","name":"displayHeight","type":{"names":["number"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#displayHeight","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"Camera.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"name":"BaseCamera","longname":"BaseCamera","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Camera.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"classdesc":"A Camera.\n\nThe Camera is the way in which all games are rendered in Phaser. They provide a view into your game world,\nand can be positioned, rotated, zoomed and scrolled accordingly.\n\nA Camera consists of two elements: The viewport and the scroll values.\n\nThe viewport is the physical position and size of the Camera within your game. Cameras, by default, are\ncreated the same size as your game, but their position and size can be set to anything. This means if you\nwanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game,\nyou'd adjust the viewport to do that (using methods like `setViewport` and `setSize`).\n\nIf you wish to change where the Camera is looking in your game, then you scroll it. You can do this\nvia the properties `scrollX` and `scrollY` or the method `setScroll`. Scrolling has no impact on the\nviewport, and changing the viewport has no impact on the scrolling.\n\nBy default a Camera will render all Game Objects it can see. You can change this using the `ignore` method,\nallowing you to filter Game Objects out on a per-Camera basis.\n\nA Camera also has built-in special effects including Fade, Flash and Camera Shake.","kind":"class","name":"Camera","memberof":"Phaser.Cameras.Scene2D","since":"3.0.0","augments":["Phaser.Cameras.Scene2D.BaseCamera","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.Tint"],"params":[{"type":{"names":["number"]},"description":"The x position of the Camera, relative to the top-left of the game canvas.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Camera, relative to the top-left of the game canvas.","name":"y"},{"type":{"names":["number"]},"description":"The width of the Camera, in pixels.","name":"width"},{"type":{"names":["number"]},"description":"The height of the Camera, in pixels.","name":"height"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.Camera","___s":true},{"meta":{"filename":"Camera.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Does this Camera allow the Game Objects it renders to receive input events?","name":"inputEnabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#inputEnabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera Fade effect handler.\nTo fade this camera see the `Camera.fade` methods.","name":"fadeEffect","type":{"names":["Phaser.Cameras.Scene2D.Effects.Fade"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#fadeEffect","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":90,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera Flash effect handler.\nTo flash this camera see the `Camera.flash` method.","name":"flashEffect","type":{"names":["Phaser.Cameras.Scene2D.Effects.Flash"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#flashEffect","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":100,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera Shake effect handler.\nTo shake this camera see the `Camera.shake` method.","name":"shakeEffect","type":{"names":["Phaser.Cameras.Scene2D.Effects.Shake"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#shakeEffect","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera Pan effect handler.\nTo pan this camera see the `Camera.pan` method.","name":"panEffect","type":{"names":["Phaser.Cameras.Scene2D.Effects.Pan"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#panEffect","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera Zoom effect handler.\nTo zoom this camera see the `Camera.zoom` method.","name":"zoomEffect","type":{"names":["Phaser.Cameras.Scene2D.Effects.Zoom"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#zoomEffect","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The linear interpolation value to use when following a target.\n\nCan also be set via `setLerp` or as part of the `startFollow` call.\n\nThe default values of 1 means the camera will instantly snap to the target coordinates.\nA lower value, such as 0.1 means the camera will more slowly track the target, giving\na smooth transition. You can set the horizontal and vertical values independently, and also\nadjust this value in real-time during your game.\n\nBe sure to keep the value between 0 and 1. A value of zero will disable tracking on that axis.","name":"lerp","type":{"names":["Phaser.Math.Vector2"]},"since":"3.9.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#lerp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The values stored in this property are subtracted from the Camera targets position, allowing you to\noffset the camera from the actual target x/y coordinates by this amount.\nCan also be set via `setFollowOffset` or as part of the `startFollow` call.","name":"followOffset","type":{"names":["Phaser.Math.Vector2"]},"since":"3.9.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#followOffset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera dead zone.\n\nThe deadzone is only used when the camera is following a target.\n\nIt defines a rectangular region within which if the target is present, the camera will not scroll.\nIf the target moves outside of this area, the camera will begin scrolling in order to follow it.\n\nThe `lerp` values that you can set for a follower target also apply when using a deadzone.\n\nYou can directly set this property to be an instance of a Rectangle. Or, you can use the\n`setDeadzone` method for a chainable approach.\n\nThe rectangle you provide can have its dimensions adjusted dynamically, however, please\nnote that its position is updated every frame, as it is constantly re-centered on the cameras mid point.\n\nCalling `setDeadzone` with no arguments will reset an active deadzone, as will setting this property\nto `null`.","name":"deadzone","type":{"names":["Phaser.Geom.Rectangle"]},"nullable":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#deadzone","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":195,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera rendering directly to the canvas or to a texture?\n\nEnable rendering to texture with the method `setRenderToTexture` (just enabling this boolean won't be enough)\n\nOnce enabled you can toggle it by switching this property.\n\nTo properly remove a render texture you should call the `clearRenderToTexture()` method.","name":"renderToTexture","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.13.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#renderToTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has been set to render to a texture then this holds a reference\nto the HTML Canvas Element that the Camera is drawing to.\n\nEnable texture rendering using the method `setRenderToTexture`.\n\nThis is only populated if Phaser is running with the Canvas Renderer.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.13.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":225,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has been set to render to a texture then this holds a reference\nto the Rendering Context belonging to the Canvas element the Camera is drawing to.\n\nEnable texture rendering using the method `setRenderToTexture`.\n\nThis is only populated if Phaser is running with the Canvas Renderer.","name":"context","type":{"names":["CanvasRenderingContext2D"]},"since":"3.13.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":239,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has been set to render to a texture then this holds a reference\nto the GL Texture belonging the Camera is drawing to.\n\nEnable texture rendering using the method `setRenderToTexture`.\n\nThis is only set if Phaser is running with the WebGL Renderer.","name":"glTexture","type":{"names":["WebGLTexture"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#glTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":253,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has been set to render to a texture then this holds a reference\nto the GL Frame Buffer belonging the Camera is drawing to.\n\nEnable texture rendering using the method `setRenderToTexture`.\n\nThis is only set if Phaser is running with the WebGL Renderer.","name":"framebuffer","type":{"names":["WebGLFramebuffer"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#framebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":267,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has been set to render to a texture and to use a custom pipeline,\nthen this holds a reference to the pipeline the Camera is drawing with.\n\nEnable texture rendering using the method `setRenderToTexture`.\n\nThis is only set if Phaser is running with the WebGL Renderer.","name":"pipeline","type":{"names":["any"]},"since":"3.13.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#pipeline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":282,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the Camera to render to a texture instead of to the main canvas.\n\nThe Camera will redirect all Game Objects it's asked to render to this texture.\n\nDuring the render sequence, the texture itself will then be rendered to the main canvas.\n\nDoing this gives you the ability to modify the texture before this happens,\nallowing for special effects such as Camera specific shaders, or post-processing\non the texture.\n\nIf running under Canvas the Camera will render to its `canvas` property.\n\nIf running under WebGL the Camera will create a frame buffer, which is stored in its `framebuffer` and `glTexture` properties.\n\nIf you set a camera to render to a texture then it will emit 2 events during the render loop:\n\nFirst, it will emit the event `prerender`. This happens right before any Game Object's are drawn to the Camera texture.\n\nThen, it will emit the event `postrender`. This happens after all Game Object's have been drawn, but right before the\nCamera texture is rendered to the main game canvas. It's the final point at which you can manipulate the texture before\nit appears in-game.\n\nYou should not enable this unless you plan on actually using the texture it creates\nsomehow, otherwise you're just doubling the work required to render your game.\n\nTo temporarily disable rendering to a texture, toggle the `renderToTexture` boolean.\n\nIf you no longer require the Camera to render to a texture, call the `clearRenderToTexture` method,\nwhich will delete the respective textures and free-up resources.","kind":"function","name":"setRenderToTexture","since":"3.13.0","params":[{"type":{"names":["string","Phaser.Renderer.WebGL.WebGLPipeline"]},"optional":true,"description":"An optional WebGL Pipeline to render with, can be either a string which is the name of the pipeline, or a pipeline reference.","name":"pipeline"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setRenderToTexture","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":345,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the WebGL pipeline this Camera is using when rendering to a texture.\n\nYou can pass either the string-based name of the pipeline, or a reference to the pipeline itself.\n\nCall this method with no arguments to clear any previously set pipeline.","kind":"function","name":"setPipeline","since":"3.13.0","params":[{"type":{"names":["string","Phaser.Renderer.WebGL.WebGLPipeline"]},"optional":true,"description":"The WebGL Pipeline to render with, can be either a string which is the name of the pipeline, or a pipeline reference. Or if left empty it will clear the pipeline.","name":"pipeline"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setPipeline","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":378,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera was set to render to a texture, this will clear the resources it was using and\nredirect it to render back to the primary Canvas again.\n\nIf you only wish to temporarily disable rendering to a texture then you can toggle the\nproperty `renderToTexture` instead.","kind":"function","name":"clearRenderToTexture","since":"3.13.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#clearRenderToTexture","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":433,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the Camera dead zone.\n\nThe deadzone is only used when the camera is following a target.\n\nIt defines a rectangular region within which if the target is present, the camera will not scroll.\nIf the target moves outside of this area, the camera will begin scrolling in order to follow it.\n\nThe deadzone rectangle is re-positioned every frame so that it is centered on the mid-point\nof the camera. This allows you to use the object for additional game related checks, such as\ntesting if an object is within it or not via a Rectangle.contains call.\n\nThe `lerp` values that you can set for a follower target also apply when using a deadzone.\n\nCalling this method with no arguments will reset an active deadzone.","kind":"function","name":"setDeadzone","since":"3.11.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of the deadzone rectangle in pixels. If not specified the deadzone is removed.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the deadzone rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setDeadzone","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":495,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Fades the Camera in from the given color over the duration specified.","kind":"function","name":"fadeIn","fires":["Phaser.Cameras.Scene2D.Events#event:FADE_IN_START","Phaser.Cameras.Scene2D.Events#event:FADE_IN_COMPLETE"],"since":"3.3.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["function"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#fadeIn","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":518,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Fades the Camera out to the given color over the duration specified.\nThis is an alias for Camera.fade that forces the fade to start, regardless of existing fades.","kind":"function","name":"fadeOut","fires":["Phaser.Cameras.Scene2D.Events#event:FADE_OUT_START","Phaser.Cameras.Scene2D.Events#event:FADE_OUT_COMPLETE"],"since":"3.3.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["function"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#fadeOut","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":542,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Fades the Camera from the given color to transparent over the duration specified.","kind":"function","name":"fadeFrom","fires":["Phaser.Cameras.Scene2D.Events#event:FADE_IN_START","Phaser.Cameras.Scene2D.Events#event:FADE_IN_COMPLETE"],"since":"3.5.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the effect to start immediately, even if already running.","name":"force"},{"type":{"names":["function"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#fadeFrom","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":566,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Fades the Camera from transparent to the given color over the duration specified.","kind":"function","name":"fade","fires":["Phaser.Cameras.Scene2D.Events#event:FADE_OUT_START","Phaser.Cameras.Scene2D.Events#event:FADE_OUT_COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the effect to start immediately, even if already running.","name":"force"},{"type":{"names":["function"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#fade","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Flashes the Camera by setting it to the given color immediately and then fading it away again quickly over the duration specified.","kind":"function","name":"flash","fires":["Phaser.Cameras.Scene2D.Events#event:FLASH_START","Phaser.Cameras.Scene2D.Events#event:FLASH_COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":250,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the effect to start immediately, even if already running.","name":"force"},{"type":{"names":["function"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#flash","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":614,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Shakes the Camera by the given intensity over the duration specified.","kind":"function","name":"shake","fires":["Phaser.Cameras.Scene2D.Events#event:SHAKE_START","Phaser.Cameras.Scene2D.Events#event:SHAKE_COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":100,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["number","Phaser.Math.Vector2"]},"optional":true,"defaultvalue":0.05,"description":"The intensity of the shake.","name":"intensity"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the shake effect to start immediately, even if already running.","name":"force"},{"type":{"names":["function"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#shake","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":636,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"This effect will scroll the Camera so that the center of its viewport finishes at the given destination,\nover the duration and with the ease specified.","kind":"function","name":"pan","fires":["Phaser.Cameras.Scene2D.Events#event:PAN_START","Phaser.Cameras.Scene2D.Events#event:PAN_COMPLETE"],"since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The destination x coordinate to scroll the center of the Camera viewport to.","name":"x"},{"type":{"names":["number"]},"description":"The destination y coordinate to scroll the center of the Camera viewport to.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Linear'","description":"The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function.","name":"ease"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the pan effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraPanCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\nthe current camera scroll x coordinate and the current camera scroll y coordinate.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#pan","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":662,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"This effect will zoom the Camera to the given scale, over the duration and with the ease specified.","kind":"function","name":"zoomTo","fires":["Phaser.Cameras.Scene2D.Events#event:ZOOM_START","Phaser.Cameras.Scene2D.Events#event:ZOOM_COMPLETE"],"since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The target Camera zoom value.","name":"zoom"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Linear'","description":"The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function.","name":"ease"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the pan effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraPanCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\nthe current camera scroll x coordinate and the current camera scroll y coordinate.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#zoomTo","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":791,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the linear interpolation value to use when following a target.\n\nThe default values of 1 means the camera will instantly snap to the target coordinates.\nA lower value, such as 0.1 means the camera will more slowly track the target, giving\na smooth transition. You can set the horizontal and vertical values independently, and also\nadjust this value in real-time during your game.\n\nBe sure to keep the value between 0 and 1. A value of zero will disable tracking on that axis.","kind":"function","name":"setLerp","since":"3.9.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The amount added to the horizontal linear interpolation of the follow target.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The amount added to the vertical linear interpolation of the follow target.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setLerp","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":819,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the horizontal and vertical offset of the camera from its follow target.\nThe values are subtracted from the targets position during the Cameras update step.","kind":"function","name":"setFollowOffset","since":"3.9.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal offset from the camera follow target.x position.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical offset from the camera follow target.y position.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setFollowOffset","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":841,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the Camera to follow a Game Object.\n\nWhen enabled the Camera will automatically adjust its scroll position to keep the target Game Object\nin its center.\n\nYou can set the linear interpolation value used in the follow code.\nUse low lerp values (such as 0.1) to automatically smooth the camera motion.\n\nIf you find you're getting a slight \"jitter\" effect when following an object it's probably to do with sub-pixel\nrendering of the targets position. This can be rounded by setting the `roundPixels` argument to `true` to\nforce full pixel rounding rendering. Note that this can still be broken if you have specified a non-integer zoom\nvalue on the camera. So be sure to keep the camera zoom to integers.","kind":"function","name":"startFollow","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","object"]},"description":"The target for the Camera to follow.","name":"target"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Round the camera position to whole integers to avoid sub-pixel rendering?","name":"roundPixels"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A value between 0 and 1. This value specifies the amount of linear interpolation to use when horizontally tracking the target. The closer the value to 1, the faster the camera will track.","name":"lerpX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A value between 0 and 1. This value specifies the amount of linear interpolation to use when vertically tracking the target. The closer the value to 1, the faster the camera will track.","name":"lerpY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal offset from the camera follow target.x position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical offset from the camera follow target.y position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#startFollow","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":906,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Stops a Camera from following a Game Object, if previously set via `Camera.startFollow`.","kind":"function","name":"stopFollow","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#stopFollow","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":921,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Resets any active FX, such as a fade, flash or shake. Useful to call after a fade in order to\nremove the fade.","kind":"function","name":"resetFX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#resetFX","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":962,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Destroys this Camera instance. You rarely need to call this directly.\n\nCalled by the Camera Manager. If you wish to destroy a Camera please use `CameraManager.remove` as\ncameras are stored in a pool, ready for recycling later, and calling this directly will prevent that.","kind":"function","name":"destroy","fires":["Phaser.Cameras.Scene2D.Events#event:DESTROY"],"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#destroy","scope":"instance","overrides":"Phaser.Cameras.Scene2D.BaseCamera#destroy","___s":true},{"meta":{"range":[180,208],"filename":"CameraManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"name":"Camera","longname":"Camera","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CameraManager.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"classdesc":"The Camera Manager is a plugin that belongs to a Scene and is responsible for managing all of the Scene Cameras.\n\nBy default you can access the Camera Manager from within a Scene using `this.cameras`, although this can be changed\nin your game config.\n\nCreate new Cameras using the `add` method. Or extend the Camera class with your own addition code and then add\nthe new Camera in using the `addExisting` method.\n\nCameras provide a view into your game world, and can be positioned, rotated, zoomed and scrolled accordingly.\n\nA Camera consists of two elements: The viewport and the scroll values.\n\nThe viewport is the physical position and size of the Camera within your game. Cameras, by default, are\ncreated the same size as your game, but their position and size can be set to anything. This means if you\nwanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game,\nyou'd adjust the viewport to do that (using methods like `setViewport` and `setSize`).\n\nIf you wish to change where the Camera is looking in your game, then you scroll it. You can do this\nvia the properties `scrollX` and `scrollY` or the method `setScroll`. Scrolling has no impact on the\nviewport, and changing the viewport has no impact on the scrolling.\n\nBy default a Camera will render all Game Objects it can see. You can change this using the `ignore` method,\nallowing you to filter Game Objects out on a per-Camera basis. The Camera Manager can manage up to 31 unique \n'Game Object ignore capable' Cameras. Any Cameras beyond 31 that you create will all be given a Camera ID of\nzero, meaning that they cannot be used for Game Object exclusion. This means if you need your Camera to ignore\nGame Objects, make sure it's one of the first 31 created.\n\nA Camera also has built-in special effects including Fade, Flash, Camera Shake, Pan and Zoom.","kind":"class","name":"CameraManager","memberof":"Phaser.Cameras.Scene2D","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that owns the Camera Manager plugin.","name":"scene"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.CameraManager","___s":true},{"meta":{"filename":"CameraManager.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Scene that owns the Camera Manager plugin.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CameraManager.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Scene.Systems handler for the Scene that owns the Camera Manager.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CameraManager.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"All Cameras created by, or added to, this Camera Manager, will have their `roundPixels`\nproperty set to match this value. By default it is set to match the value set in the\ngame configuration, but can be changed at any point. Equally, individual cameras can\nalso be changed as needed.","name":"roundPixels","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#roundPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CameraManager.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"An Array of the Camera objects being managed by this Camera Manager.\nThe Cameras are updated and rendered in the same order in which they appear in this array.\nDo not directly add or remove entries to this array. However, you can move the contents\naround the array should you wish to adjust the display order.","name":"cameras","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#cameras","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CameraManager.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A handy reference to the 'main' camera. By default this is the first Camera the\nCamera Manager creates. You can also set it directly, or use the `makeMain` argument\nin the `add` and `addExisting` methods. It allows you to access it from your game:\n\n```javascript\nvar cam = this.cameras.main;\n```\n\nAlso see the properties `camera1`, `camera2` and so on.","name":"main","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#main","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CameraManager.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A default un-transformed Camera that doesn't exist on the camera list and doesn't\ncount towards the total number of cameras being managed. It exists for other\nsystems, as well as your own code, should they require a basic un-transformed\ncamera instance from which to calculate a view matrix.","name":"default","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"since":"3.17.0","memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#default","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CameraManager.js","lineno":205,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Adds a new Camera into the Camera Manager. The Camera Manager can support up to 31 different Cameras.\n\nEach Camera has its own viewport, which controls the size of the Camera and its position within the canvas.\n\nUse the `Camera.scrollX` and `Camera.scrollY` properties to change where the Camera is looking, or the\nCamera methods such as `centerOn`. Cameras also have built in special effects, such as fade, flash, shake,\npan and zoom.\n\nBy default Cameras are transparent and will render anything that they can see based on their `scrollX`\nand `scrollY` values. Game Objects can be set to be ignored by a Camera by using the `Camera.ignore` method.\n\nThe Camera will have its `roundPixels` property set to whatever `CameraManager.roundPixels` is. You can change\nit after creation if required.\n\nSee the Camera class documentation for more details.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the Camera viewport.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the Camera viewport.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the Camera viewport. If not given it'll be the game config size.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the Camera viewport. If not given it'll be the game config size.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Set this Camera as being the 'main' camera. This just makes the property `main` a reference to it.","name":"makeMain"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The name of the Camera.","name":"name"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The newly created Camera."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#add","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":261,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Adds an existing Camera into the Camera Manager.\n\nThe Camera should either be a `Phaser.Cameras.Scene2D.Camera` instance, or a class that extends from it.\n\nThe Camera will have its `roundPixels` property set to whatever `CameraManager.roundPixels` is. You can change\nit after addition if required.\n\nThe Camera will be assigned an ID, which is used for Game Object exclusion and then added to the\nmanager. As long as it doesn't already exist in the manager it will be added then returned.\n\nIf this method returns `null` then the Camera already exists in this Camera Manager.","kind":"function","name":"addExisting","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to be added to the Camera Manager.","name":"camera"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Set this Camera as being the 'main' camera. This just makes the property `main` a reference to it.","name":"makeMain"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"nullable":true,"description":"The Camera that was added to the Camera Manager, or `null` if it couldn't be added."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#addExisting","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Gets the total number of Cameras in this Camera Manager.\n\nIf the optional `isVisible` argument is set it will only count Cameras that are currently visible.","kind":"function","name":"getTotal","since":"3.11.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Set the `true` to only include visible Cameras in the total.","name":"isVisible"}],"returns":[{"type":{"names":["integer"]},"description":"The total number of Cameras in this Camera Manager."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#getTotal","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":388,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Populates this Camera Manager based on the given configuration object, or an array of config objects.\n\nSee the `Phaser.Types.Cameras.Scene2D.CameraConfig` documentation for details of the object structure.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraConfig","Array."]},"description":"A Camera configuration object, or an array of them, to be added to this Camera Manager.","name":"config"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.CameraManager"]},"description":"This Camera Manager instance."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#fromJSON","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":457,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Gets a Camera based on its name.\n\nCamera names are optional and don't have to be set, so this method is only of any use if you\nhave given your Cameras unique names.","kind":"function","name":"getCamera","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the Camera.","name":"name"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"nullable":true,"description":"The first Camera with a name matching the given string, otherwise `null`."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#getCamera","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Returns an array of all cameras below the given Pointer.\n\nThe first camera in the array is the top-most camera in the camera list.","kind":"function","name":"getCamerasBelowPointer","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer to check against.","name":"pointer"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cameras below the Pointer."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#getCamerasBelowPointer","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":520,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Removes the given Camera, or an array of Cameras, from this Camera Manager.\n\nIf found in the Camera Manager it will be immediately removed from the local cameras array.\nIf also currently the 'main' camera, 'main' will be reset to be camera 0.\n\nThe removed Cameras are automatically destroyed if the `runDestroy` argument is `true`, which is the default.\nIf you wish to re-use the cameras then set this to `false`, but know that they will retain their references\nand internal data until destroyed or re-added to a Camera Manager.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera","Array."]},"description":"The Camera, or an array of Cameras, to be removed from this Camera Manager.","name":"camera"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Automatically call `Camera.destroy` on each Camera removed from this Camera Manager.","name":"runDestroy"}],"returns":[{"type":{"names":["integer"]},"description":"The total number of Cameras removed."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#remove","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Resets this Camera Manager.\n\nThis will iterate through all current Cameras, destroying them all, then it will reset the\ncameras array, reset the ID counter and create 1 new single camera using the default values.","kind":"function","name":"resetAll","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The freshly created main Camera."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#resetAll","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":651,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The event handler that manages the `resize` event dispatched by the Scale Manager.","kind":"function","name":"onResize","since":"3.18.0","params":[{"type":{"names":["Phaser.Structs.Size"]},"description":"The default Game Size object. This is the un-modified game dimensions.","name":"gameSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"The base Size object. The game dimensions multiplied by the resolution. The canvas width / height values match this.","name":"baseSize"}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#onResize","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":676,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Resizes all cameras to the given dimensions.","kind":"function","name":"resize","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The new width of the camera.","name":"width"},{"type":{"names":["number"]},"description":"The new height of the camera.","name":"height"}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#resize","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"Fade.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Fade.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"classdesc":"A Camera Fade effect.\n\nThis effect will fade the camera viewport to the given color, over the duration specified.\n\nOnly the camera viewport is faded. None of the objects it is displaying are impacted, i.e. their colors do\nnot change.\n\nThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\nwhich is invoked each frame for the duration of the effect, if required.","kind":"class","name":"Fade","memberof":"Phaser.Cameras.Scene2D.Effects","since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera this effect is acting upon.","name":"camera"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.Effects.Fade","___s":true},{"meta":{"filename":"Fade.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The Camera this effect belongs to.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"readonly":true,"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Fade.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Is this effect actively running?","name":"isRunning","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Fade.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Has this effect finished running?\n\nThis is different from `isRunning` because it remains set to `true` when the effect is over,\nuntil the effect is either reset or started again.","name":"isComplete","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#isComplete","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Fade.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The direction of the fade.\n`true` = fade out (transparent to color), `false` = fade in (color to transparent)","name":"direction","type":{"names":["boolean"]},"readonly":true,"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#direction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Fade.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The duration of the effect, in milliseconds.","name":"duration","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Fade.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"If this effect is running this holds the current percentage of the progress, a value between 0 and 1.","name":"progress","type":{"names":["number"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Fade.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Fades the Camera to or from the given color over the duration specified.","kind":"function","name":"start","fires":["Phaser.Cameras.Scene2D.Events#event:FADE_IN_START","Phaser.Cameras.Scene2D.Events#event:FADE_OUT_START"],"since":"3.5.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The direction of the fade. `true` = fade out (transparent to color), `false` = fade in (color to transparent)","name":"direction"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraFadeCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera on which the effect was started."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#start","scope":"instance","___s":true},{"meta":{"filename":"Fade.js","lineno":237,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The main update loop for this effect. Called automatically by the Camera.","kind":"function","name":"update","since":"3.5.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#update","scope":"instance","___s":true},{"meta":{"filename":"Fade.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally by the Canvas Renderer.","kind":"function","name":"postRenderCanvas","since":"3.5.0","params":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas context to render to.","name":"ctx"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the effect drew to the renderer, otherwise `false`."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#postRenderCanvas","scope":"instance","___s":true},{"meta":{"filename":"Fade.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally by the WebGL Renderer.","kind":"function","name":"postRenderWebGL","since":"3.5.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"The WebGL Pipeline to render to.","name":"pipeline"},{"type":{"names":["function"]},"description":"A function that will return the gl safe tint colors.","name":"getTintFunction"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the effect drew to the renderer, otherwise `false`."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#postRenderWebGL","scope":"instance","___s":true},{"meta":{"filename":"Fade.js","lineno":330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally when the effect completes.","kind":"function","name":"effectComplete","fires":["Phaser.Cameras.Scene2D.Events#event:FADE_IN_COMPLETE","Phaser.Cameras.Scene2D.Events#event:FADE_OUT_COMPLETE"],"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#effectComplete","scope":"instance","___s":true},{"meta":{"filename":"Fade.js","lineno":351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Resets this camera effect.\nIf it was previously running, it stops instantly without calling its onComplete callback or emitting an event.","kind":"function","name":"reset","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#reset","scope":"instance","___s":true},{"meta":{"filename":"Fade.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Destroys this effect, releasing it from the Camera.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#destroy","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"Flash.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Flash.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"classdesc":"A Camera Flash effect.\n\nThis effect will flash the camera viewport to the given color, over the duration specified.\n\nOnly the camera viewport is flashed. None of the objects it is displaying are impacted, i.e. their colors do\nnot change.\n\nThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\nwhich is invoked each frame for the duration of the effect, if required.","kind":"class","name":"Flash","memberof":"Phaser.Cameras.Scene2D.Effects","since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera this effect is acting upon.","name":"camera"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.Effects.Flash","___s":true},{"meta":{"filename":"Flash.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The Camera this effect belongs to.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"readonly":true,"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Flash.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Is this effect actively running?","name":"isRunning","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Flash.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The duration of the effect, in milliseconds.","name":"duration","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Flash.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"If this effect is running this holds the current percentage of the progress, a value between 0 and 1.","name":"progress","type":{"names":["number"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Flash.js","lineno":153,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Flashes the Camera to or from the given color over the duration specified.","kind":"function","name":"start","fires":["Phaser.Cameras.Scene2D.Events#event:FLASH_START","Phaser.Cameras.Scene2D.Events#event:FLASH_COMPLETE"],"since":"3.5.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":250,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraFlashCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera on which the effect was started."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#start","scope":"instance","___s":true},{"meta":{"filename":"Flash.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The main update loop for this effect. Called automatically by the Camera.","kind":"function","name":"update","since":"3.5.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#update","scope":"instance","___s":true},{"meta":{"filename":"Flash.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally by the Canvas Renderer.","kind":"function","name":"postRenderCanvas","since":"3.5.0","params":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas context to render to.","name":"ctx"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the effect drew to the renderer, otherwise `false`."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#postRenderCanvas","scope":"instance","___s":true},{"meta":{"filename":"Flash.js","lineno":266,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally by the WebGL Renderer.","kind":"function","name":"postRenderWebGL","since":"3.5.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"The WebGL Pipeline to render to.","name":"pipeline"},{"type":{"names":["function"]},"description":"A function that will return the gl safe tint colors.","name":"getTintFunction"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the effect drew to the renderer, otherwise `false`."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#postRenderWebGL","scope":"instance","___s":true},{"meta":{"filename":"Flash.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally when the effect completes.","kind":"function","name":"effectComplete","fires":["Phaser.Cameras.Scene2D.Events#event:FLASH_COMPLETE"],"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#effectComplete","scope":"instance","___s":true},{"meta":{"filename":"Flash.js","lineno":315,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Resets this camera effect.\nIf it was previously running, it stops instantly without calling its onComplete callback or emitting an event.","kind":"function","name":"reset","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#reset","scope":"instance","___s":true},{"meta":{"filename":"Flash.js","lineno":330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Destroys this effect, releasing it from the Camera.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#destroy","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"Pan.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Pan.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"classdesc":"A Camera Pan effect.\n\nThis effect will scroll the Camera so that the center of its viewport finishes at the given destination,\nover the duration and with the ease specified.\n\nOnly the camera scroll is moved. None of the objects it is displaying are impacted, i.e. their positions do\nnot change.\n\nThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\nwhich is invoked each frame for the duration of the effect if required.","kind":"class","name":"Pan","memberof":"Phaser.Cameras.Scene2D.Effects","since":"3.11.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera this effect is acting upon.","name":"camera"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.Effects.Pan","___s":true},{"meta":{"filename":"Pan.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The Camera this effect belongs to.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Is this effect actively running?","name":"isRunning","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The duration of the effect, in milliseconds.","name":"duration","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The starting scroll coordinates to pan the camera from.","name":"source","type":{"names":["Phaser.Math.Vector2"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The constantly updated value based on zoom.","name":"current","type":{"names":["Phaser.Math.Vector2"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#current","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The destination scroll coordinates to pan the camera to.","name":"destination","type":{"names":["Phaser.Math.Vector2"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#destination","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The ease function to use during the pan.","name":"ease","type":{"names":["function"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#ease","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"If this effect is running this holds the current percentage of the progress, a value between 0 and 1.","name":"progress","type":{"names":["number"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":148,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"This effect will scroll the Camera so that the center of its viewport finishes at the given destination,\nover the duration and with the ease specified.","kind":"function","name":"start","fires":["Phaser.Cameras.Scene2D.Events#event:PAN_START","Phaser.Cameras.Scene2D.Events#event:PAN_COMPLETE"],"since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The destination x coordinate to scroll the center of the Camera viewport to.","name":"x"},{"type":{"names":["number"]},"description":"The destination y coordinate to scroll the center of the Camera viewport to.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Linear'","description":"The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function.","name":"ease"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the pan effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraPanCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\nthe current camera scroll x coordinate and the current camera scroll y coordinate.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera on which the effect was started."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#start","scope":"instance","___s":true},{"meta":{"filename":"Pan.js","lineno":217,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The main update loop for this effect. Called automatically by the Camera.","kind":"function","name":"update","since":"3.11.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#update","scope":"instance","___s":true},{"meta":{"filename":"Pan.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally when the effect completes.","kind":"function","name":"effectComplete","fires":["Phaser.Cameras.Scene2D.Events#event:PAN_COMPLETE"],"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#effectComplete","scope":"instance","___s":true},{"meta":{"filename":"Pan.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Resets this camera effect.\nIf it was previously running, it stops instantly without calling its onComplete callback or emitting an event.","kind":"function","name":"reset","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#reset","scope":"instance","___s":true},{"meta":{"filename":"Pan.js","lineno":302,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Destroys this effect, releasing it from the Camera.","kind":"function","name":"destroy","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#destroy","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"Shake.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Shake.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"classdesc":"A Camera Shake effect.\n\nThis effect will shake the camera viewport by a random amount, bounded by the specified intensity, each frame.\n\nOnly the camera viewport is moved. None of the objects it is displaying are impacted, i.e. their positions do\nnot change.\n\nThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\nwhich is invoked each frame for the duration of the effect if required.","kind":"class","name":"Shake","memberof":"Phaser.Cameras.Scene2D.Effects","since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera this effect is acting upon.","name":"camera"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.Effects.Shake","___s":true},{"meta":{"filename":"Shake.js","lineno":37,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The Camera this effect belongs to.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"readonly":true,"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shake.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Is this effect actively running?","name":"isRunning","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shake.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The duration of the effect, in milliseconds.","name":"duration","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shake.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The intensity of the effect. Use small float values. The default when the effect starts is 0.05.\nThis is a Vector2 object, allowing you to control the shake intensity independently across x and y.\nYou can modify this value while the effect is active to create more varied shake effects.","name":"intensity","type":{"names":["Phaser.Math.Vector2"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#intensity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shake.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"If this effect is running this holds the current percentage of the progress, a value between 0 and 1.","name":"progress","type":{"names":["number"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shake.js","lineno":143,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Shakes the Camera by the given intensity over the duration specified.","kind":"function","name":"start","fires":["Phaser.Cameras.Scene2D.Events#event:SHAKE_START","Phaser.Cameras.Scene2D.Events#event:SHAKE_COMPLETE"],"since":"3.5.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":100,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["number","Phaser.Math.Vector2"]},"optional":true,"defaultvalue":0.05,"description":"The intensity of the shake.","name":"intensity"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the shake effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraShakeCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera on which the effect was started."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#start","scope":"instance","___s":true},{"meta":{"filename":"Shake.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The pre-render step for this effect. Called automatically by the Camera.","kind":"function","name":"preRender","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#preRender","scope":"instance","___s":true},{"meta":{"filename":"Shake.js","lineno":212,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The main update loop for this effect. Called automatically by the Camera.","kind":"function","name":"update","since":"3.5.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#update","scope":"instance","___s":true},{"meta":{"filename":"Shake.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally when the effect completes.","kind":"function","name":"effectComplete","fires":["Phaser.Cameras.Scene2D.Events#event:SHAKE_COMPLETE"],"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#effectComplete","scope":"instance","___s":true},{"meta":{"filename":"Shake.js","lineno":279,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Resets this camera effect.\nIf it was previously running, it stops instantly without calling its onComplete callback or emitting an event.","kind":"function","name":"reset","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#reset","scope":"instance","___s":true},{"meta":{"filename":"Shake.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Destroys this effect, releasing it from the Camera.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#destroy","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"Zoom.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Zoom.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"classdesc":"A Camera Zoom effect.\n\nThis effect will zoom the Camera to the given scale, over the duration and with the ease specified.\n\nThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\nwhich is invoked each frame for the duration of the effect if required.","kind":"class","name":"Zoom","memberof":"Phaser.Cameras.Scene2D.Effects","since":"3.11.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera this effect is acting upon.","name":"camera"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.Effects.Zoom","___s":true},{"meta":{"filename":"Zoom.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The Camera this effect belongs to.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Is this effect actively running?","name":"isRunning","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The duration of the effect, in milliseconds.","name":"duration","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The starting zoom value;","name":"source","type":{"names":["number"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The destination zoom value.","name":"destination","type":{"names":["number"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#destination","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The ease function to use during the zoom.","name":"ease","type":{"names":["function"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#ease","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"If this effect is running this holds the current percentage of the progress, a value between 0 and 1.","name":"progress","type":{"names":["number"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"This effect will zoom the Camera to the given scale, over the duration and with the ease specified.","kind":"function","name":"start","fires":["Phaser.Cameras.Scene2D.Events#event:ZOOM_START","Phaser.Cameras.Scene2D.Events#event:ZOOM_COMPLETE"],"since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The target Camera zoom value.","name":"zoom"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Linear'","description":"The ease to use for the Zoom. Can be any of the Phaser Easing constants or a custom function.","name":"ease"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the zoom effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraZoomCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent three arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\nand the current camera zoom value.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera on which the effect was started."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#start","scope":"instance","___s":true},{"meta":{"filename":"Zoom.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The main update loop for this effect. Called automatically by the Camera.","kind":"function","name":"update","since":"3.11.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#update","scope":"instance","___s":true},{"meta":{"filename":"Zoom.js","lineno":240,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally when the effect completes.","kind":"function","name":"effectComplete","fires":["Phaser.Cameras.Scene2D.Events#event:ZOOM_COMPLETE"],"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#effectComplete","scope":"instance","___s":true},{"meta":{"filename":"Zoom.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Resets this camera effect.\nIf it was previously running, it stops instantly without calling its onComplete callback or emitting an event.","kind":"function","name":"reset","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#reset","scope":"instance","___s":true},{"meta":{"filename":"Zoom.js","lineno":272,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Destroys this effect, releasing it from the Camera.","kind":"function","name":"destroy","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"kind":"namespace","name":"Effects","memberof":"Phaser.Cameras.Scene2D","longname":"Phaser.Cameras.Scene2D.Effects","scope":"static","___s":true},{"meta":{"filename":"DESTROY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Destroy Camera Event.\n\nThis event is dispatched by a Camera instance when it is destroyed by the Camera Manager.","kind":"event","name":"DESTROY","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"The camera that was destroyed.","name":"camera"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:DESTROY","scope":"instance","___s":true},{"meta":{"filename":"FADE_IN_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Fade In Complete Event.\n\nThis event is dispatched by a Camera instance when the Fade In Effect completes.\n\nListen to it from a Camera instance using `Camera.on('camerafadeincomplete', listener)`.","kind":"event","name":"FADE_IN_COMPLETE","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Fade"]},"description":"A reference to the effect instance.","name":"effect"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:FADE_IN_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"FADE_IN_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Fade In Start Event.\n\nThis event is dispatched by a Camera instance when the Fade In Effect starts.\n\nListen to it from a Camera instance using `Camera.on('camerafadeinstart', listener)`.","kind":"event","name":"FADE_IN_START","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Fade"]},"description":"A reference to the effect instance.","name":"effect"},{"type":{"names":["integer"]},"description":"The duration of the effect.","name":"duration"},{"type":{"names":["integer"]},"description":"The red color channel value.","name":"red"},{"type":{"names":["integer"]},"description":"The green color channel value.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color channel value.","name":"blue"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:FADE_IN_START","scope":"instance","___s":true},{"meta":{"filename":"FADE_OUT_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Fade Out Complete Event.\n\nThis event is dispatched by a Camera instance when the Fade Out Effect completes.\n\nListen to it from a Camera instance using `Camera.on('camerafadeoutcomplete', listener)`.","kind":"event","name":"FADE_OUT_COMPLETE","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Fade"]},"description":"A reference to the effect instance.","name":"effect"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:FADE_OUT_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"FADE_OUT_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Fade Out Start Event.\n\nThis event is dispatched by a Camera instance when the Fade Out Effect starts.\n\nListen to it from a Camera instance using `Camera.on('camerafadeoutstart', listener)`.","kind":"event","name":"FADE_OUT_START","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Fade"]},"description":"A reference to the effect instance.","name":"effect"},{"type":{"names":["integer"]},"description":"The duration of the effect.","name":"duration"},{"type":{"names":["integer"]},"description":"The red color channel value.","name":"red"},{"type":{"names":["integer"]},"description":"The green color channel value.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color channel value.","name":"blue"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:FADE_OUT_START","scope":"instance","___s":true},{"meta":{"filename":"FLASH_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Flash Complete Event.\n\nThis event is dispatched by a Camera instance when the Flash Effect completes.","kind":"event","name":"FLASH_COMPLETE","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Flash"]},"description":"A reference to the effect instance.","name":"effect"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:FLASH_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"FLASH_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Flash Start Event.\n\nThis event is dispatched by a Camera instance when the Flash Effect starts.","kind":"event","name":"FLASH_START","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Flash"]},"description":"A reference to the effect instance.","name":"effect"},{"type":{"names":["integer"]},"description":"The duration of the effect.","name":"duration"},{"type":{"names":["integer"]},"description":"The red color channel value.","name":"red"},{"type":{"names":["integer"]},"description":"The green color channel value.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color channel value.","name":"blue"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:FLASH_START","scope":"instance","___s":true},{"meta":{"filename":"PAN_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Pan Complete Event.\n\nThis event is dispatched by a Camera instance when the Pan Effect completes.","kind":"event","name":"PAN_COMPLETE","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Pan"]},"description":"A reference to the effect instance.","name":"effect"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:PAN_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"PAN_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Pan Start Event.\n\nThis event is dispatched by a Camera instance when the Pan Effect starts.","kind":"event","name":"PAN_START","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Pan"]},"description":"A reference to the effect instance.","name":"effect"},{"type":{"names":["integer"]},"description":"The duration of the effect.","name":"duration"},{"type":{"names":["number"]},"description":"The destination scroll x coordinate.","name":"x"},{"type":{"names":["number"]},"description":"The destination scroll y coordinate.","name":"y"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:PAN_START","scope":"instance","___s":true},{"meta":{"filename":"POST_RENDER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Post-Render Event.\n\nThis event is dispatched by a Camera instance after is has finished rendering.\nIt is only dispatched if the Camera is rendering to a texture.\n\nListen to it from a Camera instance using: `camera.on('postrender', listener)`.","kind":"event","name":"POST_RENDER","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"The camera that has finished rendering to a texture.","name":"camera"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:POST_RENDER","scope":"instance","___s":true},{"meta":{"filename":"PRE_RENDER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Pre-Render Event.\n\nThis event is dispatched by a Camera instance when it is about to render.\nIt is only dispatched if the Camera is rendering to a texture.\n\nListen to it from a Camera instance using: `camera.on('prerender', listener)`.","kind":"event","name":"PRE_RENDER","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"The camera that is about to render to a texture.","name":"camera"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:PRE_RENDER","scope":"instance","___s":true},{"meta":{"filename":"SHAKE_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Shake Complete Event.\n\nThis event is dispatched by a Camera instance when the Shake Effect completes.","kind":"event","name":"SHAKE_COMPLETE","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Shake"]},"description":"A reference to the effect instance.","name":"effect"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:SHAKE_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"SHAKE_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Shake Start Event.\n\nThis event is dispatched by a Camera instance when the Shake Effect starts.","kind":"event","name":"SHAKE_START","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Shake"]},"description":"A reference to the effect instance.","name":"effect"},{"type":{"names":["integer"]},"description":"The duration of the effect.","name":"duration"},{"type":{"names":["number"]},"description":"The intensity of the effect.","name":"intensity"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:SHAKE_START","scope":"instance","___s":true},{"meta":{"filename":"ZOOM_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Zoom Complete Event.\n\nThis event is dispatched by a Camera instance when the Zoom Effect completes.","kind":"event","name":"ZOOM_COMPLETE","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Zoom"]},"description":"A reference to the effect instance.","name":"effect"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:ZOOM_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"ZOOM_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Zoom Start Event.\n\nThis event is dispatched by a Camera instance when the Zoom Effect starts.","kind":"event","name":"ZOOM_START","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Zoom"]},"description":"A reference to the effect instance.","name":"effect"},{"type":{"names":["integer"]},"description":"The duration of the effect.","name":"duration"},{"type":{"names":["number"]},"description":"The destination zoom value.","name":"zoom"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:ZOOM_START","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Cameras.Scene2D","longname":"Phaser.Cameras.Scene2D.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"kind":"namespace","name":"Scene2D","memberof":"Phaser.Cameras","longname":"Phaser.Cameras.Scene2D","scope":"static","___s":true},{"meta":{"filename":"CameraConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"CameraConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The name of the Camera.","name":"name"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the Camera viewport.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the Camera viewport.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the Camera viewport.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the Camera viewport.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The default zoom level of the Camera.","name":"zoom"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of the Camera, in radians.","name":"rotation"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the Camera round pixels before rendering?","name":"roundPixels"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal scroll position of the Camera.","name":"scrollX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical scroll position of the Camera.","name":"scrollY"},{"type":{"names":["false","string"]},"optional":true,"defaultvalue":false,"description":"A CSS color string controlling the Camera background color.","name":"backgroundColor"},{"type":{"names":["object"]},"optional":true,"nullable":true,"description":"Defines the Camera bounds.","name":"bounds"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The top-left extent of the Camera bounds.","name":"bounds.x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The top-left extent of the Camera bounds.","name":"bounds.y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the Camera bounds.","name":"bounds.width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the Camera bounds.","name":"bounds.height"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.CameraConfig","scope":"static","___s":true},{"meta":{"filename":"CameraFadeCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"CameraFadeCallback","type":{"names":["function"]},"since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera on which the effect is running.","name":"camera"},{"type":{"names":["number"]},"description":"The progress of the effect. A value between 0 and 1.","name":"progress"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.CameraFadeCallback","scope":"static","___s":true},{"meta":{"filename":"CameraFlashCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"CameraFlashCallback","type":{"names":["function"]},"since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera on which the effect is running.","name":"camera"},{"type":{"names":["number"]},"description":"The progress of the effect. A value between 0 and 1.","name":"progress"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.CameraFlashCallback","scope":"static","___s":true},{"meta":{"filename":"CameraPanCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"CameraPanCallback","type":{"names":["function"]},"since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera on which the effect is running.","name":"camera"},{"type":{"names":["number"]},"description":"The progress of the effect. A value between 0 and 1.","name":"progress"},{"type":{"names":["number"]},"description":"The Camera's new scrollX coordinate.","name":"x"},{"type":{"names":["number"]},"description":"The Camera's new scrollY coordinate.","name":"y"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.CameraPanCallback","scope":"static","___s":true},{"meta":{"filename":"CameraShakeCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"CameraShakeCallback","type":{"names":["function"]},"since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera on which the effect is running.","name":"camera"},{"type":{"names":["number"]},"description":"The progress of the effect. A value between 0 and 1.","name":"progress"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.CameraShakeCallback","scope":"static","___s":true},{"meta":{"filename":"CameraZoomCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"CameraZoomCallback","type":{"names":["function"]},"since":"3.11.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera on which the effect is running.","name":"camera"},{"type":{"names":["number"]},"description":"The progress of the effect. A value between 0 and 1.","name":"progress"},{"type":{"names":["number"]},"description":"The Camera's new zoom value.","name":"zoom"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.CameraZoomCallback","scope":"static","___s":true},{"meta":{"filename":"JSONCamera.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"JSONCamera","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The name of the camera","name":"name"},{"type":{"names":["number"]},"description":"The horizontal position of camera","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of camera","name":"y"},{"type":{"names":["number"]},"description":"The width size of camera","name":"width"},{"type":{"names":["number"]},"description":"The height size of camera","name":"height"},{"type":{"names":["number"]},"description":"The zoom of camera","name":"zoom"},{"type":{"names":["number"]},"description":"The rotation of camera","name":"rotation"},{"type":{"names":["boolean"]},"description":"The round pixels st status of camera","name":"roundPixels"},{"type":{"names":["number"]},"description":"The horizontal scroll of camera","name":"scrollX"},{"type":{"names":["number"]},"description":"The vertical scroll of camera","name":"scrollY"},{"type":{"names":["string"]},"description":"The background color of camera","name":"backgroundColor"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.JSONCameraBounds","undefined"]},"optional":true,"description":"The bounds of camera","name":"bounds"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.JSONCamera","scope":"static","___s":true},{"meta":{"filename":"JSONCameraBounds.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"JSONCameraBounds","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The horizontal position of camera","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of camera","name":"y"},{"type":{"names":["number"]},"description":"The width size of camera","name":"width"},{"type":{"names":["number"]},"description":"The height size of camera","name":"height"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.JSONCameraBounds","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"namespace","name":"Scene2D","memberof":"Phaser.Types.Cameras","longname":"Phaser.Types.Cameras.Scene2D","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"FixedKeyControl.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"classdesc":"A Fixed Key Camera Control.\n\nThis allows you to control the movement and zoom of a camera using the defined keys.\n\n```javascript\nvar camControl = new FixedKeyControl({\n camera: this.cameras.main,\n left: cursors.left,\n right: cursors.right,\n speed: float OR { x: 0, y: 0 }\n});\n```\n\nMovement is precise and has no 'smoothing' applied to it.\n\nYou must call the `update` method of this controller every frame.","kind":"class","name":"FixedKeyControl","memberof":"Phaser.Cameras.Controls","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Cameras.Controls.FixedKeyControlConfig"]},"description":"The Fixed Key Control configuration object.","name":"config"}],"scope":"static","longname":"Phaser.Cameras.Controls.FixedKeyControl","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Camera that this Control will update.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera left.","name":"left","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera right.","name":"right","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera up.","name":"up","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#up","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera down.","name":"down","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#down","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will zoom the Camera in.","name":"zoomIn","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#zoomIn","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will zoom the Camera out.","name":"zoomOut","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#zoomOut","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.","name":"zoomSpeed","type":{"names":["number"]},"defaultvalue":"0.01","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#zoomSpeed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The horizontal speed the camera will move.","name":"speedX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#speedX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The vertical speed the camera will move.","name":"speedY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#speedY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"A flag controlling if the Controls will update the Camera or not.","name":"active","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":176,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Starts the Key Control running, providing it has been linked to a camera.","kind":"function","name":"start","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Controls.FixedKeyControl"]},"description":"This Key Control instance."}],"memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#start","scope":"instance","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Stops this Key Control from running. Call `start` to start it again.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Controls.FixedKeyControl"]},"description":"This Key Control instance."}],"memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#stop","scope":"instance","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Binds this Key Control to a camera.","kind":"function","name":"setCamera","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera to bind this Key Control to.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Cameras.Controls.FixedKeyControl"]},"description":"This Key Control instance."}],"memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#setCamera","scope":"instance","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Applies the results of pressing the control keys to the Camera.\n\nYou must call this every step, it is not called automatically.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#update","scope":"instance","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":279,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Destroys this Key Control.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"SmoothedKeyControl.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"classdesc":"A Smoothed Key Camera Control.\n\nThis allows you to control the movement and zoom of a camera using the defined keys.\nUnlike the Fixed Camera Control you can also provide physics values for acceleration, drag and maxSpeed for smoothing effects.\n\n```javascript\nvar controlConfig = {\n camera: this.cameras.main,\n left: cursors.left,\n right: cursors.right,\n up: cursors.up,\n down: cursors.down,\n zoomIn: this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.Q),\n zoomOut: this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.E),\n zoomSpeed: 0.02,\n acceleration: 0.06,\n drag: 0.0005,\n maxSpeed: 1.0\n};\n```\n\nYou must call the `update` method of this controller every frame.","kind":"class","name":"SmoothedKeyControl","memberof":"Phaser.Cameras.Controls","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Cameras.Controls.SmoothedKeyControlConfig"]},"description":"The Smoothed Key Control configuration object.","name":"config"}],"scope":"static","longname":"Phaser.Cameras.Controls.SmoothedKeyControl","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Camera that this Control will update.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera left.","name":"left","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera right.","name":"right","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera up.","name":"up","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#up","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera down.","name":"down","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#down","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will zoom the Camera in.","name":"zoomIn","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#zoomIn","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will zoom the Camera out.","name":"zoomOut","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#zoomOut","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.","name":"zoomSpeed","type":{"names":["number"]},"defaultvalue":"0.01","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#zoomSpeed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The horizontal acceleration the camera will move.","name":"accelX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#accelX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The vertical acceleration the camera will move.","name":"accelY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#accelY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The horizontal drag applied to the camera when it is moving.","name":"dragX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#dragX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":171,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The vertical drag applied to the camera when it is moving.","name":"dragY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#dragY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":194,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The maximum horizontal speed the camera will move.","name":"maxSpeedX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#maxSpeedX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":204,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The maximum vertical speed the camera will move.","name":"maxSpeedY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#maxSpeedY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":260,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"A flag controlling if the Controls will update the Camera or not.","name":"active","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Starts the Key Control running, providing it has been linked to a camera.","kind":"function","name":"start","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Controls.SmoothedKeyControl"]},"description":"This Key Control instance."}],"memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#start","scope":"instance","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":285,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Stops this Key Control from running. Call `start` to start it again.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Controls.SmoothedKeyControl"]},"description":"This Key Control instance."}],"memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#stop","scope":"instance","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Binds this Key Control to a camera.","kind":"function","name":"setCamera","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera to bind this Key Control to.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Cameras.Controls.SmoothedKeyControl"]},"description":"This Key Control instance."}],"memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#setCamera","scope":"instance","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":317,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Applies the results of pressing the control keys to the Camera.\n\nYou must call this every step, it is not called automatically.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#update","scope":"instance","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":456,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Destroys this Key Control.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"kind":"namespace","name":"Controls","memberof":"Phaser.Cameras","longname":"Phaser.Cameras.Controls","scope":"static","___s":true},{"meta":{"filename":"FixedKeyControlConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls/typedefs"},"kind":"typedef","name":"FixedKeyControlConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera that this Control will update.","name":"camera"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera left.","name":"left"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera right.","name":"right"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera up.","name":"up"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera down.","name":"down"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will zoom the Camera in.","name":"zoomIn"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will zoom the Camera out.","name":"zoomOut"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.01,"description":"The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.","name":"zoomSpeed"},{"type":{"names":["number","Object"]},"optional":true,"defaultvalue":0,"description":"The horizontal and vertical speed the camera will move.","name":"speed"}],"memberof":"Phaser.Types.Cameras.Controls","longname":"Phaser.Types.Cameras.Controls.FixedKeyControlConfig","scope":"static","___s":true},{"meta":{"filename":"SmoothedKeyControlConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls/typedefs"},"kind":"typedef","name":"SmoothedKeyControlConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera that this Control will update.","name":"camera"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera left.","name":"left"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera right.","name":"right"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera up.","name":"up"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will zoom the Camera in.","name":"zoomIn"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will zoom the Camera out.","name":"zoomOut"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.01,"description":"The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.","name":"zoomSpeed"},{"type":{"names":["number","Object"]},"optional":true,"defaultvalue":0,"description":"The horizontal and vertical acceleration the camera will move.","name":"acceleration"},{"type":{"names":["number","Object"]},"optional":true,"defaultvalue":0,"description":"The horizontal and vertical drag applied to the camera when it is moving.","name":"drag"},{"type":{"names":["number","Object"]},"optional":true,"defaultvalue":0,"description":"The maximum horizontal and vertical speed the camera will move.","name":"maxSpeed"}],"memberof":"Phaser.Types.Cameras.Controls","longname":"Phaser.Types.Cameras.Controls.SmoothedKeyControlConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls/typedefs"},"kind":"namespace","name":"Controls","memberof":"Phaser.Types.Cameras","longname":"Phaser.Types.Cameras.Controls","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras"},"kind":"namespace","name":"Cameras","memberof":"Phaser","longname":"Phaser.Cameras","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras"},"kind":"namespace","name":"Cameras","memberof":"Phaser.Types","longname":"Phaser.Types.Cameras","scope":"static","___s":true},{"meta":{"range":[225,2132],"filename":"const.js","lineno":13,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Global constants.","ignore":true,"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Phaser Release Version","name":"VERSION","kind":"constant","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.VERSION","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":29,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"AUTO Detect Renderer.","name":"AUTO","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.AUTO","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Canvas Renderer.","name":"CANVAS","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.CANVAS","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":49,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"WebGL Renderer.","name":"WEBGL","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.WEBGL","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":59,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Headless Renderer.","name":"HEADLESS","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.HEADLESS","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":69,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"In Phaser the value -1 means 'forever' in lots of cases, this const allows you to use it instead\nto help you remember what the value is doing in your code.","name":"FOREVER","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.FOREVER","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Direction constant.","name":"NONE","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.NONE","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Direction constant.","name":"UP","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.UP","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Direction constant.","name":"DOWN","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.DOWN","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Direction constant.","name":"LEFT","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.LEFT","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Direction constant.","name":"RIGHT","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.RIGHT","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Config.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Config.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"classdesc":"The active game configuration settings, parsed from a {@link Phaser.Types.Core.GameConfig} object.","kind":"class","name":"Config","memberof":"Phaser.Core","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Core.GameConfig"]},"optional":true,"description":"The configuration object for your Phaser Game instance.","name":"GameConfig"}],"see":["Phaser.Game#config"],"scope":"static","longname":"Phaser.Core.Config","___s":true},{"meta":{"filename":"Config.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"width","type":{"names":["integer","string"]},"description":"The width of the underlying canvas, in pixels.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#width","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"height","type":{"names":["integer","string"]},"description":"The height of the underlying canvas, in pixels.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#height","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"zoom","type":{"names":["Phaser.Scale.ZoomType","integer"]},"description":"The zoom factor, as used by the Scale Manager.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#zoom","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"resolution","type":{"names":["number"]},"description":"The canvas device pixel resolution. Currently un-used.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#resolution","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"parent","type":{"names":["*"]},"nullable":true,"description":"A parent DOM element into which the canvas created by the renderer will be injected.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#parent","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"scaleMode","type":{"names":["Phaser.Scale.ScaleModeType"]},"description":"The scale mode as used by the Scale Manager. The default is zero, which is no scaling.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#scaleMode","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"expandParent","type":{"names":["boolean"]},"description":"Is the Scale Manager allowed to adjust the CSS height property of the parent to be 100%?","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#expandParent","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"autoRound","type":{"names":["integer"]},"description":"Automatically round the display and style sizes of the canvas. This can help with performance in lower-powered devices.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#autoRound","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"autoCenter","type":{"names":["Phaser.Scale.CenterType"]},"description":"Automatically center the canvas within the parent?","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#autoCenter","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"resizeInterval","type":{"names":["integer"]},"description":"How many ms should elapse before checking if the browser size has changed?","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#resizeInterval","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"fullscreenTarget","type":{"names":["HTMLElement","string"]},"nullable":true,"description":"The DOM element that will be sent into full screen mode, or its `id`. If undefined Phaser will create its own div and insert the canvas into it when entering fullscreen mode.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#fullscreenTarget","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"minWidth","type":{"names":["integer"]},"description":"The minimum width, in pixels, the canvas will scale down to. A value of zero means no minimum.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#minWidth","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":109,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"maxWidth","type":{"names":["integer"]},"description":"The maximum width, in pixels, the canvas will scale up to. A value of zero means no maximum.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#maxWidth","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"minHeight","type":{"names":["integer"]},"description":"The minimum height, in pixels, the canvas will scale down to. A value of zero means no minimum.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#minHeight","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"maxHeight","type":{"names":["integer"]},"description":"The maximum height, in pixels, the canvas will scale up to. A value of zero means no maximum.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#maxHeight","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"renderType","type":{"names":["number"]},"description":"Force Phaser to use a specific renderer. Can be `CONST.CANVAS`, `CONST.WEBGL`, `CONST.HEADLESS` or `CONST.AUTO` (default)","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#renderType","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"canvas","type":{"names":["HTMLCanvasElement"]},"nullable":true,"description":"Force Phaser to use your own Canvas element instead of creating one.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#canvas","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"context","type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"nullable":true,"description":"Force Phaser to use your own Canvas context instead of creating one.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#context","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":162,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"canvasStyle","type":{"names":["string"]},"nullable":true,"description":"Optional CSS attributes to be set on the canvas object created by the renderer.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#canvasStyle","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"customEnvironment","type":{"names":["boolean"]},"description":"Is Phaser running under a custom (non-native web) environment? If so, set this to `true` to skip internal Feature detection. If `true` the `renderType` cannot be left as `AUTO`.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#customEnvironment","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":172,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"sceneConfig","type":{"names":["object"]},"nullable":true,"description":"The default Scene configuration object.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#sceneConfig","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"seed","type":{"names":["Array."]},"description":"A seed which the Random Data Generator will use. If not given, a dynamic seed based on the time is used.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#seed","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":184,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"gameTitle","type":{"names":["string"]},"description":"The title of the game.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#gameTitle","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":189,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"gameURL","type":{"names":["string"]},"description":"The URL of the game.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#gameURL","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":194,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"gameVersion","type":{"names":["string"]},"description":"The version of the game.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#gameVersion","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":199,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"autoFocus","type":{"names":["boolean"]},"description":"If `true` the window will automatically be given focus immediately and on any future mousedown event.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#autoFocus","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":206,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"domCreateContainer","type":{"names":["boolean"]},"nullable":true,"description":"Should the game create a div element to act as a DOM Container? Only enable if you're using DOM Element objects. You must provide a parent object if you use this feature.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#domCreateContainer","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"domBehindCanvas","type":{"names":["boolean"]},"nullable":true,"description":"Should the DOM Container that is created (if `dom.createContainer` is true) be positioned behind (true) or over the top (false, the default) of the game canvas?","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#domBehindCanvas","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":218,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputKeyboard","type":{"names":["boolean"]},"description":"Enable the Keyboard Plugin. This can be disabled in games that don't need keyboard input.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputKeyboard","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":223,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputKeyboardEventTarget","type":{"names":["*"]},"description":"The DOM Target to listen for keyboard events on. Defaults to `window` if not specified.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputKeyboardEventTarget","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":228,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputKeyboardCapture","type":{"names":["Array."]},"nullable":true,"description":"`preventDefault` will be called on every non-modified key which has a key code in this array. By default, it is empty.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputKeyboardCapture","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":233,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputMouse","type":{"names":["boolean","object"]},"description":"Enable the Mouse Plugin. This can be disabled in games that don't need mouse input.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputMouse","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":238,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputMouseEventTarget","type":{"names":["*"]},"nullable":true,"description":"The DOM Target to listen for mouse events on. Defaults to the game canvas if not specified.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputMouseEventTarget","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":243,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputMouseCapture","type":{"names":["boolean"]},"description":"Should mouse events be captured? I.e. have prevent default called on them.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputMouseCapture","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":248,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputTouch","type":{"names":["boolean"]},"description":"Enable the Touch Plugin. This can be disabled in games that don't need touch input.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputTouch","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":253,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputTouchEventTarget","type":{"names":["*"]},"nullable":true,"description":"The DOM Target to listen for touch events on. Defaults to the game canvas if not specified.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputTouchEventTarget","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":258,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputTouchCapture","type":{"names":["boolean"]},"description":"Should touch events be captured? I.e. have prevent default called on them.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputTouchCapture","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":263,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputActivePointers","type":{"names":["integer"]},"description":"The number of Pointer objects created by default. In a mouse-only, or non-multi touch game, you can leave this as 1.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputActivePointers","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":268,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputSmoothFactor","type":{"names":["integer"]},"description":"The smoothing factor to apply during Pointer movement. See {@link Phaser.Input.Pointer#smoothFactor}.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputSmoothFactor","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputWindowEvents","type":{"names":["boolean"]},"description":"Should Phaser listen for input events on the Window? If you disable this, events like 'POINTER_UP_OUTSIDE' will no longer fire.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputWindowEvents","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":278,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputGamepad","type":{"names":["boolean"]},"description":"Enable the Gamepad Plugin. This can be disabled in games that don't need gamepad input.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputGamepad","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":283,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputGamepadEventTarget","type":{"names":["*"]},"description":"The DOM Target to listen for gamepad events on. Defaults to `window` if not specified.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputGamepadEventTarget","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":288,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"disableContextMenu","type":{"names":["boolean"]},"description":"Set to `true` to disable the right-click context menu.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#disableContextMenu","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":293,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"audio","type":{"names":["Phaser.Types.Core.AudioConfig"]},"description":"The Audio Configuration object.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#audio","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":300,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"hideBanner","type":{"names":["boolean"]},"description":"Don't write the banner line to the console.log.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#hideBanner","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":305,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"hidePhaser","type":{"names":["boolean"]},"description":"Omit Phaser's name and version from the banner.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#hidePhaser","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":310,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"bannerTextColor","type":{"names":["string"]},"description":"The color of the banner text.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#bannerTextColor","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":315,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"bannerBackgroundColor","type":{"names":["Array."]},"description":"The background colors of the banner.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#bannerBackgroundColor","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":325,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"fps","type":{"names":["Phaser.Types.Core.FPSConfig"]},"nullable":true,"description":"The Frame Rate Configuration object, as parsed by the Timestep class.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#fps","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":335,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"antialias","type":{"names":["boolean"]},"description":"When set to `true`, WebGL uses linear interpolation to draw scaled or rotated textures, giving a smooth appearance. When set to `false`, WebGL uses nearest-neighbor interpolation, giving a crisper appearance. `false` also disables antialiasing of the game canvas itself, if the browser supports it, when the game canvas is scaled.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#antialias","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":340,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"antialiasGL","type":{"names":["boolean"]},"description":"Sets the `antialias` property when the WebGL context is created. Setting this value does not impact any subsequent textures that are created, or the canvas style attributes.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#antialiasGL","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":345,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"mipmapFilter","type":{"names":["string"]},"description":"Sets the `mipmapFilter` property when the WebGL renderer is created.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#mipmapFilter","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":350,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"desynchronized","type":{"names":["boolean"]},"description":"When set to `true` it will create a desynchronized context for both 2D and WebGL. See https://developers.google.com/web/updates/2019/05/desynchronized for details.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#desynchronized","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":355,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"roundPixels","type":{"names":["boolean"]},"description":"Draw texture-based Game Objects at only whole-integer positions. Game Objects without textures, like Graphics, ignore this property.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#roundPixels","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":360,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"pixelArt","type":{"names":["boolean"]},"description":"Prevent pixel art from becoming blurred when scaled. It will remain crisp (tells the WebGL renderer to automatically create textures using a linear filter mode).","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#pixelArt","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":371,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"transparent","type":{"names":["boolean"]},"description":"Whether the game canvas will have a transparent background.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#transparent","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":376,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"clearBeforeRender","type":{"names":["boolean"]},"description":"Whether the game canvas will be cleared between each rendering frame. You can disable this if you have a full-screen background image or game object.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#clearBeforeRender","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":381,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"premultipliedAlpha","type":{"names":["boolean"]},"description":"In WebGL mode, sets the drawing buffer to contain colors with pre-multiplied alpha.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#premultipliedAlpha","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":386,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"failIfMajorPerformanceCaveat","type":{"names":["boolean"]},"description":"Let the browser abort creating a WebGL context if it judges performance would be unacceptable.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#failIfMajorPerformanceCaveat","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":391,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"powerPreference","type":{"names":["string"]},"description":"\"high-performance\", \"low-power\" or \"default\". A hint to the browser on how much device power the game might use.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#powerPreference","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":396,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"batchSize","type":{"names":["integer"]},"description":"The default WebGL Batch size.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#batchSize","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":401,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"maxLights","type":{"names":["integer"]},"description":"The maximum number of lights allowed to be visible within range of a single Camera in the LightManager.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#maxLights","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":408,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"backgroundColor","type":{"names":["Phaser.Display.Color"]},"description":"The background color of the game canvas. The default is black. This value is ignored if `transparent` is set to `true`.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#backgroundColor","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":418,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"preBoot","type":{"names":["Phaser.Types.Core.BootCallback"]},"description":"Called before Phaser boots. Useful for initializing anything not related to Phaser that Phaser may require while booting.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#preBoot","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":423,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"postBoot","type":{"names":["Phaser.Types.Core.BootCallback"]},"description":"A function to run at the end of the boot sequence. At this point, all the game systems have started and plugins have been loaded.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#postBoot","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":428,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"physics","type":{"names":["Phaser.Types.Core.PhysicsConfig"]},"description":"The Physics Configuration object.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#physics","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":433,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"defaultPhysicsSystem","type":{"names":["boolean","string"]},"description":"The default physics system. It will be started for each scene. Either 'arcade', 'impact' or 'matter'.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#defaultPhysicsSystem","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":438,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderBaseURL","type":{"names":["string"]},"description":"A URL used to resolve paths given to the loader. Example: 'http://labs.phaser.io/assets/'.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderBaseURL","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":443,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderPath","type":{"names":["string"]},"description":"A URL path used to resolve relative paths given to the loader. Example: 'images/sprites/'.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderPath","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":448,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderMaxParallelDownloads","type":{"names":["integer"]},"description":"Maximum parallel downloads allowed for resources (Default to 32).","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderMaxParallelDownloads","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":453,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderCrossOrigin","type":{"names":["string","undefined"]},"description":"'anonymous', 'use-credentials', or `undefined`. If you're not making cross-origin requests, leave this as `undefined`. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes}.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderCrossOrigin","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":458,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderResponseType","type":{"names":["string"]},"description":"The response type of the XHR request, e.g. `blob`, `text`, etc.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderResponseType","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":463,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderAsync","type":{"names":["boolean"]},"description":"Should the XHR request use async or not?","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderAsync","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":468,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderUser","type":{"names":["string"]},"description":"Optional username for all XHR requests.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderUser","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":473,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderPassword","type":{"names":["string"]},"description":"Optional password for all XHR requests.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderPassword","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":478,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderTimeout","type":{"names":["integer"]},"description":"Optional XHR timeout value, in ms.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderTimeout","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":501,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"installGlobalPlugins","type":{"names":["any"]},"description":"An array of global plugins to be installed.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#installGlobalPlugins","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":506,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"installScenePlugins","type":{"names":["any"]},"description":"An array of Scene level plugins to be installed.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#installScenePlugins","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":537,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"defaultPlugins","type":{"names":["any"]},"description":"The plugins installed into every Scene (in addition to CoreScene and Global).","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#defaultPlugins","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":545,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"defaultImage","type":{"names":["string"]},"description":"A base64 encoded PNG that will be used as the default blank texture.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#defaultImage","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":550,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"missingImage","type":{"names":["string"]},"description":"A base64 encoded PNG that will be used as the default texture when a texture is assigned that is missing or not loaded.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#missingImage","scope":"instance","___s":true},{"meta":{"range":[180,250],"filename":"CreateRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"name":"CanvasInterpolation","longname":"CanvasInterpolation","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CreateRenderer.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Called automatically by Phaser.Game and responsible for creating the renderer it will use.\n\nRelies upon two webpack global flags to be defined: `WEBGL_RENDERER` and `CANVAS_RENDERER` during build time, but not at run-time.","kind":"function","name":"CreateRenderer","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Phaser.Game instance on which the renderer will be set.","name":"game"}],"memberof":"Phaser.Core","longname":"Phaser.Core.CreateRenderer","scope":"static","___s":true},{"meta":{"range":[180,207],"filename":"DebugHeader.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DebugHeader.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Called automatically by Phaser.Game and responsible for creating the console.log debug header.\n\nYou can customize or disable the header via the Game Config object.","kind":"function","name":"DebugHeader","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Phaser.Game instance which will output this debug header.","name":"game"}],"memberof":"Phaser.Core","longname":"Phaser.Core.DebugHeader","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"Game.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"name":"AddToDOM","longname":"AddToDOM","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Game.js","lineno":41,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"classdesc":"The Phaser.Game instance is the main controller for the entire Phaser game. It is responsible\nfor handling the boot process, parsing the configuration values, creating the renderer,\nand setting-up all of the global Phaser systems, such as sound and input.\nOnce that is complete it will start the Scene Manager and then begin the main game loop.\n\nYou should generally avoid accessing any of the systems created by Game, and instead use those\nmade available to you via the Phaser.Scene Systems class instead.","kind":"class","name":"Game","memberof":"Phaser","fires":["Phaser.Core.Events#event:BLUR","Phaser.Core.Events#event:FOCUS","Phaser.Core.Events#event:HIDDEN","Phaser.Core.Events#event:VISIBLE"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Core.GameConfig"]},"optional":true,"description":"The configuration object for your Phaser Game instance.","name":"GameConfig"}],"scope":"static","longname":"Phaser.Game","___s":true},{"meta":{"filename":"Game.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The parsed Game Configuration object.\n\nThe values stored within this object are read-only and should not be changed at run-time.","name":"config","type":{"names":["Phaser.Core.Config"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A reference to either the Canvas or WebGL Renderer that this Game is using.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A reference to an HTML Div Element used as the DOM Element Container.\n\nOnly set if `createDOMContainer` is `true` in the game config (by default it is `false`) and\nif you provide a parent element to insert the Phaser Game inside.\n\nSee the DOM Element Game Object for more details.","name":"domContainer","type":{"names":["HTMLDivElement"]},"since":"3.17.0","memberof":"Phaser.Game","longname":"Phaser.Game#domContainer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A reference to the HTML Canvas Element that Phaser uses to render the game.\nThis is created automatically by Phaser unless you provide a `canvas` property\nin your Game Config.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A reference to the Rendering Context belonging to the Canvas Element this game is rendering to.\nIf the game is running under Canvas it will be a 2d Canvas Rendering Context.\nIf the game is running under WebGL it will be a WebGL Rendering Context.\nThis context is created automatically by Phaser unless you provide a `context` property\nin your Game Config.","name":"context","type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A flag indicating when this Game instance has finished its boot process.","name":"isBooted","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#isBooted","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A flag indicating if this Game is currently running its game step or not.","name":"isRunning","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An Event Emitter which is used to broadcast game-level events from the global systems.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Animation Manager.\n\nThe Animation Manager is a global system responsible for managing all animations used within your game.","name":"anims","type":{"names":["Phaser.Animations.AnimationManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#anims","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Texture Manager.\n\nThe Texture Manager is a global system responsible for managing all textures being used by your game.","name":"textures","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#textures","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Cache Manager.\n\nThe Cache Manager is a global system responsible for caching, accessing and releasing external game assets.","name":"cache","type":{"names":["Phaser.Cache.CacheManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#cache","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":189,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Data Manager","name":"registry","type":{"names":["Phaser.Data.DataManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#registry","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":198,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Input Manager.\n\nThe Input Manager is a global system responsible for the capture of browser-level input events.","name":"input","type":{"names":["Phaser.Input.InputManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#input","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":209,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Scene Manager.\n\nThe Scene Manager is a global system responsible for creating, modifying and updating the Scenes in your game.","name":"scene","type":{"names":["Phaser.Scenes.SceneManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A reference to the Device inspector.\n\nContains information about the device running this game, such as OS, browser vendor and feature support.\nUsed by various systems to determine capabilities and code paths.","name":"device","type":{"names":["Phaser.DeviceConf"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#device","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":232,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Scale Manager.\n\nThe Scale Manager is a global system responsible for handling scaling of the game canvas.","name":"scale","type":{"names":["Phaser.Scale.ScaleManager"]},"since":"3.16.0","memberof":"Phaser.Game","longname":"Phaser.Game#scale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":243,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the base Sound Manager.\n\nThe Sound Manager is a global system responsible for the playback and updating of all audio in your game.\n\nYou can disable the inclusion of the Sound Manager in your build by toggling the webpack `FEATURE_SOUND` flag.","name":"sound","type":{"names":["Phaser.Sound.NoAudioSoundManager","Phaser.Sound.HTML5AudioSoundManager","Phaser.Sound.WebAudioSoundManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#sound","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":261,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Time Step.\n\nThe Time Step is a global system responsible for setting-up and responding to the browser frame events, processing\nthem and calculating delta values. It then automatically calls the game step.","name":"loop","type":{"names":["Phaser.Core.TimeStep"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#loop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Plugin Manager.\n\nThe Plugin Manager is a global system that allows plugins to register themselves with it, and can then install\nthose plugins into Scenes as required.","name":"plugins","type":{"names":["Phaser.Plugins.PluginManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#plugins","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":287,"columnno":12,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Facebook Instant Games Plugin.\n\nThis will only be available if the plugin has been built into Phaser,\nor you're using the special Facebook Instant Games custom build.","name":"facebook","type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"since":"3.13.0","memberof":"Phaser.Game","longname":"Phaser.Game#facebook","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":331,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Does the window the game is running in currently have focus or not?\nThis is modified by the VisibilityHandler.","name":"hasFocus","type":{"names":["boolean"]},"readonly":true,"since":"3.9.0","memberof":"Phaser.Game","longname":"Phaser.Game#hasFocus","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":437,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The main Game Step. Called automatically by the Time Step, once per browser frame (typically as a result of\nRequest Animation Frame, or Set Timeout on very old browsers.)\n\nThe step will update the global managers first, then proceed to update each Scene in turn, via the Scene Manager.\n\nIt will then render each Scene in turn, via the Renderer. This process emits `prerender` and `postrender` events.","kind":"function","name":"step","fires":["Phaser.Core.Events#event:PRE_STEP_EVENT","Phaser.Core.Events#event:STEP_EVENT","Phaser.Core.Events#event:POST_STEP_EVENT","Phaser.Core.Events#event:PRE_RENDER_EVENT","Phaser.Core.Events#event:POST_RENDER_EVENT"],"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Game","longname":"Phaser.Game#step","scope":"instance","___s":true},{"meta":{"filename":"Game.js","lineno":502,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A special version of the Game Step for the HEADLESS renderer only.\n\nThe main Game Step. Called automatically by the Time Step, once per browser frame (typically as a result of\nRequest Animation Frame, or Set Timeout on very old browsers.)\n\nThe step will update the global managers first, then proceed to update each Scene in turn, via the Scene Manager.\n\nThis process emits `prerender` and `postrender` events, even though nothing actually displays.","kind":"function","name":"headlessStep","fires":["Phaser.Game#event:prerenderEvent","Phaser.Game#event:postrenderEvent"],"since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Game","longname":"Phaser.Game#headlessStep","scope":"instance","___s":true},{"meta":{"filename":"Game.js","lineno":610,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Returns the current game frame.\n\nWhen the game starts running, the frame is incremented every time Request Animation Frame, or Set Timeout, fires.","kind":"function","name":"getFrame","since":"3.16.0","returns":[{"type":{"names":["number"]},"description":"The current game frame."}],"memberof":"Phaser.Game","longname":"Phaser.Game#getFrame","scope":"instance","___s":true},{"meta":{"filename":"Game.js","lineno":625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Returns the time that the current game step started at, as based on `performance.now`.","kind":"function","name":"getTime","since":"3.16.0","returns":[{"type":{"names":["number"]},"description":"The current game timestamp."}],"memberof":"Phaser.Game","longname":"Phaser.Game#getTime","scope":"instance","___s":true},{"meta":{"filename":"Game.js","lineno":638,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Flags this Game instance as needing to be destroyed on the _next frame_, making this an asynchronous operation.\n\nIt will wait until the current frame has completed and then call `runDestroy` internally.\n\nIf you need to react to the games eventual destruction, listen for the `DESTROY` event.\n\nIf you **do not** need to run Phaser again on the same web page you can set the `noReturn` argument to `true` and it will free-up\nmemory being held by the core Phaser plugins. If you do need to create another game instance on the same page, leave this as `false`.","kind":"function","name":"destroy","fires":["Phaser.Core.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if you would like the parent canvas element removed from the DOM, or `false` to leave it in place.","name":"removeCanvas"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` all the core Phaser plugins are destroyed. You cannot create another instance of Phaser on the same web page if you do this.","name":"noReturn"}],"memberof":"Phaser.Game","longname":"Phaser.Game#destroy","scope":"instance","___s":true},{"meta":{"range":[180,213],"filename":"TimeStep.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TimeStep.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"classdesc":"The core runner class that Phaser uses to handle the game loop. It can use either Request Animation Frame,\nor SetTimeout, based on browser support and config settings, to create a continuous loop within the browser.\n\nEach time the loop fires, `TimeStep.step` is called and this is then passed onto the core Game update loop,\nit is the core heartbeat of your game. It will fire as often as Request Animation Frame is capable of handling\non the target device.\n\nNote that there are lots of situations where a browser will stop updating your game. Such as if the player\nswitches tabs, or covers up the browser window with another application. In these cases, the 'heartbeat'\nof your game will pause, and only resume when focus is returned to it by the player. There is no way to avoid\nthis situation, all you can do is use the visibility events the browser, and Phaser, provide to detect when\nit has happened and then gracefully recover.","kind":"class","name":"TimeStep","memberof":"Phaser.Core","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"A reference to the Phaser.Game instance that owns this Time Step.","name":"game"},{"type":{"names":["Phaser.Types.Core.FPSConfig"]},"name":"config"}],"scope":"static","longname":"Phaser.Core.TimeStep","___s":true},{"meta":{"filename":"TimeStep.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A reference to the Phaser.Game instance.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The Request Animation Frame DOM Event handler.","name":"raf","type":{"names":["Phaser.DOM.RequestAnimationFrame"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#raf","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":63,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A flag that is set once the TimeStep has started running and toggled when it stops.","name":"started","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#started","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A flag that is set once the TimeStep has started running and toggled when it stops.\nThe difference between this value and `started` is that `running` is toggled when\nthe TimeStep is sent to sleep, where-as `started` remains `true`, only changing if\nthe TimeStep is actually stopped, not just paused.","name":"running","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#running","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The minimum fps rate you want the Time Step to run at.","name":"minFps","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#minFps","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The target fps rate for the Time Step to run at.\n\nSetting this value will not actually change the speed at which the browser runs, that is beyond\nthe control of Phaser. Instead, it allows you to determine performance issues and if the Time Step\nis spiraling out of control.","name":"targetFps","type":{"names":["integer"]},"defaultvalue":"60","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#targetFps","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An exponential moving average of the frames per second.","name":"actualFps","type":{"names":["integer"]},"readonly":true,"defaultvalue":"60","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#actualFps","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":145,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The time at which the next fps rate update will take place.\nWhen an fps update happens, the `framesThisSecond` value is reset.","name":"nextFpsUpdate","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#nextFpsUpdate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The number of frames processed this second.","name":"framesThisSecond","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#framesThisSecond","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A callback to be invoked each time the Time Step steps.","name":"callback","type":{"names":["Phaser.Types.Core.TimeStepCallback"]},"defaultvalue":"NOOP","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#callback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"You can force the Time Step to use Set Timeout instead of Request Animation Frame by setting\nthe `forceSetTimeOut` property to `true` in the Game Configuration object. It cannot be changed at run-time.","name":"forceSetTimeOut","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#forceSetTimeOut","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":190,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The time, calculated at the start of the current step, as smoothed by the delta value.","name":"time","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#time","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":200,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The time at which the game started running. This value is adjusted if the game is then\npaused and resumes.","name":"startTime","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#startTime","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The time, as returned by `performance.now` of the previous step.","name":"lastTime","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#lastTime","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":221,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The current frame the game is on. This counter is incremented once every game step, regardless of how much\ntime has passed and is unaffected by delta smoothing.","name":"frame","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":233,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Is the browser currently considered in focus by the Page Visibility API?\nThis value is set in the `blur` method, which is called automatically by the Game instance.","name":"inFocus","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#inFocus","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":267,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The delta time, in ms, since the last game step. This is a clamped and smoothed average value.","name":"delta","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#delta","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":277,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Internal index of the delta history position.","name":"deltaIndex","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#deltaIndex","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":287,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Internal array holding the previous delta values, used for delta smoothing.","name":"deltaHistory","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#deltaHistory","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":296,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The maximum number of delta values that are retained in order to calculate a smoothed moving average.\n\nThis can be changed in the Game Config via the `fps.deltaHistory` property. The default is 10.","name":"deltaSmoothingMax","type":{"names":["integer"]},"defaultvalue":"10","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#deltaSmoothingMax","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":308,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The number of frames that the cooldown is set to after the browser panics over the FPS rate, usually\nas a result of switching tabs and regaining focus.\n\nThis can be changed in the Game Config via the `fps.panicMax` property. The default is 120.","name":"panicMax","type":{"names":["integer"]},"defaultvalue":"120","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#panicMax","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":321,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The actual elapsed time in ms between one update and the next.\n\nUnlike with `delta`, no smoothing, capping, or averaging is applied to this value.\nSo please be careful when using this value in math calculations.","name":"rawDelta","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#rawDelta","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":334,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The time, as returned by `performance.now` at the very start of the current step.\nThis can differ from the `time` value in that it isn't calculated based on the delta value.","name":"now","type":{"names":["number"]},"defaultvalue":"0","since":"3.18.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#now","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":345,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Apply smoothing to the delta value used within Phasers internal calculations?\n\nThis can be changed in the Game Config via the `fps.smoothStep` property. The default is `true`.\n\nSmoothing helps settle down the delta values after browser tab switches, or other situations\nwhich could cause significant delta spikes or dips. By default it has been enabled in Phaser 3\nsince the first version, but is now exposed under this property (and the corresponding game config\n`smoothStep` value), to allow you to easily disable it, should you require.","name":"smoothStep","type":{"names":["boolean"]},"since":"3.22.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#smoothStep","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":362,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Called by the Game instance when the DOM window.onBlur event triggers.","kind":"function","name":"blur","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#blur","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Called by the Game instance when the DOM window.onFocus event triggers.","kind":"function","name":"focus","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#focus","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":386,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Called when the visibility API says the game is 'hidden' (tab switch out of view, etc)","kind":"function","name":"pause","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#pause","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":397,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Called when the visibility API says the game is 'visible' again (tab switch back into view, etc)","kind":"function","name":"resume","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#resume","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Resets the time, lastTime, fps averages and delta history.\nCalled automatically when a browser sleeps them resumes.","kind":"function","name":"resetDelta","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#resetDelta","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":439,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Starts the Time Step running, if it is not already doing so.\nCalled automatically by the Game Boot process.","kind":"function","name":"start","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Core.TimeStepCallback"]},"description":"The callback to be invoked each time the Time Step steps.","name":"callback"}],"memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#start","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The main step method. This is called each time the browser updates, either by Request Animation Frame,\nor by Set Timeout. It is responsible for calculating the delta values, frame totals, cool down history and more.\nYou generally should never call this method directly.","kind":"function","name":"step","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#step","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":607,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Manually calls `TimeStep.step`.","kind":"function","name":"tick","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#tick","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":618,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Sends the TimeStep to sleep, stopping Request Animation Frame (or SetTimeout) and toggling the `running` flag to false.","kind":"function","name":"sleep","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#sleep","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":634,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Wakes-up the TimeStep, restarting Request Animation Frame (or SetTimeout) and toggling the `running` flag to true.\nThe `seamless` argument controls if the wake-up should adjust the start time or not.","kind":"function","name":"wake","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Adjust the startTime based on the lastTime values.","name":"seamless"}],"memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#wake","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":661,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Gets the duration which the game has been running, in seconds.","kind":"function","name":"getDuration","since":"3.17.0","returns":[{"type":{"names":["number"]},"description":"The duration in seconds."}],"memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#getDuration","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":674,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Gets the duration which the game has been running, in ms.","kind":"function","name":"getDurationMS","since":"3.17.0","returns":[{"type":{"names":["number"]},"description":"The duration in ms."}],"memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#getDurationMS","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":687,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Stops the TimeStep running.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["Phaser.Core.TimeStep"]},"description":"The TimeStep object."}],"memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#stop","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":705,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Destroys the TimeStep. This will stop Request Animation Frame, stop the step, clear the callbacks and null\nany objects.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#destroy","scope":"instance","___s":true},{"meta":{"range":[180,208],"filename":"VisibilityHandler.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"name":"Events","longname":"Events","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"VisibilityHandler.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The Visibility Handler is responsible for listening out for document level visibility change events.\nThis includes `visibilitychange` if the browser supports it, and blur and focus events. It then uses\nthe provided Event Emitter and fires the related events.","kind":"function","name":"VisibilityHandler","fires":["Phaser.Core.Events#event:BLUR","Phaser.Core.Events#event:FOCUS","Phaser.Core.Events#event:HIDDEN","Phaser.Core.Events#event:VISIBLE"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Game instance this Visibility Handler is working on.","name":"game"}],"memberof":"Phaser.Core","longname":"Phaser.Core.VisibilityHandler","scope":"static","___s":true},{"meta":{"filename":"BLUR_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Blur Event.\n\nThis event is dispatched by the Game Visibility Handler when the window in which the Game instance is embedded\nenters a blurred state. The blur event is raised when the window loses focus. This can happen if a user swaps\ntab, or if they simply remove focus from the browser to another app.","kind":"event","name":"BLUR","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:BLUR","scope":"instance","___s":true},{"meta":{"filename":"BOOT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Boot Event.\n\nThis event is dispatched when the Phaser Game instance has finished booting, but before it is ready to start running.\nThe global systems use this event to know when to set themselves up, dispatching their own `ready` events as required.","kind":"event","name":"BOOT","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:BOOT","scope":"instance","___s":true},{"meta":{"filename":"CONTEXT_LOST_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Context Lost Event.\n\nThis event is dispatched by the Game if the WebGL Renderer it is using encounters a WebGL Context Lost event from the browser.\n\nThe partner event is `CONTEXT_RESTORED`.","kind":"event","name":"CONTEXT_LOST","since":"3.19.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:CONTEXT_LOST","scope":"instance","___s":true},{"meta":{"filename":"CONTEXT_RESTORED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Context Restored Event.\n\nThis event is dispatched by the Game if the WebGL Renderer it is using encounters a WebGL Context Restored event from the browser.\n\nThe partner event is `CONTEXT_LOST`.","kind":"event","name":"CONTEXT_RESTORED","since":"3.19.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:CONTEXT_RESTORED","scope":"instance","___s":true},{"meta":{"filename":"DESTROY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Destroy Event.\n\nThis event is dispatched when the game instance has been told to destroy itself.\nLots of internal systems listen to this event in order to clear themselves out.\nCustom plugins and game code should also do the same.","kind":"event","name":"DESTROY","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:DESTROY","scope":"instance","___s":true},{"meta":{"filename":"FOCUS_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Focus Event.\n\nThis event is dispatched by the Game Visibility Handler when the window in which the Game instance is embedded\nenters a focused state. The focus event is raised when the window re-gains focus, having previously lost it.","kind":"event","name":"FOCUS","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:FOCUS","scope":"instance","___s":true},{"meta":{"filename":"HIDDEN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Hidden Event.\n\nThis event is dispatched by the Game Visibility Handler when the document in which the Game instance is embedded\nenters a hidden state. Only browsers that support the Visibility API will cause this event to be emitted.\n\nIn most modern browsers, when the document enters a hidden state, the Request Animation Frame and setTimeout, which\ncontrol the main game loop, will automatically pause. There is no way to stop this from happening. It is something\nyour game should account for in its own code, should the pause be an issue (i.e. for multiplayer games)","kind":"event","name":"HIDDEN","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:HIDDEN","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Pause Event.\n\nThis event is dispatched when the Game loop enters a paused state, usually as a result of the Visibility Handler.","kind":"event","name":"PAUSE","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:PAUSE","scope":"instance","___s":true},{"meta":{"filename":"POST_RENDER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Post-Render Event.\n\nThis event is dispatched right at the end of the render process.\n\nEvery Scene will have rendered and been drawn to the canvas by the time this event is fired.\nUse it for any last minute post-processing before the next game step begins.","kind":"event","name":"POST_RENDER","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"A reference to the current renderer being used by the Game instance.","name":"renderer"}],"memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:POST_RENDER","scope":"instance","___s":true},{"meta":{"filename":"POST_STEP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Post-Step Event.\n\nThis event is dispatched after the Scene Manager has updated.\nHook into it from plugins or systems that need to do things before the render starts.","kind":"event","name":"POST_STEP","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:POST_STEP","scope":"instance","___s":true},{"meta":{"filename":"PRE_RENDER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Pre-Render Event.\n\nThis event is dispatched immediately before any of the Scenes have started to render.\n\nThe renderer will already have been initialized this frame, clearing itself and preparing to receive the Scenes for rendering, but it won't have actually drawn anything yet.","kind":"event","name":"PRE_RENDER","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"A reference to the current renderer being used by the Game instance.","name":"renderer"}],"memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:PRE_RENDER","scope":"instance","___s":true},{"meta":{"filename":"PRE_STEP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Pre-Step Event.\n\nThis event is dispatched before the main Game Step starts. By this point in the game cycle none of the Scene updates have yet happened.\nHook into it from plugins or systems that need to update before the Scene Manager does.","kind":"event","name":"PRE_STEP","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:PRE_STEP","scope":"instance","___s":true},{"meta":{"filename":"READY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Ready Event.\n\nThis event is dispatched when the Phaser Game instance has finished booting, the Texture Manager is fully ready,\nand all local systems are now able to start.","kind":"event","name":"READY","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:READY","scope":"instance","___s":true},{"meta":{"filename":"RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Resume Event.\n\nThis event is dispatched when the game loop leaves a paused state and resumes running.","kind":"event","name":"RESUME","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:RESUME","scope":"instance","___s":true},{"meta":{"filename":"STEP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Step Event.\n\nThis event is dispatched after the Game Pre-Step and before the Scene Manager steps.\nHook into it from plugins or systems that need to update before the Scene Manager does, but after the core Systems have.","kind":"event","name":"STEP","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:STEP","scope":"instance","___s":true},{"meta":{"filename":"VISIBLE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Visible Event.\n\nThis event is dispatched by the Game Visibility Handler when the document in which the Game instance is embedded\nenters a visible state, previously having been hidden.\n\nOnly browsers that support the Visibility API will cause this event to be emitted.","kind":"event","name":"VISIBLE","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:VISIBLE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Core","longname":"Phaser.Core.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"namespace","name":"Core","memberof":"Phaser","longname":"Phaser.Core","scope":"static","___s":true},{"meta":{"filename":"AudioConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"description":"Config object containing various sound settings.","kind":"typedef","name":"AudioConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use HTML5 Audio instead of Web Audio.","name":"disableWebAudio"},{"type":{"names":["AudioContext"]},"optional":true,"description":"An existing Web Audio context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Disable all audio output.","name":"noAudio"}],"see":["Phaser.Sound.SoundManagerCreator"],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.AudioConfig","scope":"static","___s":true},{"meta":{"filename":"BannerConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"BannerConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Omit Phaser's name and version from the banner.","name":"hidePhaser"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#ffffff'","description":"The color of the banner text.","name":"text"},{"type":{"names":["Array."]},"optional":true,"description":"The background colors of the banner.","name":"background"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.BannerConfig","scope":"static","___s":true},{"meta":{"filename":"BootCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"BootCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The game.","name":"game"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.BootCallback","scope":"static","___s":true},{"meta":{"filename":"CallbacksConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"CallbacksConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.Core.BootCallback"]},"optional":true,"defaultvalue":"Phaser.Types.Core.NOOP","description":"A function to run at the start of the boot sequence.","name":"preBoot"},{"type":{"names":["Phaser.Types.Core.BootCallback"]},"optional":true,"defaultvalue":"Phaser.Types.Core.NOOP","description":"A function to run at the end of the boot sequence. At this point, all the game systems have started and plugins have been loaded.","name":"postBoot"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.CallbacksConfig","scope":"static","___s":true},{"meta":{"filename":"DOMContainerConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"DOMContainerConfig","type":{"names":["object"]},"since":"3.12.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the game create a div element to act as a DOM Container? Only enable if you're using DOM Element objects. You must provide a parent object if you use this feature.","name":"createContainer"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the DOM Container that is created (if `dom.createContainer` is true) be positioned behind (true) or over the top (false, the default) of the game canvas?","name":"behindCanvas"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.DOMContainerConfig","scope":"static","___s":true},{"meta":{"filename":"FPSConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"FPSConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":5,"description":"The minimum acceptable rendering rate, in frames per second.","name":"min"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":60,"description":"The optimum rendering rate, in frames per second.","name":"target"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use setTimeout instead of requestAnimationFrame to run the game loop.","name":"forceSetTimeOut"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"Calculate the average frame delta from this many consecutive frame intervals.","name":"deltaHistory"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":120,"description":"The amount of frames the time step counts before we trust the delta values again.","name":"panicMax"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Apply delta smoothing during the game update to help avoid spikes?","name":"smoothStep"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.FPSConfig","scope":"static","___s":true},{"meta":{"filename":"GameConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"GameConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["integer","string"]},"optional":true,"defaultvalue":1024,"description":"The width of the game, in game pixels.","name":"width"},{"type":{"names":["integer","string"]},"optional":true,"defaultvalue":768,"description":"The height of the game, in game pixels.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Simple scale applied to the game canvas. 2 is double size, 0.5 is half size, etc.","name":"zoom"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The size of each game pixel, in canvas pixels. Values larger than 1 are \"high\" resolution.","name":"resolution"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"CONST.AUTO","description":"Which renderer to use. Phaser.AUTO, Phaser.CANVAS, Phaser.HEADLESS, or Phaser.WEBGL. AUTO picks WEBGL if available, otherwise CANVAS.","name":"type"},{"type":{"names":["HTMLElement","string"]},"optional":true,"defaultvalue":null,"description":"The DOM element that will contain the game canvas, or its `id`. If undefined or if the named element doesn't exist, the game canvas is inserted directly into the document body. If `null` no parent will be used and you are responsible for adding the canvas to your environment.","name":"parent"},{"type":{"names":["HTMLCanvasElement"]},"optional":true,"defaultvalue":null,"description":"Provide your own Canvas element for Phaser to use instead of creating one.","name":"canvas"},{"type":{"names":["string"]},"optional":true,"defaultvalue":null,"description":"CSS styles to apply to the game canvas instead of Phasers default styles.","name":"canvasStyle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is Phaser running under a custom (non-native web) environment? If so, set this to `true` to skip internal Feature detection. If `true` the `renderType` cannot be left as `AUTO`.","name":"customEnvironment"},{"type":{"names":["CanvasRenderingContext2D"]},"optional":true,"description":"Provide your own Canvas Context for Phaser to use, instead of creating one.","name":"context"},{"type":{"names":["Phaser.Scene","Array.","Phaser.Types.Scenes.SettingsConfig","Array.","Phaser.Types.Scenes.CreateSceneFromObjectConfig","Array.","function","Array."]},"optional":true,"defaultvalue":null,"description":"A scene or scenes to add to the game. If several are given, the first is started; the remainder are started only if they have `{ active: true }`. See the `sceneConfig` argument in `Phaser.Scenes.SceneManager#add`.","name":"scene"},{"type":{"names":["Array."]},"optional":true,"description":"Seed for the random number generator.","name":"seed"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The title of the game. Shown in the browser console.","name":"title"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'http://phaser.io'","description":"The URL of the game. Shown in the browser console.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The version of the game. Shown in the browser console.","name":"version"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Automatically call window.focus() when the game boots. Usually necessary to capture input events if the game is in a separate frame.","name":"autoFocus"},{"type":{"names":["boolean","Phaser.Types.Core.InputConfig"]},"optional":true,"description":"Input configuration, or `false` to disable all game input.","name":"input"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Disable the browser's default 'contextmenu' event (usually triggered by a right-button mouse click).","name":"disableContextMenu"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the game canvas will have a transparent background.","name":"transparent"},{"type":{"names":["boolean","Phaser.Types.Core.BannerConfig"]},"optional":true,"defaultvalue":false,"description":"Configuration for the banner printed in the browser console when the game starts.","name":"banner"},{"type":{"names":["Phaser.Types.Core.DOMContainerConfig"]},"optional":true,"description":"The DOM Container configuration object.","name":"dom"},{"type":{"names":["Phaser.Types.Core.FPSConfig"]},"optional":true,"description":"Game loop configuration.","name":"fps"},{"type":{"names":["Phaser.Types.Core.RenderConfig"]},"optional":true,"description":"Game renderer configuration.","name":"render"},{"type":{"names":["string","number"]},"optional":true,"defaultvalue":"0x000000","description":"The background color of the game canvas. The default is black.","name":"backgroundColor"},{"type":{"names":["Phaser.Types.Core.CallbacksConfig"]},"optional":true,"description":"Optional callbacks to run before or after game boot.","name":"callbacks"},{"type":{"names":["Phaser.Types.Core.LoaderConfig"]},"optional":true,"description":"Loader configuration.","name":"loader"},{"type":{"names":["Phaser.Types.Core.ImagesConfig"]},"optional":true,"description":"Images configuration.","name":"images"},{"type":{"names":["Phaser.Types.Core.PhysicsConfig"]},"optional":true,"description":"Physics configuration.","name":"physics"},{"type":{"names":["Phaser.Types.Core.PluginObject","Array."]},"optional":true,"description":"Plugins to install.","name":"plugins"},{"type":{"names":["Phaser.Types.Core.ScaleConfig"]},"optional":true,"description":"The Scale Manager configuration.","name":"scale"},{"type":{"names":["Phaser.Types.Core.AudioConfig"]},"optional":true,"description":"The Audio Configuration object.","name":"audio"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.GameConfig","scope":"static","___s":true},{"meta":{"filename":"GamepadInputConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"GamepadInputConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["*"]},"optional":true,"defaultvalue":"window","description":"Where the Gamepad Manager listens for gamepad input events.","name":"target"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.GamepadInputConfig","scope":"static","___s":true},{"meta":{"filename":"ImagesConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"ImagesConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"URL to use for the 'default' texture.","name":"default"},{"type":{"names":["string"]},"optional":true,"description":"URL to use for the 'missing' texture.","name":"missing"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.ImagesConfig","scope":"static","___s":true},{"meta":{"filename":"InputConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"InputConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean","Phaser.Types.Core.KeyboardInputConfig"]},"optional":true,"defaultvalue":true,"description":"Keyboard input configuration. `true` uses the default configuration and `false` disables keyboard input.","name":"keyboard"},{"type":{"names":["boolean","Phaser.Types.Core.MouseInputConfig"]},"optional":true,"defaultvalue":true,"description":"Mouse input configuration. `true` uses the default configuration and `false` disables mouse input.","name":"mouse"},{"type":{"names":["boolean","Phaser.Types.Core.TouchInputConfig"]},"optional":true,"defaultvalue":true,"description":"Touch input configuration. `true` uses the default configuration and `false` disables touch input.","name":"touch"},{"type":{"names":["boolean","Phaser.Types.Core.GamepadInputConfig"]},"optional":true,"defaultvalue":false,"description":"Gamepad input configuration. `true` enables gamepad input.","name":"gamepad"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The maximum number of touch pointers. See {@link Phaser.Input.InputManager#pointers}.","name":"activePointers"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The smoothing factor to apply during Pointer movement. See {@link Phaser.Input.Pointer#smoothFactor}.","name":"smoothFactor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should Phaser listen for input events on the Window? If you disable this, events like 'POINTER_UP_OUTSIDE' will no longer fire.","name":"windowEvents"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.InputConfig","scope":"static","___s":true},{"meta":{"filename":"KeyboardInputConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"KeyboardInputConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["*"]},"optional":true,"defaultvalue":"window","description":"Where the Keyboard Manager listens for keyboard input events.","name":"target"},{"type":{"names":["Array."]},"optional":true,"nullable":true,"description":"`preventDefault` will be called on every non-modified key which has a key code in this array. By default it is empty.","name":"capture"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.KeyboardInputConfig","scope":"static","___s":true},{"meta":{"filename":"LoaderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"LoaderConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"A URL used to resolve paths given to the loader. Example: 'http://labs.phaser.io/assets/'.","name":"baseURL"},{"type":{"names":["string"]},"optional":true,"description":"A URL path used to resolve relative paths given to the loader. Example: 'images/sprites/'.","name":"path"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The maximum number of resources the loader will start loading at once.","name":"maxParallelDownloads"},{"type":{"names":["string","undefined"]},"optional":true,"description":"'anonymous', 'use-credentials', or `undefined`. If you're not making cross-origin requests, leave this as `undefined`. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes}.","name":"crossOrigin"},{"type":{"names":["string"]},"optional":true,"description":"The response type of the XHR request, e.g. `blob`, `text`, etc.","name":"responseType"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the XHR request use async or not?","name":"async"},{"type":{"names":["string"]},"optional":true,"description":"Optional username for all XHR requests.","name":"user"},{"type":{"names":["string"]},"optional":true,"description":"Optional password for all XHR requests.","name":"password"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optional XHR timeout value, in ms.","name":"timeout"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.LoaderConfig","scope":"static","___s":true},{"meta":{"filename":"MouseInputConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"MouseInputConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["*"]},"optional":true,"defaultvalue":null,"description":"Where the Mouse Manager listens for mouse input events. The default is the game canvas.","name":"target"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether mouse input events have `preventDefault` called on them.","name":"capture"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.MouseInputConfig","scope":"static","___s":true},{"meta":{"filename":"NOOP.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"description":"This callback type is completely empty, a no-operation.","kind":"typedef","name":"NOOP","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.NOOP","scope":"static","___s":true},{"meta":{"filename":"PhysicsConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"PhysicsConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"The default physics system. It will be started for each scene. Phaser provides 'arcade', 'impact', and 'matter'.","name":"default"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeWorldConfig"]},"optional":true,"description":"Arcade Physics configuration.","name":"arcade"},{"type":{"names":["Phaser.Types.Physics.Impact.WorldConfig"]},"optional":true,"description":"Impact Physics configuration.","name":"impact"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterWorldConfig"]},"optional":true,"description":"Matter Physics configuration.","name":"matter"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.PhysicsConfig","scope":"static","___s":true},{"meta":{"filename":"PluginObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"PluginObject","type":{"names":["object"]},"since":"3.8.0","properties":[{"type":{"names":["Array."]},"optional":true,"nullable":true,"description":"Global plugins to install.","name":"global"},{"type":{"names":["Array."]},"optional":true,"nullable":true,"description":"Scene plugins to install.","name":"scene"},{"type":{"names":["Array."]},"optional":true,"description":"The default set of scene plugins (names).","name":"default"},{"type":{"names":["Array."]},"optional":true,"description":"Plugins to *add* to the default set of scene plugins.","name":"defaultMerge"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.PluginObject","scope":"static","___s":true},{"meta":{"filename":"PluginObjectItem.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"PluginObjectItem","type":{"names":["object"]},"since":"3.8.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"A key to identify the plugin in the Plugin Manager.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The plugin itself. Usually a class/constructor.","name":"plugin"},{"type":{"names":["boolean"]},"optional":true,"description":"Whether the plugin should be started automatically.","name":"start"},{"type":{"names":["string"]},"optional":true,"description":"For a scene plugin, add the plugin to the scene's systems object under this key (`this.sys.KEY`, from the scene).","name":"systemKey"},{"type":{"names":["string"]},"optional":true,"description":"For a scene plugin, add the plugin to the scene object under this key (`this.KEY`, from the scene).","name":"sceneKey"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Scene Systems, this is the property key map used.","name":"mapping"},{"type":{"names":["*"]},"optional":true,"description":"Arbitrary data passed to the plugin's init() method.","name":"data"}],"examples":["// Global plugin\n{ key: 'BankPlugin', plugin: BankPluginV3, start: true, data: { gold: 5000 } }","// Scene plugin\n{ key: 'WireFramePlugin', plugin: WireFramePlugin, systemKey: 'wireFramePlugin', sceneKey: 'wireframe' }"],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.PluginObjectItem","scope":"static","___s":true},{"meta":{"filename":"RenderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"RenderConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"When set to `true`, WebGL uses linear interpolation to draw scaled or rotated textures, giving a smooth appearance. When set to `false`, WebGL uses nearest-neighbor interpolation, giving a crisper appearance. `false` also disables antialiasing of the game canvas itself, if the browser supports it, when the game canvas is scaled.","name":"antialias"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets the `antialias` property when the WebGL context is created. Setting this value does not impact any subsequent textures that are created, or the canvas style attributes.","name":"antialiasGL"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When set to `true` it will create a desynchronized context for both 2D and WebGL. See https://developers.google.com/web/updates/2019/05/desynchronized for details.","name":"desynchronized"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets `antialias` and `roundPixels` to true. This is the best setting for pixel-art games.","name":"pixelArt"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Draw texture-based Game Objects at only whole-integer positions. Game Objects without textures, like Graphics, ignore this property.","name":"roundPixels"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the game canvas will be transparent. Boolean that indicates if the canvas contains an alpha channel. If set to false, the browser now knows that the backdrop is always opaque, which can speed up drawing of transparent content and images.","name":"transparent"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether the game canvas will be cleared between each rendering frame.","name":"clearBeforeRender"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"In WebGL mode, the drawing buffer contains colors with pre-multiplied alpha.","name":"premultipliedAlpha"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Let the browser abort creating a WebGL context if it judges performance would be unacceptable.","name":"failIfMajorPerformanceCaveat"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'default'","description":"\"high-performance\", \"low-power\" or \"default\". A hint to the browser on how much device power the game might use.","name":"powerPreference"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":2000,"description":"The default WebGL batch size.","name":"batchSize"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The maximum number of lights allowed to be visible within range of a single Camera in the LightManager.","name":"maxLights"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'LINEAR'","description":"The mipmap magFilter to be used when creating WebGL textures.","name":"mipmapFilter"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.RenderConfig","scope":"static","___s":true},{"meta":{"filename":"ScaleConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"ScaleConfig","type":{"names":["object"]},"since":"3.16.0","properties":[{"type":{"names":["integer","string"]},"optional":true,"defaultvalue":1024,"description":"The base width of your game. Can be an integer or a string: '100%'. If a string it will only work if you have set a parent element that has a size.","name":"width"},{"type":{"names":["integer","string"]},"optional":true,"defaultvalue":768,"description":"The base height of your game. Can be an integer or a string: '100%'. If a string it will only work if you have set a parent element that has a size.","name":"height"},{"type":{"names":["Phaser.Scale.ZoomType","integer"]},"optional":true,"defaultvalue":1,"description":"The zoom value of the game canvas.","name":"zoom"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The rendering resolution of the canvas. This is reserved for future use and is currently ignored.","name":"resolution"},{"type":{"names":["HTMLElement","string"]},"optional":true,"nullable":true,"description":"The DOM element that will contain the game canvas, or its `id`. If undefined, or if the named element doesn't exist, the game canvas is inserted directly into the document body. If `null` no parent will be used and you are responsible for adding the canvas to your environment.","name":"parent"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Is the Scale Manager allowed to adjust the CSS height property of the parent and/or document body to be 100%?","name":"expandParent"},{"type":{"names":["Phaser.Scale.ScaleModeType"]},"optional":true,"defaultvalue":"Phaser.Scale.ScaleModes.NONE","description":"The scale mode.","name":"mode"},{"type":{"names":["WidthHeight"]},"optional":true,"description":"The minimum width and height the canvas can be scaled down to.","name":"min"},{"type":{"names":["WidthHeight"]},"optional":true,"description":"The maximum width the canvas can be scaled up to.","name":"max"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Automatically round the display and style sizes of the canvas. This can help with performance in lower-powered devices.","name":"autoRound"},{"type":{"names":["Phaser.Scale.CenterType"]},"optional":true,"defaultvalue":"Phaser.Scale.Center.NO_CENTER","description":"Automatically center the canvas within the parent?","name":"autoCenter"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":500,"description":"How many ms should elapse before checking if the browser size has changed?","name":"resizeInterval"},{"type":{"names":["HTMLElement","string"]},"optional":true,"nullable":true,"description":"The DOM element that will be sent into full screen mode, or its `id`. If undefined Phaser will create its own div and insert the canvas into it when entering fullscreen mode.","name":"fullscreenTarget"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.ScaleConfig","scope":"static","___s":true},{"meta":{"filename":"TimeStepCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"TimeStepCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The Delta Average.","name":"average"},{"type":{"names":["number"]},"description":"Interpolation - how far between what is expected and where we are?","name":"interpolation"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.TimeStepCallback","scope":"static","___s":true},{"meta":{"filename":"TouchInputConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"TouchInputConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["*"]},"optional":true,"defaultvalue":null,"description":"Where the Touch Manager listens for touch input events. The default is the game canvas.","name":"target"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether touch input events have preventDefault() called on them.","name":"capture"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.TouchInputConfig","scope":"static","___s":true},{"meta":{"filename":"WidthHeight.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"WidthHeight","type":{"names":["object"]},"since":"3.16.0","properties":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The width.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The height.","name":"height"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.WidthHeight","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"namespace","name":"Core","memberof":"Phaser.Types","longname":"Phaser.Types.Core","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"GenerateTexture.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/create"},"name":"Arne16","longname":"Arne16","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GenerateTexture.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create"},"description":"[description]","kind":"function","name":"GenerateTexture","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Create.GenerateTextureConfig"]},"description":"[description]","name":"config"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"[description]"}],"memberof":"Phaser.Create","longname":"Phaser.Create.GenerateTexture","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create"},"kind":"namespace","name":"Create","memberof":"Phaser","longname":"Phaser.Create","scope":"static","___s":true},{"meta":{"filename":"Arne16.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/palettes"},"description":"A 16 color palette by [Arne](http://androidarts.com/palette/16pal.htm)","name":"ARNE16","since":"3.0.0","type":{"names":["Phaser.Types.Create.Palette"]},"memberof":"Phaser.Create.Palettes","longname":"Phaser.Create.Palettes.ARNE16","scope":"static","kind":"member","___s":true},{"meta":{"filename":"C64.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/palettes"},"description":"A 16 color palette inspired by the Commodore 64.","name":"C64","since":"3.0.0","type":{"names":["Phaser.Types.Create.Palette"]},"memberof":"Phaser.Create.Palettes","longname":"Phaser.Create.Palettes.C64","scope":"static","kind":"member","___s":true},{"meta":{"filename":"CGA.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/palettes"},"description":"A 16 color CGA inspired palette by [Arne](http://androidarts.com/palette/16pal.htm)","name":"CGA","since":"3.0.0","type":{"names":["Phaser.Types.Create.Palette"]},"memberof":"Phaser.Create.Palettes","longname":"Phaser.Create.Palettes.CGA","scope":"static","kind":"member","___s":true},{"meta":{"filename":"JMP.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/palettes"},"description":"A 16 color JMP palette by [Arne](http://androidarts.com/palette/16pal.htm)","name":"JMP","since":"3.0.0","type":{"names":["Phaser.Types.Create.Palette"]},"memberof":"Phaser.Create.Palettes","longname":"Phaser.Create.Palettes.JMP","scope":"static","kind":"member","___s":true},{"meta":{"filename":"MSX.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/palettes"},"description":"A 16 color palette inspired by Japanese computers like the MSX.","name":"MSX","since":"3.0.0","type":{"names":["Phaser.Types.Create.Palette"]},"memberof":"Phaser.Create.Palettes","longname":"Phaser.Create.Palettes.MSX","scope":"static","kind":"member","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/palettes"},"kind":"namespace","name":"Palettes","memberof":"Phaser.Create","longname":"Phaser.Create.Palettes","scope":"static","___s":true},{"meta":{"filename":"GenerateTextureConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/typedefs"},"kind":"typedef","name":"GenerateTextureCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"[description]","name":"canvas"},{"type":{"names":["CanvasRenderingContext2D"]},"description":"[description]","name":"context"}],"memberof":"Phaser.Types.Create","longname":"Phaser.Types.Create.GenerateTextureCallback","scope":"static","___s":true},{"meta":{"filename":"GenerateTextureConfig.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/typedefs"},"kind":"typedef","name":"GenerateTextureConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["array"]},"optional":true,"defaultvalue":"[]","description":"[description]","name":"data"},{"type":{"names":["HTMLCanvasElement"]},"optional":true,"defaultvalue":null,"description":"[description]","name":"canvas"},{"type":{"names":["Phaser.Types.Create.Palette"]},"optional":true,"defaultvalue":"Arne16","description":"[description]","name":"palette"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The width of each 'pixel' in the generated texture.","name":"pixelWidth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The height of each 'pixel' in the generated texture.","name":"pixelHeight"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"[description]","name":"resizeCanvas"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"[description]","name":"clearCanvas"},{"type":{"names":["Phaser.Types.Create.GenerateTextureCallback"]},"optional":true,"description":"[description]","name":"preRender"},{"type":{"names":["Phaser.Types.Create.GenerateTextureCallback"]},"optional":true,"description":"[description]","name":"postRender"}],"memberof":"Phaser.Types.Create","longname":"Phaser.Types.Create.GenerateTextureConfig","scope":"static","___s":true},{"meta":{"filename":"Palette.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/typedefs"},"kind":"typedef","name":"Palette","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"Color value 1.","name":"0"},{"type":{"names":["string"]},"description":"Color value 2.","name":"1"},{"type":{"names":["string"]},"description":"Color value 3.","name":"2"},{"type":{"names":["string"]},"description":"Color value 4.","name":"3"},{"type":{"names":["string"]},"description":"Color value 5.","name":"4"},{"type":{"names":["string"]},"description":"Color value 6.","name":"5"},{"type":{"names":["string"]},"description":"Color value 7.","name":"6"},{"type":{"names":["string"]},"description":"Color value 8.","name":"7"},{"type":{"names":["string"]},"description":"Color value 9.","name":"8"},{"type":{"names":["string"]},"description":"Color value 10.","name":"9"},{"type":{"names":["string"]},"description":"Color value 11.","name":"A"},{"type":{"names":["string"]},"description":"Color value 12.","name":"B"},{"type":{"names":["string"]},"description":"Color value 13.","name":"C"},{"type":{"names":["string"]},"description":"Color value 14.","name":"D"},{"type":{"names":["string"]},"description":"Color value 15.","name":"E"},{"type":{"names":["string"]},"description":"Color value 16.","name":"F"}],"memberof":"Phaser.Types.Create","longname":"Phaser.Types.Create.Palette","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/typedefs"},"kind":"namespace","name":"Create","memberof":"Phaser.Types","longname":"Phaser.Types.Create","scope":"static","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"classdesc":"A higher-order Bézier curve constructed of four points.","kind":"class","name":"CubicBezier","augments":["Phaser.Curves.Curve"],"memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Array."]},"description":"Start point, or an array of point pairs.","name":"p0"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"Control Point 1.","name":"p1"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"Control Point 2.","name":"p2"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"End Point.","name":"p3"}],"scope":"static","longname":"Phaser.Curves.CubicBezier","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The start point of this curve.","name":"p0","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#p0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The first control point of this curve.","name":"p1","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#p1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The second control point of this curve.","name":"p2","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#p2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The end point of this curve.","name":"p3","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#p3","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the starting point on the curve.","kind":"function","name":"getStartPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getStartPoint","scope":"instance","overrides":"Phaser.Curves.Curve#getStartPoint","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns the resolution of this curve.","kind":"function","name":"getResolution","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of divisions used by this curve.","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"The resolution of the curve."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getResolution","scope":"instance","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":118,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get point at relative position in curve according to length.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getPoint","scope":"instance","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":143,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Draws this curve to the specified graphics object.","kind":"function","name":"draw","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The graphics object this curve should be drawn to.","name":"graphics"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The number of intermediary points that make up this curve. A higher number of points will result in a smoother curve.","name":"pointsTotal"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The graphics object this curve was drawn to. Useful for method chaining."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#draw","scope":"instance","overrides":"Phaser.Curves.Curve#draw","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":176,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a JSON object that describes this curve.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#toJSON","scope":"instance","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":199,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Generates a curve from a JSON object.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Curves.CubicBezier"]},"description":"The curve generated from the JSON object."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier.fromJSON","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Curve.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Curve.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"classdesc":"A Base Curve class, which all other curve types extend.\n\nBased on the three.js Curve classes created by [zz85](http://www.lab4games.net/zz85/blog)","kind":"class","name":"Curve","memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The curve type.","name":"type"}],"scope":"static","longname":"Phaser.Curves.Curve","___s":true},{"meta":{"filename":"Curve.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"String based identifier for the type of curve.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The default number of divisions within the curve.","name":"defaultDivisions","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#defaultDivisions","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The quantity of arc length divisions within the curve.","name":"arcLengthDivisions","type":{"names":["integer"]},"defaultvalue":"100","since":"3.0.0","memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#arcLengthDivisions","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"An array of cached arc length values.","name":"cacheArcLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#cacheArcLengths","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Does the data of this curve need updating?","name":"needsUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#needsUpdate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"For a curve on a Path, `false` means the Path will ignore this curve.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":111,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Draws this curve on the given Graphics object.\n\nThe curve is drawn using `Graphics.strokePoints` so will be drawn at whatever the present Graphics stroke color is.\nThe Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.","kind":"function","name":"draw","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics instance onto which this curve will be drawn.","name":"graphics"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The resolution of the curve. The higher the value the smoother it will render, at the cost of rendering performance.","name":"pointsTotal"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to which the curve was drawn."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#draw","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a Rectangle where the position and dimensions match the bounds of this Curve.\n\nYou can control the accuracy of the bounds. The value given is used to work out how many points\nto plot across the curve. Higher values are more accurate at the cost of calculation speed.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the bounds in. If falsey a new object will be created.","name":"out"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":16,"description":"The accuracy of the bounds calculations.","name":"accuracy"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A Rectangle object holding the bounds of this curve. If `out` was given it will be this object."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getBounds","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns an array of points, spaced out X distance pixels apart.\nThe smaller the distance, the larger the array will be.","kind":"function","name":"getDistancePoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The distance, in pixels, between each point along the curve.","name":"distance"}],"returns":[{"type":{"names":["Array."]},"description":"An Array of Point objects."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getDistancePoints","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the end of the curve.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"Optional Vector object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector2 containing the coordinates of the curves end point."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getEndPoint","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get total curve arc length","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the curve."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getLength","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a list of cumulative segment lengths.\n\nThese lengths are\n\n- [0] 0\n- [1] The first segment\n- [2] The first and second segment\n- ...\n- [divisions] All segments","kind":"function","name":"getLengths","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions or segments.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cumulative lengths."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getLengths","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at a relative position on the curve, by arc length.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getPointAt","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of evenly spaced points from the curve.\n\nYou can pass `divisions`, `stepRate`, or neither.\n\nThe number of divisions will be\n\n1. `divisions`, if `divisions` > 0; or\n2. `this.getLength / stepRate`, if `stepRate` > 0; or\n3. `this.defaultDivisions`\n\n`1 + divisions` points will be returned.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"The curve distance between points, implying `divisions`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the curve."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a random point from the curve.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of equally spaced points (by arc distance) from the curve.\n\n`1 + divisions` points will be returned.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.defaultDivisions","description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array of points."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getSpacedPoints","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the start of the curve.","kind":"function","name":"getStartPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getStartPoint","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve.\nIn case any sub curve does not implement its tangent derivation,\n2 points a small delta apart will be used to find its gradient\nwhich seems to give a reasonable approximation","kind":"function","name":"getTangent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector approximating the tangent line at the point t (delta +/- 0.0001)"}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getTangent","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve, by arc length.","kind":"function","name":"getTangentAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getTangentAt","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getTFromDistance","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getTFromDistance","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getUtoTmapping","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"u"},{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getUtoTmapping","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Calculate and cache the arc lengths.","kind":"function","name":"updateArcLengths","since":"3.0.0","see":["Phaser.Curves.Curve#getLengths()"],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#updateArcLengths","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"classdesc":"An Elliptical Curve derived from the Base Curve class.\n\nSee https://en.wikipedia.org/wiki/Elliptic_curve for more details.","kind":"class","name":"Ellipse","augments":["Phaser.Curves.Curve"],"memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Types.Curves.EllipseCurveConfig"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the ellipse, or an Ellipse Curve configuration object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the ellipse.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal radius of ellipse.","name":"xRadius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical radius of ellipse.","name":"yRadius"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The start angle of the ellipse, in degrees.","name":"startAngle"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":360,"description":"The end angle of the ellipse, in degrees.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the ellipse angles are given as clockwise (`true`) or counter-clockwise (`false`).","name":"clockwise"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The rotation of the ellipse, in degrees.","name":"rotation"}],"scope":"static","longname":"Phaser.Curves.Ellipse","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The center point of the ellipse. Used for calculating rotation.","name":"p0","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#p0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":143,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the starting point on the curve.","kind":"function","name":"getStartPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getStartPoint","scope":"instance","overrides":"Phaser.Curves.Curve#getStartPoint","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":162,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getResolution","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getResolution","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":177,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get point at relative position in curve according to length.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getPoint","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":253,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the horizontal radius of this curve.","kind":"function","name":"setXRadius","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal radius of this curve.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setXRadius","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the vertical radius of this curve.","kind":"function","name":"setYRadius","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical radius of this curve.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setYRadius","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the width of this curve.","kind":"function","name":"setWidth","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this curve.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setWidth","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":304,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the height of this curve.","kind":"function","name":"setHeight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The height of this curve.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setHeight","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the start angle of this curve.","kind":"function","name":"setStartAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The start angle of this curve, in radians.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setStartAngle","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":338,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the end angle of this curve.","kind":"function","name":"setEndAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The end angle of this curve, in radians.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setEndAngle","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets if this curve extends clockwise or anti-clockwise.","kind":"function","name":"setClockwise","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The clockwise state of this curve.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setClockwise","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the rotation of this curve.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The rotation of this curve, in radians.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setRotation","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":389,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The x coordinate of the center of the ellipse.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The y coordinate of the center of the ellipse.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The horizontal radius of the ellipse.","name":"xRadius","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#xRadius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":452,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The vertical radius of the ellipse.","name":"yRadius","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#yRadius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":473,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The start angle of the ellipse in degrees.","name":"startAngle","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#startAngle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The end angle of the ellipse in degrees.","name":"endAngle","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#endAngle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":515,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"`true` if the ellipse rotation is clockwise or `false` if anti-clockwise.","name":"clockwise","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#clockwise","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":536,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The rotation of the ellipse, relative to the center, in degrees.","name":"angle","type":{"names":["number"]},"since":"3.14.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":557,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The rotation of the ellipse, relative to the center, in radians.","name":"rotation","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":578,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"JSON serialization of the curve.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONEllipseCurve"]},"description":"The JSON object containing this curve data."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#toJSON","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":603,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Creates a curve from the provided Ellipse Curve Configuration object.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Curves.JSONEllipseCurve"]},"description":"The JSON object containing this curve data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"The ellipse curve constructed from the configuration object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse.fromJSON","scope":"static","___s":true},{"meta":{"filename":"LineCurve.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"classdesc":"A LineCurve is a \"curve\" comprising exactly two points (a line segment).","kind":"class","name":"Line","augments":["Phaser.Curves.Curve"],"memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Array."]},"description":"The first endpoint.","name":"p0"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"The second endpoint.","name":"p1"}],"scope":"static","longname":"Phaser.Curves.Line","___s":true},{"meta":{"filename":"LineCurve.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The first endpoint.","name":"p0","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#p0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LineCurve.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The second endpoint.","name":"p1","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#p1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LineCurve.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The quantity of arc length divisions within the curve.","name":"arcLengthDivisions","type":{"names":["integer"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#arcLengthDivisions","scope":"instance","kind":"member","overrides":"Phaser.Curves.Curve#arcLengthDivisions","___s":true},{"meta":{"filename":"LineCurve.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a Rectangle where the position and dimensions match the bounds of this Curve.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"A Rectangle object to store the bounds in. If not given a new Rectangle will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A Rectangle object holding the bounds of this curve. If `out` was given it will be this object."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getBounds","scope":"instance","overrides":"Phaser.Curves.Curve#getBounds","___s":true},{"meta":{"filename":"LineCurve.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the starting point on the curve.","kind":"function","name":"getStartPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getStartPoint","scope":"instance","overrides":"Phaser.Curves.Curve#getStartPoint","___s":true},{"meta":{"filename":"LineCurve.js","lineno":116,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the resolution of the line.","kind":"function","name":"getResolution","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The number of divisions to consider.","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"The resolution. Equal to the number of divisions."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getResolution","scope":"instance","___s":true},{"meta":{"filename":"LineCurve.js","lineno":133,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get point at relative position in curve according to length.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getPoint","scope":"instance","___s":true},{"meta":{"filename":"LineCurve.js","lineno":162,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets a point at a given position on the line.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getPointAt","scope":"instance","overrides":"Phaser.Curves.Curve#getPointAt","___s":true},{"meta":{"filename":"LineCurve.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the slope of the line as a unit vector.","kind":"function","name":"getTangent","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getTangent","scope":"instance","overrides":"Phaser.Curves.Curve#getTangent","___s":true},{"meta":{"filename":"LineCurve.js","lineno":199,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getUtoTmapping","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"u"},{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getUtoTmapping","scope":"instance","overrides":"Phaser.Curves.Curve#getUtoTmapping","___s":true},{"meta":{"filename":"LineCurve.js","lineno":235,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Draws this curve on the given Graphics object.\n\nThe curve is drawn using `Graphics.lineBetween` so will be drawn at whatever the present Graphics line color is.\nThe Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.","kind":"function","name":"draw","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics instance onto which this curve will be drawn.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to which the curve was drawn."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#draw","scope":"instance","overrides":"Phaser.Curves.Curve#draw","___s":true},{"meta":{"filename":"LineCurve.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets a JSON representation of the line.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#toJSON","scope":"instance","___s":true},{"meta":{"filename":"LineCurve.js","lineno":279,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Configures this line from a JSON representation.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Curves.Line"]},"description":"A new LineCurve object."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line.fromJSON","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"QuadraticBezierCurve.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"classdesc":"[description]","kind":"class","name":"QuadraticBezier","augments":["Phaser.Curves.Curve"],"memberof":"Phaser.Curves","since":"3.2.0","params":[{"type":{"names":["Phaser.Math.Vector2","Array."]},"description":"Start point, or an array of point pairs.","name":"p0"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"Control Point 1.","name":"p1"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"Control Point 2.","name":"p2"}],"scope":"static","longname":"Phaser.Curves.QuadraticBezier","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","name":"p0","type":{"names":["Phaser.Math.Vector2"]},"since":"3.2.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#p0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","name":"p1","type":{"names":["Phaser.Math.Vector2"]},"since":"3.2.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#p1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","name":"p2","type":{"names":["Phaser.Math.Vector2"]},"since":"3.2.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#p2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the starting point on the curve.","kind":"function","name":"getStartPoint","since":"3.2.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getStartPoint","scope":"instance","overrides":"Phaser.Curves.Curve#getStartPoint","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getResolution","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getResolution","scope":"instance","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get point at relative position in curve according to length.","kind":"function","name":"getPoint","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getPoint","scope":"instance","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"draw","since":"3.2.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`Graphics` object to draw onto.","name":"graphics"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"Number of points to be used for drawing the curve. Higher numbers result in smoother curve but require more processing.","name":"pointsTotal"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`Graphics` object that was drawn to."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#draw","scope":"instance","overrides":"Phaser.Curves.Curve#draw","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":165,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Converts the curve into a JSON compatible object.","kind":"function","name":"toJSON","since":"3.2.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#toJSON","scope":"instance","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":187,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Creates a curve from a JSON object, e. g. created by `toJSON`.","kind":"function","name":"fromJSON","since":"3.2.0","params":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Curves.QuadraticBezier"]},"description":"The created curve instance."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier.fromJSON","scope":"static","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"classdesc":"Create a smooth 2d spline curve from a series of points.","kind":"class","name":"Spline","augments":["Phaser.Curves.Curve"],"memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["Array.","Array.","Array.>"]},"optional":true,"description":"The points that configure the curve.","name":"points"}],"scope":"static","longname":"Phaser.Curves.Spline","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The Vector2 points that configure the curve.","name":"points","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#points","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":51,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Add a list of points to the current list of Vector2 points of the curve.","kind":"function","name":"addPoints","since":"3.0.0","params":[{"type":{"names":["Array.","Array.","Array.>"]},"description":"The points that configure the curve.","name":"points"}],"returns":[{"type":{"names":["Phaser.Curves.Spline"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#addPoints","scope":"instance","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Add a point to the current list of Vector2 points of the curve.","kind":"function","name":"addPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of this curve","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of this curve","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The new Vector2 added to the curve"}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#addPoint","scope":"instance","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":111,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the starting point on the curve.","kind":"function","name":"getStartPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getStartPoint","scope":"instance","overrides":"Phaser.Curves.Curve#getStartPoint","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":130,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getResolution","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getResolution","scope":"instance","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get point at relative position in curve according to length.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getPoint","scope":"instance","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Exports a JSON object containing this curve data.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#toJSON","scope":"instance","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":204,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Imports a JSON object containing this curve data.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Curves.Spline"]},"description":"The spline curve created."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline.fromJSON","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"kind":"namespace","name":"Curves","memberof":"Phaser","longname":"Phaser.Curves","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"MoveTo.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MoveTo.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"classdesc":"A MoveTo Curve is a very simple curve consisting of only a single point. Its intended use is to move the ending point in a Path.","kind":"class","name":"MoveTo","memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"`x` pixel coordinate.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"`y` pixel coordinate.","name":"y"}],"scope":"static","longname":"Phaser.Curves.MoveTo","___s":true},{"meta":{"filename":"MoveTo.js","lineno":30,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Denotes that this Curve does not influence the bounds, points, and drawing of its parent Path. Must be `false` or some methods in the parent Path will throw errors.","name":"active","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MoveTo.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"The lone point which this curve consists of.","name":"p0","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#p0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MoveTo.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Get point at relative position in curve according to length.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#getPoint","scope":"instance","___s":true},{"meta":{"filename":"MoveTo.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Retrieves the point at given position in the curve. This will always return this curve's only point.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position in the path to retrieve, between 0 and 1. Not used.","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"An optional vector in which to store the point.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The modified `out` vector, or a new `Vector2` if none was provided."}],"memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#getPointAt","scope":"instance","___s":true},{"meta":{"filename":"MoveTo.js","lineno":88,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Gets the resolution of this curve.","kind":"function","name":"getResolution","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The resolution of this curve. For a MoveTo the value is always 1."}],"memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#getResolution","scope":"instance","___s":true},{"meta":{"filename":"MoveTo.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Gets the length of this curve.","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this curve. For a MoveTo the value is always 0."}],"memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#getLength","scope":"instance","___s":true},{"meta":{"filename":"MoveTo.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Converts this curve into a JSON-serializable object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"A primitive object with the curve's type and only point."}],"memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#toJSON","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":21,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"classdesc":"A Path combines multiple Curves into one continuous compound curve.\nIt does not matter how many Curves are in the Path or what type they are.\n\nA Curve in a Path does not have to start where the previous Curve ends - that is to say, a Path does not\nhave to be an uninterrupted curve. Only the order of the Curves influences the actual points on the Path.","kind":"class","name":"Path","memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The X coordinate of the Path's starting point or a {@link Phaser.Types.Curves.JSONPath}.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The Y coordinate of the Path's starting point.","name":"y"}],"scope":"static","longname":"Phaser.Curves.Path","___s":true},{"meta":{"filename":"Path.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"The name of this Path.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Path.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"The list of Curves which make up this Path.","name":"curves","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#curves","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Path.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"The cached length of each Curve in the Path.\n\nUsed internally by {@link #getCurveLengths}.","name":"cacheLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#cacheLengths","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Path.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Automatically closes the path.","name":"autoClose","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#autoClose","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Path.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"The starting point of the Path.\n\nThis is not necessarily equivalent to the starting point of the first Curve in the Path. In an empty Path, it's also treated as the ending point.","name":"startPoint","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#startPoint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Path.js","lineno":130,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Appends a Curve to the end of the Path.\n\nThe Curve does not have to start where the Path ends or, for an empty Path, at its defined starting point.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Curves.Curve"]},"description":"The Curve to append.","name":"curve"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#add","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a circular Ellipse Curve positioned at the end of the Path.","kind":"function","name":"circleTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"`true` to create a clockwise circle as opposed to a counter-clockwise circle.","name":"clockwise"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of the circle in degrees.","name":"rotation"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#circleTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":168,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Ensures that the Path is closed.\n\nA closed Path starts and ends at the same point. If the Path is not closed, a straight Line Curve will be created from the ending point directly to the starting point. During the check, the actual starting point of the Path, i.e. the starting point of the first Curve, will be used as opposed to the Path's defined {@link startPoint}, which could differ.\n\nCalling this method on an empty Path will result in an error.","kind":"function","name":"closePath","since":"3.0.0","returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#closePath","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a cubic bezier curve starting at the previous end point and ending at p3, using p1 and p2 as control points.","kind":"function","name":"cubicBezierTo","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Math.Vector2"]},"description":"The x coordinate of the end point. Or, if a Vector2, the p1 value.","name":"x"},{"type":{"names":["number","Phaser.Math.Vector2"]},"description":"The y coordinate of the end point. Or, if a Vector2, the p2 value.","name":"y"},{"type":{"names":["number","Phaser.Math.Vector2"]},"description":"The x coordinate of the first control point. Or, if a Vector2, the p3 value.","name":"control1X"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate of the first control point. Not used if Vector2s are provided as the first 3 arguments.","name":"control1Y"},{"type":{"names":["number"]},"optional":true,"description":"The x coordinate of the second control point. Not used if Vector2s are provided as the first 3 arguments.","name":"control2X"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate of the second control point. Not used if Vector2s are provided as the first 3 arguments.","name":"control2Y"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#cubicBezierTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":236,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a Quadratic Bezier Curve starting at the ending point of the Path.","kind":"function","name":"quadraticBezierTo","since":"3.2.0","params":[{"type":{"names":["number","Array."]},"description":"The X coordinate of the second control point or, if it's a `Vector2`, the first control point.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The Y coordinate of the second control point or, if `x` is a `Vector2`, the second control point.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"If `x` is not a `Vector2`, the X coordinate of the first control point.","name":"controlX"},{"type":{"names":["number"]},"optional":true,"description":"If `x` is not a `Vector2`, the Y coordinate of the first control point.","name":"controlY"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#quadraticBezierTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Draws all Curves in the Path to a Graphics Game Object.","kind":"function","name":"draw","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics Game Object to draw to.","name":"graphics"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The number of points to draw for each Curve. Higher numbers result in a smoother curve but require more processing.","name":"pointsTotal"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object which was drawn to."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#draw","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates an ellipse curve positioned at the previous end point, using the given parameters.","kind":"function","name":"ellipseTo","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal radius of ellipse.","name":"xRadius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical radius of ellipse.","name":"yRadius"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The start angle of the ellipse, in degrees.","name":"startAngle"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":360,"description":"The end angle of the ellipse, in degrees.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the ellipse angles are given as clockwise (`true`) or counter-clockwise (`false`).","name":"clockwise"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of the ellipse, in degrees.","name":"rotation"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#ellipseTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a Path from a Path Configuration object.\n\nThe provided object should be a {@link Phaser.Types.Curves.JSONPath}, as returned by {@link #toJSON}. Providing a malformed object may cause errors.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Curves.JSONPath"]},"description":"The JSON object containing the Path data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#fromJSON","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":386,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Returns a Rectangle with a position and size matching the bounds of this Path.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the bounds in.","name":"out"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":16,"description":"The accuracy of the bounds calculations. Higher values are more accurate at the cost of calculation speed.","name":"accuracy"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified `out` Rectangle, or a new Rectangle if none was provided."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getBounds","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":435,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Returns an array containing the length of the Path at the end of each Curve.\n\nThe result of this method will be cached to avoid recalculating it in subsequent calls. The cache is only invalidated when the {@link #curves} array changes in length, leading to potential inaccuracies if a Curve in the Path is changed, or if a Curve is removed and another is added in its place.","kind":"function","name":"getCurveLengths","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"An array containing the length of the Path at the end of each one of its Curves."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getCurveLengths","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Returns the ending point of the Path.\n\nA Path's ending point is equivalent to the ending point of the last Curve in the Path. For an empty Path, the ending point is at the Path's defined {@link #startPoint}.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"The object to store the point in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The modified `out` object, or a new Vector2 if none was provided."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getEndPoint","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":502,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Returns the total length of the Path.","see":["{@link #getCurveLengths}"],"kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the Path."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getLength","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":528,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Calculates the coordinates of the point at the given normalized location (between 0 and 1) on the Path.\n\nThe location is relative to the entire Path, not to an individual Curve. A location of 0.5 is always in the middle of the Path and is thus an equal distance away from both its starting and ending points. In a Path with one Curve, it would be in the middle of the Curve; in a Path with two Curves, it could be anywhere on either one of them depending on their lengths.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The location of the point to return, between 0 and 1.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"The object in which to store the calculated point.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"nullable":true,"description":"The modified `out` object, or a new `Vector2` if none was provided."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getPoint","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":571,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Get a sequence of points on the path.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":12,"description":"The number of divisions per resolution per curve.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Vector2 objects that containing the points along the Path."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Returns a randomly chosen point anywhere on the path. This follows the same rules as `getPoint` in that it may return a point on any Curve inside this path.\n\nWhen calling this method multiple times, the points are not guaranteed to be equally spaced spatially.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"`Vector2` instance that should be used for storing the result. If `undefined` a new `Vector2` will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The modified `out` object, or a new `Vector2` if none was provided."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":646,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Divides this Path into a set of equally spaced points,\n\nThe resulting points are equally spaced with respect to the points' position on the path, but not necessarily equally spaced spatially.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":40,"description":"The amount of points to divide this Path into.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"A list of the points this path was subdivided into."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getSpacedPoints","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":677,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Returns the starting point of the Path.","kind":"function","name":"getStartPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"`Vector2` instance that should be used for storing the result. If `undefined` a new `Vector2` will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The modified `out` object, or a new Vector2 if none was provided."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getStartPoint","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":696,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a line curve from the previous end point to x/y.","kind":"function","name":"lineTo","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Math.Vector2"]},"description":"The X coordinate of the line's end point, or a `Vector2` containing the entire end point.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The Y coordinate of the line's end point, if a number was passed as the X parameter.","name":"y"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#lineTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a spline curve starting at the previous end point, using the given points on the curve.","kind":"function","name":"splineTo","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The points the newly created spline curve should consist of.","name":"points"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#splineTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":740,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a \"gap\" in this path from the path's current end point to the given coordinates.\n\nAfter calling this function, this Path's end point will be equal to the given coordinates","kind":"function","name":"moveTo","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Math.Vector2"]},"description":"The X coordinate of the position to move the path's end point to, or a `Vector2` containing the entire new end point.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the position to move the path's end point to, if a number was passed as the X coordinate.","name":"y"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#moveTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":765,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Converts this Path to a JSON object containing the path information and its constituent curves.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONPath"]},"description":"The JSON object containing this path's data."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#toJSON","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":791,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"cacheLengths must be recalculated.","kind":"function","name":"updateArcLengths","since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#updateArcLengths","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":804,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Disposes of this Path, clearing its internal references to objects so they can be garbage-collected.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#destroy","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":819,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a new Path Object.","kind":"function","name":"path","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Path.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Path.","name":"y"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"The Path Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#path","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurveConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/typedefs"},"kind":"typedef","name":"EllipseCurveConfig","type":{"names":["object"]},"properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the ellipse.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the ellipse.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal radius of the ellipse.","name":"xRadius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical radius of the ellipse.","name":"yRadius"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The start angle of the ellipse, in degrees.","name":"startAngle"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":360,"description":"The end angle of the ellipse, in degrees.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets if the the ellipse rotation is clockwise (true) or anti-clockwise (false)","name":"clockwise"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The rotation of the ellipse, in degrees.","name":"rotation"}],"memberof":"Phaser.Types.Curves","longname":"Phaser.Types.Curves.EllipseCurveConfig","scope":"static","___s":true},{"meta":{"filename":"JSONCurve.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/typedefs"},"kind":"typedef","name":"JSONCurve","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The of the curve","name":"type"},{"type":{"names":["Array."]},"description":"The arrays of points like `[x1, y1, x2, y2]`","name":"points"}],"memberof":"Phaser.Types.Curves","longname":"Phaser.Types.Curves.JSONCurve","scope":"static","___s":true},{"meta":{"filename":"JSONEllipseCurve.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/typedefs"},"kind":"typedef","name":"JSONEllipseCurve","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The of the curve.","name":"type"},{"type":{"names":["number"]},"description":"The x coordinate of the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the ellipse.","name":"y"},{"type":{"names":["number"]},"description":"The horizontal radius of ellipse.","name":"xRadius"},{"type":{"names":["number"]},"description":"The vertical radius of ellipse.","name":"yRadius"},{"type":{"names":["integer"]},"description":"The start angle of the ellipse, in degrees.","name":"startAngle"},{"type":{"names":["integer"]},"description":"The end angle of the ellipse, in degrees.","name":"endAngle"},{"type":{"names":["boolean"]},"description":"Sets if the the ellipse rotation is clockwise (true) or anti-clockwise (false)","name":"clockwise"},{"type":{"names":["integer"]},"description":"The rotation of ellipse, in degrees.","name":"rotation"}],"memberof":"Phaser.Types.Curves","longname":"Phaser.Types.Curves.JSONEllipseCurve","scope":"static","___s":true},{"meta":{"filename":"JSONPath.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/typedefs"},"kind":"typedef","name":"JSONPath","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The of the curve.","name":"type"},{"type":{"names":["number"]},"description":"The X coordinate of the curve's starting point.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the path's starting point.","name":"y"},{"type":{"names":["boolean"]},"description":"The path is auto closed.","name":"autoClose"},{"type":{"names":["Array."]},"description":"The list of the curves","name":"curves"}],"memberof":"Phaser.Types.Curves","longname":"Phaser.Types.Curves.JSONPath","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/typedefs"},"kind":"namespace","name":"Curves","memberof":"Phaser.Types","longname":"Phaser.Types.Curves","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"DataManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DataManager.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"kind":"typedef","name":"DataEachCallback","type":{"names":["function"]},"params":[{"type":{"names":["*"]},"description":"The parent object of the DataManager.","name":"parent"},{"type":{"names":["string"]},"description":"The key of the value.","name":"key"},{"type":{"names":["*"]},"description":"The value.","name":"value"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the game object, key, and data.","name":"args"}],"longname":"DataEachCallback","scope":"global","___s":true},{"meta":{"filename":"DataManager.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"classdesc":"The Data Manager Component features a means to store pieces of data specific to a Game Object, System or Plugin.\nYou can then search, query it, and retrieve the data. The parent must either extend EventEmitter,\nor have a property called `events` that is an instance of it.","kind":"class","name":"DataManager","memberof":"Phaser.Data","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object that this DataManager belongs to.","name":"parent"},{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"The DataManager's event emitter.","name":"eventEmitter"}],"scope":"static","longname":"Phaser.Data.DataManager","___s":true},{"meta":{"filename":"DataManager.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The object that this DataManager belongs to.","name":"parent","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManager.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The DataManager's event emitter.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManager.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The data list.","name":"list","type":{"names":["Object."]},"defaultvalue":"{}","since":"3.0.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#list","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManager.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The public values list. You can use this to access anything you have stored\nin this Data Manager. For example, if you set a value called `gold` you can\naccess it via:\n\n```javascript\nthis.data.values.gold;\n```\n\nYou can also modify it directly:\n\n```javascript\nthis.data.values.gold += 1000;\n```\n\nDoing so will emit a `setdata` event from the parent of this Data Manager.\n\nDo not modify this object directly. Adding properties directly to this object will not\nemit any events. Always use `DataManager.set` to create new items the first time around.","name":"values","type":{"names":["Object."]},"defaultvalue":"{}","since":"3.10.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#values","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManager.js","lineno":116,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Retrieves the value for the given key, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nthis.data.get('gold');\n```\n\nOr access the value directly:\n\n```javascript\nthis.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nthis.data.get([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#get","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Retrieves all data values in a new object.","kind":"function","name":"getAll","since":"3.0.0","returns":[{"type":{"names":["Object."]},"description":"All data values."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#getAll","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Queries the DataManager for the values of keys matching the given regular expression.","kind":"function","name":"query","since":"3.0.0","params":[{"type":{"names":["RegExp"]},"description":"A regular expression object. If a non-RegExp object obj is passed, it is implicitly converted to a RegExp by using new RegExp(obj).","name":"search"}],"returns":[{"type":{"names":["Object."]},"description":"The values of the keys matching the search string."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#query","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Sets a value for the given key. If the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\ndata.set('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\ndata.set({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `get`:\n\n```javascript\ndata.get('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\ndata.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"set","fires":["Phaser.Data.Events#event:SET_DATA","Phaser.Data.Events#event:CHANGE_DATA","Phaser.Data.Events#event:CHANGE_DATA_KEY"],"since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object or key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#set","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Passes all data entries to the given callback.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["DataEachCallback"]},"description":"The function to call.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"Value to use as `this` when executing callback.","name":"context"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the game object, key, and data.","name":"args"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#each","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":381,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Merge the given object of key value pairs into this DataManager.\n\nAny newly created values will emit a `setdata` event. Any updated values (see the `overwrite` argument)\nwill emit a `changedata` event.","kind":"function","name":"merge","fires":["Phaser.Data.Events#event:SET_DATA","Phaser.Data.Events#event:CHANGE_DATA","Phaser.Data.Events#event:CHANGE_DATA_KEY"],"since":"3.0.0","params":[{"type":{"names":["Object."]},"description":"The data to merge.","name":"data"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to overwrite existing data. Defaults to true.","name":"overwrite"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#merge","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":414,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Remove the value for the given key.\n\nIf the key is found in this Data Manager it is removed from the internal lists and a\n`removedata` event is emitted.\n\nYou can also pass in an array of keys, in which case all keys in the array will be removed:\n\n```javascript\nthis.data.remove([ 'gold', 'armor', 'health' ]);\n```","kind":"function","name":"remove","fires":["Phaser.Data.Events#event:REMOVE_DATA"],"since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key to remove, or an array of keys to remove.","name":"key"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#remove","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Retrieves the data associated with the given 'key', deletes it from this Data Manager, then returns it.","kind":"function","name":"pop","fires":["Phaser.Data.Events#event:REMOVE_DATA"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the value to retrieve and delete.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value of the given key."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#pop","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":511,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Determines whether the given key is set in this Data Manager.\n\nPlease note that the keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if the key exists, otherwise `false`."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#has","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Freeze or unfreeze this Data Manager. A frozen Data Manager will block all attempts\nto create new values or update existing ones.","kind":"function","name":"setFreeze","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether to freeze or unfreeze the Data Manager.","name":"value"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#setFreeze","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":547,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Delete all data in this Data Manager and unfreeze it.","kind":"function","name":"reset","since":"3.0.0","returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#reset","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Destroy this data manager.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#destroy","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":585,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Gets or sets the frozen state of this Data Manager.\nA frozen Data Manager will block all attempts to create new values or update existing ones.","name":"freeze","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#freeze","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManager.js","lineno":607,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Return the total number of entries in this Data Manager.","name":"count","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#count","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,213],"filename":"DataManagerPlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DataManagerPlugin.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"classdesc":"The Data Component features a means to store pieces of data specific to a Game Object, System or Plugin.\nYou can then search, query it, and retrieve the data. The parent must either extend EventEmitter,\nor have a property called `events` that is an instance of it.","kind":"class","name":"DataManagerPlugin","augments":["Phaser.Data.DataManager"],"memberof":"Phaser.Data","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that this DataManager belongs to.","name":"scene"}],"scope":"static","longname":"Phaser.Data.DataManagerPlugin","___s":true},{"meta":{"filename":"DataManagerPlugin.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"A reference to the Scene that this DataManager belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManagerPlugin.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"A reference to the Scene's Systems.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManagerPlugin.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The Scene that owns this plugin is being destroyed.\nWe need to shutdown and then kill off all external references.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#destroy","scope":"instance","overrides":"Phaser.Data.DataManager#destroy","___s":true},{"meta":{"filename":"CHANGE_DATA_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data/events"},"description":"The Change Data Event.\n\nThis event is dispatched by a Data Manager when an item in the data store is changed.\n\nGame Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\na change data event from a Game Object you would use: `sprite.data.on('changedata', listener)`.\n\nThis event is dispatched for all items that change in the Data Manager.\nTo listen for the change of a specific item, use the `CHANGE_DATA_KEY_EVENT` event.","kind":"event","name":"CHANGE_DATA","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"A reference to the object that the Data Manager responsible for this event belongs to.","name":"parent"},{"type":{"names":["string"]},"description":"The unique key of the data item within the Data Manager.","name":"key"},{"type":{"names":["any"]},"description":"The new value of the item in the Data Manager.","name":"value"},{"type":{"names":["any"]},"description":"The previous value of the item in the Data Manager.","name":"previousValue"}],"memberof":"Phaser.Data.Events","longname":"Phaser.Data.Events#event:CHANGE_DATA","scope":"instance","___s":true},{"meta":{"filename":"CHANGE_DATA_KEY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data/events"},"description":"The Change Data Key Event.\n\nThis event is dispatched by a Data Manager when an item in the data store is changed.\n\nGame Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\nthe change of a specific data item from a Game Object you would use: `sprite.data.on('changedata-key', listener)`,\nwhere `key` is the unique string key of the data item. For example, if you have a data item stored called `gold`\nthen you can listen for `sprite.data.on('changedata-gold')`.","kind":"event","name":"CHANGE_DATA_KEY","since":"3.16.1","params":[{"type":{"names":["any"]},"description":"A reference to the object that owns the instance of the Data Manager responsible for this event.","name":"parent"},{"type":{"names":["any"]},"description":"The item that was updated in the Data Manager. This can be of any data type, i.e. a string, boolean, number, object or instance.","name":"value"},{"type":{"names":["any"]},"description":"The previous item that was updated in the Data Manager. This can be of any data type, i.e. a string, boolean, number, object or instance.","name":"previousValue"}],"memberof":"Phaser.Data.Events","longname":"Phaser.Data.Events#event:CHANGE_DATA_KEY","scope":"instance","___s":true},{"meta":{"filename":"REMOVE_DATA_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data/events"},"description":"The Remove Data Event.\n\nThis event is dispatched by a Data Manager when an item is removed from it.\n\nGame Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\nthe removal of a data item on a Game Object you would use: `sprite.data.on('removedata', listener)`.","kind":"event","name":"REMOVE_DATA","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"A reference to the object that owns the instance of the Data Manager responsible for this event.","name":"parent"},{"type":{"names":["string"]},"description":"The unique key of the data item within the Data Manager.","name":"key"},{"type":{"names":["any"]},"description":"The item that was removed from the Data Manager. This can be of any data type, i.e. a string, boolean, number, object or instance.","name":"data"}],"memberof":"Phaser.Data.Events","longname":"Phaser.Data.Events#event:REMOVE_DATA","scope":"instance","___s":true},{"meta":{"filename":"SET_DATA_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data/events"},"description":"The Set Data Event.\n\nThis event is dispatched by a Data Manager when a new item is added to the data store.\n\nGame Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\nthe addition of a new data item on a Game Object you would use: `sprite.data.on('setdata', listener)`.","kind":"event","name":"SET_DATA","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"A reference to the object that owns the instance of the Data Manager responsible for this event.","name":"parent"},{"type":{"names":["string"]},"description":"The unique key of the data item within the Data Manager.","name":"key"},{"type":{"names":["any"]},"description":"The item that was added to the Data Manager. This can be of any data type, i.e. a string, boolean, number, object or instance.","name":"data"}],"memberof":"Phaser.Data.Events","longname":"Phaser.Data.Events#event:SET_DATA","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Data","longname":"Phaser.Data.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"kind":"namespace","name":"Data","memberof":"Phaser","longname":"Phaser.Data","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"Audio.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"name":"Browser","longname":"Browser","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Audio.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the audio playback capabilities of the device running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.audio` from within any Scene.","kind":"typedef","name":"Audio","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Can this device play HTML Audio tags?","name":"audioData"},{"type":{"names":["boolean"]},"description":"Can this device play EC-3 Dolby Digital Plus files?","name":"dolby"},{"type":{"names":["boolean"]},"description":"Can this device can play m4a files.","name":"m4a"},{"type":{"names":["boolean"]},"description":"Can this device play mp3 files?","name":"mp3"},{"type":{"names":["boolean"]},"description":"Can this device play ogg files?","name":"ogg"},{"type":{"names":["boolean"]},"description":"Can this device play opus files?","name":"opus"},{"type":{"names":["boolean"]},"description":"Can this device play wav files?","name":"wav"},{"type":{"names":["boolean"]},"description":"Does this device have the Web Audio API?","name":"webAudio"},{"type":{"names":["boolean"]},"description":"Can this device play webm files?","name":"webm"}],"memberof":"Phaser.Device","longname":"Phaser.Device.Audio","scope":"static","___s":true},{"meta":{"range":[180,200],"filename":"Browser.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"name":"OS","longname":"OS","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Browser.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the browser type and version running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.browser` from within any Scene.","kind":"typedef","name":"Browser","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Set to true if running in Chrome.","name":"chrome"},{"type":{"names":["boolean"]},"description":"Set to true if running in Microsoft Edge browser.","name":"edge"},{"type":{"names":["boolean"]},"description":"Set to true if running in Firefox.","name":"firefox"},{"type":{"names":["boolean"]},"description":"Set to true if running in Internet Explorer 11 or less (not Edge).","name":"ie"},{"type":{"names":["boolean"]},"description":"Set to true if running in Mobile Safari.","name":"mobileSafari"},{"type":{"names":["boolean"]},"description":"Set to true if running in Opera.","name":"opera"},{"type":{"names":["boolean"]},"description":"Set to true if running in Safari.","name":"safari"},{"type":{"names":["boolean"]},"description":"Set to true if running in the Silk browser (as used on the Amazon Kindle)","name":"silk"},{"type":{"names":["boolean"]},"description":"Set to true if running a Trident version of Internet Explorer (IE11+)","name":"trident"},{"type":{"names":["number"]},"description":"If running in Chrome this will contain the major version number.","name":"chromeVersion"},{"type":{"names":["number"]},"description":"If running in Firefox this will contain the major version number.","name":"firefoxVersion"},{"type":{"names":["number"]},"description":"If running in Internet Explorer this will contain the major version number. Beyond IE10 you should use Browser.trident and Browser.tridentVersion.","name":"ieVersion"},{"type":{"names":["number"]},"description":"If running in Safari this will contain the major version number.","name":"safariVersion"},{"type":{"names":["number"]},"description":"If running in Internet Explorer 11 this will contain the major version number. See {@link http://msdn.microsoft.com/en-us/library/ie/ms537503(v=vs.85).aspx}","name":"tridentVersion"}],"memberof":"Phaser.Device","longname":"Phaser.Device.Browser","scope":"static","___s":true},{"meta":{"range":[180,232],"filename":"CanvasFeatures.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CanvasFeatures.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the canvas features of the browser running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.canvasFeatures` from within any Scene.","kind":"typedef","name":"CanvasFeatures","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Set to true if the browser supports inversed alpha.","name":"supportInverseAlpha"},{"type":{"names":["boolean"]},"description":"Set to true if the browser supports new canvas blend modes.","name":"supportNewBlendModes"}],"memberof":"Phaser.Device","longname":"Phaser.Device.CanvasFeatures","scope":"static","___s":true},{"meta":{"range":[180,200],"filename":"Features.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"name":"OS","longname":"OS","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Features.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the features of the browser running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.features` from within any Scene.","kind":"typedef","name":"Features","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"nullable":true,"description":"True if canvas supports a 'copy' bitblt onto itself when the source and destination regions overlap.","name":"canvasBitBltShift"},{"type":{"names":["boolean"]},"description":"Is canvas available?","name":"canvas"},{"type":{"names":["boolean"]},"description":"Is file available?","name":"file"},{"type":{"names":["boolean"]},"description":"Is fileSystem available?","name":"fileSystem"},{"type":{"names":["boolean"]},"description":"Does the device support the getUserMedia API?","name":"getUserMedia"},{"type":{"names":["boolean"]},"description":"Is the device big or little endian? (only detected if the browser supports TypedArrays)","name":"littleEndian"},{"type":{"names":["boolean"]},"description":"Is localStorage available?","name":"localStorage"},{"type":{"names":["boolean"]},"description":"Is Pointer Lock available?","name":"pointerLock"},{"type":{"names":["boolean"]},"description":"Does the device context support 32bit pixel manipulation using array buffer views?","name":"support32bit"},{"type":{"names":["boolean"]},"description":"Does the device support the Vibration API?","name":"vibration"},{"type":{"names":["boolean"]},"description":"Is webGL available?","name":"webGL"},{"type":{"names":["boolean"]},"description":"Is worker available?","name":"worker"}],"memberof":"Phaser.Device","longname":"Phaser.Device.Features","scope":"static","___s":true},{"meta":{"filename":"Fullscreen.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the full screen support of the browser running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.fullscreen` from within any Scene.","kind":"typedef","name":"Fullscreen","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Does the browser support the Full Screen API?","name":"available"},{"type":{"names":["boolean"]},"description":"Does the browser support access to the Keyboard during Full Screen mode?","name":"keyboard"},{"type":{"names":["string"]},"description":"If the browser supports the Full Screen API this holds the call you need to use to cancel it.","name":"cancel"},{"type":{"names":["string"]},"description":"If the browser supports the Full Screen API this holds the call you need to use to activate it.","name":"request"}],"memberof":"Phaser.Device","longname":"Phaser.Device.Fullscreen","scope":"static","___s":true},{"meta":{"range":[1183,2777],"filename":"Fullscreen.js","lineno":35,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Checks for support of the Full Screen API.","ignore":true,"name":"init","longname":"init","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[180,210],"filename":"Input.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"name":"Browser","longname":"Browser","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Input.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the input support of the browser running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.input` from within any Scene.","kind":"typedef","name":"Input","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"nullable":true,"description":"The newest type of Wheel/Scroll event supported: 'wheel', 'mousewheel', 'DOMMouseScroll'","name":"wheelType"},{"type":{"names":["boolean"]},"description":"Is navigator.getGamepads available?","name":"gamepads"},{"type":{"names":["boolean"]},"description":"Is mspointer available?","name":"mspointer"},{"type":{"names":["boolean"]},"description":"Is touch available?","name":"touch"}],"memberof":"Phaser.Device","longname":"Phaser.Device.Input","scope":"static","___s":true},{"meta":{"filename":"OS.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the operating system of the device running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.os` from within any Scene.","kind":"typedef","name":"OS","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Is running on android?","name":"android"},{"type":{"names":["boolean"]},"description":"Is running on chromeOS?","name":"chromeOS"},{"type":{"names":["boolean"]},"description":"Is the game running under Apache Cordova?","name":"cordova"},{"type":{"names":["boolean"]},"description":"Is the game running under the Intel Crosswalk XDK?","name":"crosswalk"},{"type":{"names":["boolean"]},"description":"Is running on a desktop?","name":"desktop"},{"type":{"names":["boolean"]},"description":"Is the game running under Ejecta?","name":"ejecta"},{"type":{"names":["boolean"]},"description":"Is the game running under GitHub Electron?","name":"electron"},{"type":{"names":["boolean"]},"description":"Is running on iOS?","name":"iOS"},{"type":{"names":["boolean"]},"description":"Is running on iPad?","name":"iPad"},{"type":{"names":["boolean"]},"description":"Is running on iPhone?","name":"iPhone"},{"type":{"names":["boolean"]},"description":"Is running on an Amazon Kindle?","name":"kindle"},{"type":{"names":["boolean"]},"description":"Is running on linux?","name":"linux"},{"type":{"names":["boolean"]},"description":"Is running on macOS?","name":"macOS"},{"type":{"names":["boolean"]},"description":"Is the game running under Node.js?","name":"node"},{"type":{"names":["boolean"]},"description":"Is the game running under Node-Webkit?","name":"nodeWebkit"},{"type":{"names":["boolean"]},"description":"Set to true if running as a WebApp, i.e. within a WebView","name":"webApp"},{"type":{"names":["boolean"]},"description":"Is running on windows?","name":"windows"},{"type":{"names":["boolean"]},"description":"Is running on a Windows Phone?","name":"windowsPhone"},{"type":{"names":["number"]},"description":"If running in iOS this will contain the major version number.","name":"iOSVersion"},{"type":{"names":["number"]},"description":"PixelRatio of the host device?","name":"pixelRatio"}],"memberof":"Phaser.Device","longname":"Phaser.Device.OS","scope":"static","___s":true},{"meta":{"filename":"Video.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the video support of the browser running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.video` from within any Scene.\n\nIn Phaser 3.20 the properties were renamed to drop the 'Video' suffix.","kind":"typedef","name":"Video","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Can this device play h264 mp4 video files?","name":"h264"},{"type":{"names":["boolean"]},"description":"Can this device play hls video files?","name":"hls"},{"type":{"names":["boolean"]},"description":"Can this device play h264 mp4 video files?","name":"mp4"},{"type":{"names":["boolean"]},"description":"Can this device play ogg video files?","name":"ogg"},{"type":{"names":["boolean"]},"description":"Can this device play vp9 video files?","name":"vp9"},{"type":{"names":["boolean"]},"description":"Can this device play webm video files?","name":"webm"}],"memberof":"Phaser.Device","longname":"Phaser.Device.Video","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"kind":"namespace","name":"Device","since":"3.0.0","memberof":"Phaser","longname":"Phaser.Device","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"kind":"typedef","name":"DeviceConf","type":{"names":["object"]},"properties":[{"type":{"names":["Phaser.Device.OS"]},"description":"The OS Device functions.","name":"os"},{"type":{"names":["Phaser.Device.Browser"]},"description":"The Browser Device functions.","name":"browser"},{"type":{"names":["Phaser.Device.Features"]},"description":"The Features Device functions.","name":"features"},{"type":{"names":["Phaser.Device.Input"]},"description":"The Input Device functions.","name":"input"},{"type":{"names":["Phaser.Device.Audio"]},"description":"The Audio Device functions.","name":"audio"},{"type":{"names":["Phaser.Device.Video"]},"description":"The Video Device functions.","name":"video"},{"type":{"names":["Phaser.Device.Fullscreen"]},"description":"The Fullscreen Device functions.","name":"fullscreen"},{"type":{"names":["Phaser.Device.CanvasFeatures"]},"description":"The Canvas Device functions.","name":"canvasFeatures"}],"memberof":"Phaser","longname":"Phaser.DeviceConf","scope":"static","___s":true},{"meta":{"range":[180,2832],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"name":"ALIGN_CONST","longname":"ALIGN_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a top-left alignment or position.","kind":"constant","name":"TOP_LEFT","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.TOP_LEFT","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a top-center alignment or position.","kind":"constant","name":"TOP_CENTER","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.TOP_CENTER","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a top-right alignment or position.","kind":"constant","name":"TOP_RIGHT","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.TOP_RIGHT","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a left-top alignment or position.","kind":"constant","name":"LEFT_TOP","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.LEFT_TOP","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a left-center alignment or position.","kind":"constant","name":"LEFT_CENTER","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.LEFT_CENTER","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a left-bottom alignment or position.","kind":"constant","name":"LEFT_BOTTOM","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.LEFT_BOTTOM","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a center alignment or position.","kind":"constant","name":"CENTER","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.CENTER","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a right-top alignment or position.","kind":"constant","name":"RIGHT_TOP","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.RIGHT_TOP","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a right-center alignment or position.","kind":"constant","name":"RIGHT_CENTER","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.RIGHT_CENTER","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a right-bottom alignment or position.","kind":"constant","name":"RIGHT_BOTTOM","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.RIGHT_BOTTOM","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":99,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a bottom-left alignment or position.","kind":"constant","name":"BOTTOM_LEFT","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.BOTTOM_LEFT","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a bottom-center alignment or position.","kind":"constant","name":"BOTTOM_CENTER","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.BOTTOM_CENTER","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a bottom-right alignment or position.","kind":"constant","name":"BOTTOM_RIGHT","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.BOTTOM_RIGHT","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"BottomCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BottomCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the bottom center of the other.","kind":"function","name":"BottomCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.BottomCenter","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"BottomLeft.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BottomLeft.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the bottom left of the other.","kind":"function","name":"BottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.BottomLeft","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"BottomRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BottomRight.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the bottom right of the other.","kind":"function","name":"BottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.BottomRight","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"Center.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"CenterOn","longname":"CenterOn","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Center.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the center of the other.","kind":"function","name":"Center","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.Center","scope":"static","___s":true},{"meta":{"range":[180,227],"filename":"LeftCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetCenterY","longname":"GetCenterY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LeftCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the left center of the other.","kind":"function","name":"LeftCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.LeftCenter","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"QuickSet.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"ALIGN_CONST","longname":"ALIGN_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuickSet.js","lineno":25,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned relative to the other.\nThe alignment used is based on the `position` argument, which is an `ALIGN_CONST` value, such as `LEFT_CENTER` or `TOP_RIGHT`.","kind":"function","name":"QuickSet","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"child"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["integer"]},"description":"The position to align the Game Object with. This is an align constant, such as `ALIGN_CONST.LEFT_CENTER`.","name":"position"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.QuickSet","scope":"static","___s":true},{"meta":{"range":[180,227],"filename":"RightCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetCenterY","longname":"GetCenterY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RightCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the right center of the other.","kind":"function","name":"RightCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.RightCenter","scope":"static","___s":true},{"meta":{"range":[180,227],"filename":"TopCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetCenterX","longname":"GetCenterX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TopCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the top center of the other.","kind":"function","name":"TopCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.TopCenter","scope":"static","___s":true},{"meta":{"range":[180,221],"filename":"TopLeft.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetLeft","longname":"GetLeft","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TopLeft.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the top left of the other.","kind":"function","name":"TopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.TopLeft","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"TopRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetRight","longname":"GetRight","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TopRight.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the top right of the other.","kind":"function","name":"TopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.TopRight","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"kind":"namespace","name":"In","memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.In","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"kind":"namespace","name":"Align","memberof":"Phaser.Display","longname":"Phaser.Display.Align","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"BottomCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BottomCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the bottom center position of the other.","kind":"function","name":"BottomCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.BottomCenter","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"BottomLeft.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BottomLeft.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the bottom left position of the other.","kind":"function","name":"BottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.BottomLeft","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"BottomRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BottomRight.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the bottom right position of the other.","kind":"function","name":"BottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.BottomRight","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"LeftBottom.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LeftBottom.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the left bottom position of the other.","kind":"function","name":"LeftBottom","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.LeftBottom","scope":"static","___s":true},{"meta":{"range":[180,227],"filename":"LeftCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetCenterY","longname":"GetCenterY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LeftCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the left center position of the other.","kind":"function","name":"LeftCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.LeftCenter","scope":"static","___s":true},{"meta":{"range":[180,221],"filename":"LeftTop.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetLeft","longname":"GetLeft","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LeftTop.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the left top position of the other.","kind":"function","name":"LeftTop","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.LeftTop","scope":"static","___s":true},{"meta":{"range":[149,182],"filename":"QuickSet.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"ALIGN_CONST","longname":"ALIGN_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuickSet.js","lineno":24,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes a Game Object and aligns it next to another, at the given position.\nThe alignment used is based on the `position` argument, which is a `Phaser.Display.Align` property such as `LEFT_CENTER` or `TOP_RIGHT`.","kind":"function","name":"QuickSet","since":"3.22.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"child"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["integer"]},"description":"The position to align the Game Object with. This is an align constant, such as `Phaser.Display.Align.LEFT_CENTER`.","name":"position"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.QuickSet","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"RightBottom.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RightBottom.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the right bottom position of the other.","kind":"function","name":"RightBottom","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.RightBottom","scope":"static","___s":true},{"meta":{"range":[180,227],"filename":"RightCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetCenterY","longname":"GetCenterY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RightCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the right center position of the other.","kind":"function","name":"RightCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.RightCenter","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"RightTop.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetRight","longname":"GetRight","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RightTop.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the right top position of the other.","kind":"function","name":"RightTop","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.RightTop","scope":"static","___s":true},{"meta":{"range":[180,227],"filename":"TopCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetCenterX","longname":"GetCenterX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TopCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the top center position of the other.","kind":"function","name":"TopCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.TopCenter","scope":"static","___s":true},{"meta":{"range":[180,221],"filename":"TopLeft.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetLeft","longname":"GetLeft","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TopLeft.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the top left position of the other.","kind":"function","name":"TopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.TopLeft","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"TopRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetRight","longname":"GetRight","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TopRight.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the top right position of the other.","kind":"function","name":"TopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.TopRight","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"kind":"namespace","name":"To","memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.To","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"CenterOn.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"name":"SetCenterX","longname":"SetCenterX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CenterOn.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that it is centered on the given coordinates.","kind":"function","name":"CenterOn","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The horizontal coordinate to position the Game Object on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to position the Game Object on.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.CenterOn","scope":"static","___s":true},{"meta":{"filename":"GetBottom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the bottom coordinate from the bounds of the Game Object.","kind":"function","name":"GetBottom","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The bottom coordinate of the bounds of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetBottom","scope":"static","___s":true},{"meta":{"filename":"GetCenterX.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the center x coordinate from the bounds of the Game Object.","kind":"function","name":"GetCenterX","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The center x coordinate of the bounds of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetCenterX","scope":"static","___s":true},{"meta":{"filename":"GetCenterY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the center y coordinate from the bounds of the Game Object.","kind":"function","name":"GetCenterY","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The center y coordinate of the bounds of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetCenterY","scope":"static","___s":true},{"meta":{"filename":"GetLeft.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the left coordinate from the bounds of the Game Object.","kind":"function","name":"GetLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The left coordinate of the bounds of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetLeft","scope":"static","___s":true},{"meta":{"filename":"GetOffsetX.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the amount the Game Object is visually offset from its x coordinate.\nThis is the same as `width * origin.x`.\nThis value will only be > 0 if `origin.x` is not equal to zero.","kind":"function","name":"GetOffsetX","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The horizontal offset of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetOffsetX","scope":"static","___s":true},{"meta":{"filename":"GetOffsetY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the amount the Game Object is visually offset from its y coordinate.\nThis is the same as `width * origin.y`.\nThis value will only be > 0 if `origin.y` is not equal to zero.","kind":"function","name":"GetOffsetY","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The vertical offset of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetOffsetY","scope":"static","___s":true},{"meta":{"filename":"GetRight.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the right coordinate from the bounds of the Game Object.","kind":"function","name":"GetRight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The right coordinate of the bounds of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetRight","scope":"static","___s":true},{"meta":{"filename":"GetTop.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the top coordinate from the bounds of the Game Object.","kind":"function","name":"GetTop","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The top coordinate of the bounds of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetTop","scope":"static","___s":true},{"meta":{"filename":"SetBottom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that the bottom of its bounds aligns with the given coordinate.","kind":"function","name":"SetBottom","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The coordinate to position the Game Object bounds on.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.SetBottom","scope":"static","___s":true},{"meta":{"filename":"SetCenterX.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that the center top of its bounds aligns with the given coordinate.","kind":"function","name":"SetCenterX","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The coordinate to position the Game Object bounds on.","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.SetCenterX","scope":"static","___s":true},{"meta":{"filename":"SetCenterY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that the center top of its bounds aligns with the given coordinate.","kind":"function","name":"SetCenterY","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The coordinate to position the Game Object bounds on.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.SetCenterY","scope":"static","___s":true},{"meta":{"filename":"SetLeft.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that the left of its bounds aligns with the given coordinate.","kind":"function","name":"SetLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The coordinate to position the Game Object bounds on.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.SetLeft","scope":"static","___s":true},{"meta":{"filename":"SetRight.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that the left of its bounds aligns with the given coordinate.","kind":"function","name":"SetRight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The coordinate to position the Game Object bounds on.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.SetRight","scope":"static","___s":true},{"meta":{"filename":"SetTop.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that the top of its bounds aligns with the given coordinate.","kind":"function","name":"SetTop","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The coordinate to position the Game Object bounds on.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.SetTop","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"kind":"namespace","name":"Bounds","memberof":"Phaser.Display","longname":"Phaser.Display.Bounds","scope":"static","___s":true},{"meta":{"filename":"CanvasInterpolation.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"kind":"namespace","name":"CanvasInterpolation","since":"3.0.0","memberof":"Phaser.Display.Canvas","longname":"Phaser.Display.Canvas.CanvasInterpolation","scope":"static","___s":true},{"meta":{"filename":"CanvasInterpolation.js","lineno":13,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Sets the CSS image-rendering property on the given canvas to be 'crisp' (aka 'optimize contrast' on webkit).","kind":"function","name":"setCrisp","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas object to have the style set on.","name":"canvas"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas."}],"memberof":"Phaser.Display.Canvas.CanvasInterpolation","longname":"Phaser.Display.Canvas.CanvasInterpolation.setCrisp","scope":"static","___s":true},{"meta":{"filename":"CanvasInterpolation.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Sets the CSS image-rendering property on the given canvas to be 'bicubic' (aka 'auto').","kind":"function","name":"setBicubic","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas object to have the style set on.","name":"canvas"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas."}],"memberof":"Phaser.Display.Canvas.CanvasInterpolation","longname":"Phaser.Display.Canvas.CanvasInterpolation.setBicubic","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"CanvasPool.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CanvasPool.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"The CanvasPool is a global static object, that allows Phaser to recycle and pool 2D Context Canvas DOM elements.\nIt does not pool WebGL Contexts, because once the context options are set they cannot be modified again, \nwhich is useless for some of the Phaser pipelines / renderer.\n\nThis singleton is instantiated as soon as Phaser loads, before a Phaser.Game instance has even been created.\nWhich means all instances of Phaser Games on the same page can share the one single pool.","kind":"namespace","name":"CanvasPool","since":"3.0.0","memberof":"Phaser.Display.Canvas","longname":"Phaser.Display.Canvas.CanvasPool","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":29,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Creates a new Canvas DOM element, or pulls one from the pool if free.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The parent of the Canvas object.","name":"parent"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The width of the Canvas.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The height of the Canvas.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Phaser.CANVAS","description":"The type of the Canvas. Either `Phaser.CANVAS` or `Phaser.WEBGL`.","name":"canvasType"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use the generated Canvas element as the parent?","name":"selfParent"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas element that was created or pulled from the pool"}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.create","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Creates a new Canvas DOM element, or pulls one from the pool if free.","kind":"function","name":"create2D","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The parent of the Canvas object.","name":"parent"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The width of the Canvas.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The height of the Canvas.","name":"height"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The created canvas."}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.create2D","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Creates a new Canvas DOM element, or pulls one from the pool if free.","kind":"function","name":"createWebGL","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The parent of the Canvas object.","name":"parent"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The width of the Canvas.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The height of the Canvas.","name":"height"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The created WebGL canvas."}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.createWebGL","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Gets the first free canvas index from the pool.","kind":"function","name":"first","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Phaser.CANVAS","description":"The type of the Canvas. Either `Phaser.CANVAS` or `Phaser.WEBGL`.","name":"canvasType"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The first free canvas, or `null` if a WebGL canvas was requested or if the pool doesn't have free canvases."}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.first","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Looks up a canvas based on its parent, and if found puts it back in the pool, freeing it up for re-use.\nThe canvas has its width and height set to 1, and its parent attribute nulled.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The canvas or the parent of the canvas to free.","name":"parent"}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.remove","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Gets the total number of used canvas elements in the pool.","kind":"function","name":"total","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of used canvases."}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.total","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":205,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Gets the total number of free canvas elements in the pool.","kind":"function","name":"free","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of free canvases."}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.free","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":218,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Disable context smoothing on any new Canvas element created.","kind":"function","name":"disableSmoothing","since":"3.0.0","memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.disableSmoothing","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Enable context smoothing on any new Canvas element created.","kind":"function","name":"enableSmoothing","since":"3.0.0","memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.enableSmoothing","scope":"static","___s":true},{"meta":{"filename":"Smoothing.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"kind":"namespace","name":"Smoothing","since":"3.0.0","memberof":"Phaser.Display.Canvas","longname":"Phaser.Display.Canvas.Smoothing","scope":"static","___s":true},{"meta":{"filename":"Smoothing.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Gets the Smoothing Enabled vendor prefix being used on the given context, or null if not set.","kind":"function","name":"getPrefix","since":"3.0.0","params":[{"type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"description":"The canvas context to check.","name":"context"}],"returns":[{"type":{"names":["string"]},"description":"The name of the property on the context which controls image smoothing (either `imageSmoothingEnabled` or a vendor-prefixed version thereof), or `null` if not supported."}],"memberof":"Phaser.Display.Canvas.Smoothing","longname":"Phaser.Display.Canvas.Smoothing.getPrefix","scope":"static","___s":true},{"meta":{"filename":"Smoothing.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.\nBy default browsers have image smoothing enabled, which isn't always what you visually want, especially\nwhen using pixel art in a game. Note that this sets the property on the context itself, so that any image\ndrawn to the context will be affected. This sets the property across all current browsers but support is\npatchy on earlier browsers, especially on mobile.","kind":"function","name":"enable","since":"3.0.0","params":[{"type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"description":"The context on which to enable smoothing.","name":"context"}],"returns":[{"type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"description":"The provided context."}],"memberof":"Phaser.Display.Canvas.Smoothing","longname":"Phaser.Display.Canvas.Smoothing.enable","scope":"static","___s":true},{"meta":{"filename":"Smoothing.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.\nBy default browsers have image smoothing enabled, which isn't always what you visually want, especially\nwhen using pixel art in a game. Note that this sets the property on the context itself, so that any image\ndrawn to the context will be affected. This sets the property across all current browsers but support is\npatchy on earlier browsers, especially on mobile.","kind":"function","name":"disable","since":"3.0.0","params":[{"type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"description":"The context on which to disable smoothing.","name":"context"}],"returns":[{"type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"description":"The provided context."}],"memberof":"Phaser.Display.Canvas.Smoothing","longname":"Phaser.Display.Canvas.Smoothing.disable","scope":"static","___s":true},{"meta":{"filename":"Smoothing.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Returns `true` if the given context has image smoothing enabled, otherwise returns `false`.\nReturns null if no smoothing prefix is available.","kind":"function","name":"isEnabled","since":"3.0.0","params":[{"type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"description":"The context to check.","name":"context"}],"returns":[{"type":{"names":["boolean"]},"nullable":true,"description":"`true` if smoothing is enabled on the context, otherwise `false`. `null` if not supported."}],"memberof":"Phaser.Display.Canvas.Smoothing","longname":"Phaser.Display.Canvas.Smoothing.isEnabled","scope":"static","___s":true},{"meta":{"filename":"TouchAction.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Sets the touch-action property on the canvas style. Can be used to disable default browser touch actions.","kind":"function","name":"TouchAction","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas element to have the style applied to.","name":"canvas"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'none'","description":"The touch action value to set on the canvas. Set to `none` to disable touch actions.","name":"value"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas element."}],"memberof":"Phaser.Display.Canvas","longname":"Phaser.Display.Canvas.TouchAction","scope":"static","___s":true},{"meta":{"filename":"UserSelect.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Sets the user-select property on the canvas style. Can be used to disable default browser selection actions.","kind":"function","name":"UserSelect","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas element to have the style applied to.","name":"canvas"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'none'","description":"The touch callout value to set on the canvas. Set to `none` to disable touch callouts.","name":"value"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas element."}],"memberof":"Phaser.Display.Canvas","longname":"Phaser.Display.Canvas.UserSelect","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"kind":"namespace","name":"Canvas","memberof":"Phaser.Display","longname":"Phaser.Display.Canvas","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Color.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Color.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"kind":"namespace","name":"Color","memberof":"Phaser.Display","longname":"Phaser.Display.Color","scope":"static","___s":true},{"meta":{"filename":"Color.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"classdesc":"The Color class holds a single color value and allows for easy modification and reading of it.","kind":"class","name":"Color","memberof":"Phaser.Display","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The red color value. A number between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The green color value. A number between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The blue color value. A number between 0 and 255.","name":"blue"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The alpha value. A number between 0 and 255.","name":"alpha"}],"scope":"static","longname":"Phaser.Display.Color","___s":true},{"meta":{"filename":"Color.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"An array containing the calculated color values for WebGL use.","name":"gl","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#gl","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":177,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets this color to be transparent. Sets all values to zero.","kind":"function","name":"transparent","since":"3.0.0","returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#transparent","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":199,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets the color of this Color component.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The red color value. A number between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"description":"The green color value. A number between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color value. A number between 0 and 255.","name":"blue"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The alpha value. A number between 0 and 255.","name":"alpha"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Update the HSV values after setting the RGB values?","name":"updateHSV"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#setTo","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":230,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets the red, green, blue and alpha GL values of this Color component.","kind":"function","name":"setGLTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The red color value. A number between 0 and 1.","name":"red"},{"type":{"names":["number"]},"description":"The green color value. A number between 0 and 1.","name":"green"},{"type":{"names":["number"]},"description":"The blue color value. A number between 0 and 1.","name":"blue"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value. A number between 0 and 1.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#setGLTo","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets the color based on the color object given.","kind":"function","name":"setFromRGB","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Display.InputColorObject"]},"description":"An object containing `r`, `g`, `b` and optionally `a` values in the range 0 to 255.","name":"color"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#setFromRGB","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets the color based on the hue, saturation and lightness values given.","kind":"function","name":"setFromHSV","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The hue, in the range 0 - 1. This is the base color.","name":"h"},{"type":{"names":["number"]},"description":"The saturation, in the range 0 - 1. This controls how much of the hue will be in the final color, where 1 is fully saturated and 0 will give you white.","name":"s"},{"type":{"names":["number"]},"description":"The value, in the range 0 - 1. This controls how dark the color is. Where 1 is as bright as possible and 0 is black.","name":"v"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#setFromHSV","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Returns a new Color component using the values from this one.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A new Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#clone","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets this Color object to be grayscaled based on the shade value given.","kind":"function","name":"gray","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"A value between 0 and 255.","name":"shade"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#gray","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":387,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets this Color object to be a random color between the `min` and `max` values given.","kind":"function","name":"random","since":"3.13.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The minimum random color value. Between 0 and 255.","name":"min"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The maximum random color value. Between 0 and 255.","name":"max"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#random","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets this Color object to be a random grayscale color between the `min` and `max` values given.","kind":"function","name":"randomGray","since":"3.13.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The minimum random color value. Between 0 and 255.","name":"min"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The maximum random color value. Between 0 and 255.","name":"max"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#randomGray","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Increase the saturation of this Color by the percentage amount given.\nThe saturation is the amount of the base color in the hue.","kind":"function","name":"saturate","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The percentage amount to change this color by. A value between 0 and 100.","name":"amount"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#saturate","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Decrease the saturation of this Color by the percentage amount given.\nThe saturation is the amount of the base color in the hue.","kind":"function","name":"desaturate","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The percentage amount to change this color by. A value between 0 and 100.","name":"amount"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#desaturate","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":467,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Increase the lightness of this Color by the percentage amount given.","kind":"function","name":"lighten","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The percentage amount to change this color by. A value between 0 and 100.","name":"amount"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#lighten","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":484,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Decrease the lightness of this Color by the percentage amount given.","kind":"function","name":"darken","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The percentage amount to change this color by. A value between 0 and 100.","name":"amount"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#darken","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Brighten this Color by the percentage amount given.","kind":"function","name":"brighten","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The percentage amount to change this color by. A value between 0 and 100.","name":"amount"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#brighten","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":524,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The color of this Color component, not including the alpha channel.","name":"color","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#color","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The color of this Color component, including the alpha channel.","name":"color32","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#color32","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":558,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The color of this Color component as a string which can be used in CSS color values.","name":"rgba","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#rgba","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":575,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The red color value, normalized to the range 0 to 1.","name":"redGL","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#redGL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":600,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The green color value, normalized to the range 0 to 1.","name":"greenGL","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#greenGL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The blue color value, normalized to the range 0 to 1.","name":"blueGL","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#blueGL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":650,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The alpha color value, normalized to the range 0 to 1.","name":"alphaGL","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#alphaGL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":675,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The red color value, normalized to the range 0 to 255.","name":"red","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#red","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":702,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The green color value, normalized to the range 0 to 255.","name":"green","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#green","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":729,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The blue color value, normalized to the range 0 to 255.","name":"blue","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#blue","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":756,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The alpha color value, normalized to the range 0 to 255.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":783,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The hue color value. A number between 0 and 1.\nThis is the base color.","name":"h","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#h","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":807,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The saturation color value. A number between 0 and 1.\nThis controls how much of the hue will be in the final color, where 1 is fully saturated and 0 will give you white.","name":"s","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#s","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":831,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The lightness color value. A number between 0 and 1.\nThis controls how dark the color is. Where 1 is as bright as possible and 0 is black.","name":"v","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#v","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ColorToRGBA.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts the given color value into an Object containing r,g,b and a properties.","kind":"function","name":"ColorToRGBA","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A color value, optionally including the alpha value.","name":"color"}],"returns":[{"type":{"names":["Phaser.Types.Display.ColorObject"]},"description":"An object containing the parsed color values."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.ColorToRGBA","scope":"static","___s":true},{"meta":{"filename":"ComponentToHex.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Returns a string containing a hex representation of the given color component.","kind":"function","name":"ComponentToHex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The color channel to get the hex value for, must be a value between 0 and 255.","name":"color"}],"returns":[{"type":{"names":["string"]},"description":"A string of length 2 characters, i.e. 255 = ff, 100 = 64."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.ComponentToHex","scope":"static","___s":true},{"meta":{"filename":"GetColor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Given 3 separate color values this will return an integer representation of it.","kind":"function","name":"GetColor","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The red color value. A number between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"description":"The green color value. A number between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color value. A number between 0 and 255.","name":"blue"}],"returns":[{"type":{"names":["number"]},"description":"The combined color value."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.GetColor","scope":"static","___s":true},{"meta":{"filename":"GetColor32.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Given an alpha and 3 color values this will return an integer representation of it.","kind":"function","name":"GetColor32","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The red color value. A number between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"description":"The green color value. A number between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color value. A number between 0 and 255.","name":"blue"},{"type":{"names":["integer"]},"description":"The alpha color value. A number between 0 and 255.","name":"alpha"}],"returns":[{"type":{"names":["number"]},"description":"The combined color value."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.GetColor32","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"HSLToColor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Color","longname":"Color","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HSLToColor.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts HSL (hue, saturation and lightness) values to a Phaser Color object.","kind":"function","name":"HSLToColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The hue value in the range 0 to 1.","name":"h"},{"type":{"names":["number"]},"description":"The saturation value in the range 0 to 1.","name":"s"},{"type":{"names":["number"]},"description":"The lightness value in the range 0 to 1.","name":"l"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object created from the results of the h, s and l values."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.HSLToColor","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"HSVColorWheel.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"HSVToRGB","longname":"HSVToRGB","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HSVColorWheel.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Get HSV color wheel values in an array which will be 360 elements in size.","kind":"function","name":"HSVColorWheel","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The saturation, in the range 0 - 1.","name":"s"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The value, in the range 0 - 1.","name":"v"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing 360 elements, where each contains a single numeric value corresponding to the color at that point in the HSV color wheel."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.HSVColorWheel","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"HSVToRGB.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"GetColor","longname":"GetColor","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HSVToRGB.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts an HSV (hue, saturation and value) color value to RGB.\nConversion formula from http://en.wikipedia.org/wiki/HSL_color_space.\nAssumes HSV values are contained in the set [0, 1].\nBased on code by Michael Jackson (https://github.com/mjijackson)","kind":"function","name":"HSVToRGB","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The hue, in the range 0 - 1. This is the base color.","name":"h"},{"type":{"names":["number"]},"description":"The saturation, in the range 0 - 1. This controls how much of the hue will be in the final color, where 1 is fully saturated and 0 will give you white.","name":"s"},{"type":{"names":["number"]},"description":"The value, in the range 0 - 1. This controls how dark the color is. Where 1 is as bright as possible and 0 is black.","name":"v"},{"type":{"names":["Phaser.Types.Display.ColorObject","Phaser.Display.Color"]},"optional":true,"description":"A Color object to store the results in. If not given a new ColorObject will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Types.Display.ColorObject","Phaser.Display.Color"]},"description":"An object with the red, green and blue values set in the r, g and b properties."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.HSVToRGB","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"HexStringToColor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Color","longname":"Color","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HexStringToColor.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts a hex string into a Phaser Color object.\n\nThe hex string can supplied as `'#0033ff'` or the short-hand format of `'#03f'`; it can begin with an optional \"#\" or \"0x\", or be unprefixed.\n\nAn alpha channel is _not_ supported.","kind":"function","name":"HexStringToColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The hex color value to convert, such as `#0033ff` or the short-hand format: `#03f`.","name":"hex"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object populated by the values of the given string."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.HexStringToColor","scope":"static","___s":true},{"meta":{"filename":"HueToComponent.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts a hue to an RGB color.\nBased on code by Michael Jackson (https://github.com/mjijackson)","kind":"function","name":"HueToComponent","since":"3.0.0","params":[{"type":{"names":["number"]},"name":"p"},{"type":{"names":["number"]},"name":"q"},{"type":{"names":["number"]},"name":"t"}],"returns":[{"type":{"names":["number"]},"description":"The combined color value."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.HueToComponent","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"IntegerToColor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Color","longname":"Color","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IntegerToColor.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts the given color value into an instance of a Color object.","kind":"function","name":"IntegerToColor","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The color value to convert into a Color object.","name":"input"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.IntegerToColor","scope":"static","___s":true},{"meta":{"filename":"IntegerToRGB.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Return the component parts of a color as an Object with the properties alpha, red, green, blue.\n\nAlpha will only be set if it exists in the given color (0xAARRGGBB)","kind":"function","name":"IntegerToRGB","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The color value to convert into a Color object.","name":"input"}],"returns":[{"type":{"names":["Phaser.Types.Display.ColorObject"]},"description":"An object with the red, green and blue values set in the r, g and b properties."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.IntegerToRGB","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"Interpolate.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Linear","longname":"Linear","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Interpolate.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"kind":"namespace","name":"Interpolate","memberof":"Phaser.Display.Color","since":"3.0.0","longname":"Phaser.Display.Color.Interpolate","scope":"static","___s":true},{"meta":{"filename":"Interpolate.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Interpolates between the two given color ranges over the length supplied.","kind":"function","name":"RGBWithRGB","memberof":"Phaser.Display.Color.Interpolate","scope":"static","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Red value.","name":"r1"},{"type":{"names":["number"]},"description":"Blue value.","name":"g1"},{"type":{"names":["number"]},"description":"Green value.","name":"b1"},{"type":{"names":["number"]},"description":"Red value.","name":"r2"},{"type":{"names":["number"]},"description":"Blue value.","name":"g2"},{"type":{"names":["number"]},"description":"Green value.","name":"b2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"Distance to interpolate over.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Index to start from.","name":"index"}],"returns":[{"type":{"names":["Phaser.Types.Display.ColorObject"]},"description":"An object containing the interpolated color values."}],"longname":"Phaser.Display.Color.Interpolate.RGBWithRGB","___s":true},{"meta":{"filename":"Interpolate.js","lineno":48,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Interpolates between the two given color objects over the length supplied.","kind":"function","name":"ColorWithColor","memberof":"Phaser.Display.Color.Interpolate","scope":"static","since":"3.0.0","params":[{"type":{"names":["Phaser.Display.Color"]},"description":"The first Color object.","name":"color1"},{"type":{"names":["Phaser.Display.Color"]},"description":"The second Color object.","name":"color2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"Distance to interpolate over.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Index to start from.","name":"index"}],"returns":[{"type":{"names":["Phaser.Types.Display.ColorObject"]},"description":"An object containing the interpolated color values."}],"longname":"Phaser.Display.Color.Interpolate.ColorWithColor","___s":true},{"meta":{"filename":"Interpolate.js","lineno":71,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Interpolates between the Color object and color values over the length supplied.","kind":"function","name":"ColorWithRGB","memberof":"Phaser.Display.Color.Interpolate","scope":"static","since":"3.0.0","params":[{"type":{"names":["Phaser.Display.Color"]},"description":"The first Color object.","name":"color1"},{"type":{"names":["number"]},"description":"Red value.","name":"r"},{"type":{"names":["number"]},"description":"Blue value.","name":"g"},{"type":{"names":["number"]},"description":"Green value.","name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"Distance to interpolate over.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Index to start from.","name":"index"}],"returns":[{"type":{"names":["Phaser.Types.Display.ColorObject"]},"description":"An object containing the interpolated color values."}],"longname":"Phaser.Display.Color.Interpolate.ColorWithRGB","___s":true},{"meta":{"range":[180,206],"filename":"ObjectToColor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Color","longname":"Color","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ObjectToColor.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts an object containing `r`, `g`, `b` and `a` properties into a Color class instance.","kind":"function","name":"ObjectToColor","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Display.InputColorObject"]},"description":"An object containing `r`, `g`, `b` and `a` properties in the range 0 to 255.","name":"input"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.ObjectToColor","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"RGBStringToColor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Color","longname":"Color","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RGBStringToColor.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts a CSS 'web' string into a Phaser Color object.\n\nThe web string can be in the format `'rgb(r,g,b)'` or `'rgba(r,g,b,a)'` where r/g/b are in the range [0..255] and a is in the range [0..1].","kind":"function","name":"RGBStringToColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The CSS format color string, using the `rgb` or `rgba` format.","name":"rgb"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.RGBStringToColor","scope":"static","___s":true},{"meta":{"filename":"RGBToHSV.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts an RGB color value to HSV (hue, saturation and value).\nConversion formula from http://en.wikipedia.org/wiki/HSL_color_space.\nAssumes RGB values are contained in the set [0, 255] and returns h, s and v in the set [0, 1].\nBased on code by Michael Jackson (https://github.com/mjijackson)","kind":"function","name":"RGBToHSV","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The red color value. A number between 0 and 255.","name":"r"},{"type":{"names":["integer"]},"description":"The green color value. A number between 0 and 255.","name":"g"},{"type":{"names":["integer"]},"description":"The blue color value. A number between 0 and 255.","name":"b"},{"type":{"names":["Phaser.Types.Display.HSVColorObject","Phaser.Display.Color"]},"optional":true,"description":"An object to store the color values in. If not given an HSV Color Object will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Types.Display.HSVColorObject","Phaser.Display.Color"]},"description":"An object with the properties `h`, `s` and `v` set."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.RGBToHSV","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"RGBToString.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"ComponentToHex","longname":"ComponentToHex","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RGBToString.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts the color values into an HTML compatible color string, prefixed with either `#` or `0x`.","kind":"function","name":"RGBToString","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The red color value. A number between 0 and 255.","name":"r"},{"type":{"names":["integer"]},"description":"The green color value. A number between 0 and 255.","name":"g"},{"type":{"names":["integer"]},"description":"The blue color value. A number between 0 and 255.","name":"b"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The alpha value. A number between 0 and 255.","name":"a"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"#","description":"The prefix of the string. Either `#` or `0x`.","name":"prefix"}],"returns":[{"type":{"names":["string"]},"description":"A string-based representation of the color values."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.RGBToString","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"RandomRGB.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Between","longname":"Between","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomRGB.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Creates a new Color object where the r, g, and b values have been set to random values\nbased on the given min max values.","kind":"function","name":"RandomRGB","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The minimum value to set the random range from (between 0 and 255)","name":"min"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The maximum value to set the random range from (between 0 and 255)","name":"max"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.RandomRGB","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"ValueToColor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"HexStringToColor","longname":"HexStringToColor","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ValueToColor.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts the given source color value into an instance of a Color class.\nThe value can be either a string, prefixed with `rgb` or a hex string, a number or an Object.","kind":"function","name":"ValueToColor","since":"3.0.0","params":[{"type":{"names":["string","number","Phaser.Types.Display.InputColorObject"]},"description":"The source color value to convert.","name":"input"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.ValueToColor","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Color","longname":"Color","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display"},"kind":"namespace","name":"Display","memberof":"Phaser","longname":"Phaser.Display","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"BitmapMask.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapMask.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"classdesc":"A Bitmap Mask combines the alpha (opacity) of a masked pixel with the alpha of another pixel.\nUnlike the Geometry Mask, which is a clipping path, a Bitmap Mask behaves like an alpha mask,\nnot a clipping path. It is only available when using the WebGL Renderer.\n\nA Bitmap Mask can use any Game Object to determine the alpha of each pixel of the masked Game Object(s).\nFor any given point of a masked Game Object's texture, the pixel's alpha will be multiplied by the alpha\nof the pixel at the same position in the Bitmap Mask's Game Object. The color of the pixel from the\nBitmap Mask doesn't matter.\n\nFor example, if a pure blue pixel with an alpha of 0.95 is masked with a pure red pixel with an\nalpha of 0.5, the resulting pixel will be pure blue with an alpha of 0.475. Naturally, this means\nthat a pixel in the mask with an alpha of 0 will hide the corresponding pixel in all masked Game Objects\n A pixel with an alpha of 1 in the masked Game Object will receive the same alpha as the\ncorresponding pixel in the mask.\n\nThe Bitmap Mask's location matches the location of its Game Object, not the location of the\nmasked objects. Moving or transforming the underlying Game Object will change the mask\n(and affect the visibility of any masked objects), whereas moving or transforming a masked object\nwill not affect the mask.\n\nThe Bitmap Mask will not render its Game Object by itself. If the Game Object is not in a\nScene's display list, it will only be used for the mask and its full texture will not be directly\nvisible. Adding the underlying Game Object to a Scene will not cause any problems - it will\nrender as a normal Game Object and will also serve as a mask.","kind":"class","name":"BitmapMask","memberof":"Phaser.Display.Masks","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene which this Bitmap Mask will be used in.","name":"scene"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"scope":"static","longname":"Phaser.Display.Masks.BitmapMask","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"A reference to either the Canvas or WebGL Renderer that this Mask is using.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.11.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"bitmapMask","type":{"names":["Phaser.GameObjects.GameObject"]},"since":"3.0.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#bitmapMask","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"The texture used for the mask's framebuffer.","name":"maskTexture","type":{"names":["WebGLTexture"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#maskTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"The texture used for the main framebuffer.","name":"mainTexture","type":{"names":["WebGLTexture"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#mainTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Whether the Bitmap Mask is dirty and needs to be updated.","name":"dirty","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"The framebuffer to which a masked Game Object is rendered.","name":"mainFramebuffer","type":{"names":["WebGLFramebuffer"]},"since":"3.0.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#mainFramebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"The framebuffer to which the Bitmap Mask's masking Game Object is rendered.","name":"maskFramebuffer","type":{"names":["WebGLFramebuffer"]},"since":"3.0.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#maskFramebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"The previous framebuffer set in the renderer before this one was enabled.","name":"prevFramebuffer","type":{"names":["WebGLFramebuffer"]},"since":"3.17.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#prevFramebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Whether to invert the masks alpha.\n\nIf `true`, the alpha of the masking pixel will be inverted before it's multiplied with the masked pixel. Essentially, this means that a masked area will be visible only if the corresponding area in the mask is invisible.","name":"invertAlpha","type":{"names":["boolean"]},"since":"3.1.2","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#invertAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":139,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Is this mask a stencil mask?","name":"isStencil","type":{"names":["boolean"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#isStencil","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Sets a new masking Game Object for the Bitmap Mask.","kind":"function","name":"setBitmap","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#setBitmap","scope":"instance","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":194,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Prepares the WebGL Renderer to render a Game Object with this mask applied.\n\nThis renders the masking Game Object to the mask framebuffer and switches to the main framebuffer so that the masked Game Object will be rendered to it instead of being rendered directly to the frame.","kind":"function","name":"preRenderWebGL","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The WebGL Renderer to prepare.","name":"renderer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The masked Game Object which will be drawn.","name":"maskedObject"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to render to.","name":"camera"}],"memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#preRenderWebGL","scope":"instance","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":211,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Finalizes rendering of a masked Game Object.\n\nThis resets the previously bound framebuffer and switches the WebGL Renderer to the Bitmap Mask Pipeline, which uses a special fragment shader to apply the masking effect.","kind":"function","name":"postRenderWebGL","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The WebGL Renderer to clean up.","name":"renderer"}],"memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#postRenderWebGL","scope":"instance","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":226,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"This is a NOOP method. Bitmap Masks are not supported by the Canvas Renderer.","kind":"function","name":"preRenderCanvas","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The Canvas Renderer which would be rendered to.","name":"renderer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The masked Game Object which would be rendered.","name":"mask"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to render to.","name":"camera"}],"memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#preRenderCanvas","scope":"instance","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"This is a NOOP method. Bitmap Masks are not supported by the Canvas Renderer.","kind":"function","name":"postRenderCanvas","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The Canvas Renderer which would be rendered to.","name":"renderer"}],"memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#postRenderCanvas","scope":"instance","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Destroys this BitmapMask and nulls any references it holds.\n\nNote that if a Game Object is currently using this mask it will _not_ automatically detect you have destroyed it,\nso be sure to call `clearMask` on any Game Object using it, before destroying it.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"GeometryMask.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GeometryMask.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"classdesc":"A Geometry Mask can be applied to a Game Object to hide any pixels of it which don't intersect\na visible pixel from the geometry mask. The mask is essentially a clipping path which can only\nmake a masked pixel fully visible or fully invisible without changing its alpha (opacity).\n\nA Geometry Mask uses a Graphics Game Object to determine which pixels of the masked Game Object(s)\nshould be clipped. For any given point of a masked Game Object's texture, the pixel will only be displayed\nif the Graphics Game Object of the Geometry Mask has a visible pixel at the same position. The color and\nalpha of the pixel from the Geometry Mask do not matter.\n\nThe Geometry Mask's location matches the location of its Graphics object, not the location of the masked objects.\nMoving or transforming the underlying Graphics object will change the mask (and affect the visibility\nof any masked objects), whereas moving or transforming a masked object will not affect the mask.\nYou can think of the Geometry Mask (or rather, of its Graphics object) as an invisible curtain placed\nin front of all masked objects which has its own visual properties and, naturally, respects the camera's\nvisual properties, but isn't affected by and doesn't follow the masked objects by itself.","kind":"class","name":"GeometryMask","memberof":"Phaser.Display.Masks","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"This parameter is not used.","name":"scene"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics Game Object to use for the Geometry Mask. Doesn't have to be in the Display List.","name":"graphicsGeometry"}],"scope":"static","longname":"Phaser.Display.Masks.GeometryMask","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"The Graphics object which describes the Geometry Mask.","name":"geometryMask","type":{"names":["Phaser.GameObjects.Graphics"]},"since":"3.0.0","memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#geometryMask","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Similar to the BitmapMasks invertAlpha setting this to true will then hide all pixels\ndrawn to the Geometry Mask.","name":"invertAlpha","type":{"names":["boolean"]},"since":"3.16.0","memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#invertAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Is this mask a stencil mask?","name":"isStencil","type":{"names":["boolean"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#isStencil","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Sets a new Graphics object for the Geometry Mask.","kind":"function","name":"setShape","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object which will be used for the Geometry Mask.","name":"graphicsGeometry"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#setShape","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Sets the `invertAlpha` property of this Geometry Mask.\nInverting the alpha essentially flips the way the mask works.","kind":"function","name":"setInvertAlpha","since":"3.17.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Invert the alpha of this mask?","name":"value"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#setInvertAlpha","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":118,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Renders the Geometry Mask's underlying Graphics object to the OpenGL stencil buffer and enables the stencil test, which clips rendered pixels according to the mask.","kind":"function","name":"preRenderWebGL","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The WebGL Renderer instance to draw to.","name":"renderer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object being rendered.","name":"child"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera the Game Object is being rendered through.","name":"camera"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#preRenderWebGL","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Applies the current stencil mask to the renderer.","kind":"function","name":"applyStencil","since":"3.17.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The WebGL Renderer instance to draw to.","name":"renderer"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera the Game Object is being rendered through.","name":"camera"},{"type":{"names":["boolean"]},"description":"Is this an INCR stencil or a DECR stencil?","name":"inc"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#applyStencil","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Flushes all rendered pixels and disables the stencil test of a WebGL context, thus disabling the mask for it.","kind":"function","name":"postRenderWebGL","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The WebGL Renderer instance to draw flush.","name":"renderer"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#postRenderWebGL","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Sets the clipping path of a 2D canvas context to the Geometry Mask's underlying Graphics object.","kind":"function","name":"preRenderCanvas","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"The Canvas Renderer instance to set the clipping path on.","name":"renderer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object being rendered.","name":"mask"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera the Game Object is being rendered through.","name":"camera"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#preRenderCanvas","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Restore the canvas context's previous clipping path, thus turning off the mask for it.","kind":"function","name":"postRenderCanvas","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"The Canvas Renderer instance being restored.","name":"renderer"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#postRenderCanvas","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":293,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Destroys this GeometryMask and nulls any references it holds.\n\nNote that if a Game Object is currently using this mask it will _not_ automatically detect you have destroyed it,\nso be sure to call `clearMask` on any Game Object using it, before destroying it.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"kind":"namespace","name":"Masks","memberof":"Phaser.Display","longname":"Phaser.Display.Masks","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"BaseShader.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/shader"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BaseShader.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/shader"},"classdesc":"A BaseShader is a small resource class that contains the data required for a WebGL Shader to be created.\n\nIt contains the raw source code to the fragment and vertex shader, as well as an object that defines\nthe uniforms the shader requires, if any.\n\nBaseShaders are stored in the Shader Cache, available in a Scene via `this.cache.shaders` and are referenced\nby a unique key-based string. Retrieve them via `this.cache.shaders.get(key)`.\n\nBaseShaders are created automatically by the GLSL File Loader when loading an external shader resource.\nThey can also be created at runtime, allowing you to use dynamically generated shader source code.\n\nDefault fragment and vertex source is used if not provided in the constructor, setting-up a basic shader,\nsuitable for debug rendering.","kind":"class","name":"BaseShader","memberof":"Phaser.Display","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of this shader. Must be unique within the shader cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The fragment source for the shader.","name":"fragmentSrc"},{"type":{"names":["string"]},"optional":true,"description":"The vertex source for the shader.","name":"vertexSrc"},{"type":{"names":["any"]},"optional":true,"description":"Optional object defining the uniforms the shader uses.","name":"uniforms"}],"scope":"static","longname":"Phaser.Display.BaseShader","___s":true},{"meta":{"filename":"BaseShader.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/shader"},"description":"The key of this shader, unique within the shader cache of this Phaser game instance.","name":"key","type":{"names":["string"]},"since":"3.17.0","memberof":"Phaser.Display.BaseShader","longname":"Phaser.Display.BaseShader#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseShader.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/shader"},"description":"The source code, as a string, of the fragment shader being used.","name":"fragmentSrc","type":{"names":["string"]},"since":"3.17.0","memberof":"Phaser.Display.BaseShader","longname":"Phaser.Display.BaseShader#fragmentSrc","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseShader.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/shader"},"description":"The source code, as a string, of the vertex shader being used.","name":"vertexSrc","type":{"names":["string"]},"since":"3.17.0","memberof":"Phaser.Display.BaseShader","longname":"Phaser.Display.BaseShader#vertexSrc","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseShader.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/shader"},"description":"The default uniforms for this shader.","name":"uniforms","type":{"names":["any"]},"nullable":true,"since":"3.17.0","memberof":"Phaser.Display.BaseShader","longname":"Phaser.Display.BaseShader#uniforms","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ColorObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/typedefs"},"kind":"typedef","name":"ColorObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The red color value in the range 0 to 255.","name":"r"},{"type":{"names":["number"]},"description":"The green color value in the range 0 to 255.","name":"g"},{"type":{"names":["number"]},"description":"The blue color value in the range 0 to 255.","name":"b"},{"type":{"names":["number"]},"description":"The alpha color value in the range 0 to 255.","name":"a"}],"memberof":"Phaser.Types.Display","longname":"Phaser.Types.Display.ColorObject","scope":"static","___s":true},{"meta":{"filename":"HSVColorObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/typedefs"},"kind":"typedef","name":"HSVColorObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The hue color value. A number between 0 and 1","name":"h"},{"type":{"names":["number"]},"description":"The saturation color value. A number between 0 and 1","name":"s"},{"type":{"names":["number"]},"description":"The lightness color value. A number between 0 and 1","name":"v"}],"memberof":"Phaser.Types.Display","longname":"Phaser.Types.Display.HSVColorObject","scope":"static","___s":true},{"meta":{"filename":"InputColorObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/typedefs"},"kind":"typedef","name":"InputColorObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"The red color value in the range 0 to 255.","name":"r"},{"type":{"names":["number"]},"optional":true,"description":"The green color value in the range 0 to 255.","name":"g"},{"type":{"names":["number"]},"optional":true,"description":"The blue color value in the range 0 to 255.","name":"b"},{"type":{"names":["number"]},"optional":true,"description":"The alpha color value in the range 0 to 255.","name":"a"}],"memberof":"Phaser.Types.Display","longname":"Phaser.Types.Display.InputColorObject","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/typedefs"},"kind":"namespace","name":"Display","memberof":"Phaser.Types","longname":"Phaser.Types.Display","scope":"static","___s":true},{"meta":{"filename":"AddToDOM.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Adds the given element to the DOM. If a parent is provided the element is added as a child of the parent, providing it was able to access it.\nIf no parent was given it falls back to using `document.body`.","kind":"function","name":"AddToDOM","since":"3.0.0","params":[{"type":{"names":["HTMLElement"]},"description":"The element to be added to the DOM. Usually a Canvas object.","name":"element"},{"type":{"names":["string","HTMLElement"]},"optional":true,"description":"The parent in which to add the element. Can be a string which is passed to `getElementById` or an actual DOM object.","name":"parent"}],"returns":[{"type":{"names":["HTMLElement"]},"description":"The element that was added to the DOM."}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.AddToDOM","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"CreateDOMContainer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"name":"AddToDOM","longname":"AddToDOM","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,208],"filename":"DOMContentLoaded.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"name":"OS","longname":"OS","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DOMContentLoaded.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"kind":"typedef","name":"ContentLoadedCallback","type":{"names":["function"]},"longname":"ContentLoadedCallback","scope":"global","___s":true},{"meta":{"filename":"DOMContentLoaded.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Inspects the readyState of the document. If the document is already complete then it invokes the given callback.\nIf not complete it sets up several event listeners such as `deviceready`, and once those fire, it invokes the callback.\nCalled automatically by the Phaser.Game instance. Should not usually be accessed directly.","kind":"function","name":"DOMContentLoaded","since":"3.0.0","params":[{"type":{"names":["ContentLoadedCallback"]},"description":"The callback to be invoked when the device is ready and the DOM content is loaded.","name":"callback"}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.DOMContentLoaded","scope":"static","___s":true},{"meta":{"filename":"GetInnerHeight.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Attempts to determine the document inner height across iOS and standard devices.\nBased on code by @tylerjpeterson","kind":"function","name":"GetInnerHeight","since":"3.16.0","params":[{"type":{"names":["boolean"]},"description":"Is this running on iOS?","name":"iOS"}],"returns":[{"type":{"names":["number"]},"description":"The inner height value."}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.GetInnerHeight","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"GetScreenOrientation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetScreenOrientation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Attempts to determine the screen orientation using the Orientation API.","kind":"function","name":"GetScreenOrientation","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The width of the viewport.","name":"width"},{"type":{"names":["number"]},"description":"The height of the viewport.","name":"height"}],"returns":[{"type":{"names":["string"]},"description":"The orientation."}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.GetScreenOrientation","scope":"static","___s":true},{"meta":{"filename":"GetTarget.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Attempts to get the target DOM element based on the given value, which can be either\na string, in which case it will be looked-up by ID, or an element node. If nothing\ncan be found it will return a reference to the document.body.","kind":"function","name":"GetTarget","since":"3.16.0","params":[{"type":{"names":["HTMLElement"]},"description":"The DOM element to look-up.","name":"element"}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.GetTarget","scope":"static","___s":true},{"meta":{"filename":"ParseXML.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Takes the given data string and parses it as XML.\nFirst tries to use the window.DOMParser and reverts to the Microsoft.XMLDOM if that fails.\nThe parsed XML object is returned, or `null` if there was an error while parsing the data.","kind":"function","name":"ParseXML","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The XML source stored in a string.","name":"data"}],"returns":[{"type":{"names":["DOMParser","ActiveXObject"]},"nullable":true,"description":"The parsed XML data, or `null` if the data could not be parsed."}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.ParseXML","scope":"static","___s":true},{"meta":{"filename":"RemoveFromDOM.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Attempts to remove the element from its parentNode in the DOM.","kind":"function","name":"RemoveFromDOM","since":"3.0.0","params":[{"type":{"names":["HTMLElement"]},"description":"The DOM element to remove from its parent node.","name":"element"}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.RemoveFromDOM","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"RequestAnimationFrame.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"classdesc":"Abstracts away the use of RAF or setTimeOut for the core game update loop.\nThis is invoked automatically by the Phaser.Game instance.","kind":"class","name":"RequestAnimationFrame","memberof":"Phaser.DOM","since":"3.0.0","scope":"static","longname":"Phaser.DOM.RequestAnimationFrame","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":26,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"True if RequestAnimationFrame is running, otherwise false.","name":"isRunning","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The callback to be invoked each step.","name":"callback","type":{"names":["FrameRequestCallback"]},"since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#callback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The most recent timestamp. Either a DOMHighResTimeStamp under RAF or `Date.now` under SetTimeout.","name":"tick","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#tick","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"True if the step is using setTimeout instead of RAF.","name":"isSetTimeOut","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#isSetTimeOut","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The setTimeout or RAF callback ID used when canceling them.","name":"timeOutID","type":{"names":["number"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#timeOutID","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The previous time the step was called.","name":"lastTime","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#lastTime","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":85,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The target FPS rate in ms.\nOnly used when setTimeout is used instead of RAF.","name":"target","type":{"names":["number"]},"defaultvalue":"0","since":"3.21.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#target","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The RAF step function.\nUpdates the local tick value, invokes the callback and schedules another call to requestAnimationFrame.","name":"step","type":{"names":["FrameRequestCallback"]},"since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#step","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The SetTimeout step function.\nUpdates the local tick value, invokes the callback and schedules another call to setTimeout.","name":"stepTimeout","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#stepTimeout","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Starts the requestAnimationFrame or setTimeout process running.","kind":"function","name":"start","since":"3.0.0","params":[{"type":{"names":["FrameRequestCallback"]},"description":"The callback to invoke each step.","name":"callback"},{"type":{"names":["boolean"]},"description":"Should it use SetTimeout, even if RAF is available?","name":"forceSetTimeOut"},{"type":{"names":["number"]},"description":"The target fps rate (in ms). Only used when setTimeout is used.","name":"targetFPS"}],"memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#start","scope":"instance","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Stops the requestAnimationFrame or setTimeout from running.","kind":"function","name":"stop","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#stop","scope":"instance","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":193,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Stops the step from running and clears the callback reference.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"kind":"namespace","name":"DOM","memberof":"Phaser","longname":"Phaser.DOM","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"EventEmitter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"classdesc":"EventEmitter is a Scene Systems plugin compatible version of eventemitter3.","kind":"class","name":"EventEmitter","memberof":"Phaser.Events","since":"3.0.0","scope":"static","longname":"Phaser.Events.EventEmitter","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#shutdown","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":42,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#destroy","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#eventNames","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#listeners","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#listenerCount","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#emit","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"`this`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#on","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"`this`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#addListener","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"`this`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#once","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"`this`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#removeListener","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"`this`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#off","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"`this`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#removeAllListeners","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"kind":"namespace","name":"Events","memberof":"Phaser","longname":"Phaser.Events","scope":"static","___s":true},{"meta":{"range":[180,226],"filename":"BuildGameObject.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"BlendModes","longname":"BlendModes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BuildGameObject.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Builds a Game Object using the provided configuration object.","kind":"function","name":"BuildGameObject","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene.","name":"scene"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The initial GameObject.","name":"gameObject"},{"type":{"names":["Phaser.Types.GameObjects.GameObjectConfig"]},"description":"The config to build the GameObject with.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The built Game Object."}],"memberof":"Phaser.GameObjects","longname":"Phaser.GameObjects.BuildGameObject","scope":"static","___s":true},{"meta":{"range":[180,242],"filename":"BuildGameObjectAnimation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"GetAdvancedValue","longname":"GetAdvancedValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BuildGameObjectAnimation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds an Animation component to a Sprite and populates it based on the given config.","kind":"function","name":"BuildGameObjectAnimation","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"The sprite to add an Animation component to.","name":"sprite"},{"type":{"names":["object"]},"description":"The animation config.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"The updated Sprite."}],"memberof":"Phaser.GameObjects","longname":"Phaser.GameObjects.BuildGameObjectAnimation","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"DisplayList.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DisplayList.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"classdesc":"The Display List plugin.\n\nDisplay Lists belong to a Scene and maintain the list of Game Objects to render every frame.\n\nSome of these Game Objects may also be part of the Scene's [Update List]{@link Phaser.GameObjects.UpdateList}, for updating.","kind":"class","name":"DisplayList","augments":["Phaser.Structs.List."],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that this Display List belongs to.","name":"scene"}],"scope":"static","longname":"Phaser.GameObjects.DisplayList","___s":true},{"meta":{"filename":"DisplayList.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flag the determines whether Game Objects should be sorted when `depthSort()` is called.","name":"sortChildrenFlag","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#sortChildrenFlag","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DisplayList.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Scene that this Display List belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DisplayList.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Scene's Systems.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DisplayList.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Force a sort of the display list on the next call to depthSort.","kind":"function","name":"queueDepthSort","since":"3.0.0","memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#queueDepthSort","scope":"instance","___s":true},{"meta":{"filename":"DisplayList.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Immediately sorts the display list if the flag is set.","kind":"function","name":"depthSort","since":"3.0.0","memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#depthSort","scope":"instance","___s":true},{"meta":{"filename":"DisplayList.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compare the depth of two Game Objects.","kind":"function","name":"sortByDepth","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first Game Object.","name":"childA"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The second Game Object.","name":"childB"}],"returns":[{"type":{"names":["integer"]},"description":"The difference between the depths of each Game Object."}],"memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#sortByDepth","scope":"instance","___s":true},{"meta":{"filename":"DisplayList.js","lineno":141,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array which contains all objects currently on the Display List.\nThis is a reference to the main list array, not a copy of it, so be careful not to modify it.","kind":"function","name":"getChildren","since":"3.12.0","returns":[{"type":{"names":["Array."]},"description":"The group members."}],"memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#getChildren","scope":"instance","___s":true},{"meta":{"range":[180,213],"filename":"GameObject.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GameObject.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"classdesc":"The base class that all Game Objects extend.\nYou don't create GameObjects directly and they cannot be added to the display list.\nInstead, use them as the base for your own custom classes.","kind":"class","name":"GameObject","memberof":"Phaser.GameObjects","augments":["Phaser.Events.EventEmitter"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs.","name":"scene"},{"type":{"names":["string"]},"description":"A textual representation of the type of Game Object, i.e. `sprite`.","name":"type"}],"scope":"static","longname":"Phaser.GameObjects.GameObject","___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#state","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#parentContainer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#tabIndex","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#renderFlags","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#cameraFilter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#input","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#body","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#ignoreDestroy","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#setActive","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#setName","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#setState","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#setDataEnabled","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#setData","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#getData","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#setInteractive","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#disableInteractive","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#removeInteractive","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#update","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#toJSON","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#willRender","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#getIndexList","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"GameObject.js","lineno":626,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The bitmask that `GameObject.renderFlags` is compared against to determine if the Game Object will render or not.","kind":"constant","name":"RENDER_MASK","type":{"names":["integer"]},"memberof":"Phaser.GameObjects.GameObject","scope":"static","longname":"Phaser.GameObjects.GameObject.RENDER_MASK","___s":true},{"meta":{"range":[180,213],"filename":"GameObjectCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GameObjectCreator.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"classdesc":"The Game Object Creator is a Scene plugin that allows you to quickly create many common\ntypes of Game Objects and return them. Unlike the Game Object Factory, they are not automatically\nadded to the Scene.\n\nGame Objects directly register themselves with the Creator and inject their own creation\nmethods into the class.","kind":"class","name":"GameObjectCreator","memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object Factory belongs.","name":"scene"}],"scope":"static","longname":"Phaser.GameObjects.GameObjectCreator","___s":true},{"meta":{"range":[180,213],"filename":"GameObjectFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GameObjectFactory.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"classdesc":"The Game Object Factory is a Scene plugin that allows you to quickly create many common\ntypes of Game Objects and have them automatically registered with the Scene.\n\nGame Objects directly register themselves with the Factory and inject their own creation\nmethods into the class.","kind":"class","name":"GameObjectFactory","memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object Factory belongs.","name":"scene"}],"scope":"static","longname":"Phaser.GameObjects.GameObjectFactory","___s":true},{"meta":{"filename":"GameObjectFactory.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds an existing Game Object to this Scene.\n\nIf the Game Object renders, it will be added to the Display List.\nIf it has a `preUpdate` method, it will be added to the Update List.","kind":"function","name":"existing","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Group"]},"description":"The child to be added to this Scene.","name":"child"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was added."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#existing","scope":"instance","___s":true},{"meta":{"filename":"GameObjectFactory.js","lineno":170,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Static method called directly by the Game Object factory functions.\nWith this method you can register a custom GameObject factory in the GameObjectFactory,\nproviding a name (`factoryType`) and the constructor (`factoryFunction`) in order\nto be called when you call to Phaser.Scene.add[ factoryType ] method.","kind":"function","name":"register","scope":"static","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the factory that you will use to call to Phaser.Scene.add[ factoryType ] method.","name":"factoryType"},{"type":{"names":["function"]},"description":"The constructor function to be called when you invoke to the Phaser.Scene.add method.","name":"factoryFunction"}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory.register","___s":true},{"meta":{"filename":"GameObjectFactory.js","lineno":191,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Static method called directly by the Game Object factory functions.\nWith this method you can remove a custom GameObject factory registered in the GameObjectFactory,\nproviding a its `factoryType`.","kind":"function","name":"remove","scope":"static","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the factory that you want to remove from the GameObjectFactory.","name":"factoryType"}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory.remove","___s":true},{"meta":{"range":[180,213],"filename":"UpdateList.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"UpdateList.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"classdesc":"The Update List plugin.\n\nUpdate Lists belong to a Scene and maintain the list Game Objects to be updated every frame.\n\nSome or all of these Game Objects may also be part of the Scene's [Display List]{@link Phaser.GameObjects.DisplayList}, for Rendering.","kind":"class","name":"UpdateList","augments":["Phaser.Structs.ProcessQueue."],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that the Update List belongs to.","name":"scene"}],"scope":"static","longname":"Phaser.GameObjects.UpdateList","___s":true},{"meta":{"filename":"UpdateList.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Scene that the Update List belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.GameObjects.UpdateList","longname":"Phaser.GameObjects.UpdateList#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"UpdateList.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Scene's Systems.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.GameObjects.UpdateList","longname":"Phaser.GameObjects.UpdateList#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"UpdateList.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The update step.\n\nPre-updates every active Game Object in the list.","kind":"function","name":"sceneUpdate","since":"3.20.0","params":[{"type":{"names":["number"]},"description":"The current timestamp.","name":"time"},{"type":{"names":["number"]},"description":"The delta time elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.GameObjects.UpdateList","longname":"Phaser.GameObjects.UpdateList#sceneUpdate","scope":"instance","___s":true},{"meta":{"filename":"UpdateList.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Scene that owns this plugin is shutting down.\n\nWe need to kill and reset all internal properties as well as stop listening to Scene events.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.UpdateList","longname":"Phaser.GameObjects.UpdateList#shutdown","scope":"instance","___s":true},{"meta":{"filename":"UpdateList.js","lineno":204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Scene that owns this plugin is being destroyed.\n\nWe need to shutdown and then kill off all external references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.GameObjects.UpdateList","longname":"Phaser.GameObjects.UpdateList#destroy","scope":"instance","___s":true},{"meta":{"range":[180,232],"filename":"ParseFromAtlas.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"name":"ParseXMLBitmapFont","longname":"ParseXMLBitmapFont","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,229],"filename":"ParseRetroFont.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"name":"GetValue","longname":"GetValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseRetroFont.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Parses a Retro Font configuration object so you can pass it to the BitmapText constructor\nand create a BitmapText object using a fixed-width retro font.","kind":"function","name":"Parse","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Phaser Scene.","name":"scene"},{"type":{"names":["Phaser.Types.GameObjects.BitmapText.RetroFontConfig"]},"description":"The font configuration object.","name":"config"}],"returns":[{"type":{"names":["object"]},"description":"A parsed Bitmap Font data entry for the Bitmap Font cache."}],"memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.Parse","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"RetroFont.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"name":"RETRO_FONT_CONST","longname":"RETRO_FONT_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RetroFont.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"kind":"namespace","name":"RetroFont","since":"3.6.0","memberof":"Phaser.GameObjects","longname":"Phaser.GameObjects.RetroFont","scope":"static","___s":true},{"meta":{"range":[180,3027],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"name":"RETRO_FONT_CONST","longname":"RETRO_FONT_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 1 = !\\\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\\\]^_`abcdefghijklmnopqrstuvwxyz{|}~","name":"TEXT_SET1","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET1","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 2 = !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ","name":"TEXT_SET2","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET2","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 3 = ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789","name":"TEXT_SET3","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET3","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 4 = ABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789","name":"TEXT_SET4","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET4","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 5 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,/() '!?-*:0123456789","name":"TEXT_SET5","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET5","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 6 = ABCDEFGHIJKLMNOPQRSTUVWXYZ!?:;0123456789\"(),-.'","name":"TEXT_SET6","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET6","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 7 = AGMSY+:4BHNTZ!;5CIOU.?06DJPV,(17EKQW\")28FLRX-'39","name":"TEXT_SET7","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET7","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 8 = 0123456789 .ABCDEFGHIJKLMNOPQRSTUVWXYZ","name":"TEXT_SET8","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET8","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 9 = ABCDEFGHIJKLMNOPQRSTUVWXYZ()-0123456789.:,'\"?!","name":"TEXT_SET9","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET9","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 10 = ABCDEFGHIJKLMNOPQRSTUVWXYZ","name":"TEXT_SET10","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET10","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":99,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 11 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,\"-+!?()':;0123456789","name":"TEXT_SET11","since":"3.6.0","type":{"names":["string"]},"memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET11","scope":"static","kind":"member","___s":true},{"meta":{"range":[180,224],"filename":"DynamicBitmapText.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"name":"BitmapText","longname":"BitmapText","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"classdesc":"BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\n\nDuring rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to\nmatch the font structure.\n\nDynamic Bitmap Text objects are different from Static Bitmap Text in that they invoke a callback for each\nletter being rendered during the render pass. This callback allows you to manipulate the properties of\neach letter being rendered, such as its position, scale or tint, allowing you to create interesting effects\nlike jiggling text, which can't be done with Static text. This means that Dynamic Text takes more processing\ntime, so only use them if you require the callback ability they have.\n\nBitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\nto use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\nprocessing the font texture in an image editor, applying fills and any other effects required.\n\nTo create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\n\nTo create a BitmapText data files you need a 3rd party app such as:\n\nBMFont (Windows, free): http://www.angelcode.com/products/bmfont/\nGlyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner\nLittera (Web-based, free): http://kvazars.com/littera/\n\nFor most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\nconverting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: http://codebeautify.org/xmltojson","kind":"class","name":"DynamicBitmapText","augments":["Phaser.GameObjects.BitmapText"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. It can only belong to one Scene at any given time.","name":"scene"},{"type":{"names":["number"]},"description":"The x coordinate of this Game Object in world space.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of this Game Object in world space.","name":"y"},{"type":{"names":["string"]},"description":"The key of the font to use from the Bitmap Font cache.","name":"font"},{"type":{"names":["string","Array."]},"optional":true,"description":"The string, or array of strings, to be set as the content of this Bitmap Text.","name":"text"},{"type":{"names":["number"]},"optional":true,"description":"The font size of this Bitmap Text.","name":"size"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The alignment of the text in a multi-line BitmapText object.","name":"align"}],"scope":"static","longname":"Phaser.GameObjects.DynamicBitmapText","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"The horizontal scroll position of the Bitmap Text.","name":"scrollX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scrollX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"The vertical scroll position of the Bitmap Text.","name":"scrollY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scrollY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"The crop width of the Bitmap Text.","name":"cropWidth","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#cropWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"The crop height of the Bitmap Text.","name":"cropHeight","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#cropHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":109,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"A callback that alters how each character of the Bitmap Text is rendered.","name":"displayCallback","type":{"names":["Phaser.Types.GameObjects.BitmapText.DisplayCallback"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#displayCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"The data object that is populated during rendering, then passed to the displayCallback.\nYou should modify this object then return it back from the callback. It's updated values\nwill be used to render the specific glyph.\n\nPlease note that if you need a reference to this object locally in your game code then you\nshould shallow copy it, as it's updated and re-used for every glyph in the text.","name":"callbackData","type":{"names":["Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig"]},"since":"3.11.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#callbackData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"Set the crop size of this Bitmap Text.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the crop.","name":"width"},{"type":{"names":["number"]},"description":"The height of the crop.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setSize","scope":"instance","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":168,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"Set a callback that alters how each character of the Bitmap Text is rendered.\n\nThe callback receives a {@link Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig} object that contains information about the character that's\nabout to be rendered.\n\nIt should return an object with `x`, `y`, `scale` and `rotation` properties that will be used instead of the\nusual values when rendering.","kind":"function","name":"setDisplayCallback","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.DisplayCallback"]},"description":"The display callback to set.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setDisplayCallback","scope":"instance","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"Set the horizontal scroll position of this Bitmap Text.","kind":"function","name":"setScrollX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll position to set.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setScrollX","scope":"instance","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"Set the vertical scroll position of this Bitmap Text.","kind":"function","name":"setScrollY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical scroll position to set.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setScrollY","scope":"instance","___s":true},{"meta":{"range":[180,249],"filename":"DynamicBitmapTextCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"name":"SetTransform","longname":"SetTransform","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"DynamicBitmapTextCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"name":"BitmapText","longname":"BitmapText","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DynamicBitmapTextCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"Creates a new Dynamic Bitmap Text Game Object and returns it.\n\nNote: This method will only be available if the Dynamic Bitmap Text Game Object has been built into Phaser.","kind":"function","name":"dynamicBitmapText","since":"3.0.0\n²","params":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapTextConfig"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#dynamicBitmapText","scope":"instance","___s":true},{"meta":{"range":[180,230],"filename":"DynamicBitmapTextFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"name":"DynamicBitmapText","longname":"DynamicBitmapText","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DynamicBitmapTextFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"Creates a new Dynamic Bitmap Text Game Object and adds it to the Scene.\n\nBitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\n\nDuring rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to\nmatch the font structure.\n\nDynamic Bitmap Text objects are different from Static Bitmap Text in that they invoke a callback for each\nletter being rendered during the render pass. This callback allows you to manipulate the properties of\neach letter being rendered, such as its position, scale or tint, allowing you to create interesting effects\nlike jiggling text, which can't be done with Static text. This means that Dynamic Text takes more processing\ntime, so only use them if you require the callback ability they have.\n\nBitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\nto use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\nprocessing the font texture in an image editor, applying fills and any other effects required.\n\nTo create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\n\nTo create a BitmapText data files you need a 3rd party app such as:\n\nBMFont (Windows, free): http://www.angelcode.com/products/bmfont/\nGlyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner\nLittera (Web-based, free): http://kvazars.com/littera/\n\nFor most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\nconverting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: http://codebeautify.org/xmltojson\n\nNote: This method will only be available if the Dynamic Bitmap Text Game Object has been built into Phaser.","kind":"function","name":"dynamicBitmapText","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the Game Object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Game Object.","name":"y"},{"type":{"names":["string"]},"description":"The key of the font to use from the BitmapFont cache.","name":"font"},{"type":{"names":["string","Array."]},"optional":true,"description":"The string, or array of strings, to be set as the content of this Bitmap Text.","name":"text"},{"type":{"names":["number"]},"optional":true,"description":"The font size to set.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#dynamicBitmapText","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"DynamicBitmapTextRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"DynamicBitmapTextWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"BitmapText.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapText.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"classdesc":"BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\n\nDuring rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to\nmatch the font structure.\n\nBitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\nto use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\nprocessing the font texture in an image editor, applying fills and any other effects required.\n\nTo create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\n\nTo create a BitmapText data files you need a 3rd party app such as:\n\nBMFont (Windows, free): {@link http://www.angelcode.com/products/bmfont/|http://www.angelcode.com/products/bmfont/}\nGlyph Designer (OS X, commercial): {@link http://www.71squared.com/en/glyphdesigner|http://www.71squared.com/en/glyphdesigner}\nLittera (Web-based, free): {@link http://kvazars.com/littera/|http://kvazars.com/littera/}\n\nFor most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\nconverting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: {@link http://codebeautify.org/xmltojson|http://codebeautify.org/xmltojson}","kind":"class","name":"BitmapText","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. It can only belong to one Scene at any given time.","name":"scene"},{"type":{"names":["number"]},"description":"The x coordinate of this Game Object in world space.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of this Game Object in world space.","name":"y"},{"type":{"names":["string"]},"description":"The key of the font to use from the Bitmap Font cache.","name":"font"},{"type":{"names":["string","Array."]},"optional":true,"description":"The string, or array of strings, to be set as the content of this Bitmap Text.","name":"text"},{"type":{"names":["number"]},"optional":true,"description":"The font size of this Bitmap Text.","name":"size"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The alignment of the text in a multi-line BitmapText object.","name":"align"}],"scope":"static","longname":"Phaser.GameObjects.BitmapText","___s":true},{"meta":{"filename":"BitmapText.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The key of the Bitmap Font used by this Bitmap Text.\nTo change the font after creation please use `setFont`.","name":"font","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#font","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The data of the Bitmap Font used by this Bitmap Text.","name":"fontData","type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapFontData"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#fontData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The character code used to detect for word wrapping.\nDefaults to 32 (a space character).","name":"wordWrapCharCode","type":{"names":["number"]},"since":"3.21.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#wordWrapCharCode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":214,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the lines of text in this BitmapText to be left-aligned.\nThis only has any effect if this BitmapText contains more than one line of text.","kind":"function","name":"setLeftAlign","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setLeftAlign","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":232,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the lines of text in this BitmapText to be center-aligned.\nThis only has any effect if this BitmapText contains more than one line of text.","kind":"function","name":"setCenterAlign","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setCenterAlign","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":250,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the lines of text in this BitmapText to be right-aligned.\nThis only has any effect if this BitmapText contains more than one line of text.","kind":"function","name":"setRightAlign","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setRightAlign","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the font size of this Bitmap Text.","kind":"function","name":"setFontSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The font size to set.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setFontSize","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Sets the letter spacing between each character of this Bitmap Text.\nCan be a positive value to increase the space, or negative to reduce it.\nSpacing is applied after the kerning values have been set.","kind":"function","name":"setLetterSpacing","since":"3.4.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The amount of horizontal space to add between each character.","name":"spacing"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setLetterSpacing","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the textual content of this BitmapText.\n\nAn array of strings will be converted into multi-line text. Use the align methods to change multi-line alignment.","kind":"function","name":"setText","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The string, or array of strings, to be set as the content of this BitmapText.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setText","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":346,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Calculate the bounds of this Bitmap Text.\n\nAn object is returned that contains the position, width and height of the Bitmap Text in local and global\ncontexts.\n\nLocal size is based on just the font size and a [0, 0] position.\n\nGlobal size takes into account the Game Object's scale, world position and display origin.\n\nAlso in the object is data regarding the length of each line, should this be a multi-line BitmapText.","kind":"function","name":"getTextBounds","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"description":"Whether to round the results to the nearest integer.","name":"round"}],"returns":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapTextSize"]},"description":"An object that describes the size of this Bitmap Text."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getTextBounds","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Changes the font this BitmapText is using to render.\n\nThe new texture is loaded and applied to the BitmapText. The existing test, size and alignment are preserved,\nunless overridden via the arguments.","kind":"function","name":"setFont","since":"3.11.0","params":[{"type":{"names":["string"]},"description":"The key of the font to use from the Bitmap Font cache.","name":"font"},{"type":{"names":["number"]},"optional":true,"description":"The font size of this Bitmap Text. If not specified the current size will be used.","name":"size"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The alignment of the text in a multi-line BitmapText object. If not specified the current alignment will be used.","name":"align"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setFont","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Sets the maximum display width of this BitmapText in pixels.\n\nIf `BitmapText.text` is longer than `maxWidth` then the lines will be automatically wrapped\nbased on the previous whitespace character found in the line.\n\nIf no whitespace was found then no wrapping will take place and consequently the `maxWidth` value will not be honored.\n\nDisable maxWidth by setting the value to 0.\n\nYou can set the whitespace character to be searched for by setting the `wordWrapCharCode` parameter or property.","kind":"function","name":"setMaxWidth","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The maximum display width of this BitmapText in pixels. Set to zero to disable.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"The character code to check for when word wrapping. Defaults to 32 (the space character).","name":"wordWrapCharCode"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setMaxWidth","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":459,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Controls the alignment of each line of text in this BitmapText object.\n\nOnly has any effect when this BitmapText contains multiple lines of text, split with carriage-returns.\nHas no effect with single-lines of text.\n\nSee the methods `setLeftAlign`, `setCenterAlign` and `setRightAlign`.\n\n0 = Left aligned (default)\n1 = Middle aligned\n2 = Right aligned\n\nThe alignment position is based on the longest line of text.","name":"align","type":{"names":["integer"]},"since":"3.11.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#align","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":492,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The text that this Bitmap Text object displays.\n\nYou can also use the method `setText` if you want a chainable way to change the text content.","name":"text","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#text","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":515,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The font size of this Bitmap Text.\n\nYou can also use the method `setFontSize` if you want a chainable way to change the font size.","name":"fontSize","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#fontSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":539,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Adds / Removes spacing between characters.\n\nCan be a negative or positive number.\n\nYou can also use the method `setLetterSpacing` if you want a chainable way to change the letter spacing.","name":"letterSpacing","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#letterSpacing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":565,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The maximum display width of this BitmapText in pixels.\n\nIf BitmapText.text is longer than maxWidth then the lines will be automatically wrapped\nbased on the last whitespace character found in the line.\n\nIf no whitespace was found then no wrapping will take place and consequently the maxWidth value will not be honored.\n\nDisable maxWidth by setting the value to 0.","name":"maxWidth","type":{"names":["number"]},"since":"3.21.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#maxWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":594,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The width of this Bitmap Text.","name":"width","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":613,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The height of this bitmap text.","name":"height","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Build a JSON representation of this Bitmap Text.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.JSONBitmapText"]},"description":"A JSON representation of this Bitmap Text."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#toJSON","scope":"instance","overrides":"Phaser.GameObjects.GameObject#toJSON","___s":true},{"meta":{"filename":"BitmapText.js","lineno":661,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Left align the text characters in a multi-line BitmapText object.","name":"ALIGN_LEFT","type":{"names":["integer"]},"since":"3.11.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText.ALIGN_LEFT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":670,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Center align the text characters in a multi-line BitmapText object.","name":"ALIGN_CENTER","type":{"names":["integer"]},"since":"3.11.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText.ALIGN_CENTER","scope":"static","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":679,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Right align the text characters in a multi-line BitmapText object.","name":"ALIGN_RIGHT","type":{"names":["integer"]},"since":"3.11.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText.ALIGN_RIGHT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":688,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Parse an XML Bitmap Font from an Atlas.\n\nAdds the parsed Bitmap Font data to the cache with the `fontName` key.","kind":"function","name":"ParseFromAtlas","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to parse the Bitmap Font for.","name":"scene"},{"type":{"names":["string"]},"description":"The key of the font to add to the Bitmap Font cache.","name":"fontName"},{"type":{"names":["string"]},"description":"The key of the BitmapFont's texture.","name":"textureKey"},{"type":{"names":["string"]},"description":"The key of the BitmapFont texture's frame.","name":"frameKey"},{"type":{"names":["string"]},"description":"The key of the XML data of the font to parse.","name":"xmlKey"},{"type":{"names":["integer"]},"optional":true,"description":"The x-axis spacing to add between each letter.","name":"xSpacing"},{"type":{"names":["integer"]},"optional":true,"description":"The y-axis spacing to add to the line height.","name":"ySpacing"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the parsing was successful or not."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText.ParseFromAtlas","scope":"static","___s":true},{"meta":{"filename":"BitmapText.js","lineno":708,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Parse an XML font to Bitmap Font data for the Bitmap Font cache.","kind":"function","name":"ParseXMLBitmapFont","since":"3.17.0","params":[{"type":{"names":["XMLDocument"]},"description":"The XML Document to parse the font from.","name":"xml"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x-axis spacing to add between each letter.","name":"xSpacing"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y-axis spacing to add to the line height.","name":"ySpacing"},{"type":{"names":["Phaser.Textures.Frame"]},"optional":true,"description":"The texture frame to take into account while parsing.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapFontData"]},"description":"The parsed Bitmap Font data."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText.ParseXMLBitmapFont","scope":"static","___s":true},{"meta":{"range":[180,249],"filename":"BitmapTextCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"name":"SetTransform","longname":"SetTransform","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"BitmapTextCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"name":"BitmapText","longname":"BitmapText","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapTextCreator.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Creates a new Bitmap Text Game Object and returns it.\n\nNote: This method will only be available if the Bitmap Text Game Object has been built into Phaser.","kind":"function","name":"bitmapText","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapTextConfig"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#bitmapText","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"BitmapTextFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"name":"BitmapText","longname":"BitmapText","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapTextFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Creates a new Bitmap Text Game Object and adds it to the Scene.\n\nBitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\n\nDuring rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to\nmatch the font structure.\n\nBitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\nto use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\nprocessing the font texture in an image editor, applying fills and any other effects required.\n\nTo create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\n\nTo create a BitmapText data files you need a 3rd party app such as:\n\nBMFont (Windows, free): http://www.angelcode.com/products/bmfont/\nGlyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner\nLittera (Web-based, free): http://kvazars.com/littera/\n\nFor most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\nconverting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: http://codebeautify.org/xmltojson\n\nNote: This method will only be available if the Bitmap Text Game Object has been built into Phaser.","kind":"function","name":"bitmapText","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the Game Object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Game Object.","name":"y"},{"type":{"names":["string"]},"description":"The key of the font to use from the BitmapFont cache.","name":"font"},{"type":{"names":["string","Array."]},"optional":true,"description":"The string, or array of strings, to be set as the content of this Bitmap Text.","name":"text"},{"type":{"names":["number"]},"optional":true,"description":"The font size to set.","name":"size"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The alignment of the text in a multi-line BitmapText object.","name":"align"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#bitmapText","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"BitmapTextRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"BitmapTextWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapFontCharacterData.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"description":"The font data for an individual character of a Bitmap Font.\n\nDescribes the character's position, size, offset and kerning.","kind":"typedef","name":"BitmapFontCharacterData","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The x position of the character.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the character.","name":"y"},{"type":{"names":["number"]},"description":"The width of the character.","name":"width"},{"type":{"names":["number"]},"description":"The height of the character.","name":"height"},{"type":{"names":["number"]},"description":"The center x position of the character.","name":"centerX"},{"type":{"names":["number"]},"description":"The center y position of the character.","name":"centerY"},{"type":{"names":["number"]},"description":"The x offset of the character.","name":"xOffset"},{"type":{"names":["number"]},"description":"The y offset of the character.","name":"yOffset"},{"type":{"names":["object"]},"description":"Extra data for the character.","name":"data"},{"type":{"names":["Object."]},"description":"Kerning values, keyed by character code.","name":"kerning"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData","scope":"static","___s":true},{"meta":{"filename":"BitmapFontData.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"description":"Bitmap Font data that can be used by a BitmapText Game Object.","kind":"typedef","name":"BitmapFontData","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The name of the font.","name":"font"},{"type":{"names":["number"]},"description":"The size of the font.","name":"size"},{"type":{"names":["number"]},"description":"The line height of the font.","name":"lineHeight"},{"type":{"names":["boolean"]},"description":"Whether this font is a retro font (monospace).","name":"retroFont"},{"type":{"names":["Object."]},"description":"The character data of the font, keyed by character code. Each character datum includes a position, size, offset and more.","name":"chars"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.BitmapFontData","scope":"static","___s":true},{"meta":{"filename":"BitmapTextConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"BitmapTextConfig","type":{"names":["object"]},"augments":["Phaser.Types.GameObjects.GameObjectConfig"],"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The key of the font to use from the BitmapFont cache.","name":"font"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The string, or array of strings, to be set as the content of this Bitmap Text.","name":"text"},{"type":{"names":["number","false"]},"optional":true,"defaultvalue":false,"description":"The font size to set.","name":"size"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.BitmapTextConfig","scope":"static","___s":true},{"meta":{"filename":"BitmapTextSize.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"BitmapTextSize","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.GlobalBitmapTextSize"]},"description":"The position and size of the BitmapText, taking into account the position and scale of the Game Object.","name":"global"},{"type":{"names":["Phaser.Types.GameObjects.BitmapText.LocalBitmapTextSize"]},"description":"The position and size of the BitmapText, taking just the font size into account.","name":"local"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.BitmapTextSize","scope":"static","___s":true},{"meta":{"filename":"DisplayCallbackConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"DisplayCallbackConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"The Dynamic Bitmap Text object that owns this character being rendered.","name":"parent"},{"type":{"names":["Phaser.Types.GameObjects.BitmapText.TintConfig"]},"description":"The tint of the character being rendered. Always zero in Canvas.","name":"tint"},{"type":{"names":["number"]},"description":"The index of the character being rendered.","name":"index"},{"type":{"names":["number"]},"description":"The character code of the character being rendered.","name":"charCode"},{"type":{"names":["number"]},"description":"The x position of the character being rendered.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the character being rendered.","name":"y"},{"type":{"names":["number"]},"description":"The scale of the character being rendered.","name":"scale"},{"type":{"names":["number"]},"description":"The rotation of the character being rendered.","name":"rotation"},{"type":{"names":["any"]},"description":"Custom data stored with the character being rendered.","name":"data"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig","scope":"static","___s":true},{"meta":{"filename":"DisplayCallbackConfig.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"DisplayCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig"]},"description":"Settings of the character that is about to be rendered.","name":"display"}],"returns":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig"]},"description":"Altered position, scale and rotation values for the character that is about to be rendered."}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.DisplayCallback","scope":"static","___s":true},{"meta":{"filename":"GlobalBitmapTextSize.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"description":"The position and size of the Bitmap Text in global space, taking into account the Game Object's scale and world position.","kind":"typedef","name":"GlobalBitmapTextSize","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The x position of the BitmapText, taking into account the x position and scale of the Game Object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the BitmapText, taking into account the y position and scale of the Game Object.","name":"y"},{"type":{"names":["number"]},"description":"The width of the BitmapText, taking into account the x scale of the Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of the BitmapText, taking into account the y scale of the Game Object.","name":"height"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.GlobalBitmapTextSize","scope":"static","___s":true},{"meta":{"filename":"JSONBitmapText.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"JSONBitmapText","type":{"names":["object"]},"augments":["Phaser.Types.GameObjects.JSONGameObject"],"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The name of the font.","name":"font"},{"type":{"names":["string"]},"description":"The text that this Bitmap Text displays.","name":"text"},{"type":{"names":["number"]},"description":"The size of the font.","name":"fontSize"},{"type":{"names":["number"]},"description":"Adds / Removes spacing between characters.","name":"letterSpacing"},{"type":{"names":["integer"]},"description":"The alignment of the text in a multi-line BitmapText object.","name":"align"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.JSONBitmapText","scope":"static","___s":true},{"meta":{"filename":"LocalBitmapTextSize.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"description":"The position and size of the Bitmap Text in local space, taking just the font size into account.","kind":"typedef","name":"LocalBitmapTextSize","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The x position of the BitmapText.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the BitmapText.","name":"y"},{"type":{"names":["number"]},"description":"The width of the BitmapText.","name":"width"},{"type":{"names":["number"]},"description":"The height of the BitmapText.","name":"height"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.LocalBitmapTextSize","scope":"static","___s":true},{"meta":{"filename":"RetroFontConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"RetroFontConfig","type":{"names":["object"]},"since":"3.6.0","properties":[{"type":{"names":["string"]},"description":"The key of the image containing the font.","name":"image"},{"type":{"names":["number"]},"description":"If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.","name":"offset.x"},{"type":{"names":["number"]},"description":"If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.","name":"offset.y"},{"type":{"names":["number"]},"description":"The width of each character in the font set.","name":"width"},{"type":{"names":["number"]},"description":"The height of each character in the font set.","name":"height"},{"type":{"names":["string"]},"description":"The characters used in the font set, in display order. You can use the TEXT_SET consts for common font set arrangements.","name":"chars"},{"type":{"names":["number"]},"description":"The number of characters per row in the font set. If not given charsPerRow will be the image width / characterWidth.","name":"charsPerRow"},{"type":{"names":["number"]},"description":"If the characters in the font set have horizontal spacing between them set the required amount here.","name":"spacing.x"},{"type":{"names":["number"]},"description":"If the characters in the font set have vertical spacing between them set the required amount here.","name":"spacing.y"},{"type":{"names":["number"]},"description":"The amount of vertical space to add to the line height of the font.","name":"lineSpacing"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.RetroFontConfig","scope":"static","___s":true},{"meta":{"filename":"TintConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"TintConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The top left tint value. Always zero in canvas.","name":"topLeft"},{"type":{"names":["number"]},"description":"The top right tint value. Always zero in canvas.","name":"topRight"},{"type":{"names":["number"]},"description":"The bottom left tint value. Always zero in canvas.","name":"bottomLeft"},{"type":{"names":["number"]},"description":"The bottom right tint value. Always zero in canvas.","name":"bottomRight"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.TintConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"namespace","name":"BitmapText","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.BitmapText","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"Blitter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"name":"BlitterRender","longname":"BlitterRender","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Blitter.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"kind":"typedef","name":"CreateCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"The Bob that was created by the Blitter.","name":"bob"},{"type":{"names":["integer"]},"description":"The position of the Bob within the Blitter display list.","name":"index"}],"longname":"CreateCallback","scope":"global","___s":true},{"meta":{"filename":"Blitter.js","lineno":22,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"classdesc":"A Blitter Game Object.\n\nThe Blitter Game Object is a special kind of container that creates, updates and manages Bob objects.\nBobs are designed for rendering speed rather than flexibility. They consist of a texture, or frame from a texture,\na position and an alpha value. You cannot scale or rotate them. They use a batched drawing method for speed\nduring rendering.\n\nA Blitter Game Object has one texture bound to it. Bobs created by the Blitter can use any Frame from this\nTexture to render with, but they cannot use any other Texture. It is this single texture-bind that allows\nthem their speed.\n\nIf you have a need to blast a large volume of frames around the screen then Blitter objects are well worth\ninvestigating. They are especially useful for using as a base for your own special effects systems.","kind":"class","name":"Blitter","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. It can only belong to one Scene at any given time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of this Game Object in world space.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of this Game Object in world space.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'__DEFAULT'","description":"The key of the texture this Game Object will use for rendering. The Texture must already exist in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":0,"description":"The Frame of the Texture that this Game Object will use. Only set if the Texture has multiple frames, such as a Texture Atlas or Sprite Sheet.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.Blitter","___s":true},{"meta":{"filename":"Blitter.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The children of this Blitter.\nThis List contains all of the Bob objects created by the Blitter.","name":"children","type":{"names":["Phaser.Structs.List."]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#children","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Blitter.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Is the Blitter considered dirty?\nA 'dirty' Blitter has had its child count changed since the last frame.","name":"dirty","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Blitter.js","lineno":122,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Creates a new Bob in this Blitter.\n\nThe Bob is created at the given coordinates, relative to the Blitter and uses the given frame.\nA Bob can use any frame belonging to the texture bound to the Blitter.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.","name":"y"},{"type":{"names":["string","integer","Phaser.Textures.Frame"]},"optional":true,"description":"The Frame the Bob will use. It _must_ be part of the Texture the parent Blitter object is using.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the created Bob render or not?","name":"visible"},{"type":{"names":["integer"]},"optional":true,"description":"The position in the Blitters Display List to add the new Bob at. Defaults to the top of the list.","name":"index"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"The newly created Bob object."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#create","scope":"instance","___s":true},{"meta":{"filename":"Blitter.js","lineno":162,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Creates multiple Bob objects within this Blitter and then passes each of them to the specified callback.","kind":"function","name":"createFromCallback","since":"3.0.0","params":[{"type":{"names":["CreateCallback"]},"description":"The callback to invoke after creating a bob. It will be sent two arguments: The Bob and the index of the Bob.","name":"callback"},{"type":{"names":["integer"]},"description":"The quantity of Bob objects to create.","name":"quantity"},{"type":{"names":["string","integer","Phaser.Textures.Frame","Array.","Array.","Array."]},"optional":true,"description":"The Frame the Bobs will use. It must be part of the Blitter Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the created Bob render or not?","name":"visible"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Bob objects that were created."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#createFromCallback","scope":"instance","___s":true},{"meta":{"filename":"Blitter.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Creates multiple Bobs in one call.\n\nThe amount created is controlled by a combination of the `quantity` argument and the number of frames provided.\n\nIf the quantity is set to 10 and you provide 2 frames, then 20 Bobs will be created. 10 with the first\nframe and 10 with the second.","kind":"function","name":"createMultiple","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The quantity of Bob objects to create.","name":"quantity"},{"type":{"names":["string","integer","Phaser.Textures.Frame","Array.","Array.","Array."]},"optional":true,"description":"The Frame the Bobs will use. It must be part of the Blitter Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the created Bob render or not?","name":"visible"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Bob objects that were created."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#createMultiple","scope":"instance","___s":true},{"meta":{"filename":"Blitter.js","lineno":230,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Checks if the given child can render or not, by checking its `visible` and `alpha` values.","kind":"function","name":"childCanRender","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"The Bob to check for rendering.","name":"child"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if the given child can render, otherwise `false`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#childCanRender","scope":"instance","___s":true},{"meta":{"filename":"Blitter.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Returns an array of Bobs to be rendered.\nIf the Blitter is dirty then a new list is generated and stored in `renderList`.","kind":"function","name":"getRenderList","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"An array of Bob objects that will be rendered this frame."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getRenderList","scope":"instance","___s":true},{"meta":{"filename":"Blitter.js","lineno":265,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Removes all Bobs from the children List and clears the dirty flag.","kind":"function","name":"clear","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#clear","scope":"instance","___s":true},{"meta":{"range":[180,210],"filename":"BlitterCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"name":"Blitter","longname":"Blitter","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BlitterCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Creates a new Blitter Game Object and returns it.\n\nNote: This method will only be available if the Blitter Game Object has been built into Phaser.","kind":"function","name":"blitter","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#blitter","scope":"instance","___s":true},{"meta":{"range":[180,210],"filename":"BlitterFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"name":"Blitter","longname":"Blitter","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BlitterFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Creates a new Blitter Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Blitter Game Object has been built into Phaser.","kind":"function","name":"blitter","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the Game Object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Game Object.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture the Blitter object will use.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The default Frame children of the Blitter will use.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#blitter","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"BlitterRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"BlitterWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"Bob.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Bob.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"classdesc":"A Bob Game Object.\n\nA Bob belongs to a Blitter Game Object. The Blitter is responsible for managing and rendering this object.\n\nA Bob has a position, alpha value and a frame from a texture that it uses to render with. You can also toggle\nthe flipped and visible state of the Bob. The Frame the Bob uses to render can be changed dynamically, but it\nmust be a Frame within the Texture used by the parent Blitter.\n\nBob positions are relative to the Blitter parent. So if you move the Blitter parent, all Bob children will\nhave their positions impacted by this change as well.\n\nYou can manipulate Bob objects directly from your game code, but the creation and destruction of them should be\nhandled via the Blitter parent.","kind":"class","name":"Bob","memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"The parent Blitter object is responsible for updating this Bob.","name":"blitter"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world, relative to the parent Blitter position.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world, relative to the parent Blitter position.","name":"y"},{"type":{"names":["string","integer"]},"description":"The Frame this Bob will render with, as defined in the Texture the parent Blitter is using.","name":"frame"},{"type":{"names":["boolean"]},"description":"Should the Bob render visible or not to start with?","name":"visible"}],"scope":"static","longname":"Phaser.GameObjects.Bob","___s":true},{"meta":{"filename":"Bob.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The Blitter object that this Bob belongs to.","name":"parent","type":{"names":["Phaser.GameObjects.Blitter"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The x position of this Bob, relative to the x position of the Blitter.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The y position of this Bob, relative to the y position of the Blitter.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"A blank object which can be used to store data related to this Bob in.","name":"data","type":{"names":["object"]},"defaultvalue":"{}","since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The tint value of this Bob.","name":"tint","type":{"names":["number"]},"defaultvalue":"0xffffff","since":"3.20.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#tint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The horizontally flipped state of the Bob.\nA Bob that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture.","name":"flipX","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#flipX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The vertically flipped state of the Bob.\nA Bob that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture.","name":"flipY","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#flipY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Changes the Texture Frame being used by this Bob.\nThe frame must be part of the Texture the parent Blitter is using.\nIf no value is given it will use the default frame of the Blitter parent.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer","Phaser.Textures.Frame"]},"optional":true,"description":"The frame to be used during rendering.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setFrame","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Resets the horizontal and vertical flipped state of this Bob back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#resetFlip","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Resets this Bob.\n\nChanges the position to the values given, and optionally changes the frame.\n\nAlso resets the flipX and flipY values, sets alpha back to 1 and visible to true.","kind":"function","name":"reset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.","name":"y"},{"type":{"names":["string","integer","Phaser.Textures.Frame"]},"optional":true,"description":"The Frame the Bob will use. It _must_ be part of the Texture the parent Blitter object is using.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#reset","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":228,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Changes the position of this Bob to the values given.","kind":"function","name":"setPosition","since":"3.20.0","params":[{"type":{"names":["number"]},"description":"The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":247,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Sets the horizontal flipped state of this Bob.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setFlipX","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":264,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Sets the vertical flipped state of this Bob.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setFlipY","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":281,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Sets the horizontal and vertical flipped state of this Bob.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setFlip","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Sets the visibility of this Bob.\n\nAn invisible Bob will skip rendering.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setVisible","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Set the Alpha level of this Bob. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nA Bob with alpha 0 will skip rendering.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The alpha value used for this Bob. Between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setAlpha","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":339,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Sets the tint of this Bob.","kind":"function","name":"setTint","since":"3.20.0","params":[{"type":{"names":["number"]},"description":"The tint value used for this Bob. Between 0 and 0xffffff.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setTint","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":356,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Destroys this Bob instance.\nRemoves itself from the Blitter and clears the parent, frame and data properties.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#destroy","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":374,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The visible state of the Bob.\n\nAn invisible Bob will skip rendering.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#visible","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":398,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The alpha value of the Bob, between 0 and 1.\n\nA Bob with alpha 0 will skip rendering.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,215],"filename":"Alpha.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Alpha.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the alpha properties of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Alpha","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Alpha","scope":"static","___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Alpha"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#clearAlpha","scope":"instance","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Alpha"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#setAlpha","scope":"instance","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#alphaTopRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,215],"filename":"AlphaSingle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the alpha property of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"AlphaSingle","since":"3.22.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.AlphaSingle","scope":"static","___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.AlphaSingle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.AlphaSingle","longname":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","scope":"instance","___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.AlphaSingle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.AlphaSingle","longname":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","scope":"instance","___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.AlphaSingle","longname":"Phaser.GameObjects.Components.AlphaSingle#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,233],"filename":"Animation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"BaseAnimation","longname":"BaseAnimation","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Animation.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"classdesc":"A Game Object Animation Controller.\n\nThis controller lives as an instance within a Game Object, accessible as `sprite.anims`.","kind":"class","name":"Animation","memberof":"Phaser.GameObjects.Components","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to which this animation controller belongs.","name":"parent"}],"scope":"static","longname":"Phaser.GameObjects.Components.Animation","___s":true},{"meta":{"filename":"Animation.js","lineno":30,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Game Object to which this animation controller belongs.","name":"parent","type":{"names":["Phaser.GameObjects.GameObject"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A reference to the global Animation Manager.","name":"animationManager","type":{"names":["Phaser.Animations.AnimationManager"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#animationManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Is an animation currently playing or not?","name":"isPlaying","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#isPlaying","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current Animation loaded into this Animation Controller.","name":"currentAnim","type":{"names":["Phaser.Animations.Animation"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#currentAnim","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current AnimationFrame being displayed by this Animation Controller.","name":"currentFrame","type":{"names":["Phaser.Animations.AnimationFrame"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#currentFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The key of the next Animation to be loaded into this Animation Controller when the current animation completes.","name":"nextAnim","type":{"names":["string"]},"nullable":true,"defaultvalue":"null","since":"3.16.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#nextAnim","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The frame rate of playback in frames per second.\nThe default is 24 if the `duration` property is `null`.","name":"frameRate","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#frameRate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"How long the animation should play for, in milliseconds.\nIf the `frameRate` property has been set then it overrides this value,\notherwise the `frameRate` is derived from `duration`.","name":"duration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"ms per frame, not including frame specific modifiers that may be present in the Animation data.","name":"msPerFrame","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#msPerFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Skip frames if the time lags, or always advanced anyway?","name":"skipMissedFrames","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#skipMissedFrames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":188,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Will the playhead move forwards (`true`) or in reverse (`false`).","name":"forward","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#forward","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":210,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Internal time overflow accumulator.","name":"accumulator","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#accumulator","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The time point at which the next animation frame will change.","name":"nextTick","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#nextTick","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":230,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"An internal counter keeping track of how many repeats are left to play.","name":"repeatCounter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#repeatCounter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":240,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"An internal flag keeping track of pending repeats.","name":"pendingRepeat","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#pendingRepeat","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an animation to be played immediately after the current one completes.\n\nThe current animation must enter a 'completed' state for this to happen, i.e. finish all of its repeats, delays, etc, or have the `stop` method called directly on it.\n\nAn animation set to repeat forever will never enter a completed state.\n\nYou can chain a new animation at any point, including before the current one starts playing, during it, or when it ends (via its `animationcomplete` callback).\nChained animations are specific to a Game Object, meaning different Game Objects can have different chained animations without impacting the global animation they're playing.\n\nCall this method with no arguments to reset the chained animation.","kind":"function","name":"chain","since":"3.16.0","params":[{"type":{"names":["string","Phaser.Animations.Animation"]},"optional":true,"description":"The string-based key of the animation to play next, as defined previously in the Animation Manager. Or an Animation instance.","name":"key"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#chain","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":329,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the amount of time, in milliseconds, that the animation will be delayed before starting playback.","kind":"function","name":"setDelay","since":"3.4.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount of time, in milliseconds, to wait before starting playback.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setDelay","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":348,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the amount of time, in milliseconds that the animation will be delayed before starting playback.","kind":"function","name":"getDelay","since":"3.4.0","returns":[{"type":{"names":["integer"]},"description":"The amount of time, in milliseconds, the Animation will wait before starting playback."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getDelay","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":361,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Waits for the specified delay, in milliseconds, then starts playback of the requested animation.","kind":"function","name":"delayedPlay","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The delay, in milliseconds, to wait before starting the animation playing.","name":"delay"},{"type":{"names":["string"]},"description":"The key of the animation to play.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The frame of the animation to start from.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#delayedPlay","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":382,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Returns the key of the animation currently loaded into this component.","kind":"function","name":"getCurrentKey","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The key of the Animation loaded into this component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getCurrentKey","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Pause the current animation and set the `isPlaying` property to `false`.\nYou can optionally pause it at a specific frame.","kind":"function","name":"pause","since":"3.0.0","params":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"optional":true,"description":"An optional frame to set after pausing the animation.","name":"atFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#pause","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":453,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resumes playback of a paused animation and sets the `isPlaying` property to `true`.\nYou can optionally tell it to start playback from a specific frame.","kind":"function","name":"resume","since":"3.0.0","params":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"optional":true,"description":"An optional frame to set before restarting playback.","name":"fromFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#resume","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":480,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"`true` if the current animation is paused, otherwise `false`.","name":"isPaused","readonly":true,"type":{"names":["boolean"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#isPaused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":497,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Plays an Animation on a Game Object that has the Animation component, such as a Sprite.\n\nAnimations are stored in the global Animation Manager and are referenced by a unique string-based key.","kind":"function","name":"play","fires":["Phaser.GameObjects.Components.Animation#event:onStartEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Animations.Animation"]},"description":"The string-based key of the animation to play, as defined previously in the Animation Manager. Or an Animation instance.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#play","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":535,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Plays an Animation (in reverse mode) on the Game Object that owns this Animation Component.","kind":"function","name":"playReverse","fires":["Phaser.GameObjects.Components.Animation#event:onStartEvent"],"since":"3.12.0","params":[{"type":{"names":["string","Phaser.Animations.Animation"]},"description":"The string-based key of the animation to play, as defined previously in the Animation Manager. Or an Animation instance.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If an animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#playReverse","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":569,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Load an Animation and fires 'onStartEvent' event, extracted from 'play' method.","kind":"function","name":"_startAnimation","fires":["Phaser.Animations.Events#event:START_ANIMATION_EVENT","Phaser.Animations.Events#event:SPRITE_START_ANIMATION_EVENT","Phaser.Animations.Events#event:SPRITE_START_KEY_ANIMATION_EVENT"],"since":"3.12.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play, as defined previously in the Animation Manager.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#_startAnimation","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":619,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Reverse the Animation that is already playing on the Game Object.","kind":"function","name":"reverse","since":"3.12.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#reverse","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":639,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Returns a value between 0 and 1 indicating how far this animation is through, ignoring repeats and yoyos.\nIf the animation has a non-zero repeat defined, `getProgress` and `getTotalProgress` will be different\nbecause `getProgress` doesn't include any repeats or repeat delays, whereas `getTotalProgress` does.","kind":"function","name":"getProgress","since":"3.4.0","returns":[{"type":{"names":["number"]},"description":"The progress of the current animation, between 0 and 1."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getProgress","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":661,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Takes a value between 0 and 1 and uses it to set how far this animation is through playback.\nDoes not factor in repeats or yoyos, but does handle playing forwards or backwards.","kind":"function","name":"setProgress","since":"3.4.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The progress value, between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setProgress","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":684,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Handle the removal of an animation from the Animation Manager.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The key of the removed Animation.","name":"key"},{"type":{"names":["Phaser.Animations.Animation"]},"optional":true,"description":"The removed Animation.","name":"animation"}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#remove","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":705,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the number of times that the animation will repeat\nafter its first iteration. For example, if returns 1, the animation will\nplay a total of twice (the initial play plus 1 repeat).\nA value of -1 means the animation will repeat indefinitely.","kind":"function","name":"getRepeat","since":"3.4.0","returns":[{"type":{"names":["integer"]},"description":"The number of times that the animation will repeat."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getRepeat","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":721,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the number of times that the animation should repeat\nafter its first iteration. For example, if repeat is 1, the animation will\nplay a total of twice (the initial play plus 1 repeat).\nTo repeat indefinitely, use -1. repeat should always be an integer.","kind":"function","name":"setRepeat","since":"3.4.0","params":[{"type":{"names":["integer"]},"description":"The number of times that the animation should repeat.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setRepeat","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":743,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the amount of delay between repeats, if any.","kind":"function","name":"getRepeatDelay","since":"3.4.0","returns":[{"type":{"names":["number"]},"description":"The delay between repeats."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getRepeatDelay","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":756,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the amount of time in seconds between repeats.\nFor example, if `repeat` is 2 and `repeatDelay` is 10, the animation will play initially,\nthen wait for 10 seconds before repeating, then play again, then wait another 10 seconds\nbefore doing its final repeat.","kind":"function","name":"setRepeatDelay","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The delay to wait between repeats, in seconds.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setRepeatDelay","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":776,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Restarts the current animation from its beginning, optionally including its delay value.","kind":"function","name":"restart","fires":["Phaser.Animations.Events#event:RESTART_ANIMATION_EVENT","Phaser.Animations.Events#event:SPRITE_RESTART_ANIMATION_EVENT","Phaser.Animations.Events#event:SPRITE_RESTART_KEY_ANIMATION_EVENT"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to include the delay value of the animation when restarting.","name":"includeDelay"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#restart","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":817,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Immediately stops the current animation from playing and dispatches the `animationcomplete` event.\n\nIf no animation is set, no event will be dispatched.\n\nIf there is another animation queued (via the `chain` method) then it will start playing immediately.","kind":"function","name":"stop","fires":["Phaser.GameObjects.Components.Animation#event:onCompleteEvent"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#stop","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":861,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Stops the current animation from playing after the specified time delay, given in milliseconds.","kind":"function","name":"stopAfterDelay","fires":["Phaser.GameObjects.Components.Animation#event:onCompleteEvent"],"since":"3.4.0","params":[{"type":{"names":["integer"]},"description":"The number of milliseconds to wait before stopping this animation.","name":"delay"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#stopAfterDelay","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":880,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Stops the current animation from playing when it next repeats.","kind":"function","name":"stopOnRepeat","fires":["Phaser.GameObjects.Components.Animation#event:onCompleteEvent"],"since":"3.4.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#stopOnRepeat","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":896,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Stops the current animation from playing when it next sets the given frame.\nIf this frame doesn't exist within the animation it will not stop it from playing.","kind":"function","name":"stopOnFrame","fires":["Phaser.GameObjects.Components.Animation#event:onCompleteEvent"],"since":"3.4.0","params":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The frame to check before stopping this animation.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#stopOnFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":916,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Time Scale factor, allowing you to make the animation go go faster or slower than default.\nWhere 1 = normal speed (the default), 0.5 = half speed, 2 = double speed, etc.","kind":"function","name":"setTimeScale","since":"3.4.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The time scale factor, where 1 is no change, 0.5 is half speed, etc.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setTimeScale","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":936,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the Time Scale factor.","kind":"function","name":"getTimeScale","since":"3.4.0","returns":[{"type":{"names":["number"]},"description":"The Time Scale value."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getTimeScale","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":949,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Returns the total number of frames in this animation.","kind":"function","name":"getTotalFrames","since":"3.4.0","returns":[{"type":{"names":["integer"]},"description":"The total number of frames in this animation."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getTotalFrames","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":962,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The internal update loop for the Animation Component.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current timestamp.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#update","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":996,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the given Animation Frame as being the current frame\nand applies it to the parent Game Object, adjusting its size and origin as needed.","kind":"function","name":"setCurrentFrame","since":"3.4.0","params":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The Animation Frame to set as being current.","name":"animationFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object this Animation Component belongs to."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setCurrentFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":1070,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Advances the animation to the next frame, regardless of the time or animation state.\nIf the animation is set to repeat, or yoyo, this will still take effect.\n\nCalling this does not change the direction of the animation. I.e. if it was currently\nplaying in reverse, calling this method doesn't then change the direction to forwards.","kind":"function","name":"nextFrame","since":"3.16.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object this Animation Component belongs to."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#nextFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":1092,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Advances the animation to the previous frame, regardless of the time or animation state.\nIf the animation is set to repeat, or yoyo, this will still take effect.\n\nCalling this does not change the direction of the animation. I.e. if it was currently\nplaying in forwards, calling this method doesn't then change the direction to backwards.","kind":"function","name":"previousFrame","since":"3.16.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object this Animation Component belongs to."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#previousFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":1114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets if the current Animation will yoyo when it reaches the end.\nA yoyo'ing animation will play through consecutively, and then reverse-play back to the start again.","kind":"function","name":"setYoyo","since":"3.4.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"`true` if the animation should yoyo, `false` to not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object this Animation Component belongs to."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setYoyo","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":1134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets if the current Animation will yoyo when it reaches the end.\nA yoyo'ing animation will play through consecutively, and then reverse-play back to the start again.","kind":"function","name":"getYoyo","since":"3.4.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the animation is set to yoyo, `false` if not."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getYoyo","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":1148,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Destroy this Animation component.\n\nUnregisters event listeners and cleans up its references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#destroy","scope":"instance","___s":true},{"meta":{"range":[180,229],"filename":"BlendMode.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"BlendModes","longname":"BlendModes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BlendMode.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the blend mode of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"BlendMode","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.BlendMode","scope":"static","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.BlendMode","longname":"Phaser.GameObjects.Components.BlendMode#blendMode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.BlendMode"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.BlendMode","longname":"Phaser.GameObjects.Components.BlendMode#setBlendMode","scope":"instance","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for calculating and setting the size of a non-Frame based Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"ComputedSize","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.ComputedSize","scope":"static","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.ComputedSize","longname":"Phaser.GameObjects.Components.ComputedSize#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.ComputedSize","longname":"Phaser.GameObjects.Components.ComputedSize#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.ComputedSize","longname":"Phaser.GameObjects.Components.ComputedSize#displayWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.ComputedSize","longname":"Phaser.GameObjects.Components.ComputedSize#displayHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.ComputedSize"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.ComputedSize","longname":"Phaser.GameObjects.Components.ComputedSize#setSize","scope":"instance","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.ComputedSize"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.ComputedSize","longname":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","scope":"instance","___s":true},{"meta":{"filename":"Crop.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the texture of a Game Object.","kind":"namespace","name":"Crop","since":"3.12.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Crop","scope":"static","___s":true},{"meta":{"filename":"Crop.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Crop","longname":"Phaser.GameObjects.Components.Crop#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Crop.js","lineno":25,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Crop","longname":"Phaser.GameObjects.Components.Crop#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Crop.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Components.Crop","longname":"Phaser.GameObjects.Components.Crop#isCropped","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Crop.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Crop"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Crop","longname":"Phaser.GameObjects.Components.Crop#setCrop","scope":"instance","___s":true},{"meta":{"filename":"Depth.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the depth of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Depth","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Depth","scope":"static","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Depth","longname":"Phaser.GameObjects.Components.Depth#depth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Depth"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Depth","longname":"Phaser.GameObjects.Components.Depth#setDepth","scope":"instance","___s":true},{"meta":{"filename":"Flip.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for visually flipping a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Flip","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Flip","scope":"static","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#flipX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#flipY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Flip"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#toggleFlipX","scope":"instance","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Flip"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#toggleFlipY","scope":"instance","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Flip"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#setFlipX","scope":"instance","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Flip"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#setFlipY","scope":"instance","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Flip"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#setFlip","scope":"instance","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Flip"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#resetFlip","scope":"instance","___s":true},{"meta":{"range":[180,233],"filename":"GetBounds.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetBounds.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for obtaining the bounds of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"GetBounds","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.GetBounds","scope":"static","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getCenter","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getTopLeft","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getTopCenter","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getTopRight","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getRightCenter","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getBottomRight","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getBounds","scope":"instance","___s":true},{"meta":{"range":[180,233],"filename":"Mask.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"BitmapMask","longname":"BitmapMask","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Mask.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the mask of a Game Object.","kind":"namespace","name":"Mask","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Mask","scope":"static","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Mask","longname":"Phaser.GameObjects.Components.Mask#mask","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Mask"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Mask","longname":"Phaser.GameObjects.Components.Mask#setMask","scope":"instance","___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Mask"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Mask","longname":"Phaser.GameObjects.Components.Mask#clearMask","scope":"instance","___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Components.Mask","longname":"Phaser.GameObjects.Components.Mask#createBitmapMask","scope":"instance","___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Components.Mask","longname":"Phaser.GameObjects.Components.Mask#createGeometryMask","scope":"instance","___s":true},{"meta":{"filename":"Origin.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the origin of a Game Object.\nValues are normalized, given in the range 0 to 1.\nDisplay values contain the calculated pixel values.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Origin","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Origin","scope":"static","___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#originX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#originY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#displayOriginX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#displayOriginY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Origin"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#setOrigin","scope":"instance","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Origin"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","scope":"instance","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Origin"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","scope":"instance","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Origin"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"PathFollower.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"DegToRad","longname":"DegToRad","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PathFollower.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for managing a Game Object following a Path.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"PathFollower","since":"3.17.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.PathFollower","scope":"static","___s":true},{"meta":{"filename":"PathFollower.js","lineno":23,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Path this PathFollower is following. It can only follow one Path at a time.","name":"path","type":{"names":["Phaser.Curves.Path"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#path","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Should the PathFollower automatically rotate to point in the direction of the Path?","name":"rotateToPath","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#rotateToPath","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":42,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"If the PathFollower is rotating to match the Path (@see Phaser.GameObjects.PathFollower#rotateToPath)\nthis value is added to the rotation value. This allows you to rotate objects to a path but control\nthe angle of the rotation as well.","name":"pathRotationOffset","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pathRotationOffset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"An additional vector to add to the PathFollowers position, allowing you to offset it from the\nPath coordinates.","name":"pathOffset","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pathOffset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A Vector2 that stores the current point of the path the follower is on.","name":"pathVector","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pathVector","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Tween used for following the Path.","name":"pathTween","type":{"names":["Phaser.Tweens.Tween"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pathTween","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Settings for the PathFollower.","name":"pathConfig","type":{"names":["Phaser.Types.GameObjects.PathFollower.PathConfig"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pathConfig","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":102,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Path that this PathFollower should follow.\n\nOptionally accepts {@link Phaser.Types.GameObjects.PathFollower.PathConfig} settings.","kind":"function","name":"setPath","since":"3.0.0","params":[{"type":{"names":["Phaser.Curves.Path"]},"description":"The Path this PathFollower is following. It can only follow one Path at a time.","name":"path"},{"type":{"names":["number","Phaser.Types.GameObjects.PathFollower.PathConfig","Phaser.Types.Tweens.NumberTweenBuilderConfig"]},"optional":true,"description":"Settings for the PathFollower.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#setPath","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set whether the PathFollower should automatically rotate to point in the direction of the Path.","kind":"function","name":"setRotateToPath","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether the PathFollower should automatically rotate to point in the direction of the Path.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Rotation offset in degrees.","name":"offset"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#setRotateToPath","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Is this PathFollower actively following a Path or not?\n\nTo be considered as `isFollowing` it must be currently moving on a Path, and not paused.","kind":"function","name":"isFollowing","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` is this PathFollower is actively following a Path, otherwise `false`."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#isFollowing","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Starts this PathFollower following its given Path.","kind":"function","name":"startFollow","since":"3.3.0","params":[{"type":{"names":["number","Phaser.Types.GameObjects.PathFollower.PathConfig","Phaser.Types.Tweens.NumberTweenBuilderConfig"]},"optional":true,"defaultvalue":"{}","description":"The duration of the follow, or a PathFollower config object.","name":"config"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional start position of the follow, between 0 and 1.","name":"startAt"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#startFollow","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":267,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Pauses this PathFollower. It will still continue to render, but it will remain motionless at the\npoint on the Path at which you paused it.","kind":"function","name":"pauseFollow","since":"3.3.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#pauseFollow","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":288,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resumes a previously paused PathFollower.\n\nIf the PathFollower was not paused this has no effect.","kind":"function","name":"resumeFollow","since":"3.3.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#resumeFollow","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Stops this PathFollower from following the path any longer.\n\nThis will invoke any 'stop' conditions that may exist on the Path, or for the follower.","kind":"function","name":"stopFollow","since":"3.3.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#stopFollow","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Internal update handler that advances this PathFollower along the path.\n\nCalled automatically by the Scene step, should not typically be called directly.","kind":"function","name":"pathUpdate","since":"3.17.0","memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#pathUpdate","scope":"instance","___s":true},{"meta":{"filename":"Pipeline.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the WebGL rendering pipeline of a Game Object.","kind":"namespace","name":"Pipeline","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Pipeline","scope":"static","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Pipeline","longname":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Pipeline","longname":"Phaser.GameObjects.Components.Pipeline#pipeline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Components.Pipeline","longname":"Phaser.GameObjects.Components.Pipeline#initPipeline","scope":"instance","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Pipeline"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Pipeline","longname":"Phaser.GameObjects.Components.Pipeline#setPipeline","scope":"instance","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Components.Pipeline","longname":"Phaser.GameObjects.Components.Pipeline#resetPipeline","scope":"instance","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Components.Pipeline","longname":"Phaser.GameObjects.Components.Pipeline#getPipelineName","scope":"instance","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the Scroll Factor of a Game Object.","kind":"namespace","name":"ScrollFactor","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.ScrollFactor","scope":"static","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Components.ScrollFactor","longname":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Components.ScrollFactor","longname":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.ScrollFactor"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.ScrollFactor","longname":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the size of a Game Object.","kind":"namespace","name":"Size","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Size","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#displayWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#displayHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Size"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#setSizeToFrame","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Size"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#setSize","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Size"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#setDisplaySize","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the texture of a Game Object.","kind":"namespace","name":"Texture","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Texture","scope":"static","___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Texture","longname":"Phaser.GameObjects.Components.Texture#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Texture","longname":"Phaser.GameObjects.Components.Texture#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Texture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Texture","longname":"Phaser.GameObjects.Components.Texture#setTexture","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Texture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Texture","longname":"Phaser.GameObjects.Components.Texture#setFrame","scope":"instance","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the texture of a Game Object.","kind":"namespace","name":"TextureCrop","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.TextureCrop","scope":"static","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.TextureCrop","longname":"Phaser.GameObjects.Components.TextureCrop#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.TextureCrop","longname":"Phaser.GameObjects.Components.TextureCrop#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Components.TextureCrop","longname":"Phaser.GameObjects.Components.TextureCrop#isCropped","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TextureCrop"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.TextureCrop","longname":"Phaser.GameObjects.Components.TextureCrop#setCrop","scope":"instance","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TextureCrop"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.TextureCrop","longname":"Phaser.GameObjects.Components.TextureCrop#setTexture","scope":"instance","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TextureCrop"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.TextureCrop","longname":"Phaser.GameObjects.Components.TextureCrop#setFrame","scope":"instance","___s":true},{"meta":{"filename":"Tint.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the tint of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Tint","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Tint","scope":"static","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#tintFill","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Tint"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#clearTint","scope":"instance","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Tint"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#setTint","scope":"instance","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Tint"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#setTintFill","scope":"instance","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#tintTopLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#tintTopRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#tintBottomLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#tintBottomRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#tint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#isTinted","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ToJSON.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Build a JSON representation of the given Game Object.\n\nThis is typically extended further by Game Object specific implementations.","kind":"function","name":"ToJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to export as JSON.","name":"gameObject"}],"returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.ToJSON","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"Transform.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Transform.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the position, scale and rotation of a Game Object.","kind":"namespace","name":"Transform","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Transform","scope":"static","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#z","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#w","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#scale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#scaleX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#scaleY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setRandomPosition","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setRotation","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setAngle","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setScale","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setX","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setY","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setZ","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setW","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#getParentRotation","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"TransformMatrix.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"classdesc":"A Matrix used for display transformations for rendering.\n\nIt is represented like so:\n\n```\n| a | c | tx |\n| b | d | ty |\n| 0 | 0 | 1 |\n```","kind":"class","name":"TransformMatrix","memberof":"Phaser.GameObjects.Components","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The Scale X value.","name":"a"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The Skew Y value.","name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The Skew X value.","name":"c"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The Scale Y value.","name":"d"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The Translate X value.","name":"tx"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The Translate Y value.","name":"ty"}],"scope":"static","longname":"Phaser.GameObjects.Components.TransformMatrix","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The matrix values.","name":"matrix","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#matrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The decomposed matrix.","name":"decomposedMatrix","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#decomposedMatrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Scale X value.","name":"a","type":{"names":["number"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#a","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":94,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Skew Y value.","name":"b","type":{"names":["number"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#b","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":115,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Skew X value.","name":"c","type":{"names":["number"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#c","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Scale Y value.","name":"d","type":{"names":["number"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#d","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Translate X value.","name":"e","type":{"names":["number"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#e","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Translate Y value.","name":"f","type":{"names":["number"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#f","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":199,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Translate X value.","name":"tx","type":{"names":["number"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#tx","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Translate Y value.","name":"ty","type":{"names":["number"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#ty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The rotation of the Matrix. Value is in radians.","name":"rotation","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The rotation of the Matrix, normalized to be within the Phaser right-handed\nclockwise rotation space. Value is in radians.","name":"rotationNormalized","type":{"names":["number"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#rotationNormalized","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The decomposed horizontal scale of the Matrix. This value is always positive.","name":"scaleX","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#scaleX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":315,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The decomposed vertical scale of the Matrix. This value is always positive.","name":"scaleY","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#scaleY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Reset the Matrix to an identity matrix.","kind":"function","name":"loadIdentity","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#loadIdentity","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":354,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Translate the Matrix.","kind":"function","name":"translate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal translation value.","name":"x"},{"type":{"names":["number"]},"description":"The vertical translation value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#translate","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":375,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Scale the Matrix.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale value.","name":"x"},{"type":{"names":["number"]},"description":"The vertical scale value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#scale","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":398,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Rotate the Matrix.","kind":"function","name":"rotate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#rotate","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":428,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Multiply this Matrix by the given Matrix.\n\nIf an `out` Matrix is given then the results will be stored in it.\nIf it is not given, this matrix will be updated in place instead.\nUse an `out` Matrix if you do not wish to mutate this matrix.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The Matrix to multiply by.","name":"rhs"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"An optional Matrix to store the results in.","name":"out"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"Either this TransformMatrix, or the `out` Matrix, if given in the arguments."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#multiply","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":474,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Multiply this Matrix by the matrix given, including the offset.\n\nThe offsetX is added to the tx value: `offsetX * a + offsetY * c + tx`.\nThe offsetY is added to the ty value: `offsetY * b + offsetY * d + ty`.","kind":"function","name":"multiplyWithOffset","since":"3.11.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The source Matrix to copy from.","name":"src"},{"type":{"names":["number"]},"description":"Horizontal offset to factor in to the multiplication.","name":"offsetX"},{"type":{"names":["number"]},"description":"Vertical offset to factor in to the multiplication.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#multiplyWithOffset","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":521,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Transform the Matrix.","kind":"function","name":"transform","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The Scale X value.","name":"a"},{"type":{"names":["number"]},"description":"The Shear Y value.","name":"b"},{"type":{"names":["number"]},"description":"The Shear X value.","name":"c"},{"type":{"names":["number"]},"description":"The Scale Y value.","name":"d"},{"type":{"names":["number"]},"description":"The Translate X value.","name":"tx"},{"type":{"names":["number"]},"description":"The Translate Y value.","name":"ty"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#transform","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":557,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Transform a point using this Matrix.","kind":"function","name":"transformPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the point to transform.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the point to transform.","name":"y"},{"type":{"names":["Phaser.Geom.Point","Phaser.Math.Vector2","object"]},"description":"The Point object to store the transformed coordinates.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point","Phaser.Math.Vector2","object"]},"description":"The Point containing the transformed coordinates."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#transformPoint","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":588,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Invert the Matrix.","kind":"function","name":"invert","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#invert","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":619,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the values of this Matrix to copy those of the matrix given.","kind":"function","name":"copyFrom","since":"3.11.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The source Matrix to copy from.","name":"src"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#copyFrom","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":643,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the values of this Matrix to copy those of the array given.\nWhere array indexes 0, 1, 2, 3, 4 and 5 are mapped to a, b, c, d, e and f.","kind":"function","name":"copyFromArray","since":"3.11.0","params":[{"type":{"names":["array"]},"description":"The array of values to set into this matrix.","name":"src"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#copyFromArray","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":668,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Copy the values from this Matrix to the given Canvas Rendering Context.\nThis will use the Context.transform method.","kind":"function","name":"copyToContext","since":"3.12.0","params":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context to copy the matrix values to.","name":"ctx"}],"returns":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#copyToContext","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":688,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Copy the values from this Matrix to the given Canvas Rendering Context.\nThis will use the Context.setTransform method.","kind":"function","name":"setToContext","since":"3.12.0","params":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context to copy the matrix values to.","name":"ctx"}],"returns":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#setToContext","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":708,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Copy the values in this Matrix to the array given.\n\nWhere array indexes 0, 1, 2, 3, 4 and 5 are mapped to a, b, c, d, e and f.","kind":"function","name":"copyToArray","since":"3.12.0","params":[{"type":{"names":["array"]},"optional":true,"description":"The array to copy the matrix values in to.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array where elements 0 to 5 contain the values from this matrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#copyToArray","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":741,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the values of this Matrix.","kind":"function","name":"setTransform","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The Scale X value.","name":"a"},{"type":{"names":["number"]},"description":"The Shear Y value.","name":"b"},{"type":{"names":["number"]},"description":"The Shear X value.","name":"c"},{"type":{"names":["number"]},"description":"The Scale Y value.","name":"d"},{"type":{"names":["number"]},"description":"The Translate X value.","name":"tx"},{"type":{"names":["number"]},"description":"The Translate Y value.","name":"ty"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#setTransform","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":770,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Decompose this Matrix into its translation, scale and rotation values using QR decomposition.\n\nThe result must be applied in the following order to reproduce the current matrix:\n\ntranslate -> rotate -> scale","kind":"function","name":"decomposeMatrix","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"The decomposed Matrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#decomposeMatrix","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":829,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Apply the identity, translate, rotate and scale operations on the Matrix.","kind":"function","name":"applyITRS","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal translation.","name":"x"},{"type":{"names":["number"]},"description":"The vertical translation.","name":"y"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"rotation"},{"type":{"names":["number"]},"description":"The horizontal scale.","name":"scaleX"},{"type":{"names":["number"]},"description":"The vertical scale.","name":"scaleY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#applyITRS","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":863,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Takes the `x` and `y` values and returns a new position in the `output` vector that is the inverse of\nthe current matrix with its transformation applied.\n\nCan be used to translate points from world to local space.","kind":"function","name":"applyInverse","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The x position to translate.","name":"x"},{"type":{"names":["number"]},"description":"The y position to translate.","name":"y"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2, or point-like object, to store the results in.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates, inverse-transformed through this matrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#applyInverse","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":899,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Returns the X component of this matrix multiplied by the given values.\nThis is the same as `x * a + y * c + e`.","kind":"function","name":"getX","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The x value.","name":"x"},{"type":{"names":["number"]},"description":"The y value.","name":"y"}],"returns":[{"type":{"names":["number"]},"description":"The calculated x value."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#getX","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":916,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Returns the Y component of this matrix multiplied by the given values.\nThis is the same as `x * b + y * d + f`.","kind":"function","name":"getY","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The x value.","name":"x"},{"type":{"names":["number"]},"description":"The y value.","name":"y"}],"returns":[{"type":{"names":["number"]},"description":"The calculated y value."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#getY","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":933,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Returns a string that can be used in a CSS Transform call as a `matrix` property.","kind":"function","name":"getCSSMatrix","since":"3.12.0","returns":[{"type":{"names":["string"]},"description":"A string containing the CSS Transform matrix values."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#getCSSMatrix","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":948,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Destroys this Transform Matrix.","kind":"function","name":"destroy","since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#destroy","scope":"instance","___s":true},{"meta":{"filename":"Visible.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the visibility of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Visible","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Visible","scope":"static","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Visible","longname":"Phaser.GameObjects.Components.Visible#visible","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Visible"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Visible","longname":"Phaser.GameObjects.Components.Visible#setVisible","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"kind":"namespace","name":"Components","memberof":"Phaser.GameObjects","longname":"Phaser.GameObjects.Components","scope":"static","___s":true},{"meta":{"range":[225,266],"filename":"Container.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"name":"ArrayUtils","longname":"ArrayUtils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Container.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"classdesc":"A Container Game Object.\n\nA Container, as the name implies, can 'contain' other types of Game Object.\nWhen a Game Object is added to a Container, the Container becomes responsible for the rendering of it.\nBy default it will be removed from the Display List and instead added to the Containers own internal list.\n\nThe position of the Game Object automatically becomes relative to the position of the Container.\n\nWhen the Container is rendered, all of its children are rendered as well, in the order in which they exist\nwithin the Container. Container children can be repositioned using methods such as `MoveUp`, `MoveDown` and `SendToBack`.\n\nIf you modify a transform property of the Container, such as `Container.x` or `Container.rotation` then it will\nautomatically influence all children as well.\n\nContainers can include other Containers for deeply nested transforms.\n\nContainers can have masks set on them and can be used as a mask too. However, Container children cannot be masked.\nThe masks do not 'stack up'. Only a Container on the root of the display list will use its mask.\n\nContainers can be enabled for input. Because they do not have a texture you need to provide a shape for them\nto use as their hit area. Container children can also be enabled for input, independent of the Container.\n\nContainers can be given a physics body for either Arcade Physics, Impact Physics or Matter Physics. However,\nif Container _children_ are enabled for physics you may get unexpected results, such as offset bodies,\nif the Container itself, or any of its ancestors, is positioned anywhere other than at 0 x 0. Container children\nwith physics do not factor in the Container due to the excessive extra calculations needed. Please structure\nyour game to work around this.\n\nIt's important to understand the impact of using Containers. They add additional processing overhead into\nevery one of their children. The deeper you nest them, the more the cost escalates. This is especially true\nfor input events. You also loose the ability to set the display depth of Container children in the same\nflexible manner as those not within them. In short, don't use them for the sake of it. You pay a small cost\nevery time you create one, try to structure your game around avoiding that where possible.","kind":"class","name":"Container","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.AlphaSingle","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.4.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["Array."]},"optional":true,"description":"An optional array of Game Objects to add to this Container.","name":"children"}],"scope":"static","longname":"Phaser.GameObjects.Container","___s":true},{"meta":{"filename":"Container.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"An array holding the children of this Container.","name":"list","type":{"names":["Array."]},"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#list","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Does this Container exclusively manage its children?\n\nThe default is `true` which means a child added to this Container cannot\nbelong in another Container, which includes the Scene display list.\n\nIf you disable this then this Container will no longer exclusively manage its children.\nThis allows you to create all kinds of interesting graphical effects, such as replicating\nGame Objects without reparenting them all over the Scene.\nHowever, doing so will prevent children from receiving any kind of input event or have\ntheir physics bodies work by default, as they're no longer a single entity on the\ndisplay list, but are being replicated where-ever this Container is.","name":"exclusive","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#exclusive","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Containers can have an optional maximum size. If set to anything above 0 it\nwill constrict the addition of new Game Objects into the Container, capping off\nthe maximum limit the Container can grow in size to.","name":"maxSize","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#maxSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"The cursor position.","name":"position","type":{"names":["integer"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#position","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":145,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Internal Transform Matrix used for local space conversion.","name":"localTransform","type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#localTransform","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":194,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"The horizontal scroll factor of this Container.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Container.\n\nWhen a camera scrolls it will change the location at which this Container is rendered on-screen.\nIt does not change the Containers actual position values.\n\nFor a Container, setting this value will only update the Container itself, not its children.\nIf you wish to change the scrollFactor of the children as well, use the `setScrollFactor` method.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Container.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#scrollFactorX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":221,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"The vertical scroll factor of this Container.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Container.\n\nWhen a camera scrolls it will change the location at which this Container is rendered on-screen.\nIt does not change the Containers actual position values.\n\nFor a Container, setting this value will only update the Container itself, not its children.\nIf you wish to change the scrollFactor of the children as well, use the `setScrollFactor` method.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Container.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#scrollFactorY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Internal value to allow Containers to be used for input and physics.\nDo not change this value. It has no effect other than to break things.","name":"originX","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#originX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Internal value to allow Containers to be used for input and physics.\nDo not change this value. It has no effect other than to break things.","name":"originY","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#originY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":296,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Internal value to allow Containers to be used for input and physics.\nDo not change this value. It has no effect other than to break things.","name":"displayOriginX","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#displayOriginX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Internal value to allow Containers to be used for input and physics.\nDo not change this value. It has no effect other than to break things.","name":"displayOriginY","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#displayOriginY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Does this Container exclusively manage its children?\n\nThe default is `true` which means a child added to this Container cannot\nbelong in another Container, which includes the Scene display list.\n\nIf you disable this then this Container will no longer exclusively manage its children.\nThis allows you to create all kinds of interesting graphical effects, such as replicating\nGame Objects without reparenting them all over the Scene.\nHowever, doing so will prevent children from receiving any kind of input event or have\ntheir physics bodies work by default, as they're no longer a single entity on the\ndisplay list, but are being replicated where-ever this Container is.","kind":"function","name":"setExclusive","since":"3.4.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The exclusive state of this Container.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setExclusive","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":361,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Gets the bounds of this Container. It works by iterating all children of the Container,\ngetting their respective bounds, and then working out a min-max rectangle from that.\nIt does not factor in if the children render or not, all are included.\n\nSome children are unable to return their bounds, such as Graphics objects, in which case\nthey are skipped.\n\nDepending on the quantity of children in this Container it could be a really expensive call,\nso cache it and only poll it as needed.\n\nThe values are stored and returned in a Rectangle object.","kind":"function","name":"getBounds","since":"3.4.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"A Geom.Rectangle object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getBounds","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":453,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Takes a Point-like object, such as a Vector2, Geom.Point or object with public x and y properties,\nand transforms it into the space of this Container, then returns it in the output object.","kind":"function","name":"pointToContainer","since":"3.4.0","params":[{"type":{"names":["object","Phaser.Geom.Point","Phaser.Math.Vector2"]},"description":"The Source Point to be transformed.","name":"source"},{"type":{"names":["object","Phaser.Geom.Point","Phaser.Math.Vector2"]},"optional":true,"description":"A destination object to store the transformed point in. If none given a Vector2 will be created and returned.","name":"output"}],"returns":[{"type":{"names":["object","Phaser.Geom.Point","Phaser.Math.Vector2"]},"description":"The transformed point."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#pointToContainer","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":486,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the world transform matrix as used for Bounds checks.\n\nThe returned matrix is temporal and shouldn't be stored.","kind":"function","name":"getBoundsTransformMatrix","since":"3.4.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The world transform matrix."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getBoundsTransformMatrix","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Adds the given Game Object, or array of Game Objects, to this Container.\n\nEach Game Object must be unique within the Container.","kind":"function","name":"add","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"The Game Object, or array of Game Objects, to add to the Container.","name":"child"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#add","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":520,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Adds the given Game Object, or array of Game Objects, to this Container at the specified position.\n\nExisting Game Objects in the Container are shifted up.\n\nEach Game Object must be unique within the Container.","kind":"function","name":"addAt","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"The Game Object, or array of Game Objects, to add to the Container.","name":"child"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The position to insert the Game Object/s at.","name":"index"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#addAt","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":542,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the Game Object at the given position in this Container.","kind":"function","name":"getAt","since":"3.4.0","params":[{"type":{"names":["integer"]},"description":"The position to get the Game Object from.","name":"index"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The Game Object at the specified index, or `null` if none found."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getAt","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":557,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the index of the given Game Object in this Container.","kind":"function","name":"getIndex","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to search for in this Container.","name":"child"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the Game Object in this Container, or -1 if not found."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getIndex","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":572,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Sort the contents of this Container so the items are in order based on the given property.\nFor example: `sort('alpha')` would sort the elements based on the value of their `alpha` property.","kind":"function","name":"sort","since":"3.4.0","params":[{"type":{"names":["string"]},"description":"The property to lexically sort by.","name":"property"},{"type":{"names":["function"]},"optional":true,"description":"Provide your own custom handler function. Will receive 2 children which it should compare and return a boolean.","name":"handler"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#sort","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":604,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Searches for the first instance of a child with its `name` property matching the given argument.\nShould more than one child have the same name only the first is returned.","kind":"function","name":"getByName","since":"3.4.0","params":[{"type":{"names":["string"]},"description":"The name to search for.","name":"name"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The first child with a matching name, or `null` if none were found."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getByName","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":620,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns a random Game Object from this Container.","kind":"function","name":"getRandom","since":"3.4.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"An optional length, the total number of elements (from the startIndex) to choose from.","name":"length"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"description":"A random child from the Container, or `null` if the Container is empty."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getRandom","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":636,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Gets the first Game Object in this Container.\n\nYou can also specify a property and value to search for, in which case it will return the first\nGame Object in this Container with a matching property and / or value.\n\nFor example: `getFirst('visible', true)` would return the first Game Object that had its `visible` property set.\n\nYou can limit the search to the `startIndex` - `endIndex` range.","kind":"function","name":"getFirst","since":"3.4.0","params":[{"type":{"names":["string"]},"description":"The property to test on each Game Object in the Container.","name":"property"},{"type":{"names":["*"]},"description":"The value to test the property against. Must pass a strict (`===`) comparison check.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Container.length","description":"An optional end index to search up to (but not included)","name":"endIndex"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The first matching Game Object, or `null` if none was found."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getFirst","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":661,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns all Game Objects in this Container.\n\nYou can optionally specify a matching criteria using the `property` and `value` arguments.\n\nFor example: `getAll('body')` would return only Game Objects that have a body property.\n\nYou can also specify a value to compare the property to:\n\n`getAll('visible', true)` would return only Game Objects that have their visible property set to `true`.\n\nOptionally you can specify a start and end index. For example if this Container had 100 Game Objects,\nand you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\nthe first 50 Game Objects.","kind":"function","name":"getAll","since":"3.4.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The property to test on each Game Object in the Container.","name":"property"},{"type":{"names":["any"]},"optional":true,"description":"If property is set then the `property` must strictly equal this value to be included in the results.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Container.length","description":"An optional end index to search up to (but not included)","name":"endIndex"}],"returns":[{"type":{"names":["Array."]},"description":"An array of matching Game Objects from this Container."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getAll","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":691,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the total number of Game Objects in this Container that have a property\nmatching the given value.\n\nFor example: `count('visible', true)` would count all the elements that have their visible property set.\n\nYou can optionally limit the operation to the `startIndex` - `endIndex` range.","kind":"function","name":"count","since":"3.4.0","params":[{"type":{"names":["string"]},"description":"The property to check.","name":"property"},{"type":{"names":["any"]},"description":"The value to check.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Container.length","description":"An optional end index to search up to (but not included)","name":"endIndex"}],"returns":[{"type":{"names":["integer"]},"description":"The total number of Game Objects in this Container with a property matching the given value."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#count","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":714,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Swaps the position of two Game Objects in this Container.\nBoth Game Objects must belong to this Container.","kind":"function","name":"swap","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first Game Object to swap.","name":"child1"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The second Game Object to swap.","name":"child2"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#swap","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":733,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Moves a Game Object to a new position within this Container.\n\nThe Game Object must already be a child of this Container.\n\nThe Game Object is removed from its old position and inserted into the new one.\nTherefore the Container size does not change. Other children will change position accordingly.","kind":"function","name":"moveTo","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to move.","name":"child"},{"type":{"names":["integer"]},"description":"The new position of the Game Object in this Container.","name":"index"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#moveTo","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":756,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Removes the given Game Object, or array of Game Objects, from this Container.\n\nThe Game Objects must already be children of this Container.\n\nYou can also optionally call `destroy` on each Game Object that is removed from the Container.","kind":"function","name":"remove","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"The Game Object, or array of Game Objects, to be removed from the Container.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call `destroy` on each child successfully removed from this Container.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#remove","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":791,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Removes the Game Object at the given position in this Container.\n\nYou can also optionally call `destroy` on the Game Object, if one is found.","kind":"function","name":"removeAt","since":"3.4.0","params":[{"type":{"names":["integer"]},"description":"The index of the Game Object to be removed.","name":"index"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call `destroy` on the Game Object if successfully removed from this Container.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#removeAt","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":816,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Removes the Game Objects between the given positions in this Container.\n\nYou can also optionally call `destroy` on each Game Object that is removed from the Container.","kind":"function","name":"removeBetween","since":"3.4.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Container.length","description":"An optional end index to search up to (but not included)","name":"endIndex"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call `destroy` on each Game Object successfully removed from this Container.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#removeBetween","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":845,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Removes all Game Objects from this Container.\n\nYou can also optionally call `destroy` on each Game Object that is removed from the Container.","kind":"function","name":"removeAll","since":"3.4.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call `destroy` on each Game Object successfully removed from this Container.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#removeAll","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":872,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Brings the given Game Object to the top of this Container.\nThis will cause it to render on-top of any other objects in the Container.","kind":"function","name":"bringToTop","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to bring to the top of the Container.","name":"child"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#bringToTop","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":890,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Sends the given Game Object to the bottom of this Container.\nThis will cause it to render below any other objects in the Container.","kind":"function","name":"sendToBack","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to send to the bottom of the Container.","name":"child"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#sendToBack","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":908,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Moves the given Game Object up one place in this Container, unless it's already at the top.","kind":"function","name":"moveUp","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to be moved in the Container.","name":"child"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#moveUp","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":925,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Moves the given Game Object down one place in this Container, unless it's already at the bottom.","kind":"function","name":"moveDown","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to be moved in the Container.","name":"child"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#moveDown","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":942,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Reverses the order of all Game Objects in this Container.","kind":"function","name":"reverse","since":"3.4.0","returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#reverse","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":957,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Shuffles the all Game Objects in this Container using the Fisher-Yates implementation.","kind":"function","name":"shuffle","since":"3.4.0","returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#shuffle","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":972,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Replaces a Game Object in this Container with the new Game Object.\nThe new Game Object cannot already be a child of this Container.","kind":"function","name":"replace","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object in this Container that will be replaced.","name":"oldChild"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to be added to this Container.","name":"newChild"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call `destroy` on the Game Object if successfully removed from this Container.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#replace","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":1003,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns `true` if the given Game Object is a direct child of this Container.\n\nThis check does not scan nested Containers.","kind":"function","name":"exists","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to check for within this Container.","name":"child"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object is an immediate child of this Container, otherwise false."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#exists","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":1020,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Sets the property to the given value on all Game Objects in this Container.\n\nOptionally you can specify a start and end index. For example if this Container had 100 Game Objects,\nand you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\nthe first 50 Game Objects.","kind":"function","name":"setAll","since":"3.4.0","params":[{"type":{"names":["string"]},"description":"The property that must exist on the Game Object.","name":"property"},{"type":{"names":["any"]},"description":"The value to get the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Container.length","description":"An optional end index to search up to (but not included)","name":"endIndex"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setAll","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":1044,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"kind":"typedef","name":"EachContainerCallback","type":{"names":["function"]},"params":[{"type":{"names":["*"]},"description":"The child Game Object of the Container.","name":"item"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"longname":"EachContainerCallback","scope":"global","___s":true},{"meta":{"filename":"Container.js","lineno":1052,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Passes all Game Objects in this Container to the given callback.\n\nA copy of the Container is made before passing each entry to your callback.\nThis protects against the callback itself modifying the Container.\n\nIf you know for sure that the callback will not change the size of this Container\nthen you can use the more performant `Container.iterate` method instead.","kind":"function","name":"each","since":"3.4.0","params":[{"type":{"names":["function"]},"description":"The function to call.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"Value to use as `this` when executing callback.","name":"context"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#each","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":1092,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Passes all Game Objects in this Container to the given callback.\n\nOnly use this method when you absolutely know that the Container will not be modified during\nthe iteration, i.e. by removing or adding to its contents.","kind":"function","name":"iterate","since":"3.4.0","params":[{"type":{"names":["function"]},"description":"The function to call.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"Value to use as `this` when executing callback.","name":"context"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#iterate","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":1127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Sets the scroll factor of this Container and optionally all of its children.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Apply this scrollFactor to all Container children as well?","name":"updateChildren"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setScrollFactor","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":1170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"The number of Game Objects inside this Container.","name":"length","type":{"names":["integer"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#length","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":1187,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the first Game Object within the Container, or `null` if it is empty.\n\nYou can move the cursor by calling `Container.next` and `Container.previous`.","name":"first","type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#first","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":1215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the last Game Object within the Container, or `null` if it is empty.\n\nYou can move the cursor by calling `Container.next` and `Container.previous`.","name":"last","type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#last","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":1243,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the next Game Object within the Container, or `null` if it is empty.\n\nYou can move the cursor by calling `Container.next` and `Container.previous`.","name":"next","type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#next","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":1271,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the previous Game Object within the Container, or `null` if it is empty.\n\nYou can move the cursor by calling `Container.next` and `Container.previous`.","name":"previous","type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#previous","scope":"instance","kind":"member","___s":true},{"meta":{"range":[225,272],"filename":"ContainerCreator.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainerCreator.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Creates a new Container Game Object and returns it.\n\nNote: This method will only be available if the Container Game Object has been built into Phaser.","kind":"function","name":"container","since":"3.4.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#container","scope":"instance","___s":true},{"meta":{"range":[225,259],"filename":"ContainerFactory.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"name":"Container","longname":"Container","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainerFactory.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Creates a new Container Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Container Game Object has been built into Phaser.","kind":"function","name":"container","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"optional":true,"description":"An optional array of Game Objects to add to this Container.","name":"children"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#container","scope":"instance","___s":true},{"meta":{"range":[225,266],"filename":"ContainerRender.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CSSBlendModes.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Phaser Blend Modes to CSS Blend Modes Map.","name":"CSSBlendModes","kind":"member","isEnum":true,"type":{"names":["string"]},"memberof":"Phaser","readonly":true,"since":"3.12.0","longname":"Phaser.CSSBlendModes","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"DOMElement.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DOMElement.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"classdesc":"DOM Element Game Objects are a way to control and manipulate HTML Elements over the top of your game.\n\nIn order for DOM Elements to display you have to enable them by adding the following to your game\nconfiguration object:\n\n```javascript\ndom {\n createContainer: true\n}\n```\n\nWhen this is added, Phaser will automatically create a DOM Container div that is positioned over the top\nof the game canvas. This div is sized to match the canvas, and if the canvas size changes, as a result of\nsettings within the Scale Manager, the dom container is resized accordingly.\n\nYou can create a DOM Element by either passing in DOMStrings, or by passing in a reference to an existing\nElement that you wish to be placed under the control of Phaser. For example:\n\n```javascript\nthis.add.dom(x, y, 'div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\n```\n\nThe above code will insert a div element into the DOM Container at the given x/y coordinate. The DOMString in\nthe 4th argument sets the initial CSS style of the div and the final argument is the inner text. In this case,\nit will create a lime colored div that is 220px by 100px in size with the text Phaser in it, in an Arial font.\n\nYou should nearly always, without exception, use explicitly sized HTML Elements, in order to fully control\nalignment and positioning of the elements next to regular game content.\n\nRather than specify the CSS and HTML directly you can use the `load.html` File Loader to load it into the\ncache and then use the `createFromCache` method instead. You can also use `createFromHTML` and various other\nmethods available in this class to help construct your elements.\n\nOnce the element has been created you can then control it like you would any other Game Object. You can set its\nposition, scale, rotation, alpha and other properties. It will move as the main Scene Camera moves and be clipped\nat the edge of the canvas. It's important to remember some limitations of DOM Elements: The obvious one is that\nthey appear above or below your game canvas. You cannot blend them into the display list, meaning you cannot have\na DOM Element, then a Sprite, then another DOM Element behind it.\n\nThey also cannot be enabled for input. To do that, you have to use the `addListener` method to add native event\nlisteners directly. The final limitation is to do with cameras. The DOM Container is sized to match the game canvas\nentirely and clipped accordingly. DOM Elements respect camera scrolling and scrollFactor settings, but if you\nchange the size of the camera so it no longer matches the size of the canvas, they won't be clipped accordingly.\n\nAlso, all DOM Elements are inserted into the same DOM Container, regardless of which Scene they are created in.\n\nDOM Elements are a powerful way to align native HTML with your Phaser Game Objects. For example, you can insert\na login form for a multiplayer game directly into your title screen. Or a text input box for a highscore table.\nOr a banner ad from a 3rd party service. Or perhaps you'd like to use them for high resolution text display and\nUI. The choice is up to you, just remember that you're dealing with standard HTML and CSS floating over the top\nof your game, and should treat it accordingly.","kind":"class","name":"DOMElement","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.AlphaSingle","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.17.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this DOM Element in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this DOM Element in the world.","name":"y"},{"type":{"names":["Element","string"]},"optional":true,"description":"An existing DOM element, or a string. If a string starting with a # it will do a `getElementById` look-up on the string (minus the hash). Without a hash, it represents the type of element to create, i.e. 'div'.","name":"element"},{"type":{"names":["string","any"]},"optional":true,"description":"If a string, will be set directly as the elements `style` property value. If a plain object, will be iterated and the values transferred. In both cases the values replacing whatever CSS styles may have been previously set.","name":"style"},{"type":{"names":["string"]},"optional":true,"description":"If given, will be set directly as the elements `innerText` property value, replacing whatever was there before.","name":"innerText"}],"scope":"static","longname":"Phaser.GameObjects.DOMElement","___s":true},{"meta":{"filename":"DOMElement.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"A reference to the parent DOM Container that the Game instance created when it started.","name":"parent","type":{"names":["Element"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"A reference to the HTML Cache.","name":"cache","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#cache","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The actual DOM Element that this Game Object is bound to. For example, if you've created a `
`\nthen this property is a direct reference to that element within the dom.","name":"node","type":{"names":["Element"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#node","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":140,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"By default a DOM Element will have its transform, display, opacity, zIndex and blend mode properties\nupdated when its rendered. If, for some reason, you don't want any of these changed other than the\nCSS transform, then set this flag to `true`. When `true` only the CSS Transform is applied and it's\nup to you to keep track of and set the other properties as required.\n\nThis can be handy if, for example, you've a nested DOM Element and you don't want the opacity to be\npicked-up by any of its children.","name":"transformOnly","type":{"names":["boolean"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#transformOnly","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The angle, in radians, by which to skew the DOM Element on the horizontal axis.\n\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/transform","name":"skewX","type":{"names":["number"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#skewX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The angle, in radians, by which to skew the DOM Element on the vertical axis.\n\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/transform","name":"skewY","type":{"names":["number"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#skewY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"A Vector4 that contains the 3D rotation of this DOM Element around a fixed axis in 3D space.\n\nAll values in the Vector4 are treated as degrees, unless the `rotate3dAngle` property is changed.\n\nFor more details see the following MDN page:\n\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/rotate3d","name":"rotate3d","type":{"names":["Phaser.Math.Vector4"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#rotate3d","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The unit that represents the 3D rotation values. By default this is `deg` for degrees, but can\nbe changed to any supported unit. See this page for further details:\n\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/rotate3d","name":"rotate3dAngle","type":{"names":["string"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#rotate3dAngle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":204,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The native (un-scaled) width of this Game Object.\n\nFor a DOM Element this property is read-only.\n\nThe property `displayWidth` holds the computed bounds of this DOM Element, factoring in scaling.","name":"width","type":{"names":["number"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":218,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The native (un-scaled) height of this Game Object.\n\nFor a DOM Element this property is read-only.\n\nThe property `displayHeight` holds the computed bounds of this DOM Element, factoring in scaling.","name":"height","type":{"names":["number"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":232,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The computed display width of this Game Object, based on the `getBoundingClientRect` DOM call.\n\nThe property `width` holds the un-scaled width of this DOM Element.","name":"displayWidth","type":{"names":["number"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#displayWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":244,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The computed display height of this Game Object, based on the `getBoundingClientRect` DOM call.\n\nThe property `height` holds the un-scaled height of this DOM Element.","name":"displayHeight","type":{"names":["number"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#displayHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":309,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Sets the horizontal and vertical skew values of this DOM Element.\n\nFor more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/transform","kind":"function","name":"setSkew","since":"3.17.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The angle, in radians, by which to skew the DOM Element on the horizontal axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The angle, in radians, by which to skew the DOM Element on the vertical axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setSkew","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Sets the perspective CSS property of the _parent DOM Container_. This determines the distance between the z=0\nplane and the user in order to give a 3D-positioned element some perspective. Each 3D element with\nz > 0 becomes larger; each 3D-element with z < 0 becomes smaller. The strength of the effect is determined\nby the value of this property.\n\nFor more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/perspective\n\n**Changing this value changes it globally for all DOM Elements, as they all share the same parent container.**","kind":"function","name":"setPerspective","since":"3.17.0","params":[{"type":{"names":["number"]},"description":"The perspective value, in pixels, that determines the distance between the z plane and the user.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setPerspective","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":357,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The perspective CSS property value of the _parent DOM Container_. This determines the distance between the z=0\nplane and the user in order to give a 3D-positioned element some perspective. Each 3D element with\nz > 0 becomes larger; each 3D-element with z < 0 becomes smaller. The strength of the effect is determined\nby the value of this property.\n\nFor more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/perspective\n\n**Changing this value changes it globally for all DOM Elements, as they all share the same parent container.**","name":"perspective","type":{"names":["number"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#perspective","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Adds one or more native DOM event listeners onto the underlying Element of this Game Object.\nThe event is then dispatched via this Game Objects standard event emitter.\n\nFor example:\n\n```javascript\nvar div = this.add.dom(x, y, element);\n\ndiv.addListener('click');\n\ndiv.on('click', handler);\n```","kind":"function","name":"addListener","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The DOM event/s to listen for. You can specify multiple events by separating them with spaces.","name":"events"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#addListener","scope":"instance","overrides":"Phaser.GameObjects.GameObject#addListener","___s":true},{"meta":{"filename":"DOMElement.js","lineno":421,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Removes one or more native DOM event listeners from the underlying Element of this Game Object.","kind":"function","name":"removeListener","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The DOM event/s to stop listening for. You can specify multiple events by separating them with spaces.","name":"events"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#removeListener","scope":"instance","overrides":"Phaser.GameObjects.GameObject#removeListener","___s":true},{"meta":{"filename":"DOMElement.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Creates a native DOM Element, adds it to the parent DOM Container and then binds it to this Game Object,\nso you can control it. The `tagName` should be a string and is passed to `document.createElement`:\n\n```javascript\nthis.add.dom().createElement('div');\n```\n\nFor more details on acceptable tag names see: https://developer.mozilla.org/en-US/docs/Web/API/Document/createElement\n\nYou can also pass in a DOMString or style object to set the CSS on the created element, and an optional `innerText`\nvalue as well. Here is an example of a DOMString:\n\n```javascript\nthis.add.dom().createElement('div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\n```\n\nAnd using a style object:\n\n```javascript\nvar style = {\n 'background-color': 'lime';\n 'width': '200px';\n 'height': '100px';\n 'font': '48px Arial';\n};\n\nthis.add.dom().createElement('div', style, 'Phaser');\n```\n\nIf this Game Object already has an Element, it is removed from the DOM entirely first.\nAny event listeners you may have previously created will need to be re-created after this call.","kind":"function","name":"createElement","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"A string that specifies the type of element to be created. The nodeName of the created element is initialized with the value of tagName. Don't use qualified names (like \"html:a\") with this method.","name":"tagName"},{"type":{"names":["string","any"]},"optional":true,"description":"Either a DOMString that holds the CSS styles to be applied to the created element, or an object the styles will be ready from.","name":"style"},{"type":{"names":["string"]},"optional":true,"description":"A DOMString that holds the text that will be set as the innerText of the created element.","name":"innerText"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#createElement","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":507,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Binds a new DOM Element to this Game Object. If this Game Object already has an Element it is removed from the DOM\nentirely first. Any event listeners you may have previously created will need to be re-created on the new element.\n\nThe `element` argument you pass to this method can be either a string tagName:\n\n```javascript\n

Phaser

\n\nthis.add.dom().setElement('heading');\n```\n\nOr a reference to an Element instance:\n\n```javascript\n

Phaser

\n\nvar h1 = document.getElementById('heading');\n\nthis.add.dom().setElement(h1);\n```\n\nYou can also pass in a DOMString or style object to set the CSS on the created element, and an optional `innerText`\nvalue as well. Here is an example of a DOMString:\n\n```javascript\nthis.add.dom().setElement(h1, 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\n```\n\nAnd using a style object:\n\n```javascript\nvar style = {\n 'background-color': 'lime';\n 'width': '200px';\n 'height': '100px';\n 'font': '48px Arial';\n};\n\nthis.add.dom().setElement(h1, style, 'Phaser');\n```","kind":"function","name":"setElement","since":"3.17.0","params":[{"type":{"names":["string","Element"]},"description":"If a string it is passed to `getElementById()`, or it should be a reference to an existing Element.","name":"element"},{"type":{"names":["string","any"]},"optional":true,"description":"Either a DOMString that holds the CSS styles to be applied to the created element, or an object the styles will be ready from.","name":"style"},{"type":{"names":["string"]},"optional":true,"description":"A DOMString that holds the text that will be set as the innerText of the created element.","name":"innerText"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setElement","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Takes a block of html from the HTML Cache, that has previously been preloaded into the game, and then\ncreates a DOM Element from it. The loaded HTML is set as the `innerHTML` property of the created\nelement.\n\nAssume the following html is stored in a file called `loginform.html`:\n\n```html\n\n\n```\n\nWhich is loaded into your game using the cache key 'login':\n\n```javascript\nthis.load.html('login', 'assets/loginform.html');\n```\n\nYou can create a DOM Element from it using the cache key:\n\n```javascript\nthis.add.dom().createFromCache('login');\n```\n\nThe optional `elementType` argument controls the container that is created, into which the loaded html is inserted.\nThe default is a plain `div` object, but any valid tagName can be given.\n\nIf this Game Object already has an Element, it is removed from the DOM entirely first.\nAny event listeners you may have previously created will need to be re-created after this call.","kind":"function","name":"createFromCache","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"key of the html cache entry to use for this DOM Element.","name":"The"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'div'","description":"The tag name of the element into which all of the loaded html will be inserted. Defaults to a plain div tag.","name":"tagName"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#createFromCache","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":675,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Takes a string of html and then creates a DOM Element from it. The HTML is set as the `innerHTML`\nproperty of the created element.\n\n```javascript\nlet form = `\n\n\n`;\n```\n\nYou can create a DOM Element from it using the string:\n\n```javascript\nthis.add.dom().createFromHTML(form);\n```\n\nThe optional `elementType` argument controls the type of container that is created, into which the html is inserted.\nThe default is a plain `div` object, but any valid tagName can be given.\n\nIf this Game Object already has an Element, it is removed from the DOM entirely first.\nAny event listeners you may have previously created will need to be re-created after this call.","kind":"function","name":"createFromHTML","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"string of html to be set as the `innerHTML` property of the created element.","name":"A"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'div'","description":"The tag name of the element into which all of the html will be inserted. Defaults to a plain div tag.","name":"tagName"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#createFromHTML","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":735,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Removes the current DOM Element bound to this Game Object from the DOM entirely and resets the\n`node` property of this Game Object to be `null`.","kind":"function","name":"removeElement","since":"3.17.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#removeElement","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":756,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Internal method that calls `getBoundingClientRect` on the `node` and then sets the bounds width\nand height into the `displayWidth` and `displayHeight` properties, and the `clientWidth` and `clientHeight`\nvalues into the `width` and `height` properties respectively.\n\nThis is called automatically whenever a new element is created or set.","kind":"function","name":"updateSize","since":"3.17.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#updateSize","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":783,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Gets all children from this DOM Elements node, using `querySelectorAll('*')` and then iterates through\nthem, looking for the first one that has a property matching the given key and value. It then returns this child\nif found, or `null` if not.","kind":"function","name":"getChildByProperty","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The property to search the children for.","name":"property"},{"type":{"names":["string"]},"description":"The value the property must strictly equal.","name":"value"}],"returns":[{"type":{"names":["Element"]},"nullable":true,"description":"The first matching child DOM Element, or `null` if not found."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getChildByProperty","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":814,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Gets all children from this DOM Elements node, using `querySelectorAll('*')` and then iterates through\nthem, looking for the first one that has a matching id. It then returns this child if found, or `null` if not.\n\nBe aware that class and id names are case-sensitive.","kind":"function","name":"getChildByID","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The id to search the children for.","name":"id"}],"returns":[{"type":{"names":["Element"]},"nullable":true,"description":"The first matching child DOM Element, or `null` if not found."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getChildByID","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":832,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Gets all children from this DOM Elements node, using `querySelectorAll('*')` and then iterates through\nthem, looking for the first one that has a matching name. It then returns this child if found, or `null` if not.\n\nBe aware that class and id names are case-sensitive.","kind":"function","name":"getChildByName","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The name to search the children for.","name":"name"}],"returns":[{"type":{"names":["Element"]},"nullable":true,"description":"The first matching child DOM Element, or `null` if not found."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getChildByName","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":850,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Sets the `className` property of the DOM Element node and updates the internal sizes.","kind":"function","name":"setClassName","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"A string representing the class or space-separated classes of the element.","name":"className"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setClassName","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":872,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Sets the `innerText` property of the DOM Element node and updates the internal sizes.\n\nNote that only certain types of Elements can have `innerText` set on them.","kind":"function","name":"setText","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"A DOMString representing the rendered text content of the element.","name":"text"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setText","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":896,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Sets the `innerHTML` property of the DOM Element node and updates the internal sizes.","kind":"function","name":"setHTML","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"A DOMString of html to be set as the `innerHTML` property of the element.","name":"html"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setHTML","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":936,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\n\nDOMElements always return `true` as they need to still set values during the render pass, even if not visible.","kind":"function","name":"willRender","since":"3.17.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Game Object should be rendered, otherwise `false`."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#willRender","scope":"instance","overrides":"Phaser.GameObjects.GameObject#willRender","___s":true},{"meta":{"range":[180,222],"filename":"DOMElementCSSRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"name":"CSSBlendModes","longname":"CSSBlendModes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"DOMElementFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"name":"DOMElement","longname":"DOMElement","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DOMElementFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"DOM Element Game Objects are a way to control and manipulate HTML Elements over the top of your game.\n\nIn order for DOM Elements to display you have to enable them by adding the following to your game\nconfiguration object:\n\n```javascript\ndom {\n createContainer: true\n}\n```\n\nWhen this is added, Phaser will automatically create a DOM Container div that is positioned over the top\nof the game canvas. This div is sized to match the canvas, and if the canvas size changes, as a result of\nsettings within the Scale Manager, the dom container is resized accordingly.\n\nYou can create a DOM Element by either passing in DOMStrings, or by passing in a reference to an existing\nElement that you wish to be placed under the control of Phaser. For example:\n\n```javascript\nthis.add.dom(x, y, 'div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\n```\n\nThe above code will insert a div element into the DOM Container at the given x/y coordinate. The DOMString in\nthe 4th argument sets the initial CSS style of the div and the final argument is the inner text. In this case,\nit will create a lime colored div that is 220px by 100px in size with the text Phaser in it, in an Arial font.\n\nYou should nearly always, without exception, use explicitly sized HTML Elements, in order to fully control\nalignment and positioning of the elements next to regular game content.\n\nRather than specify the CSS and HTML directly you can use the `load.html` File Loader to load it into the\ncache and then use the `createFromCache` method instead. You can also use `createFromHTML` and various other\nmethods available in this class to help construct your elements.\n\nOnce the element has been created you can then control it like you would any other Game Object. You can set its\nposition, scale, rotation, alpha and other properties. It will move as the main Scene Camera moves and be clipped\nat the edge of the canvas. It's important to remember some limitations of DOM Elements: The obvious one is that\nthey appear above or below your game canvas. You cannot blend them into the display list, meaning you cannot have\na DOM Element, then a Sprite, then another DOM Element behind it.\n\nThey also cannot be enabled for input. To do that, you have to use the `addListener` method to add native event\nlisteners directly. The final limitation is to do with cameras. The DOM Container is sized to match the game canvas\nentirely and clipped accordingly. DOM Elements respect camera scrolling and scrollFactor settings, but if you\nchange the size of the camera so it no longer matches the size of the canvas, they won't be clipped accordingly.\n\nAlso, all DOM Elements are inserted into the same DOM Container, regardless of which Scene they are created in.\n\nDOM Elements are a powerful way to align native HTML with your Phaser Game Objects. For example, you can insert\na login form for a multiplayer game directly into your title screen. Or a text input box for a highscore table.\nOr a banner ad from a 3rd party service. Or perhaps you'd like to use them for high resolution text display and\nUI. The choice is up to you, just remember that you're dealing with standard HTML and CSS floating over the top\nof your game, and should treat it accordingly.\n\nNote: This method will only be available if the DOM Element Game Object has been built into Phaser.","kind":"function","name":"dom","since":"3.17.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this DOM Element in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this DOM Element in the world.","name":"y"},{"type":{"names":["HTMLElement","string"]},"optional":true,"description":"An existing DOM element, or a string. If a string starting with a # it will do a `getElementById` look-up on the string (minus the hash). Without a hash, it represents the type of element to create, i.e. 'div'.","name":"element"},{"type":{"names":["string","any"]},"optional":true,"description":"If a string, will be set directly as the elements `style` property value. If a plain object, will be iterated and the values transferred. In both cases the values replacing whatever CSS styles may have been previously set.","name":"style"},{"type":{"names":["string"]},"optional":true,"description":"If given, will be set directly as the elements `innerText` property value, replacing whatever was there before.","name":"innerText"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#dom","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"DOMElementRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DESTROY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Game Object Destroy Event.\n\nThis event is dispatched when a Game Object instance is being destroyed.\n\nListen for it on a Game Object instance using `GameObject.on('destroy', listener)`.","kind":"event","name":"DESTROY","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object which is being destroyed.","name":"gameObject"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:DESTROY","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Complete Event.\n\nThis event is dispatched when a Video finishes playback by reaching the end of its duration. It\nis also dispatched if a video marker sequence is being played and reaches the end.\n\nNote that not all videos can fire this event. Live streams, for example, have no fixed duration,\nso never technically 'complete'.\n\nIf a video is stopped from playback, via the `Video.stop` method, it will emit the\n`VIDEO_STOP` event instead of this one.\n\nListen for it from a Video Game Object instance using `Video.on('complete', listener)`.","kind":"event","name":"VIDEO_COMPLETE","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which completed playback.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_CREATED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Created Event.\n\nThis event is dispatched when the texture for a Video has been created. This happens\nwhen enough of the video source has been loaded that the browser is able to render a\nframe from it.\n\nListen for it from a Video Game Object instance using `Video.on('created', listener)`.","kind":"event","name":"VIDEO_CREATED","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which raised the event.","name":"video"},{"type":{"names":["integer"]},"description":"The width of the video.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the video.","name":"height"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_CREATED","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_ERROR_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Error Event.\n\nThis event is dispatched when a Video tries to play a source that does not exist, or is the wrong file type.\n\nListen for it from a Video Game Object instance using `Video.on('error', listener)`.","kind":"event","name":"VIDEO_ERROR","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which threw the error.","name":"video"},{"type":{"names":["Event"]},"description":"The native DOM event the browser raised during playback.","name":"event"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_ERROR","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_LOOP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Loop Event.\n\nThis event is dispatched when a Video that is currently playing has looped. This only\nhappens if the `loop` parameter was specified, or the `setLoop` method was called,\nand if the video has a fixed duration. Video streams, for example, cannot loop, as\nthey have no duration.\n\nLooping is based on the result of the Video `timeupdate` event. This event is not\nframe-accurate, due to the way browsers work, so please do not rely on this loop\nevent to be time or frame precise.\n\nListen for it from a Video Game Object instance using `Video.on('loop', listener)`.","kind":"event","name":"VIDEO_LOOP","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which has looped.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_LOOP","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_PLAY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Play Event.\n\nThis event is dispatched when a Video begins playback. For videos that do not require\ninteraction unlocking, this is usually as soon as the `Video.play` method is called.\nHowever, for videos that require unlocking, it is fired once playback begins after\nthey've been unlocked.\n\nListen for it from a Video Game Object instance using `Video.on('play', listener)`.","kind":"event","name":"VIDEO_PLAY","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which started playback.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_PLAY","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_SEEKED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Seeked Event.\n\nThis event is dispatched when a Video completes seeking to a new point in its timeline.\n\nListen for it from a Video Game Object instance using `Video.on('seeked', listener)`.","kind":"event","name":"VIDEO_SEEKED","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which completed seeking.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_SEEKED","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_SEEKING_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Seeking Event.\n\nThis event is dispatched when a Video _begins_ seeking to a new point in its timeline.\nWhen the seek is complete, it will dispatch the `VIDEO_SEEKED` event to conclude.\n\nListen for it from a Video Game Object instance using `Video.on('seeking', listener)`.","kind":"event","name":"VIDEO_SEEKING","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which started seeking.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_SEEKING","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_STOP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Stopped Event.\n\nThis event is dispatched when a Video is stopped from playback via a call to the `Video.stop` method,\neither directly via game code, or indirectly as the result of changing a video source or destroying it.\n\nListen for it from a Video Game Object instance using `Video.on('stop', listener)`.","kind":"event","name":"VIDEO_STOP","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which stopped playback.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_STOP","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_TIMEOUT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Timeout Event.\n\nThis event is dispatched when a Video has exhausted its allocated time while trying to connect to a video\nsource to start playback.\n\nListen for it from a Video Game Object instance using `Video.on('timeout', listener)`.","kind":"event","name":"VIDEO_TIMEOUT","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which timed out.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_TIMEOUT","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_UNLOCKED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Unlocked Event.\n\nThis event is dispatched when a Video that was prevented from playback due to the browsers\nMedia Engagement Interaction policy, is unlocked by a user gesture.\n\nListen for it from a Video Game Object instance using `Video.on('unlocked', listener)`.","kind":"event","name":"VIDEO_UNLOCKED","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which raised the event.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_UNLOCKED","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"kind":"namespace","name":"Events","memberof":"Phaser.GameObjects","longname":"Phaser.GameObjects.Events","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Extern.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/extern"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Extern.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/extern"},"classdesc":"An Extern Game Object is a special type of Game Object that allows you to pass\nrendering off to a 3rd party.\n\nWhen you create an Extern and place it in the display list of a Scene, the renderer will\nprocess the list as usual. When it finds an Extern it will flush the current batch,\nclear down the pipeline and prepare a transform matrix which your render function can\ntake advantage of, if required.\n\nThe WebGL context is then left is a 'clean' state, ready for you to bind your own shaders,\nor draw to it, whatever you wish to do. Once you've finished, you should free-up any\nof your resources. The Extern will then rebind the Phaser pipeline and carry on \nrendering the display list.\n\nAlthough this object has lots of properties such as Alpha, Blend Mode and Tint, none of\nthem are used during rendering unless you take advantage of them in your own render code.","kind":"class","name":"Extern","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.16.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"}],"scope":"static","longname":"Phaser.GameObjects.Extern","___s":true},{"meta":{"range":[180,208],"filename":"ExternFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/extern"},"name":"Extern","longname":"Extern","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ExternFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/extern"},"description":"Creates a new Extern Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Extern Game Object has been built into Phaser.","kind":"function","name":"extern","since":"3.16.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#extern","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"ExternRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/extern"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[176,604],"filename":"Commands.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"exports","longname":"module.exports","kind":"member","memberof":"module","scope":"static","___s":true},{"meta":{"range":[180,234],"filename":"Graphics.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"BaseCamera","longname":"BaseCamera","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Graphics.js","lineno":28,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"classdesc":"A Graphics object is a way to draw primitive shapes to your game. Primitives include forms of geometry, such as\nRectangles, Circles, and Polygons. They also include lines, arcs and curves. When you initially create a Graphics\nobject it will be empty.\n\nTo draw to it you must first specify a line style or fill style (or both), draw shapes using paths, and finally\nfill or stroke them. For example:\n\n```javascript\ngraphics.lineStyle(5, 0xFF00FF, 1.0);\ngraphics.beginPath();\ngraphics.moveTo(100, 100);\ngraphics.lineTo(200, 200);\ngraphics.closePath();\ngraphics.strokePath();\n```\n\nThere are also many helpful methods that draw and fill/stroke common shapes for you.\n\n```javascript\ngraphics.lineStyle(5, 0xFF00FF, 1.0);\ngraphics.fillStyle(0xFFFFFF, 1.0);\ngraphics.fillRect(50, 50, 400, 200);\ngraphics.strokeRect(50, 50, 400, 200);\n```\n\nWhen a Graphics object is rendered it will render differently based on if the game is running under Canvas or WebGL.\nUnder Canvas it will use the HTML Canvas context drawing operations to draw the path.\nUnder WebGL the graphics data is decomposed into polygons. Both of these are expensive processes, especially with\ncomplex shapes.\n\nIf your Graphics object doesn't change much (or at all) once you've drawn your shape to it, then you will help\nperformance by calling {@link Phaser.GameObjects.Graphics#generateTexture}. This will 'bake' the Graphics object into\na Texture, and return it. You can then use this Texture for Sprites or other display objects. If your Graphics object\nupdates frequently then you should avoid doing this, as it will constantly generate new textures, which will consume\nmemory.\n\nAs you can tell, Graphics objects are a bit of a trade-off. While they are extremely useful, you need to be careful\nin their complexity and quantity of them in your game.","kind":"class","name":"Graphics","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.AlphaSingle","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible","Phaser.GameObjects.Components.ScrollFactor"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Graphics object belongs.","name":"scene"},{"type":{"names":["Phaser.Types.GameObjects.Graphics.Options"]},"optional":true,"description":"Options that set the position and default style of this Graphics object.","name":"options"}],"scope":"static","longname":"Phaser.GameObjects.Graphics","___s":true},{"meta":{"filename":"Graphics.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The horizontal display origin of the Graphics.","name":"displayOriginX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#displayOriginX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":125,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The vertical display origin of the Graphics.","name":"displayOriginY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#displayOriginY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The array of commands used to render the Graphics.","name":"commandBuffer","type":{"names":["array"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#commandBuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":145,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The default fill color for shapes rendered by this Graphics object.","name":"defaultFillColor","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#defaultFillColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The default fill alpha for shapes rendered by this Graphics object.","name":"defaultFillAlpha","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#defaultFillAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The default stroke width for shapes rendered by this Graphics object.","name":"defaultStrokeWidth","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#defaultStrokeWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":175,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The default stroke color for shapes rendered by this Graphics object.","name":"defaultStrokeColor","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#defaultStrokeColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":185,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The default stroke alpha for shapes rendered by this Graphics object.","name":"defaultStrokeAlpha","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#defaultStrokeAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Set the default style settings for this Graphics object.","kind":"function","name":"setDefaultStyles","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Graphics.Styles"]},"description":"The styles to set as defaults.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setDefaultStyles","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Set the current line style.","kind":"function","name":"lineStyle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The stroke width.","name":"lineWidth"},{"type":{"names":["number"]},"description":"The stroke color.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The stroke alpha.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#lineStyle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":296,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Set the current fill style.","kind":"function","name":"fillStyle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The fill color.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The fill alpha.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillStyle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Sets a gradient fill style. This is a WebGL only feature.\n\nThe gradient color values represent the 4 corners of an untransformed rectangle.\nThe gradient is used to color all filled shapes and paths drawn after calling this method.\nIf you wish to turn a gradient off, call `fillStyle` and provide a new single fill color.\n\nWhen filling a triangle only the first 3 color values provided are used for the 3 points of a triangle.\n\nThis feature is best used only on rectangles and triangles. All other shapes will give strange results.\n\nNote that for objects such as arcs or ellipses, or anything which is made out of triangles, each triangle used\nwill be filled with a gradient on its own. There is no ability to gradient fill a shape or path as a single\nentity at this time.","kind":"function","name":"fillGradientStyle","since":"3.12.0","params":[{"type":{"names":["integer"]},"description":"The tint being applied to the top-left of the Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The fill alpha.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillGradientStyle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":358,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Sets a gradient line style. This is a WebGL only feature.\n\nThe gradient color values represent the 4 corners of an untransformed rectangle.\nThe gradient is used to color all stroked shapes and paths drawn after calling this method.\nIf you wish to turn a gradient off, call `lineStyle` and provide a new single line color.\n\nThis feature is best used only on single lines. All other shapes will give strange results.\n\nNote that for objects such as arcs or ellipses, or anything which is made out of triangles, each triangle used\nwill be filled with a gradient on its own. There is no ability to gradient stroke a shape or path as a single\nentity at this time.","kind":"function","name":"lineGradientStyle","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The stroke width.","name":"lineWidth"},{"type":{"names":["integer"]},"description":"The tint being applied to the top-left of the Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The fill alpha.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#lineGradientStyle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":396,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Sets the texture frame this Graphics Object will use when drawing all shapes defined after calling this.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.\n\nOnce set, all shapes will use this texture. Call this method with no arguments to clear it.\n\nThe textures are not tiled. They are stretched to the dimensions of the shapes being rendered. For this reason,\nit works best with seamless / tileable textures.\n\nThe mode argument controls how the textures are combined with the fill colors. The default value (0) will\nmultiply the texture by the fill color. A value of 1 will use just the fill color, but the alpha data from the texture,\nand a value of 2 will use just the texture and no fill color at all.","kind":"function","name":"setTexture","since":"3.12.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The key of the texture to be used, as stored in the Texture Manager. Leave blank to clear a previously set texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The texture tint mode. 0 is multiply, 1 is alpha only and 2 is texture only.","name":"mode"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setTexture","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":452,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Start a new shape path.","kind":"function","name":"beginPath","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#beginPath","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":469,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Close the current path.","kind":"function","name":"closePath","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#closePath","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":486,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the current path.","kind":"function","name":"fillPath","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillPath","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":503,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the current path.\n\nThis is an alias for `Graphics.fillPath` and does the same thing.\nIt was added to match the CanvasRenderingContext 2D API.","kind":"function","name":"fill","since":"3.16.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fill","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":523,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the current path.","kind":"function","name":"strokePath","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokePath","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":540,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the current path.\n\nThis is an alias for `Graphics.strokePath` and does the same thing.\nIt was added to match the CanvasRenderingContext 2D API.","kind":"function","name":"stroke","since":"3.16.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#stroke","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":560,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the given circle.","kind":"function","name":"fillCircleShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The circle to fill.","name":"circle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillCircleShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":575,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the given circle.","kind":"function","name":"strokeCircleShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The circle to stroke.","name":"circle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeCircleShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill a circle with the given position and radius.","kind":"function","name":"fillCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the circle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the circle.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillCircle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":611,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke a circle with the given position and radius.","kind":"function","name":"strokeCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the circle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the circle.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeCircle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the given rectangle.","kind":"function","name":"fillRectShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle to fill.","name":"rect"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillRectShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":647,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the given rectangle.","kind":"function","name":"strokeRectShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle to stroke.","name":"rect"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeRectShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":662,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill a rectangle with the given position and size.","kind":"function","name":"fillRect","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the top-left of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillRect","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":685,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke a rectangle with the given position and size.","kind":"function","name":"strokeRect","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the top-left of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeRect","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":727,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill a rounded rectangle with the given position, size and radius.","kind":"function","name":"fillRoundedRect","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the top-left of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"height"},{"type":{"names":["Phaser.Types.GameObjects.Graphics.RoundedRectRadius","number"]},"optional":true,"defaultvalue":20,"description":"The corner radius; It can also be an object to specify different radii for corners.","name":"radius"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillRoundedRect","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":773,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke a rounded rectangle with the given position, size and radius.","kind":"function","name":"strokeRoundedRect","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the top-left of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"height"},{"type":{"names":["Phaser.Types.GameObjects.Graphics.RoundedRectRadius","number"]},"optional":true,"defaultvalue":20,"description":"The corner radius; It can also be an object to specify different radii for corners.","name":"radius"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeRoundedRect","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":819,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the given point.\n\nDraws a square at the given position, 1 pixel in size by default.","kind":"function","name":"fillPointShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","Phaser.Math.Vector2","object"]},"description":"The point to fill.","name":"point"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The size of the square to draw.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillPointShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":837,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill a point at the given position.\n\nDraws a square at the given position, 1 pixel in size by default.","kind":"function","name":"fillPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the point.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the point.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The size of the square to draw.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillPoint","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":871,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the given triangle.","kind":"function","name":"fillTriangleShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The triangle to fill.","name":"triangle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillTriangleShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":886,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the given triangle.","kind":"function","name":"strokeTriangleShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The triangle to stroke.","name":"triangle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeTriangleShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":901,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill a triangle with the given points.","kind":"function","name":"fillTriangle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x0"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y0"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the third point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the third point.","name":"y2"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillTriangle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":926,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke a triangle with the given points.","kind":"function","name":"strokeTriangle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x0"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y0"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the third point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the third point.","name":"y2"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeTriangle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":951,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Draw the given line.","kind":"function","name":"strokeLineShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to stroke.","name":"line"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeLineShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":966,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Draw a line between the given points.","kind":"function","name":"lineBetween","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the start point of the line.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the start point of the line.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the end point of the line.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the end point of the line.","name":"y2"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#lineBetween","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":989,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Draw a line from the current drawing position to the given position.\n\nMoves the current drawing position to the given position.","kind":"function","name":"lineTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to draw the line to.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to draw the line to.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#lineTo","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1012,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Move the current drawing position to the given position.","kind":"function","name":"moveTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to move to.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to move to.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#moveTo","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1033,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the shape represented by the given array of points.\n\nPass `closeShape` to automatically close the shape by joining the last to the first point.\n\nPass `closePath` to automatically close the path before it is stroked.","kind":"function","name":"strokePoints","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The points to stroke.","name":"points"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When `true`, the shape is closed by joining the last point to the first point.","name":"closeShape"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When `true`, the path is closed before being stroked.","name":"closePath"},{"type":{"names":["integer"]},"optional":true,"description":"The index of `points` to stop drawing at. Defaults to `points.length`.","name":"endIndex"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokePoints","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1080,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the shape represented by the given array of points.\n\nPass `closeShape` to automatically close the shape by joining the last to the first point.\n\nPass `closePath` to automatically close the path before it is filled.","kind":"function","name":"fillPoints","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The points to fill.","name":"points"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When `true`, the shape is closed by joining the last point to the first point.","name":"closeShape"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When `true`, the path is closed before being stroked.","name":"closePath"},{"type":{"names":["integer"]},"optional":true,"description":"The index of `points` to stop at. Defaults to `points.length`.","name":"endIndex"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillPoints","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the given ellipse.","kind":"function","name":"strokeEllipseShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The ellipse to stroke.","name":"ellipse"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The number of points to draw the ellipse with.","name":"smoothness"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeEllipseShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke an ellipse with the given position and size.","kind":"function","name":"strokeEllipse","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the ellipse.","name":"y"},{"type":{"names":["number"]},"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"description":"The height of the ellipse.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The number of points to draw the ellipse with.","name":"smoothness"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeEllipse","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1172,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the given ellipse.","kind":"function","name":"fillEllipseShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The ellipse to fill.","name":"ellipse"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The number of points to draw the ellipse with.","name":"smoothness"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillEllipseShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1192,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill an ellipse with the given position and size.","kind":"function","name":"fillEllipse","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the ellipse.","name":"y"},{"type":{"names":["number"]},"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"description":"The height of the ellipse.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The number of points to draw the ellipse with.","name":"smoothness"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillEllipse","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1217,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Draw an arc.\n\nThis method can be used to create circles, or parts of circles.\n\nMake sure you call `beginPath` before starting the arc unless you wish for the arc to automatically\nclose when filled or stroked.\n\nUse the optional `overshoot` argument increase the number of iterations that take place when\nthe arc is rendered in WebGL. This is useful if you're drawing an arc with an especially thick line,\nas it will allow the arc to fully join-up. Try small values at first, i.e. 0.01.\n\nCall {@link Phaser.GameObjects.Graphics#fillPath} or {@link Phaser.GameObjects.Graphics#strokePath} after calling\nthis method to draw the arc.","kind":"function","name":"arc","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the circle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the circle.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["number"]},"description":"The starting angle, in radians.","name":"startAngle"},{"type":{"names":["number"]},"description":"The ending angle, in radians.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the drawing should be anticlockwise or clockwise.","name":"anticlockwise"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This value allows you to increase the segment iterations in WebGL rendering. Useful if the arc has a thick stroke and needs to overshoot to join-up cleanly. Use small numbers such as 0.01 to start with and increase as needed.","name":"overshoot"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#arc","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Creates a pie-chart slice shape centered at `x`, `y` with the given radius.\nYou must define the start and end angle of the slice.\n\nSetting the `anticlockwise` argument to `true` creates a shape similar to Pacman.\nSetting it to `false` creates a shape like a slice of pie.\n\nThis method will begin a new path and close the path at the end of it.\nTo display the actual slice you need to call either `strokePath` or `fillPath` after it.","kind":"function","name":"slice","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The horizontal center of the slice.","name":"x"},{"type":{"names":["number"]},"description":"The vertical center of the slice.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the slice.","name":"radius"},{"type":{"names":["number"]},"description":"The start angle of the slice, given in radians.","name":"startAngle"},{"type":{"names":["number"]},"description":"The end angle of the slice, given in radians.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the drawing should be anticlockwise or clockwise.","name":"anticlockwise"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This value allows you to overshoot the endAngle by this amount. Useful if the arc has a thick stroke and needs to overshoot to join-up cleanly.","name":"overshoot"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#slice","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Saves the state of the Graphics by pushing the current state onto a stack.\n\nThe most recently saved state can then be restored with {@link Phaser.GameObjects.Graphics#restore}.","kind":"function","name":"save","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#save","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1316,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Restores the most recently saved state of the Graphics by popping from the state stack.\n\nUse {@link Phaser.GameObjects.Graphics#save} to save the current state, and call this afterwards to restore that state.\n\nIf there is no saved state, this command does nothing.","kind":"function","name":"restore","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#restore","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Inserts a translation command into this Graphics objects command buffer.\n\nAll objects drawn _after_ calling this method will be translated\nby the given amount.\n\nThis does not change the position of the Graphics object itself,\nonly of the objects drawn by it after calling this method.","kind":"function","name":"translateCanvas","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal translation to apply.","name":"x"},{"type":{"names":["number"]},"description":"The vertical translation to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#translateCanvas","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1364,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Inserts a scale command into this Graphics objects command buffer.\n\nAll objects drawn _after_ calling this method will be scaled\nby the given amount.\n\nThis does not change the scale of the Graphics object itself,\nonly of the objects drawn by it after calling this method.","kind":"function","name":"scaleCanvas","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale to apply.","name":"x"},{"type":{"names":["number"]},"description":"The vertical scale to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#scaleCanvas","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Inserts a rotation command into this Graphics objects command buffer.\n\nAll objects drawn _after_ calling this method will be rotated\nby the given amount.\n\nThis does not change the rotation of the Graphics object itself,\nonly of the objects drawn by it after calling this method.","kind":"function","name":"rotateCanvas","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The rotation angle, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#rotateCanvas","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1417,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Clear the command buffer and reset the fill style and line style to their defaults.","kind":"function","name":"clear","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#clear","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1442,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Generate a texture from this Graphics object.\n\nIf `key` is a string it'll generate a new texture using it and add it into the\nTexture Manager (assuming no key conflict happens).\n\nIf `key` is a Canvas it will draw the texture to that canvas context. Note that it will NOT\nautomatically upload it to the GPU in WebGL mode.","kind":"function","name":"generateTexture","since":"3.0.0","params":[{"type":{"names":["string","HTMLCanvasElement"]},"description":"The key to store the texture with in the Texture Manager, or a Canvas to draw to.","name":"key"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the graphics to generate.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the graphics to generate.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#generateTexture","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1535,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"A Camera used specifically by the Graphics system for rendering to textures.","name":"TargetCamera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"since":"3.1.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics.TargetCamera","scope":"static","kind":"member","___s":true},{"meta":{"range":[180,212],"filename":"GraphicsCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"Commands","longname":"Commands","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,231],"filename":"GraphicsCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"GameObjectCreator","longname":"GameObjectCreator","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GraphicsCreator.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Creates a new Graphics Game Object and returns it.\n\nNote: This method will only be available if the Graphics Game Object has been built into Phaser.","kind":"function","name":"graphics","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#graphics","scope":"instance","___s":true},{"meta":{"range":[180,212],"filename":"GraphicsFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"Graphics","longname":"Graphics","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GraphicsFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Creates a new Graphics Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Graphics Game Object has been built into Phaser.","kind":"function","name":"graphics","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Graphics.Options"]},"optional":true,"description":"The Graphics configuration.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#graphics","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"GraphicsRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,212],"filename":"GraphicsWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"Commands","longname":"Commands","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FillStyle.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs"},"description":"Graphics fill style settings.","kind":"typedef","name":"FillStyle","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"The fill color.","name":"color"},{"type":{"names":["number"]},"optional":true,"description":"The fill alpha.","name":"alpha"}],"memberof":"Phaser.Types.GameObjects.Graphics","longname":"Phaser.Types.GameObjects.Graphics.FillStyle","scope":"static","___s":true},{"meta":{"filename":"LineStyle.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs"},"description":"Graphics line style (or stroke style) settings.","kind":"typedef","name":"LineStyle","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"The stroke width.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The stroke color.","name":"color"},{"type":{"names":["number"]},"optional":true,"description":"The stroke alpha.","name":"alpha"}],"memberof":"Phaser.Types.GameObjects.Graphics","longname":"Phaser.Types.GameObjects.Graphics.LineStyle","scope":"static","___s":true},{"meta":{"filename":"Options.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs"},"description":"Options for the Graphics game Object.","kind":"typedef","name":"Options","type":{"names":["object"]},"augments":["Phaser.Types.GameObjects.Graphics.Styles"],"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"The x coordinate of the Graphics.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate of the Graphics.","name":"y"}],"memberof":"Phaser.Types.GameObjects.Graphics","longname":"Phaser.Types.GameObjects.Graphics.Options","scope":"static","___s":true},{"meta":{"filename":"RoundedRectRadius.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs"},"kind":"typedef","name":"RoundedRectRadius","type":{"names":["object"]},"since":"3.11.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":20,"description":"Top left","name":"tl"},{"type":{"names":["number"]},"optional":true,"defaultvalue":20,"description":"Top right","name":"tr"},{"type":{"names":["number"]},"optional":true,"defaultvalue":20,"description":"Bottom right","name":"br"},{"type":{"names":["number"]},"optional":true,"defaultvalue":20,"description":"Bottom left","name":"bl"}],"memberof":"Phaser.Types.GameObjects.Graphics","longname":"Phaser.Types.GameObjects.Graphics.RoundedRectRadius","scope":"static","___s":true},{"meta":{"filename":"Styles.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs"},"description":"Graphics style settings.","kind":"typedef","name":"Styles","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Graphics.LineStyle"]},"optional":true,"description":"The style applied to shape outlines.","name":"lineStyle"},{"type":{"names":["Phaser.Types.GameObjects.Graphics.FillStyle"]},"optional":true,"description":"The style applied to shape areas.","name":"fillStyle"}],"memberof":"Phaser.Types.GameObjects.Graphics","longname":"Phaser.Types.GameObjects.Graphics.Styles","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs"},"kind":"namespace","name":"Graphics","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.Graphics","scope":"static","___s":true},{"meta":{"range":[180,215],"filename":"Group.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"name":"Actions","longname":"Actions","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Group.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"classdesc":"A Group is a way for you to create, manipulate, or recycle similar Game Objects.\n\nGroup membership is non-exclusive. A Game Object can belong to several groups, one group, or none.\n\nGroups themselves aren't displayable, and can't be positioned, rotated, scaled, or hidden.","kind":"class","name":"Group","memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The scene this group belongs to.","name":"scene"},{"type":{"names":["Array.","Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Game Objects to add to this group; or the `config` argument.","name":"children"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Settings for this group. If `key` is set, Phaser.GameObjects.Group#createMultiple is also called with these settings.","name":"config"}],"see":["Phaser.Physics.Arcade.Group","Phaser.Physics.Arcade.StaticGroup"],"scope":"static","longname":"Phaser.GameObjects.Group","___s":true},{"meta":{"filename":"Group.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"This scene this group belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Members of this group.","name":"children","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#children","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A flag identifying this object as a group.","name":"isParent","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#isParent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A textual representation of this Game Object.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"defaultvalue":"'Group'","since":"3.21.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The class to create new group members from.","name":"classType","type":{"names":["function"]},"since":"3.0.0","defaultvalue":"Phaser.GameObjects.Sprite","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#classType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The name of this group.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.18.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether this group runs its {@link Phaser.GameObjects.Group#preUpdate} method\n(which may update any members).","name":"active","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The maximum size of this group, if used as a pool. -1 is no limit.","name":"maxSize","type":{"names":["integer"]},"since":"3.0.0","defaultvalue":"-1","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#maxSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A default texture key to use when creating new group members.\n\nThis is used in {@link Phaser.GameObjects.Group#create}\nbut not in {@link Phaser.GameObjects.Group#createMultiple}.","name":"defaultKey","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#defaultKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":170,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A default texture frame to use when creating new group members.","name":"defaultFrame","type":{"names":["string","integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#defaultFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":179,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether to call the update method of any members.","name":"runChildUpdate","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.GameObjects.Group#preUpdate"],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#runChildUpdate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":190,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when adding or creating group members.","name":"createCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#createCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":199,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when removing group members.","name":"removeCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#removeCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":208,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when creating several group members at once.","name":"createMultipleCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#createMultipleCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates a new Game Object and adds it to this group, unless the group {@link Phaser.GameObjects.Group#isFull is full}.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the new Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the new Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key of the new Game Object.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"The texture frame of the new Game Object.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of the new Game Object.","name":"visible"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.GameObject#active} state of the new Game Object.","name":"active"}],"returns":[{"type":{"names":["any"]},"description":"The new Game Object (usually a Sprite, etc.)."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#create","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":294,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates several Game Objects and adds them to this group.\n\nIf the group becomes {@link Phaser.GameObjects.Group#isFull}, no further Game Objects are created.\n\nCalls {@link Phaser.GameObjects.Group#createMultipleCallback} and {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"createMultiple","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCreateConfig","Array."]},"description":"Creation settings. This can be a single configuration object or an array of such objects, which will be applied in turn.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"The newly created Game Objects."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#createMultiple","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":335,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A helper for {@link Phaser.GameObjects.Group#createMultiple}.","kind":"function","name":"createFromConfig","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"description":"Creation settings.","name":"options"}],"returns":[{"type":{"names":["Array."]},"description":"The newly created Game Objects."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#createFromConfig","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Updates any group members, if {@link Phaser.GameObjects.Group#runChildUpdate} is enabled.","kind":"function","name":"preUpdate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current timestamp.","name":"time"},{"type":{"names":["number"]},"description":"The delta time elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#preUpdate","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds a Game Object to this group.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to add.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also add the Game Object to the scene.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#add","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":562,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds several Game Objects to this group.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"addMultiple","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The Game Objects to add.","name":"children"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also add the Game Objects to the scene.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This group."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#addMultiple","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Removes a member of this Group and optionally removes it from the Scene and / or destroys it.\n\nCalls {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to remove.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally remove the Group member from the Scene it belongs to.","name":"removeFromScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call destroy on the removed Group member.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#remove","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":645,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Removes all members of this Group and optionally removes them from the Scene and / or destroys them.\n\nDoes not call {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"clear","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally remove each Group member from the Scene.","name":"removeFromScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call destroy on the removed Group members.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This group."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#clear","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":691,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Tests if a Game Object is a member of this group.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A Game Object.","name":"child"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object is a member of this group."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#contains","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":706,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"All members of the group.","kind":"function","name":"getChildren","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"The group members."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getChildren","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":719,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The number of members of the group.","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["integer"]}}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getLength","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":732,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group, from top to bottom, for the first member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirst","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getFirst","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":757,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group, from top to bottom, for the nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstNth","since":"3.6.0","params":[{"type":{"names":["integer"]},"description":"The nth matching Group member to search for.","name":"nth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getFirstNth","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":783,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group for the last member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getLast","since":"3.6.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getLast","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":808,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group for the last nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getLastNth","since":"3.6.0","params":[{"type":{"names":["integer"]},"description":"The nth matching Group member to search for.","name":"nth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getLastNth","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":937,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\nassigns `x` and `y`, and returns the member.\n\nIf no inactive member is found and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nThe new Game Object will have its active state set to `true`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first inactive group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#get","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":961,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `true`,\nassigns `x` and `y`, and returns the member.\n\nIf no active member is found and `createIfNull` is `true` and the group isn't full then it will create a new one using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstAlive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"description":"The first active group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getFirstAlive","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":985,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\nassigns `x` and `y`, and returns the member.\n\nIf no inactive member is found and `createIfNull` is `true` and the group isn't full then it will create a new one using `x`, `y`, `key`, `frame`, and `visible`.\nThe new Game Object will have an active state set to `true`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstDead","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"description":"The first inactive group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getFirstDead","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1010,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"{@link Phaser.GameObjects.Components.Animation#play Plays} an animation for all members of this group.","kind":"function","name":"playAnimation","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["string"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#playAnimation","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1028,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether this group's size at its {@link Phaser.GameObjects.Group#maxSize maximum}.","kind":"function","name":"isFull","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if the number of members equals {@link Phaser.GameObjects.Group#maxSize}."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#isFull","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1048,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Counts the number of active (or inactive) group members.","kind":"function","name":"countActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Count active (true) or inactive (false) group members.","name":"value"}],"returns":[{"type":{"names":["integer"]},"description":"The number of group members with an active state matching the `active` argument."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#countActive","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1075,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Counts the number of in-use (active) group members.","kind":"function","name":"getTotalUsed","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of group members with an active state of true."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getTotalUsed","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The difference of {@link Phaser.GameObjects.Group#maxSize} and the number of active group members.\n\nThis represents the number of group members that could be created or reactivated before reaching the size limit.","kind":"function","name":"getTotalFree","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"maxSize minus the number of active group numbers; or a large number (if maxSize is -1)."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getTotalFree","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the property as defined in `key` of each group member to the given value.","kind":"function","name":"propertyValueSet","since":"3.21.0","params":[{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#propertyValueSet","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the property as defined in `key` of each group member.","kind":"function","name":"propertyValueInc","since":"3.21.0","params":[{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#propertyValueInc","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1148,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the x of each group member.","kind":"function","name":"setX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setX","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the y of each group member.","kind":"function","name":"setY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setY","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the x, y of each group member.","kind":"function","name":"setXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the `x` property to.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to set the `y` property to. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setXY","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the x of each group member.","kind":"function","name":"incX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#incX","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the y of each group member.","kind":"function","name":"incY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `y` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#incY","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1240,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the x, y of each group member.","kind":"function","name":"incXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to be added to the `y` property. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#incXY","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Iterate through the group members changing the position of each element to be that of the element that came before\nit in the array (or after it if direction = 1)\n\nThe first group member position is set to x/y.","kind":"function","name":"shiftPosition","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to place the first item in the array at.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to place the first item in the array at.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The iteration direction. 0 = first to last and 1 = last to first.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#shiftPosition","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1282,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the angle of each group member.","kind":"function","name":"angle","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the angle to, in degrees.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#angle","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the rotation of each group member.","kind":"function","name":"rotate","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the rotation to, in radians.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#rotate","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Rotates each group member around the given point by the given angle.","kind":"function","name":"rotateAround","since":"3.21.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#rotateAround","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1336,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Rotates each group member around the given point by the given angle and distance.","kind":"function","name":"rotateAroundDistance","since":"3.21.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"},{"type":{"names":["number"]},"description":"The distance from the point of rotation in pixels.","name":"distance"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#rotateAroundDistance","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the alpha of each group member.","kind":"function","name":"setAlpha","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the alpha to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setAlpha","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the tint of each group member.","kind":"function","name":"setTint","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The tint being applied to top-left corner of item. If other parameters are given no value, this tint will be applied to whole item.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to top-right corner of item.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-left corner of item.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-right corner of item.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setTint","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1393,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the originX, originY of each group member.","kind":"function","name":"setOrigin","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the `originX` property to.","name":"originX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to set the `originY` property to. If `undefined` or `null` it uses the `originX` value.","name":"originY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originY` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setOrigin","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1413,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleX of each group member.","kind":"function","name":"scaleX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#scaleX","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleY of each group member.","kind":"function","name":"scaleY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#scaleY","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleX, scaleY of each group member.","kind":"function","name":"scaleXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `scaleX` property.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to be added to the `scaleY` property. If `undefined` or `null` it uses the `scaleX` value.","name":"scaleY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleY` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#scaleXY","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1469,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the depth of each group member.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setDepth","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1487,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the blendMode of each group member.","kind":"function","name":"setBlendMode","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setBlendMode","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1504,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Passes all group members to the Input Manager to enable them for input with identical areas and callbacks.","kind":"function","name":"setHitArea","since":"3.21.0","params":[{"type":{"names":["*"]},"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"hitAreaCallback"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setHitArea","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1522,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Shuffles the group members in place.","kind":"function","name":"shuffle","since":"3.21.0","returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#shuffle","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Deactivates a member of this group.","kind":"function","name":"kill","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A member of this group.","name":"gameObject"}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#kill","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1553,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Deactivates and hides a member of this group.","kind":"function","name":"killAndHide","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A member of this group.","name":"gameObject"}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#killAndHide","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1570,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the visible of each group member.","kind":"function","name":"setVisible","since":"3.21.0","params":[{"type":{"names":["boolean"]},"description":"The value to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setVisible","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1589,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Toggles (flips) the visible state of each member of this group.","kind":"function","name":"toggleVisible","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#toggleVisible","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1604,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Empties this group and removes it from the Scene.\n\nDoes not call {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"destroy","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also {@link Phaser.GameObjects.GameObject#destroy} each group member.","name":"destroyChildren"}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#destroy","scope":"instance","___s":true},{"meta":{"range":[180,231],"filename":"GroupCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"name":"GameObjectCreator","longname":"GameObjectCreator","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GroupCreator.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates a new Group Game Object and returns it.\n\nNote: This method will only be available if the Group Game Object has been built into Phaser.","kind":"function","name":"group","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#group","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"GroupFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"name":"Group","longname":"Group","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GroupFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates a new Group Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Group Game Object has been built into Phaser.","kind":"function","name":"group","since":"3.0.0","params":[{"type":{"names":["Array.","Phaser.Types.GameObjects.Group.GroupConfig","Array."]},"optional":true,"description":"Game Objects to add to this Group; or the `config` argument.","name":"children"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"A Group Configuration object.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#group","scope":"instance","___s":true},{"meta":{"filename":"GroupCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs"},"kind":"typedef","name":"GroupCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A group member","name":"item"}],"memberof":"Phaser.Types.GameObjects.Group","longname":"Phaser.Types.GameObjects.Group.GroupCallback","scope":"static","___s":true},{"meta":{"filename":"GroupConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs"},"kind":"typedef","name":"GroupConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["function"]},"optional":true,"nullable":true,"defaultvalue":"Sprite","description":"Sets {@link Phaser.GameObjects.Group#classType}.","name":"classType"},{"type":{"names":["string"]},"optional":true,"nullable":true,"defaultvalue":"''","description":"Sets {@link Phaser.GameObjects.Group#name}.","name":"name"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":true,"description":"Sets {@link Phaser.GameObjects.Group#active}.","name":"active"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":-1,"description":"Sets {@link Phaser.GameObjects.Group#maxSize}.","name":"maxSize"},{"type":{"names":["string"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"Sets {@link Phaser.GameObjects.Group#defaultKey}.","name":"defaultKey"},{"type":{"names":["string","integer"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"Sets {@link Phaser.GameObjects.Group#defaultFrame}.","name":"defaultFrame"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":false,"description":"Sets {@link Phaser.GameObjects.Group#runChildUpdate}.","name":"runChildUpdate"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"Sets {@link Phaser.GameObjects.Group#createCallback}.","name":"createCallback"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"Sets {@link Phaser.GameObjects.Group#removeCallback}.","name":"removeCallback"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"Sets {@link Phaser.GameObjects.Group#createMultipleCallback}.","name":"createMultipleCallback"}],"memberof":"Phaser.Types.GameObjects.Group","longname":"Phaser.Types.GameObjects.Group.GroupConfig","scope":"static","___s":true},{"meta":{"filename":"GroupCreateConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs"},"description":"The total number of objects created will be\n\n key.length * frame.length * frameQuantity * (yoyo ? 2 : 1) * (1 + repeat)\n\nIf `max` is nonzero, then the total created will not exceed `max`.\n\n`key` is required. {@link Phaser.GameObjects.Group#defaultKey} is not used.","kind":"typedef","name":"GroupCreateConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["function"]},"optional":true,"nullable":true,"description":"The class of each new Game Object.","name":"classType"},{"type":{"names":["string","Array."]},"optional":true,"description":"The texture key of each new Game Object.","name":"key"},{"type":{"names":["string","Array.","integer","Array."]},"optional":true,"nullable":true,"defaultvalue":null,"description":"The texture frame of each new Game Object.","name":"frame"},{"type":{"names":["integer"]},"optional":true,"nullable":true,"defaultvalue":false,"description":"The number of Game Objects to create. If set, this overrides the `frameQuantity` value. Use `frameQuantity` for more advanced control.","name":"quantity"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":true,"description":"The visible state of each new Game Object.","name":"visible"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":true,"description":"The active state of each new Game Object.","name":"active"},{"type":{"names":["integer"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The number of times each `key` × `frame` combination will be *repeated* (after the first combination).","name":"repeat"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":false,"description":"Select a `key` at random.","name":"randomKey"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":false,"description":"Select a `frame` at random.","name":"randomFrame"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":false,"description":"Select keys and frames by moving forward then backward through `key` and `frame`.","name":"yoyo"},{"type":{"names":["integer"]},"optional":true,"nullable":true,"defaultvalue":1,"description":"The number of times each `frame` should be combined with one `key`.","name":"frameQuantity"},{"type":{"names":["integer"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The maximum number of new Game Objects to create. 0 is no maximum.","name":"max"},{"type":{"names":["object"]},"optional":true,"nullable":true,"name":"setXY"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The horizontal position of each new Game Object.","name":"setXY.x"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The vertical position of each new Game Object.","name":"setXY.y"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's horizontal position from the previous by this amount, starting from `setXY.x`.","name":"setXY.stepX"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's vertical position from the previous by this amount, starting from `setXY.y`.","name":"setXY.stepY"},{"type":{"names":["object"]},"optional":true,"nullable":true,"name":"setRotation"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Rotation of each new Game Object.","name":"setRotation.value"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's rotation from the previous by this amount, starting at `setRotation.value`.","name":"setRotation.step"},{"type":{"names":["object"]},"optional":true,"nullable":true,"name":"setScale"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The horizontal scale of each new Game Object.","name":"setScale.x"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The vertical scale of each new Game Object.","name":"setScale.y"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's horizontal scale from the previous by this amount, starting from `setScale.x`.","name":"setScale.stepX"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game object's vertical scale from the previous by this amount, starting from `setScale.y`.","name":"setScale.stepY"},{"type":{"names":["object"]},"optional":true,"nullable":true,"name":"setAlpha"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The alpha value of each new Game Object.","name":"setAlpha.value"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's alpha from the previous by this amount, starting from `setAlpha.value`.","name":"setAlpha.step"},{"type":{"names":["object"]},"optional":true,"nullable":true,"name":"setDepth"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The depth value of each new Game Object.","name":"setDepth.value"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's depth from the previous by this amount, starting from `setDepth.value`.","name":"setDepth.step"},{"type":{"names":["object"]},"optional":true,"nullable":true,"name":"setScrollFactor"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The horizontal scroll factor of each new Game Object.","name":"setScrollFactor.x"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The vertical scroll factor of each new Game Object.","name":"setScrollFactor.y"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's horizontal scroll factor from the previous by this amount, starting from `setScrollFactor.x`.","name":"setScrollFactor.stepX"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game object's vertical scroll factor from the previous by this amount, starting from `setScrollFactor.y`.","name":"setScrollFactor.stepY"},{"type":{"names":["*"]},"optional":true,"nullable":true,"description":"A geometric shape that defines the hit area for the Game Object.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"nullable":true,"description":"A callback to be invoked when the Game Object is interacted with.","name":"hitAreaCallback"},{"type":{"names":["false","Phaser.Types.Actions.GridAlignConfig"]},"optional":true,"nullable":true,"defaultvalue":false,"description":"Align the new Game Objects in a grid using these settings.","name":"gridAlign"}],"see":["Phaser.Actions.GridAlign","Phaser.Actions.SetAlpha","Phaser.Actions.SetHitArea","Phaser.Actions.SetRotation","Phaser.Actions.SetScale","Phaser.Actions.SetXY","Phaser.Actions.SetDepth","Phaser.Actions.SetScrollFactor","Phaser.GameObjects.Group#createFromConfig","Phaser.Utils.Array.Range"],"memberof":"Phaser.Types.GameObjects.Group","longname":"Phaser.Types.GameObjects.Group.GroupCreateConfig","scope":"static","___s":true},{"meta":{"filename":"GroupMultipleCreateCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs"},"kind":"typedef","name":"GroupMultipleCreateCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The newly created group members","name":"items"}],"memberof":"Phaser.Types.GameObjects.Group","longname":"Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs"},"kind":"namespace","name":"Group","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.Group","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Image.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Image.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"classdesc":"An Image Game Object.\n\nAn Image is a light-weight Game Object useful for the display of static images in your game,\nsuch as logos, backgrounds, scenery or other non-animated elements. Images can have input\nevents and physics bodies, or be tweened, tinted or scrolled. The main difference between an\nImage and a Sprite is that you cannot animate an Image as they do not have the Animation component.","kind":"class","name":"Image","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.TextureCrop","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.Image","___s":true},{"meta":{"range":[180,227],"filename":"ImageCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImageCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"description":"Creates a new Image Game Object and returns it.\n\nNote: This method will only be available if the Image Game Object has been built into Phaser.","kind":"function","name":"image","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#image","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"ImageFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"name":"Image","longname":"Image","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImageFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"description":"Creates a new Image Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Image Game Object has been built into Phaser.","kind":"function","name":"image","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#image","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"ImageRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"kind":"namespace","name":"GameObjects","memberof":"Phaser","longname":"Phaser.GameObjects","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Light.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Light.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"classdesc":"A 2D point light.\n\nThese are typically created by a {@link Phaser.GameObjects.LightsManager}, available from within a scene via `this.lights`.\n\nAny Game Objects using the Light2D pipeline will then be affected by these Lights.\n\nThey can also simply be used to represent a point light for your own purposes.","kind":"class","name":"Light","memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the light.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the light.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the light.","name":"radius"},{"type":{"names":["number"]},"description":"The red color of the light. A value between 0 and 1.","name":"r"},{"type":{"names":["number"]},"description":"The green color of the light. A value between 0 and 1.","name":"g"},{"type":{"names":["number"]},"description":"The blue color of the light. A value between 0 and 1.","name":"b"},{"type":{"names":["number"]},"description":"The intensity of the light.","name":"intensity"}],"scope":"static","longname":"Phaser.GameObjects.Light","___s":true},{"meta":{"filename":"Light.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The horizontal position of the light.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The vertical position of the light.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The radius of the light.","name":"radius","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#radius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The red color of the light. A value between 0 and 1.","name":"r","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#r","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The green color of the light. A value between 0 and 1.","name":"g","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#g","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The blue color of the light. A value between 0 and 1.","name":"b","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#b","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The intensity of the light.","name":"intensity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#intensity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The horizontal scroll factor of the light.","name":"scrollFactorX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#scrollFactorX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The vertical scroll factor of the light.","name":"scrollFactorY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#scrollFactorY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":121,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the properties of the light.\n\nSets both horizontal and vertical scroll factor to 1. Use {@link Phaser.GameObjects.Light#setScrollFactor} to set\nthe scroll factor.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the light.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the light.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the light.","name":"radius"},{"type":{"names":["number"]},"description":"The red color. A value between 0 and 1.","name":"r"},{"type":{"names":["number"]},"description":"The green color. A value between 0 and 1.","name":"g"},{"type":{"names":["number"]},"description":"The blue color. A value between 0 and 1.","name":"b"},{"type":{"names":["number"]},"description":"The intensity of the light.","name":"intensity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"This Light object."}],"memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#set","scope":"instance","___s":true},{"meta":{"filename":"Light.js","lineno":159,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the scroll factor of the light.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of the light.","name":"x"},{"type":{"names":["number"]},"description":"The vertical scroll factor of the light.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"This Light object."}],"memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#setScrollFactor","scope":"instance","___s":true},{"meta":{"filename":"Light.js","lineno":181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the color of the light from a single integer RGB value.","kind":"function","name":"setColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The integer RGB color of the light.","name":"rgb"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"This Light object."}],"memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#setColor","scope":"instance","___s":true},{"meta":{"filename":"Light.js","lineno":202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the intensity of the light.","kind":"function","name":"setIntensity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The intensity of the light.","name":"intensity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"This Light object."}],"memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#setIntensity","scope":"instance","___s":true},{"meta":{"filename":"Light.js","lineno":219,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the position of the light.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the light.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the light.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"This Light object."}],"memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Light.js","lineno":238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the radius of the light.","kind":"function","name":"setRadius","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the light.","name":"radius"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"This Light object."}],"memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#setRadius","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"LightsManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LightsManager.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"kind":"typedef","name":"LightForEach","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"The Light.","name":"light"}],"longname":"LightForEach","scope":"global","___s":true},{"meta":{"filename":"LightsManager.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"classdesc":"Manages Lights for a Scene.\n\nAffects the rendering of Game Objects using the `Light2D` pipeline.","kind":"class","name":"LightsManager","memberof":"Phaser.GameObjects","since":"3.0.0","scope":"static","longname":"Phaser.GameObjects.LightsManager","___s":true},{"meta":{"filename":"LightsManager.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The pool of Lights.\n\nUsed to recycle removed Lights for a more efficient use of memory.","name":"lightPool","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#lightPool","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsManager.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The Lights in the Scene.","name":"lights","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#lights","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsManager.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Lights that have been culled from a Camera's viewport.\n\nLights in this list will not be rendered.","name":"culledLights","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#culledLights","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsManager.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The ambient color.","name":"ambientColor","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#ambientColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsManager.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Whether the Lights Manager is enabled.","name":"active","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsManager.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The maximum number of lights that a single Camera and the lights shader can process.\nChange this via the `maxLights` property in your game config, as it cannot be changed at runtime.","name":"maxLights","type":{"names":["integer"]},"readonly":true,"since":"3.15.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#maxLights","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsManager.js","lineno":99,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Enable the Lights Manager.","kind":"function","name":"enable","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#enable","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":119,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Disable the Lights Manager.","kind":"function","name":"disable","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#disable","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Cull any Lights that aren't visible to the given Camera.\n\nCulling Lights improves performance by ensuring that only Lights within a Camera's viewport are rendered.","kind":"function","name":"cull","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to cull Lights for.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"The culled Lights."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#cull","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Iterate over each Light with a callback.","kind":"function","name":"forEachLight","since":"3.0.0","params":[{"type":{"names":["LightForEach"]},"description":"The callback that is called with each Light.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#forEachLight","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the ambient light color.","kind":"function","name":"setAmbientColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The integer RGB color of the ambient light.","name":"rgb"}],"returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#setAmbientColor","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Returns the maximum number of Lights allowed to appear at once.","kind":"function","name":"getMaxVisibleLights","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The maximum number of Lights allowed to appear at once."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#getMaxVisibleLights","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Get the number of Lights managed by this Lights Manager.","kind":"function","name":"getLightCount","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of Lights managed by this Lights Manager."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#getLightCount","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Add a Light.","kind":"function","name":"addLight","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the Light.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the Light.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"The radius of the Light.","name":"radius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xffffff","description":"The integer RGB color of the light.","name":"rgb"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The intensity of the Light.","name":"intensity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"The Light that was added."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#addLight","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Remove a Light.","kind":"function","name":"removeLight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"The Light to remove.","name":"light"}],"returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#removeLight","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Shut down the Lights Manager.\n\nRecycles all active Lights into the Light pool, resets ambient light color and clears the lists of Lights and\nculled Lights.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#shutdown","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":342,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Destroy the Lights Manager.\n\nCleans up all references by calling {@link Phaser.GameObjects.LightsManager#shutdown}.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"LightsPlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LightsPlugin.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"classdesc":"A Scene plugin that provides a {@link Phaser.GameObjects.LightsManager} for the Light2D pipeline.\n\nAvailable from within a Scene via `this.lights`.\n\nAdd Lights using the {@link Phaser.GameObjects.LightsManager#addLight} method:\n\n```javascript\n// Enable the Lights Manager because it is disabled by default\nthis.lights.enable();\n\n// Create a Light at [400, 300] with a radius of 200\nthis.lights.addLight(400, 300, 200);\n```\n\nFor Game Objects to be affected by the Lights when rendered, you will need to set them to use the `Light2D` pipeline like so:\n\n```javascript\nsprite.setPipeline('Light2D');\n```","kind":"class","name":"LightsPlugin","augments":["Phaser.GameObjects.LightsManager"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that this Lights Plugin belongs to.","name":"scene"}],"scope":"static","longname":"Phaser.GameObjects.LightsPlugin","___s":true},{"meta":{"filename":"LightsPlugin.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"A reference to the Scene that this Lights Plugin belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsPlugin.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"A reference to the Scene's systems.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsPlugin.js","lineno":76,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Boot the Lights Plugin.","kind":"function","name":"boot","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#boot","scope":"instance","___s":true},{"meta":{"filename":"LightsPlugin.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Destroy the Lights Plugin.\n\nCleans up all references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#destroy","scope":"instance","overrides":"Phaser.GameObjects.LightsManager#destroy","___s":true},{"meta":{"range":[180,216],"filename":"Mesh.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Mesh.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"classdesc":"A Mesh Game Object.","kind":"class","name":"Mesh","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible","Phaser.GameObjects.Components.ScrollFactor"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["Array."]},"description":"An array containing the vertices data for this Mesh.","name":"vertices"},{"type":{"names":["Array."]},"description":"An array containing the uv data for this Mesh.","name":"uv"},{"type":{"names":["Array."]},"description":"An array containing the color data for this Mesh.","name":"colors"},{"type":{"names":["Array."]},"description":"An array containing the alpha data for this Mesh.","name":"alphas"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.Mesh","___s":true},{"meta":{"filename":"Mesh.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the vertices data for this Mesh.","name":"vertices","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#vertices","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Mesh.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the uv data for this Mesh.","name":"uv","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#uv","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Mesh.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the color data for this Mesh.","name":"colors","type":{"names":["Uint32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#colors","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Mesh.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the alpha data for this Mesh.","name":"alphas","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#alphas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Mesh.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"Fill or additive mode used when blending the color values?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#tintFill","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Mesh.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"This method is left intentionally empty and does not do anything.\nIt is retained to allow a Mesh or Quad to be added to a Container.","kind":"function","name":"setAlpha","since":"3.17.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setAlpha","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"MeshCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MeshCreator.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"Creates a new Mesh Game Object and returns it.\n\nNote: This method will only be available if the Mesh Game Object and WebGL support have been built into Phaser.","kind":"function","name":"mesh","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#mesh","scope":"instance","___s":true},{"meta":{"range":[180,204],"filename":"MeshFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"name":"Mesh","longname":"Mesh","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MeshFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"Creates a new Mesh Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Mesh Game Object and WebGL support have been built into Phaser.","kind":"function","name":"mesh","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["Array."]},"description":"An array containing the vertices data for this Mesh.","name":"vertices"},{"type":{"names":["Array."]},"description":"An array containing the uv data for this Mesh.","name":"uv"},{"type":{"names":["Array."]},"description":"An array containing the color data for this Mesh.","name":"colors"},{"type":{"names":["Array."]},"description":"An array containing the alpha data for this Mesh.","name":"alphas"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#mesh","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"MeshRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"MeshWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"EmitterOp.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"EmitterOp.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"classdesc":"A Particle Emitter property.\n\nFacilitates changing Particle properties as they are emitted and throughout their lifetime.","kind":"class","name":"EmitterOp","memberof":"Phaser.GameObjects.Particles","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig"]},"description":"Settings for the Particle Emitter that owns this property.","name":"config"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"},{"type":{"names":["number"]},"description":"The default value of the property.","name":"defaultValue"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the property can only be modified when a Particle is emitted.","name":"emitOnly"}],"scope":"static","longname":"Phaser.GameObjects.Particles.EmitterOp","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The name of this property.","name":"propertyKey","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#propertyKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The value of this property.","name":"propertyValue","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#propertyValue","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The default value of this property.","name":"defaultValue","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#defaultValue","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The number of steps for stepped easing between {@link Phaser.GameObjects.Particles.EmitterOp#start} and\n{@link Phaser.GameObjects.Particles.EmitterOp#end} values, per emit.","name":"steps","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#steps","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The step counter for stepped easing, per emit.","name":"counter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#counter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The start value for this property to ease between.","name":"start","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#start","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The end value for this property to ease between.","name":"end","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#end","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The easing function to use for updating this property.","name":"ease","type":{"names":["function"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#ease","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether this property can only be modified when a Particle is emitted.\n\nSet to `true` to allow only {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} callbacks to be set and\naffect this property.\n\nSet to `false` to allow both {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} and\n{@link Phaser.GameObjects.Particles.EmitterOp#onUpdate} callbacks to be set and affect this property.","name":"emitOnly","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#emitOnly","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The callback to run for Particles when they are emitted from the Particle Emitter.","name":"onEmit","type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#onEmit","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The callback to run for Particles when they are updated.","name":"onUpdate","type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#onUpdate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":153,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Load the property from a Particle Emitter configuration object.\n\nOptionally accepts a new property key to use, replacing the current one.","kind":"function","name":"loadConfig","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig"]},"optional":true,"description":"Settings for the Particle Emitter that owns this property.","name":"config"},{"type":{"names":["string"]},"optional":true,"description":"The new key to use for this property, if any.","name":"newKey"}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#loadConfig","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Build a JSON representation of this Particle Emitter property.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"A JSON representation of this Particle Emitter property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#toJSON","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Change the current value of the property and update its callback methods.","kind":"function","name":"onChange","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value of the property.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"description":"This Emitter Op object."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#onChange","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Update the {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} and\n{@link Phaser.GameObjects.Particles.EmitterOp#onUpdate} callbacks based on the type of the current\n{@link Phaser.GameObjects.Particles.EmitterOp#propertyValue}.","kind":"function","name":"setMethods","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"description":"This Emitter Op object."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#setMethods","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":366,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Check whether an object has the given property.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to check.","name":"object"},{"type":{"names":["string"]},"description":"The key of the property to look for in the object.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the property exists in the object, `false` otherwise."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#has","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":382,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Check whether an object has both of the given properties.","kind":"function","name":"hasBoth","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to check.","name":"object"},{"type":{"names":["string"]},"description":"The key of the first property to check the object for.","name":"key1"},{"type":{"names":["string"]},"description":"The key of the second property to check the object for.","name":"key2"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if both properties exist in the object, `false` otherwise."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#hasBoth","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":399,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Check whether an object has at least one of the given properties.","kind":"function","name":"hasEither","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to check.","name":"object"},{"type":{"names":["string"]},"description":"The key of the first property to check the object for.","name":"key1"},{"type":{"names":["string"]},"description":"The key of the second property to check the object for.","name":"key2"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if at least one of the properties exists in the object, `false` if neither exist."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#hasEither","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":416,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The returned value sets what the property will be at the START of the particles life, on emit.","kind":"function","name":"defaultEmit","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"},{"type":{"names":["number"]},"optional":true,"description":"The current value of the property.","name":"value"}],"returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#defaultEmit","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":433,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The returned value updates the property for the duration of the particles life.","kind":"function","name":"defaultUpdate","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"},{"type":{"names":["number"]},"description":"The T value (between 0 and 1)","name":"t"},{"type":{"names":["number"]},"description":"The current value of the property.","name":"value"}],"returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#defaultUpdate","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onEmit` callback that returns the current value of the property.","kind":"function","name":"staticValueEmit","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The current value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#staticValueEmit","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":464,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onUpdate` callback that returns the current value of the property.","kind":"function","name":"staticValueUpdate","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The current value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#staticValueUpdate","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":477,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onEmit` callback that returns a random value from the current value array.","kind":"function","name":"randomStaticValueEmit","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#randomStaticValueEmit","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":492,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onEmit` callback that returns a value between the {@link Phaser.GameObjects.Particles.EmitterOp#start} and\n{@link Phaser.GameObjects.Particles.EmitterOp#end} range.","kind":"function","name":"randomRangedValueEmit","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The key of the property.","name":"key"}],"returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#randomRangedValueEmit","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onEmit` callback that returns a stepped value between the\n{@link Phaser.GameObjects.Particles.EmitterOp#start} and {@link Phaser.GameObjects.Particles.EmitterOp#end}\nrange.","kind":"function","name":"steppedEmit","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#steppedEmit","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onEmit` callback for an eased property.\n\nIt prepares the particle for easing by {@link Phaser.GameObjects.Particles.EmitterOp#easeValueUpdate}.","kind":"function","name":"easedValueEmit","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"}],"returns":[{"type":{"names":["number"]},"description":"{@link Phaser.GameObjects.Particles.EmitterOp#start}, as the new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#easedValueEmit","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":563,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onUpdate` callback that returns an eased value between the\n{@link Phaser.GameObjects.Particles.EmitterOp#start} and {@link Phaser.GameObjects.Particles.EmitterOp#end}\nrange.","kind":"function","name":"easeValueUpdate","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"},{"type":{"names":["number"]},"description":"The T value (between 0 and 1)","name":"t"}],"returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#easeValueUpdate","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"GravityWell.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GravityWell.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"classdesc":"The GravityWell action applies a force on the particle to draw it towards, or repel it from, a single point.\n\nThe force applied is inversely proportional to the square of the distance from the particle to the point, in accordance with Newton's law of gravity.\n\nThis simulates the effect of gravity over large distances (as between planets, for example).","kind":"class","name":"GravityWell","memberof":"Phaser.GameObjects.Particles","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Types.GameObjects.Particles.GravityWellConfig"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the Gravity Well, in world space.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the Gravity Well, in world space.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The strength of the gravity force - larger numbers produce a stronger force.","name":"power"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"The minimum distance for which the gravity force is calculated.","name":"epsilon"},{"type":{"names":["number"]},"optional":true,"defaultvalue":50,"description":"The gravitational force of this Gravity Well.","name":"gravity"}],"scope":"static","longname":"Phaser.GameObjects.Particles.GravityWell","___s":true},{"meta":{"filename":"GravityWell.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The x coordinate of the Gravity Well, in world space.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.GravityWell","longname":"Phaser.GameObjects.Particles.GravityWell#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GravityWell.js","lineno":63,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The y coordinate of the Gravity Well, in world space.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.GravityWell","longname":"Phaser.GameObjects.Particles.GravityWell#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GravityWell.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The active state of the Gravity Well. An inactive Gravity Well will not influence any particles.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.GravityWell","longname":"Phaser.GameObjects.Particles.GravityWell#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GravityWell.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The strength of the gravity force - larger numbers produce a stronger force.","name":"power","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.GravityWell","longname":"Phaser.GameObjects.Particles.GravityWell#power","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GravityWell.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The minimum distance for which the gravity force is calculated.","name":"epsilon","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.GravityWell","longname":"Phaser.GameObjects.Particles.GravityWell#epsilon","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GravityWell.js","lineno":133,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Takes a Particle and updates it based on the properties of this Gravity Well.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The Particle to update.","name":"particle"},{"type":{"names":["number"]},"description":"The delta time in ms.","name":"delta"},{"type":{"names":["number"]},"description":"The delta value divided by 1000.","name":"step"}],"memberof":"Phaser.GameObjects.Particles.GravityWell","longname":"Phaser.GameObjects.Particles.GravityWell#update","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"Particle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Particle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"classdesc":"A Particle is a simple Game Object controlled by a Particle Emitter and Manager, and rendered by the Manager.\nIt uses its own lightweight physics system, and can interact only with its Emitter's bounds and zones.","kind":"class","name":"Particle","memberof":"Phaser.GameObjects.Particles","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The Emitter to which this Particle belongs.","name":"emitter"}],"scope":"static","longname":"Phaser.GameObjects.Particles.Particle","___s":true},{"meta":{"filename":"Particle.js","lineno":29,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The Emitter to which this Particle belongs.\n\nA Particle can only belong to a single Emitter and is created, updated and destroyed via it.","name":"emitter","type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#emitter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The texture frame used to render this Particle.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The x coordinate of this Particle.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The y coordinate of this Particle.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The x velocity of this Particle.","name":"velocityX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#velocityX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The y velocity of this Particle.","name":"velocityY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#velocityY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":90,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The x acceleration of this Particle.","name":"accelerationX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#accelerationX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":100,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The y acceleration of this Particle.","name":"accelerationY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#accelerationY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The maximum horizontal velocity this Particle can travel at.","name":"maxVelocityX","type":{"names":["number"]},"defaultvalue":"10000","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#maxVelocityX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The maximum vertical velocity this Particle can travel at.","name":"maxVelocityY","type":{"names":["number"]},"defaultvalue":"10000","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#maxVelocityY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The bounciness, or restitution, of this Particle.","name":"bounce","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#bounce","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":140,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The horizontal scale of this Particle.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#scaleX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":150,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The vertical scale of this Particle.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#scaleY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":160,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The alpha value of this Particle.","name":"alpha","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":170,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The angle of this Particle in degrees.","name":"angle","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":180,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The angle of this Particle in radians.","name":"rotation","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":190,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The tint applied to this Particle.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#tint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":200,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The lifespan of this Particle in ms.","name":"life","type":{"names":["number"]},"defaultvalue":"1000","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#life","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":210,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The current life of this Particle in ms.","name":"lifeCurrent","type":{"names":["number"]},"defaultvalue":"1000","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#lifeCurrent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The delay applied to this Particle upon emission, in ms.","name":"delayCurrent","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#delayCurrent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":230,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The normalized lifespan T value, where 0 is the start and 1 is the end.","name":"lifeT","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#lifeT","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":240,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The data used by the ease equation.","name":"data","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Checks to see if this Particle is alive and updating.","kind":"function","name":"isAlive","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Particle is alive and updating, otherwise `false`."}],"memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#isAlive","scope":"instance","___s":true},{"meta":{"filename":"Particle.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Resets the position of this particle back to zero.","kind":"function","name":"resetPosition","since":"3.16.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#resetPosition","scope":"instance","___s":true},{"meta":{"filename":"Particle.js","lineno":281,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Starts this Particle from the given coordinates.","kind":"function","name":"fire","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to launch this Particle from.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to launch this Particle from.","name":"y"}],"memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#fire","scope":"instance","___s":true},{"meta":{"filename":"Particle.js","lineno":389,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An internal method that calculates the velocity of the Particle.","kind":"function","name":"computeVelocity","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The Emitter that is updating this Particle.","name":"emitter"},{"type":{"names":["number"]},"description":"The delta time in ms.","name":"delta"},{"type":{"names":["number"]},"description":"The delta value divided by 1000.","name":"step"},{"type":{"names":["array"]},"description":"Particle processors (gravity wells).","name":"processors"}],"memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#computeVelocity","scope":"instance","___s":true},{"meta":{"filename":"Particle.js","lineno":452,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Checks if this Particle is still within the bounds defined by the given Emitter.\n\nIf not, and depending on the Emitter collision flags, the Particle may either stop or rebound.","kind":"function","name":"checkBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The Emitter to check the bounds against.","name":"emitter"}],"memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#checkBounds","scope":"instance","___s":true},{"meta":{"filename":"Particle.js","lineno":490,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The main update method for this Particle.\n\nUpdates its life values, computes the velocity and repositions the Particle.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delta time in ms.","name":"delta"},{"type":{"names":["number"]},"description":"The delta value divided by 1000.","name":"step"},{"type":{"names":["array"]},"description":"An optional array of update processors.","name":"processors"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if this Particle has now expired and should be removed, otherwise `false` if still active."}],"memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#update","scope":"instance","___s":true},{"meta":{"range":[180,229],"filename":"ParticleEmitter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"BlendModes","longname":"BlendModes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":24,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"classdesc":"A particle emitter represents a single particle stream.\nIt controls a pool of {@link Phaser.GameObjects.Particles.Particle Particles} and is controlled by a {@link Phaser.GameObjects.Particles.ParticleEmitterManager Particle Emitter Manager}.","kind":"class","name":"ParticleEmitter","memberof":"Phaser.GameObjects.Particles","since":"3.0.0","augments":["Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Visible"],"params":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"The Emitter Manager this Emitter belongs to.","name":"manager"},{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig"]},"description":"Settings for this emitter.","name":"config"}],"scope":"static","longname":"Phaser.GameObjects.Particles.ParticleEmitter","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The Emitter Manager this Emitter belongs to.","name":"manager","type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The texture assigned to particles.","name":"texture","type":{"names":["Phaser.Textures.Texture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The texture frames assigned to particles.","name":"frames","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#frames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The default texture frame assigned to particles.","name":"defaultFrame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#defaultFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Names of simple configuration properties.","name":"configFastMap","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#configFastMap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Names of complex configuration properties.","name":"configOpMap","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#configOpMap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":154,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The name of this Particle Emitter.\n\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The Particle Class which will be emitted by this Emitter.","name":"particleClass","type":{"names":["Phaser.GameObjects.Particles.Particle"]},"defaultvalue":"Phaser.GameObjects.Particles.Particle","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#particleClass","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":176,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The x-coordinate of the particle origin (where particles will be emitted).","name":"x","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setPosition"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The y-coordinate of the particle origin (where particles will be emitted).","name":"y","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setPosition"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":198,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A radial emitter will emit particles in all directions between angle min and max,\nusing {@link Phaser.GameObjects.Particles.ParticleEmitter#speed} as the value. If set to false then this acts as a point Emitter.\nA point emitter will emit particles only in the direction derived from the speedX and speedY values.","name":"radial","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setRadial"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#radial","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Horizontal acceleration applied to emitted particles, in pixels per second squared.","name":"gravityX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setGravity"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#gravityX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":222,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Vertical acceleration applied to emitted particles, in pixels per second squared.","name":"gravityY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setGravity"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#gravityY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":233,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether accelerationX and accelerationY are non-zero. Set automatically during configuration.","name":"acceleration","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#acceleration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":243,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Horizontal acceleration applied to emitted particles, in pixels per second squared.","name":"accelerationX","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#accelerationX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":253,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Vertical acceleration applied to emitted particles, in pixels per second squared.","name":"accelerationY","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#accelerationY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":263,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The maximum horizontal velocity of emitted particles, in pixels per second squared.","name":"maxVelocityX","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"10000","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The maximum vertical velocity of emitted particles, in pixels per second squared.","name":"maxVelocityY","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"10000","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":283,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The initial horizontal speed of emitted particles, in pixels per second.","name":"speedX","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setSpeedX"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#speedX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":294,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The initial vertical speed of emitted particles, in pixels per second.","name":"speedY","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setSpeedY"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#speedY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":305,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether moveToX and moveToY are nonzero. Set automatically during configuration.","name":"moveTo","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#moveTo","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":315,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The x-coordinate emitted particles move toward, when {@link Phaser.GameObjects.Particles.ParticleEmitter#moveTo} is true.","name":"moveToX","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#moveToX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":325,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The y-coordinate emitted particles move toward, when {@link Phaser.GameObjects.Particles.ParticleEmitter#moveTo} is true.","name":"moveToY","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#moveToY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":335,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether particles will rebound when they meet the emitter bounds.","name":"bounce","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#bounce","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":345,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The horizontal scale of emitted particles.","name":"scaleX","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"1","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setScale","Phaser.GameObjects.Particles.ParticleEmitter#setScaleX"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#scaleX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":357,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The vertical scale of emitted particles.","name":"scaleY","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"1","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setScale","Phaser.GameObjects.Particles.ParticleEmitter#setScaleY"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#scaleY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":369,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Color tint applied to emitted particles. Any alpha component (0xAA000000) is ignored.","name":"tint","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0xffffffff","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#tint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":379,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The alpha (transparency) of emitted particles.","name":"alpha","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"1","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setAlpha"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":390,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The lifespan of emitted particles, in ms.","name":"lifespan","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"1000","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setLifespan"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#lifespan","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":401,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The angle of the initial velocity of emitted particles, in degrees.","name":"angle","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"{ min: 0, max: 360 }","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setAngle"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":412,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The rotation of emitted particles, in degrees.","name":"rotate","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#rotate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":422,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A function to call when a particle is emitted.","name":"emitCallback","type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterCallback"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#emitCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":432,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The calling context for {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallback}.","name":"emitCallbackScope","type":{"names":["*"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":442,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A function to call when a particle dies.","name":"deathCallback","type":{"names":["Phaser.Types.GameObjects.Particles.ParticleDeathCallback"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#deathCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":452,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The calling context for {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallback}.","name":"deathCallbackScope","type":{"names":["*"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":462,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Set to hard limit the amount of particle objects this emitter is allowed to create.\n0 means unlimited.","name":"maxParticles","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#maxParticles","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":473,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"How many particles are emitted each time particles are emitted (one explosion or one flow cycle).","name":"quantity","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"1","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setFrequency","Phaser.GameObjects.Particles.ParticleEmitter#setQuantity"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#quantity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":485,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"How many ms to wait after emission before the particles start updating.","name":"delay","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#delay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":495,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"For a flow emitter, the time interval (>= 0) between particle flow cycles in ms.\nA value of 0 means there is one particle flow cycle for each logic update (the maximum flow frequency). This is the default setting.\nFor an exploding emitter, this value will be -1.\nCalling {@link Phaser.GameObjects.Particles.ParticleEmitter#flow} also puts the emitter in flow mode (frequency >= 0).\nCalling {@link Phaser.GameObjects.Particles.ParticleEmitter#explode} also puts the emitter in explode mode (frequency = -1).","name":"frequency","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setFrequency"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#frequency","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":510,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Controls if the emitter is currently emitting a particle flow (when frequency >= 0).\nAlready alive particles will continue to update until they expire.\nControlled by {@link Phaser.GameObjects.Particles.ParticleEmitter#start} and {@link Phaser.GameObjects.Particles.ParticleEmitter#stop}.","name":"on","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#on","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":522,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Newly emitted particles are added to the top of the particle list, i.e. rendered above those already alive.\nSet to false to send them to the back.","name":"particleBringToTop","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":533,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The time rate applied to active particles, affecting lifespan, movement, and tweens. Values larger than 1 are faster than normal.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":543,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An object describing a shape to emit particles from.","name":"emitZone","type":{"names":["Phaser.GameObjects.Particles.Zones.EdgeZone","Phaser.GameObjects.Particles.Zones.RandomZone"]},"defaultvalue":"null","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#emitZone","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":554,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An object describing a shape that deactivates particles when they interact with it.","name":"deathZone","type":{"names":["Phaser.GameObjects.Particles.Zones.DeathZone"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setDeathZone"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#deathZone","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":565,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A rectangular boundary constraining particle movement.","name":"bounds","type":{"names":["Phaser.Geom.Rectangle"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setBounds"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#bounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":576,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether particles interact with the left edge of the emitter {@link Phaser.GameObjects.Particles.ParticleEmitter#bounds}.","name":"collideLeft","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#collideLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":586,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether particles interact with the right edge of the emitter {@link Phaser.GameObjects.Particles.ParticleEmitter#bounds}.","name":"collideRight","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#collideRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":596,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether particles interact with the top edge of the emitter {@link Phaser.GameObjects.Particles.ParticleEmitter#bounds}.","name":"collideTop","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#collideTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":606,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether particles interact with the bottom edge of the emitter {@link Phaser.GameObjects.Particles.ParticleEmitter#bounds}.","name":"collideBottom","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#collideBottom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":616,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether this emitter updates itself and its particles.\n\nControlled by {@link Phaser.GameObjects.Particles.ParticleEmitter#pause}\nand {@link Phaser.GameObjects.Particles.ParticleEmitter#resume}.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":629,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Set this to false to hide any active particles.","name":"visible","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setVisible"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#visible","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":640,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The blend mode of this emitter's particles.","name":"blendMode","type":{"names":["integer"]},"since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setBlendMode"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#blendMode","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":650,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A Game Object whose position is used as the particle origin.","name":"follow","type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#startFollow","Phaser.GameObjects.Particles.ParticleEmitter#stopFollow"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#follow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":662,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The offset of the particle origin from the {@link Phaser.GameObjects.Particles.ParticleEmitter#follow} target.","name":"followOffset","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#startFollow"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#followOffset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":672,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether the emitter's {@link Phaser.GameObjects.Particles.ParticleEmitter#visible} state will track\nthe {@link Phaser.GameObjects.Particles.ParticleEmitter#follow} target's visibility state.","name":"trackVisible","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#startFollow"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#trackVisible","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":684,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The current texture frame, as an index of {@link Phaser.GameObjects.Particles.ParticleEmitter#frames}.","name":"currentFrame","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setFrame"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#currentFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":695,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether texture {@link Phaser.GameObjects.Particles.ParticleEmitter#frames} are selected at random.","name":"randomFrame","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setFrame"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#randomFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":706,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The number of consecutive particles that receive a single texture frame (per frame cycle).","name":"frameQuantity","type":{"names":["integer"]},"defaultvalue":"1","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setFrame"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#frameQuantity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":765,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Merges configuration settings into the emitter's current settings.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig"]},"description":"Settings for this emitter.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#fromJSON","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":869,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Creates a description of this emitter suitable for JSON serialization.","kind":"function","name":"toJSON","since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"An object to copy output into.","name":"output"}],"returns":[{"type":{"names":["object"]},"description":"- The output object."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#toJSON","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":919,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Continuously moves the particle origin to follow a Game Object's position.","kind":"function","name":"startFollow","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to follow.","name":"target"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Horizontal offset of the particle origin from the Game Object.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Vertical offset of the particle origin from the Game Object.","name":"offsetY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the emitter's visible state will track the target's visible state.","name":"trackVisible"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#startFollow","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":945,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Stops following a Game Object.","kind":"function","name":"stopFollow","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#stopFollow","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":962,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Chooses a texture frame from {@link Phaser.GameObjects.Particles.ParticleEmitter#frames}.","kind":"function","name":"getFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The texture frame."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#getFrame","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1002,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets a pattern for assigning texture frames to emitted particles.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["array","string","integer","Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig"]},"description":"One or more texture frames, or a configuration object.","name":"frames"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether frames should be assigned at random from `frames`.","name":"pickRandom"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The number of consecutive particles that will receive each frame.","name":"quantity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setFrame","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1059,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Turns {@link Phaser.GameObjects.Particles.ParticleEmitter#radial} particle movement on or off.","kind":"function","name":"setRadial","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Radial mode (true) or point mode (true).","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setRadial","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1078,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the position of the emitter's particle origin.\nNew particles will be emitted here.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The x-coordinate of the particle origin.","name":"x"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The y-coordinate of the particle origin.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setPosition","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1098,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets or modifies a rectangular boundary constraining the particles.\n\nTo remove the boundary, set {@link Phaser.GameObjects.Particles.ParticleEmitter#bounds} to null.","kind":"function","name":"setBounds","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Types.GameObjects.Particles.ParticleEmitterBounds","Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt"]},"description":"The x-coordinate of the left edge of the boundary, or an object representing a rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The y-coordinate of the top edge of the boundary.","name":"y"},{"type":{"names":["number"]},"description":"The width of the boundary.","name":"width"},{"type":{"names":["number"]},"description":"The height of the boundary.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setBounds","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1137,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the initial horizontal speed of emitted particles.\nChanges the emitter to point mode.","kind":"function","name":"setSpeedX","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The speed, in pixels per second.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setSpeedX","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the initial vertical speed of emitted particles.\nChanges the emitter to point mode.","kind":"function","name":"setSpeedY","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The speed, in pixels per second.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setSpeedY","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the initial radial speed of emitted particles.\nChanges the emitter to radial mode.","kind":"function","name":"setSpeed","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The speed, in pixels per second.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setSpeed","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the horizontal scale of emitted particles.","kind":"function","name":"setScaleX","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"description":"The scale, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setScaleX","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the vertical scale of emitted particles.","kind":"function","name":"setScaleY","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"description":"The scale, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setScaleY","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the scale of emitted particles.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"description":"The scale, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setScale","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the horizontal gravity applied to emitted particles.","kind":"function","name":"setGravityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Acceleration due to gravity, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setGravityX","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the vertical gravity applied to emitted particles.","kind":"function","name":"setGravityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Acceleration due to gravity, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setGravityY","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1290,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the gravity applied to emitted particles.","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Horizontal acceleration due to gravity, in pixels per second squared.","name":"x"},{"type":{"names":["number"]},"description":"Vertical acceleration due to gravity, in pixels per second squared.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setGravity","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1309,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the opacity of emitted particles.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"description":"A value between 0 (transparent) and 1 (opaque).","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setAlpha","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1326,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the color tint of emitted particles.","kind":"function","name":"setTint","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"description":"A value between 0 and 0xffffff.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setTint","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1343,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the angle of a {@link Phaser.GameObjects.Particles.ParticleEmitter#radial} particle stream.","kind":"function","name":"setEmitterAngle","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The angle of the initial velocity of emitted particles.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setEmitterAngle","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1360,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the angle of a {@link Phaser.GameObjects.Particles.ParticleEmitter#radial} particle stream.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The angle of the initial velocity of emitted particles.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setAngle","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1377,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the lifespan of newly emitted particles.","kind":"function","name":"setLifespan","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The particle lifespan, in ms.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setLifespan","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1394,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the number of particles released at each flow cycle or explosion.","kind":"function","name":"setQuantity","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The number of particles to release at each flow cycle or explosion.","name":"quantity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setQuantity","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the emitter's {@link Phaser.GameObjects.Particles.ParticleEmitter#frequency}\nand {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity}.","kind":"function","name":"setFrequency","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The time interval (>= 0) of each flow cycle, in ms; or -1 to put the emitter in explosion mode.","name":"frequency"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"The number of particles to release at each flow cycle or explosion.","name":"quantity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setFrequency","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1437,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets or removes the {@link Phaser.GameObjects.Particles.ParticleEmitter#emitZone}.\n\nAn {@link Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig EdgeZone} places particles on its edges. Its {@link Phaser.Types.GameObjects.Particles.EdgeZoneSource source} can be a Curve, Path, Circle, Ellipse, Line, Polygon, Rectangle, or Triangle; or any object with a suitable {@link Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback getPoints} method.\n\nA {@link Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig RandomZone} places randomly within its interior. Its {@link RandomZoneSource source} can be a Circle, Ellipse, Line, Polygon, Rectangle, or Triangle; or any object with a suitable {@link Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback getRandomPoint} method.","kind":"function","name":"setEmitZone","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig","Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig"]},"optional":true,"description":"An object describing the zone, or `undefined` to remove any current emit zone.","name":"zoneConfig"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1490,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets or removes the {@link Phaser.GameObjects.Particles.ParticleEmitter#deathZone}.","kind":"function","name":"setDeathZone","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig"]},"optional":true,"description":"An object describing the zone, or `undefined` to remove any current death zone.","name":"zoneConfig"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setDeathZone","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1526,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Creates inactive particles and adds them to this emitter's pool.","kind":"function","name":"reserve","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The number of particles to create.","name":"particleCount"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#reserve","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1548,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Gets the number of active (in-use) particles in this emitter.","kind":"function","name":"getAliveParticleCount","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of particles with `active=true`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#getAliveParticleCount","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1561,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Gets the number of inactive (available) particles in this emitter.","kind":"function","name":"getDeadParticleCount","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of particles with `active=false`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#getDeadParticleCount","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1574,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Gets the total number of particles in this emitter.","kind":"function","name":"getParticleCount","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of particles, including both alive and dead."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#getParticleCount","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether this emitter is at its limit (if set).","kind":"function","name":"atLimit","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if this Emitter is at its limit, or `false` if no limit, or below the `maxParticles` level."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#atLimit","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1600,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets a function to call for each newly emitted particle.","kind":"function","name":"onParticleEmit","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterCallback"]},"description":"The function.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"The calling context.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#onParticleEmit","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets a function to call for each particle death.","kind":"function","name":"onParticleDeath","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleDeathCallback"]},"description":"The function.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"The function's calling context.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#onParticleDeath","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1664,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Deactivates every particle in this emitter.","kind":"function","name":"killAll","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#killAll","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1685,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Calls a function for each active particle in this emitter.","kind":"function","name":"forEachAlive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterCallback"]},"description":"The function.","name":"callback"},{"type":{"names":["*"]},"description":"The function's calling context.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#forEachAlive","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1710,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Calls a function for each inactive particle in this emitter.","kind":"function","name":"forEachDead","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterCallback"]},"description":"The function.","name":"callback"},{"type":{"names":["*"]},"description":"The function's calling context.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#forEachDead","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1735,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Turns {@link Phaser.GameObjects.Particles.ParticleEmitter#on} the emitter and resets the flow counter.\n\nIf this emitter is in flow mode (frequency >= 0; the default), the particle flow will start (or restart).\n\nIf this emitter is in explode mode (frequency = -1), nothing will happen.\nUse {@link Phaser.GameObjects.Particles.ParticleEmitter#explode} or {@link Phaser.GameObjects.Particles.ParticleEmitter#flow} instead.","kind":"function","name":"start","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#start","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1757,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Turns {@link Phaser.GameObjects.Particles.ParticleEmitter#on off} the emitter.","kind":"function","name":"stop","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#stop","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1772,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"{@link Phaser.GameObjects.Particles.ParticleEmitter#active Deactivates} the emitter.","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#pause","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1787,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"{@link Phaser.GameObjects.Particles.ParticleEmitter#active Activates} the emitter.","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#resume","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1802,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Removes the emitter from its manager and the scene.","kind":"function","name":"remove","since":"3.22.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#remove","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1817,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sorts active particles with {@link Phaser.GameObjects.Particles.ParticleEmitter#depthSortCallback}.","kind":"function","name":"depthSort","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#depthSort","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1832,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Puts the emitter in flow mode (frequency >= 0) and starts (or restarts) a particle flow.\n\nTo resume a flow at the current frequency and quantity, use {@link Phaser.GameObjects.Particles.ParticleEmitter#start} instead.","kind":"function","name":"flow","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The time interval (>= 0) of each flow cycle, in ms.","name":"frequency"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"defaultvalue":1,"description":"The number of particles to emit at each flow cycle.","name":"count"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#flow","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1856,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Puts the emitter in explode mode (frequency = -1), stopping any current particle flow, and emits several particles all at once.","kind":"function","name":"explode","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The amount of Particles to emit.","name":"count"},{"type":{"names":["number"]},"description":"The x coordinate to emit the Particles from.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to emit the Particles from.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The most recently emitted Particle."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#explode","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1875,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Emits particles at a given position (or the emitter's current position).","kind":"function","name":"emitParticleAt","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":"this.x","description":"The x coordinate to emit the Particles from.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"this.x","description":"The y coordinate to emit the Particles from.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.quantity","description":"The number of Particles to emit.","name":"count"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The most recently emitted Particle."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#emitParticleAt","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1892,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Emits particles at a given position (or the emitter's current position).","kind":"function","name":"emitParticle","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.quantity","description":"The number of Particles to emit.","name":"count"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"this.x","description":"The x coordinate to emit the Particles from.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"this.x","description":"The y coordinate to emit the Particles from.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The most recently emitted Particle."}],"see":["Phaser.GameObjects.Particles.Particle#fire"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#emitParticle","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1954,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Updates this emitter and its particles.","kind":"function","name":"preUpdate","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#preUpdate","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":2047,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Calculates the difference of two particles, for sorting them by depth.","kind":"function","name":"depthSortCallback","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The first particle.","name":"a"},{"type":{"names":["object"]},"description":"The second particle.","name":"b"}],"returns":[{"type":{"names":["integer"]},"description":"The difference of a and b's y coordinates."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#depthSortCallback","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"ParticleEmitterManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"classdesc":"A Particle Emitter Manager creates and controls {@link Phaser.GameObjects.Particles.ParticleEmitter Particle Emitters} and {@link Phaser.GameObjects.Particles.GravityWell Gravity Wells}.","kind":"class","name":"ParticleEmitterManager","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects.Particles","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Emitter Manager belongs.","name":"scene"},{"type":{"names":["string"]},"description":"The key of the Texture this Emitter Manager will use to render particles, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Emitter Manager will use to render particles.","name":"frame"},{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig","Array."]},"optional":true,"description":"Configuration settings for one or more emitters to create.","name":"emitters"}],"scope":"static","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The time scale applied to all emitters and particles, affecting flow rate, lifespan, and movement.\nValues larger than 1 are faster than normal.\nThis is multiplied with any timeScale set on each individual emitter.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The texture used to render this Emitter Manager's particles.","name":"texture","type":{"names":["Phaser.Textures.Texture"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The texture frame used to render this Emitter Manager's particles.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Names of this Emitter Manager's texture frames.","name":"frameNames","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#frameNames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A list of Emitters being managed by this Emitter Manager.","name":"emitters","type":{"names":["Phaser.Structs.List."]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#emitters","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A list of Gravity Wells being managed by this Emitter Manager.","name":"wells","type":{"names":["Phaser.Structs.List."]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#wells","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the texture and frame this Emitter Manager will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setTexture","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":172,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the frame this Emitter Manager will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setFrame","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Assigns texture frames to an emitter.","kind":"function","name":"setEmitterFrames","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame","Array."]},"description":"The texture frames.","name":"frames"},{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The particle emitter to modify.","name":"emitter"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setEmitterFrames","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":250,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Adds an existing Particle Emitter to this Emitter Manager.","kind":"function","name":"addEmitter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The Particle Emitter to add to this Emitter Manager.","name":"emitter"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The Particle Emitter that was added to this Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#addEmitter","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":265,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Creates a new Particle Emitter object, adds it to this Emitter Manager and returns a reference to it.","kind":"function","name":"createEmitter","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig"]},"description":"Configuration settings for the Particle Emitter to create.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The Particle Emitter that was created."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#createEmitter","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Removes a Particle Emitter from this Emitter Manager, if the Emitter belongs to this Manager.","kind":"function","name":"removeEmitter","since":"3.22.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"name":"emitter"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"nullable":true,"description":"The Particle Emitter if it was removed or null if it was not."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#removeEmitter","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Adds an existing Gravity Well object to this Emitter Manager.","kind":"function","name":"addGravityWell","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.GravityWell"]},"description":"The Gravity Well to add to this Emitter Manager.","name":"well"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.GravityWell"]},"description":"The Gravity Well that was added to this Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#addGravityWell","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Creates a new Gravity Well, adds it to this Emitter Manager and returns a reference to it.","kind":"function","name":"createGravityWell","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.GravityWellConfig"]},"description":"Configuration settings for the Gravity Well to create.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.GravityWell"]},"description":"The Gravity Well that was created."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#createGravityWell","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":325,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Emits particles from each active emitter.","kind":"function","name":"emitParticle","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of particles to release from each emitter. The default is the emitter's own {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity}.","name":"count"},{"type":{"names":["number"]},"optional":true,"description":"The x-coordinate to to emit particles from. The default is the x-coordinate of the emitter's current location.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y-coordinate to to emit particles from. The default is the y-coordinate of the emitter's current location.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#emitParticle","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":354,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Emits particles from each active emitter.","kind":"function","name":"emitParticleAt","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x-coordinate to to emit particles from. The default is the x-coordinate of the emitter's current location.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y-coordinate to to emit particles from. The default is the y-coordinate of the emitter's current location.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The number of particles to release from each emitter. The default is the emitter's own {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity}.","name":"count"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#emitParticleAt","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":371,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Pauses this Emitter Manager.\n\nThis has the effect of pausing all emitters, and all particles of those emitters, currently under its control.\n\nThe particles will still render, but they will not have any of their logic updated.","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#pause","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":390,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Resumes this Emitter Manager, should it have been previously paused.","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#resume","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":405,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Gets all active particle processors (gravity wells).","kind":"function","name":"getProcessors","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"- The active gravity wells."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getProcessors","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":418,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Updates all active emitters.","kind":"function","name":"preUpdate","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#preUpdate","scope":"instance","___s":true},{"meta":{"range":[180,231],"filename":"ParticleManagerCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"GameObjectCreator","longname":"GameObjectCreator","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParticleManagerCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Creates a new Particle Emitter Manager Game Object and returns it.\n\nNote: This method will only be available if the Particles Game Object has been built into Phaser.","kind":"function","name":"particles","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#particles","scope":"instance","___s":true},{"meta":{"range":[180,231],"filename":"ParticleManagerFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParticleManagerFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Creates a new Particle Emitter Manager Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Particles Game Object has been built into Phaser.","kind":"function","name":"particles","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer","object"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"},{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig","Array."]},"optional":true,"description":"Configuration settings for one or more emitters to create.","name":"emitters"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#particles","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"ParticleManagerRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"ParticleManagerWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"kind":"namespace","name":"Particles","memberof":"Phaser.GameObjects","longname":"Phaser.GameObjects.Particles","scope":"static","___s":true},{"meta":{"filename":"DeathZoneSource.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"DeathZoneSource","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.DeathZoneSourceCallback"]},"name":"contains"}],"see":["Phaser.Geom.Circle","Phaser.Geom.Ellipse","Phaser.Geom.Polygon","Phaser.Geom.Rectangle","Phaser.Geom.Triangle"],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.DeathZoneSource","scope":"static","___s":true},{"meta":{"filename":"DeathZoneSourceCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"DeathZoneSourceCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the particle to check against this source area.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the particle to check against this source area.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"- True if the coordinates are within the source area."}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.DeathZoneSourceCallback","scope":"static","___s":true},{"meta":{"filename":"EdgeZoneSource.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"EdgeZoneSource","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback"]},"description":"A function placing points on the sources edge or edges.","name":"getPoints"}],"see":["Phaser.Curves.Curve","Phaser.Curves.Path","Phaser.Geom.Circle","Phaser.Geom.Ellipse","Phaser.Geom.Line","Phaser.Geom.Polygon","Phaser.Geom.Rectangle","Phaser.Geom.Triangle"],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EdgeZoneSource","scope":"static","___s":true},{"meta":{"filename":"EdgeZoneSourceCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"EdgeZoneSourceCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The number of particles to place on the source edge. If 0, `stepRate` should be used instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"The distance between each particle. When set, `quantity` is implied and should be set to `0`.","name":"stepRate"}],"returns":[{"type":{"names":["Array."]},"description":"- The points placed on the source edge."}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback","scope":"static","___s":true},{"meta":{"filename":"EmitterOpCustomEmitConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"EmitterOpCustomEmitConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback"]},"description":"A callback that is invoked each time the emitter emits a particle.","name":"onEmit"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpCustomEmitConfig","scope":"static","___s":true},{"meta":{"filename":"EmitterOpCustomUpdateConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"EmitterOpCustomUpdateConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback"]},"optional":true,"description":"A callback that is invoked each time the emitter emits a particle.","name":"onEmit"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback"]},"description":"A callback that is invoked each time the emitter updates.","name":"onUpdate"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpCustomUpdateConfig","scope":"static","___s":true},{"meta":{"filename":"EmitterOpEaseConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"Defines an operation yielding a value incremented continuously across a range.","kind":"typedef","name":"EmitterOpEaseConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The starting value.","name":"start"},{"type":{"names":["number"]},"description":"The ending value.","name":"end"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'Linear'","description":"The name of the easing function.","name":"ease"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpEaseConfig","scope":"static","___s":true},{"meta":{"filename":"EmitterOpOnEmitCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"The returned value sets what the property will be at the START of the particle's life, on emit.","kind":"typedef","name":"EmitterOpOnEmitCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"},{"type":{"names":["number"]},"description":"The current value of the property.","name":"value"}],"returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback","scope":"static","___s":true},{"meta":{"filename":"EmitterOpOnEmitType.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"EmitterOpOnEmitType","type":{"names":["number","Array.","Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback","Phaser.Types.GameObjects.Particles.EmitterOpRandomConfig","Phaser.Types.GameObjects.Particles.EmitterOpRandomMinMaxConfig","Phaser.Types.GameObjects.Particles.EmitterOpRandomStartEndConfig","Phaser.Types.GameObjects.Particles.EmitterOpSteppedConfig","Phaser.Types.GameObjects.Particles.EmitterOpCustomEmitConfig"]},"since":"3.18.0","memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","scope":"static","___s":true},{"meta":{"filename":"EmitterOpOnUpdateCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"The returned value updates the property for the duration of the particle's life.","kind":"typedef","name":"EmitterOpOnUpdateCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"},{"type":{"names":["number"]},"description":"The normalized lifetime of the particle, between 0 (start) and 1 (end).","name":"t"},{"type":{"names":["number"]},"description":"The current value of the property.","name":"value"}],"returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback","scope":"static","___s":true},{"meta":{"filename":"EmitterOpOnUpdateType.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"EmitterOpOnUpdateType","type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback","Phaser.Types.GameObjects.Particles.EmitterOpEaseConfig","Phaser.Types.GameObjects.Particles.EmitterOpCustomUpdateConfig"]},"since":"3.18.0","memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType","scope":"static","___s":true},{"meta":{"filename":"EmitterOpRandomConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"Defines an operation yielding a random value within a range.","kind":"typedef","name":"EmitterOpRandomConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Array."]},"description":"The minimum and maximum values, as [min, max].","name":"random"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpRandomConfig","scope":"static","___s":true},{"meta":{"filename":"EmitterOpRandomMinMaxConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"Defines an operation yielding a random value within a range.","kind":"typedef","name":"EmitterOpRandomMinMaxConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The minimum value.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value.","name":"max"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpRandomMinMaxConfig","scope":"static","___s":true},{"meta":{"filename":"EmitterOpRandomStartEndConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"Defines an operation yielding a random value within a range.","kind":"typedef","name":"EmitterOpRandomStartEndConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The starting value.","name":"start"},{"type":{"names":["number"]},"description":"The ending value.","name":"end"},{"type":{"names":["boolean"]},"description":"If false, this becomes {@link EmitterOpEaseConfig}.","name":"random"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpRandomStartEndConfig","scope":"static","___s":true},{"meta":{"filename":"EmitterOpSteppedConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"Defines an operation yielding a value incremented by steps across a range.","kind":"typedef","name":"EmitterOpSteppedConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The starting value.","name":"start"},{"type":{"names":["number"]},"description":"The ending value.","name":"end"},{"type":{"names":["number"]},"description":"The number of steps between start and end.","name":"steps"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpSteppedConfig","scope":"static","___s":true},{"meta":{"filename":"GravityWellConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"GravityWellConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the Gravity Well, in world space.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the Gravity Well, in world space.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The strength of the gravity force - larger numbers produce a stronger force.","name":"power"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"The minimum distance for which the gravity force is calculated.","name":"epsilon"},{"type":{"names":["number"]},"optional":true,"defaultvalue":50,"description":"The gravitational force of this Gravity Well.","name":"gravity"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.GravityWellConfig","scope":"static","___s":true},{"meta":{"filename":"ParticleDeathCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleDeathCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle that died.","name":"particle"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleDeathCallback","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterBounds.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterBounds","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The left edge of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The top edge of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"height"}],"see":["Phaser.GameObjects.Particles.ParticleEmitter#setBounds"],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterBounds","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterBoundsAlt.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterBoundsAlt","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The left edge of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The top edge of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"w"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"h"}],"see":["Phaser.GameObjects.Particles.ParticleEmitter#setBounds"],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle associated with the call.","name":"particle"},{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This particle emitter associated with the call.","name":"emitter"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterCallback","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#active}.","name":"active"},{"type":{"names":["Phaser.BlendModes","string"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#blendMode}.","name":"blendMode"},{"type":{"names":["*"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope} and {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope}.","name":"callbackScope"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideBottom}.","name":"collideBottom"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideLeft}.","name":"collideLeft"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideRight}.","name":"collideRight"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideTop}.","name":"collideTop"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallback}.","name":"deathCallback"},{"type":{"names":["*"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope}.","name":"deathCallbackScope"},{"type":{"names":["function"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallback}.","name":"emitCallback"},{"type":{"names":["*"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope}.","name":"emitCallbackScope"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#follow}.","name":"follow"},{"type":{"names":["number"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#frequency}.","name":"frequency"},{"type":{"names":["number"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#gravityX}.","name":"gravityX"},{"type":{"names":["number"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#gravityY}.","name":"gravityY"},{"type":{"names":["integer"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxParticles}.","name":"maxParticles"},{"type":{"names":["string"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#name}.","name":"name"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#on}.","name":"on"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop}.","name":"particleBringToTop"},{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleClass}.","name":"particleClass"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#radial}.","name":"radial"},{"type":{"names":["number"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#timeScale}.","name":"timeScale"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#trackVisible}.","name":"trackVisible"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#visible}.","name":"visible"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationX} (emit only).","name":"accelerationX"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationY} (emit only).","name":"accelerationY"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#alpha}.","name":"alpha"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#angle} (emit only).","name":"angle"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#bounce} (emit only).","name":"bounce"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#delay} (emit only).","name":"delay"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#lifespan} (emit only).","name":"lifespan"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX} (emit only).","name":"maxVelocityX"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY} (emit only).","name":"maxVelocityY"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToX} (emit only).","name":"moveToX"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToY} (emit only).","name":"moveToY"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity} (emit only).","name":"quantity"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#rotate}.","name":"rotate"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"optional":true,"description":"As {@link Phaser.GameObjects.Particles.ParticleEmitter#setScale}.","name":"scale"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#scaleX}.","name":"scaleX"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#scaleY}.","name":"scaleY"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"As {@link Phaser.GameObjects.Particles.ParticleEmitter#setSpeed} (emit only).","name":"speed"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedX} (emit only).","name":"speedX"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedY} (emit only).","name":"speedY"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#tint}.","name":"tint"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#x} (emit only).","name":"x"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#y} (emit only).","name":"y"},{"type":{"names":["object"]},"optional":true,"description":"As {@link Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone}.","name":"emitZone"},{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterBounds","Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt"]},"optional":true,"description":"As {@link Phaser.GameObjects.Particles.ParticleEmitter#setBounds}.","name":"bounds"},{"type":{"names":["object"]},"optional":true,"description":"Assigns to {@link Phaser.GameObjects.Particles.ParticleEmitter#followOffset}.","name":"followOffset"},{"type":{"names":["number"]},"optional":true,"description":"x-coordinate of the offset.","name":"followOffset.x"},{"type":{"names":["number"]},"optional":true,"description":"y-coordinate of the offset.","name":"followOffset.y"},{"type":{"names":["number","Array.","string","Array.","Phaser.Textures.Frame","Array.","Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#frames}.","name":"frame"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterConfig","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterDeathZoneConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterDeathZoneConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.DeathZoneSource"]},"description":"A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.DeathZone#source}.","name":"source"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'onEnter'","description":"'onEnter' or 'onLeave'.","name":"type"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterEdgeZoneConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterEdgeZoneConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EdgeZoneSource"]},"description":"A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.EdgeZone#source}.","name":"source"},{"type":{"names":["string"]},"description":"'edge'.","name":"type"},{"type":{"names":["integer"]},"description":"The number of particles to place on the source edge. Set to 0 to use `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"The distance between each particle. When set, `quantity` is implied and should be set to 0.","name":"stepRate"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether particles are placed from start to end and then end to start.","name":"yoyo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether one endpoint will be removed if it's identical to the other.","name":"seamless"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterFrameConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterFrameConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number","Array.","string","Array.","Phaser.Textures.Frame","Array."]},"optional":true,"description":"One or more texture frames.","name":"frames"},{"type":{"names":["boolean"]},"optional":true,"description":"Whether texture frames will be assigned consecutively (true) or at random (false).","name":"cycle"},{"type":{"names":["integer"]},"optional":true,"description":"The number of consecutive particles receiving each texture frame, when `cycle` is true.","name":"quantity"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterRandomZoneConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterRandomZoneConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.RandomZoneSource"]},"description":"A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.RandomZone#source}.","name":"source"},{"type":{"names":["string"]},"optional":true,"description":"'random'.","name":"type"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig","scope":"static","___s":true},{"meta":{"filename":"RandomZoneSource.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"RandomZoneSource","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback"]},"description":"A function modifying its point argument.","name":"getRandomPoint"}],"see":["Phaser.Geom.Circle","Phaser.Geom.Ellipse","Phaser.Geom.Line","Phaser.Geom.Polygon","Phaser.Geom.Rectangle","Phaser.Geom.Triangle"],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.RandomZoneSource","scope":"static","___s":true},{"meta":{"filename":"RandomZoneSourceCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"RandomZoneSourceCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A point to modify.","name":"point"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"namespace","name":"Particles","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.Particles","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"DeathZone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DeathZone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"classdesc":"A Death Zone.\n\nA Death Zone is a special type of zone that will kill a Particle as soon as it either enters, or leaves, the zone.\n\nThe zone consists of a `source` which could be a Geometric shape, such as a Rectangle or Ellipse, or your own\nobject as long as it includes a `contains` method for which the Particles can be tested against.","kind":"class","name":"DeathZone","memberof":"Phaser.GameObjects.Particles.Zones","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.DeathZoneSource"]},"description":"An object instance that has a `contains` method that returns a boolean when given `x` and `y` arguments.","name":"source"},{"type":{"names":["boolean"]},"description":"Should the Particle be killed when it enters the zone? `true` or leaves it? `false`","name":"killOnEnter"}],"scope":"static","longname":"Phaser.GameObjects.Particles.Zones.DeathZone","___s":true},{"meta":{"filename":"DeathZone.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"An object instance that has a `contains` method that returns a boolean when given `x` and `y` arguments.\nThis could be a Geometry shape, such as `Phaser.Geom.Circle`, or your own custom object.","name":"source","type":{"names":["Phaser.Types.GameObjects.Particles.DeathZoneSource"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.DeathZone","longname":"Phaser.GameObjects.Particles.Zones.DeathZone#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DeathZone.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Set to `true` if the Particle should be killed if it enters this zone.\nSet to `false` to kill the Particle if it leaves this zone.","name":"killOnEnter","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.DeathZone","longname":"Phaser.GameObjects.Particles.Zones.DeathZone#killOnEnter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DeathZone.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Checks if the given Particle will be killed or not by this zone.","kind":"function","name":"willKill","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The Particle to be checked against this zone.","name":"particle"}],"returns":[{"type":{"names":["boolean"]},"description":"Return `true` if the Particle is to be killed, otherwise return `false`."}],"memberof":"Phaser.GameObjects.Particles.Zones.DeathZone","longname":"Phaser.GameObjects.Particles.Zones.DeathZone#willKill","scope":"instance","___s":true},{"meta":{"range":[180,219],"filename":"EdgeZone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"EdgeZone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"classdesc":"A zone that places particles on a shape's edges.","kind":"class","name":"EdgeZone","memberof":"Phaser.GameObjects.Particles.Zones","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EdgeZoneSource"]},"description":"An object instance with a `getPoints(quantity, stepRate)` method returning an array of points.","name":"source"},{"type":{"names":["integer"]},"description":"The number of particles to place on the source edge. Set to 0 to use `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"description":"The distance between each particle. When set, `quantity` is implied and should be set to 0.","name":"stepRate"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether particles are placed from start to end and then end to start.","name":"yoyo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether one endpoint will be removed if it's identical to the other.","name":"seamless"}],"scope":"static","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":33,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"An object instance with a `getPoints(quantity, stepRate)` method returning an array of points.","name":"source","type":{"names":["Phaser.Types.GameObjects.Particles.EdgeZoneSource","Phaser.Types.GameObjects.Particles.RandomZoneSource"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"The points placed on the source edge.","name":"points","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#points","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"The number of particles to place on the source edge. Set to 0 to use `stepRate` instead.","name":"quantity","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#quantity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"The distance between each particle. When set, `quantity` is implied and should be set to 0.","name":"stepRate","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#stepRate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Whether particles are placed from start to end and then end to start.","name":"yoyo","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#yoyo","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"The counter used for iterating the EdgeZone's points.","name":"counter","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#counter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Whether one endpoint will be removed if it's identical to the other.","name":"seamless","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#seamless","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Update the {@link Phaser.GameObjects.Particles.Zones.EdgeZone#points} from the EdgeZone's\n{@link Phaser.GameObjects.Particles.Zones.EdgeZone#source}.\n\nAlso updates internal properties.","kind":"function","name":"updateSource","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.Zones.EdgeZone"]},"description":"This Edge Zone."}],"memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#updateSource","scope":"instance","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":165,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Change the source of the EdgeZone.","kind":"function","name":"changeSource","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EdgeZoneSource"]},"description":"An object instance with a `getPoints(quantity, stepRate)` method returning an array of points.","name":"source"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.Zones.EdgeZone"]},"description":"This Edge Zone."}],"memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#changeSource","scope":"instance","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Get the next point in the Zone and set its coordinates on the given Particle.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The Particle.","name":"particle"}],"memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#getPoint","scope":"instance","___s":true},{"meta":{"range":[180,219],"filename":"RandomZone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomZone.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"classdesc":"A zone that places particles randomly within a shape's area.","kind":"class","name":"RandomZone","memberof":"Phaser.GameObjects.Particles.Zones","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.RandomZoneSource"]},"description":"An object instance with a `getRandomPoint(point)` method.","name":"source"}],"scope":"static","longname":"Phaser.GameObjects.Particles.Zones.RandomZone","___s":true},{"meta":{"filename":"RandomZone.js","lineno":27,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"An object instance with a `getRandomPoint(point)` method.","name":"source","type":{"names":["Phaser.Types.GameObjects.Particles.RandomZoneSource"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.RandomZone","longname":"Phaser.GameObjects.Particles.Zones.RandomZone#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RandomZone.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Get the next point in the Zone and set its coordinates on the given Particle.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The Particle.","name":"particle"}],"memberof":"Phaser.GameObjects.Particles.Zones.RandomZone","longname":"Phaser.GameObjects.Particles.Zones.RandomZone#getPoint","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"kind":"namespace","name":"Zones","memberof":"Phaser.GameObjects.Particles","longname":"Phaser.GameObjects.Particles.Zones","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"PathFollower.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PathFollower.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower"},"classdesc":"A PathFollower Game Object.\n\nA PathFollower is a Sprite Game Object with some extra helpers to allow it to follow a Path automatically.\n\nAnything you can do with a standard Sprite can be done with this PathFollower, such as animate it, tint it,\nscale it and so on.\n\nPathFollowers are bound to a single Path at any one time and can traverse the length of the Path, from start\nto finish, forwards or backwards, or from any given point on the Path to its end. They can optionally rotate\nto face the direction of the path, be offset from the path coordinates or rotate independently of the Path.","kind":"class","name":"PathFollower","augments":["Phaser.GameObjects.Sprite","Phaser.GameObjects.Components.PathFollower"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this PathFollower belongs.","name":"scene"},{"type":{"names":["Phaser.Curves.Path"]},"description":"The Path this PathFollower is following. It can only follow one Path at a time.","name":"path"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.PathFollower","___s":true},{"meta":{"range":[180,231],"filename":"PathFollowerFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PathFollowerFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower"},"description":"Creates a new PathFollower Game Object and adds it to the Scene.\n\nNote: This method will only be available if the PathFollower Game Object has been built into Phaser.","kind":"function","name":"follower","since":"3.0.0","params":[{"type":{"names":["Phaser.Curves.Path"]},"description":"The Path this PathFollower is connected to.","name":"path"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#follower","scope":"instance","___s":true},{"meta":{"filename":"PathConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower/typedefs"},"description":"Settings for a PathFollower.","kind":"typedef","name":"PathConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1000,"description":"The duration of the path follow in ms. Must be `> 0`.","name":"duration"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The start position of the path follow, between 0 and 1. Must be less than `to`.","name":"from"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The end position of the path follow, between 0 and 1. Must be more than `from`.","name":"to"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to position the PathFollower on the Path using its path offset.","name":"positionOnPath"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the PathFollower automatically rotate to point in the direction of the Path?","name":"rotateToPath"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"If the PathFollower is rotating to match the Path, this value is added to the rotation value. This allows you to rotate objects to a path but control the angle of the rotation as well.","name":"rotationOffset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Current start position of the path follow, must be between `from` and `to`.","name":"startAt"}],"memberof":"Phaser.Types.GameObjects.PathFollower","longname":"Phaser.Types.GameObjects.PathFollower.PathConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower/typedefs"},"kind":"namespace","name":"PathFollower","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.PathFollower","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Quad.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Quad.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"classdesc":"A Quad Game Object.\n\nA Quad is a Mesh Game Object pre-configured with two triangles arranged into a rectangle, with a single\ntexture spread across them.\n\nYou can manipulate the corner points of the quad via the getters and setters such as `topLeftX`, and also\nchange their alpha and color values. The quad itself can be moved by adjusting the `x` and `y` properties.","kind":"class","name":"Quad","augments":["Phaser.GameObjects.Mesh"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Quad belongs.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.Quad","___s":true},{"meta":{"filename":"Quad.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.11.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setFrame","scope":"instance","overrides":"Phaser.GameObjects.Mesh#setFrame","___s":true},{"meta":{"filename":"Quad.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-left x vertex of this Quad.","name":"topLeftX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topLeftX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":171,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-left y vertex of this Quad.","name":"topLeftY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topLeftY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":193,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-right x vertex of this Quad.","name":"topRightX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topRightX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":214,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-right y vertex of this Quad.","name":"topRightY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topRightY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":235,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-left x vertex of this Quad.","name":"bottomLeftX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomLeftX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-left y vertex of this Quad.","name":"bottomLeftY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomLeftY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":277,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-right x vertex of this Quad.","name":"bottomRightX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomRightX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":299,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-right y vertex of this Quad.","name":"bottomRightY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomRightY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-left alpha value of this Quad.","name":"topLeftAlpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topLeftAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":343,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-right alpha value of this Quad.","name":"topRightAlpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topRightAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":364,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-left alpha value of this Quad.","name":"bottomLeftAlpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomLeftAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-right alpha value of this Quad.","name":"bottomRightAlpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomRightAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":407,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-left color value of this Quad.","name":"topLeftColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topLeftColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":429,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-right color value of this Quad.","name":"topRightColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topRightColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":450,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-left color value of this Quad.","name":"bottomLeftColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomLeftColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":471,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-right color value of this Quad.","name":"bottomRightColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomRightColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Sets the top-left vertex position of this Quad.","kind":"function","name":"setTopLeft","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the vertex.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the vertex.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setTopLeft","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":512,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Sets the top-right vertex position of this Quad.","kind":"function","name":"setTopRight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the vertex.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the vertex.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setTopRight","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":531,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Sets the bottom-left vertex position of this Quad.","kind":"function","name":"setBottomLeft","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the vertex.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the vertex.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setBottomLeft","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":550,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Sets the bottom-right vertex position of this Quad.","kind":"function","name":"setBottomRight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the vertex.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the vertex.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setBottomRight","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":569,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Resets the positions of the four corner vertices of this Quad.","kind":"function","name":"resetPosition","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#resetPosition","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":592,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Resets the alpha values used by this Quad back to 1.","kind":"function","name":"resetAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#resetAlpha","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":614,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Resets the color values used by this Quad back to 0xffffff.","kind":"function","name":"resetColors","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#resetColors","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":636,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Resets the position, alpha and color values used by this Quad.","kind":"function","name":"reset","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#reset","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"QuadCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuadCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Creates a new Quad Game Object and returns it.\n\nNote: This method will only be available if the Quad Game Object and WebGL support have been built into Phaser.","kind":"function","name":"quad","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#quad","scope":"instance","___s":true},{"meta":{"range":[180,204],"filename":"QuadFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"name":"Quad","longname":"Quad","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuadFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Creates a new Quad Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Quad Game Object and WebGL support have been built into Phaser.","kind":"function","name":"quad","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#quad","scope":"instance","___s":true},{"meta":{"range":[180,229],"filename":"RenderTexture.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"name":"BlendModes","longname":"BlendModes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RenderTexture.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"classdesc":"A Render Texture.\n\nA Render Texture is a special texture that allows any number of Game Objects to be drawn to it. You can take many complex objects and\ndraw them all to this one texture, which can they be used as the texture for other Game Object's. It's a way to generate dynamic\ntextures at run-time that are WebGL friendly and don't invoke expensive GPU uploads.\n\nNote that under WebGL a FrameBuffer, which is what the Render Texture uses internally, cannot be anti-aliased. This means\nthat when drawing objects such as Shapes to a Render Texture they will appear to be drawn with no aliasing, however this\nis a technical limitation of WebGL. To get around it, create your shape as a texture in an art package, then draw that\nto the Render Texture.","kind":"class","name":"RenderTexture","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Crop","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.2.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The width of the Render Texture.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The height of the Render Texture.","name":"height"}],"properties":[{"type":{"names":["string"]},"optional":true,"description":"The texture key to make the RenderTexture from.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"the frame to make the RenderTexture from.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.RenderTexture","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"A reference to either the Canvas or WebGL Renderer that the Game instance is using.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.2.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"A reference to the Texture Manager.","name":"textureManager","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.12.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#textureManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"The tint of the Render Texture when rendered.","name":"globalTint","type":{"names":["number"]},"defaultvalue":"0xffffff","since":"3.2.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#globalTint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"The alpha of the Render Texture when rendered.","name":"globalAlpha","type":{"names":["number"]},"defaultvalue":"1","since":"3.2.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#globalAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"The HTML Canvas Element that the Render Texture is drawing to when using the Canvas Renderer.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.2.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"A reference to the GL Frame Buffer this Render Texture is drawing to.\nThis is only set if Phaser is running with the WebGL Renderer.","name":"framebuffer","type":{"names":["WebGLFramebuffer"]},"nullable":true,"since":"3.2.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#framebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Is this Render Texture dirty or not? If not it won't spend time clearing or filling itself.","name":"dirty","type":{"names":["boolean"]},"since":"3.12.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":170,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"The Texture corresponding to this Render Texture.","name":"texture","type":{"names":["Phaser.Textures.Texture"]},"since":"3.12.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#texture","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Crop#texture","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":179,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"The Frame corresponding to this Render Texture.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.12.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#frame","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Crop#frame","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":224,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"A reference to the Rendering Context belonging to the Canvas Element this Render Texture is drawing to.","name":"context","type":{"names":["CanvasRenderingContext2D"]},"since":"3.2.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":243,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"An internal Camera that can be used to move around the Render Texture.\nControl it just like you would any Scene Camera. The difference is that it only impacts the placement of what\nis drawn to the Render Texture. You can scroll, zoom and rotate this Camera.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"since":"3.12.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":254,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"A reference to the WebGL Rendering Context.","name":"gl","type":{"names":["WebGLRenderingContext"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#gl","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":264,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"A reference to the WebGLTexture that is being rendered to in a WebGL Context.","name":"glTexture","type":{"names":["WebGLTexture"]},"defaultvalue":"null","readonly":true,"since":"3.19.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#glTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":304,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Sets the size of this Game Object.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setSize","scope":"instance","overrides":"Phaser.GameObjects.Components.ComputedSize#setSize","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":320,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Resizes the Render Texture to the new dimensions given.\n\nIf Render Texture was created from specific frame, only the size of the frame will be changed. The size of the source\ntexture will not change.\n\nIf Render Texture was not created from specific frame, the following will happen:\nIn WebGL it will destroy and then re-create the frame buffer being used by the Render Texture.\nIn Canvas it will resize the underlying canvas element.\nBoth approaches will erase everything currently drawn to the Render Texture.\n\nIf the dimensions given are the same as those already being used, calling this method will do nothing.","kind":"function","name":"resize","since":"3.10.0","params":[{"type":{"names":["number"]},"description":"The new width of the Render Texture.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The new height of the Render Texture. If not specified, will be set the same as the `width`.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#resize","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":417,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Set the tint to use when rendering this Render Texture.","kind":"function","name":"setGlobalTint","since":"3.2.0","params":[{"type":{"names":["integer"]},"description":"The tint value.","name":"tint"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setGlobalTint","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":434,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Set the alpha to use when rendering this Render Texture.","kind":"function","name":"setGlobalAlpha","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The alpha value.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setGlobalAlpha","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Stores a copy of this Render Texture in the Texture Manager using the given key.\n\nAfter doing this, any texture based Game Object, such as a Sprite, can use the contents of this\nRender Texture by using the texture key:\n\n```javascript\nvar rt = this.add.renderTexture(0, 0, 128, 128);\n\n// Draw something to the Render Texture\n\nrt.saveTexture('doodle');\n\nthis.add.image(400, 300, 'doodle');\n```\n\nUpdating the contents of this Render Texture will automatically update _any_ Game Object\nthat is using it as a texture. Calling `saveTexture` again will not save another copy\nof the same texture, it will just rename the key of the existing copy.\n\nBy default it will create a single base texture. You can add frames to the texture\nby using the `Texture.add` method. After doing this, you can then allow Game Objects\nto use a specific frame from a Render Texture.","kind":"function","name":"saveTexture","since":"3.12.0","params":[{"type":{"names":["string"]},"description":"The unique key to store the texture as within the global Texture Manager.","name":"key"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"The Texture that was saved."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#saveTexture","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":491,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Fills the Render Texture with the given color.","kind":"function","name":"fill","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The color to fill the Render Texture with.","name":"rgb"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used by the fill.","name":"alpha"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The left coordinate of the fill rectangle.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The top coordinate of the fill rectangle.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"this.frame.cutWidth","description":"The width of the fill rectangle.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"this.frame.cutHeight","description":"The height of the fill rectangle.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#fill","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":565,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Clears the Render Texture.","kind":"function","name":"clear","since":"3.2.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#clear","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":611,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Draws the given object, or an array of objects, to this Render Texture using a blend mode of ERASE.\nThis has the effect of erasing any filled pixels in the objects from this Render Texture.\n\nIt can accept any of the following:\n\n* Any renderable Game Object, such as a Sprite, Text, Graphics or TileSprite.\n* Dynamic and Static Tilemap Layers.\n* A Group. The contents of which will be iterated and drawn in turn.\n* A Container. The contents of which will be iterated fully, and drawn in turn.\n* A Scene's Display List. Pass in `Scene.children` to draw the whole list.\n* Another Render Texture.\n* A Texture Frame instance.\n* A string. This is used to look-up a texture from the Texture Manager.\n\nNote: You cannot erase a Render Texture from itself.\n\nIf passing in a Group or Container it will only draw children that return `true`\nwhen their `willRender()` method is called. I.e. a Container with 10 children,\n5 of which have `visible=false` will only draw the 5 visible ones.\n\nIf passing in an array of Game Objects it will draw them all, regardless if\nthey pass a `willRender` check or not.\n\nYou can pass in a string in which case it will look for a texture in the Texture\nManager matching that string, and draw the base frame.\n\nYou can pass in the `x` and `y` coordinates to draw the objects at. The use of\nthe coordinates differ based on what objects are being drawn. If the object is\na Group, Container or Display List, the coordinates are _added_ to the positions\nof the children. For all other types of object, the coordinates are exact.\n\nCalling this method causes the WebGL batch to flush, so it can write the texture\ndata to the framebuffer being used internally. The batch is flushed at the end,\nafter the entries have been iterated. So if you've a bunch of objects to draw,\ntry and pass them in an array in one single call, rather than making lots of\nseparate calls.","kind":"function","name":"erase","since":"3.16.0","params":[{"type":{"names":["any"]},"description":"Any renderable Game Object, or Group, Container, Display List, other Render Texture, Texture Frame or an array of any of these.","name":"entries"},{"type":{"names":["number"]},"optional":true,"description":"The x position to draw the Frame at, or the offset applied to the object.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y position to draw the Frame at, or the offset applied to the object.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#erase","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":675,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Draws the given object, or an array of objects, to this Render Texture.\n\nIt can accept any of the following:\n\n* Any renderable Game Object, such as a Sprite, Text, Graphics or TileSprite.\n* Dynamic and Static Tilemap Layers.\n* A Group. The contents of which will be iterated and drawn in turn.\n* A Container. The contents of which will be iterated fully, and drawn in turn.\n* A Scene's Display List. Pass in `Scene.children` to draw the whole list.\n* Another Render Texture.\n* A Texture Frame instance.\n* A string. This is used to look-up a texture from the Texture Manager.\n\nNote: You cannot draw a Render Texture to itself.\n\nIf passing in a Group or Container it will only draw children that return `true`\nwhen their `willRender()` method is called. I.e. a Container with 10 children,\n5 of which have `visible=false` will only draw the 5 visible ones.\n\nIf passing in an array of Game Objects it will draw them all, regardless if\nthey pass a `willRender` check or not.\n\nYou can pass in a string in which case it will look for a texture in the Texture\nManager matching that string, and draw the base frame. If you need to specify\nexactly which frame to draw then use the method `drawFrame` instead.\n\nYou can pass in the `x` and `y` coordinates to draw the objects at. The use of\nthe coordinates differ based on what objects are being drawn. If the object is\na Group, Container or Display List, the coordinates are _added_ to the positions\nof the children. For all other types of object, the coordinates are exact.\n\nThe `alpha` and `tint` values are only used by Texture Frames.\nGame Objects use their own alpha and tint values when being drawn.\n\nCalling this method causes the WebGL batch to flush, so it can write the texture\ndata to the framebuffer being used internally. The batch is flushed at the end,\nafter the entries have been iterated. So if you've a bunch of objects to draw,\ntry and pass them in an array in one single call, rather than making lots of\nseparate calls.","kind":"function","name":"draw","since":"3.2.0","params":[{"type":{"names":["any"]},"description":"Any renderable Game Object, or Group, Container, Display List, other Render Texture, Texture Frame or an array of any of these.","name":"entries"},{"type":{"names":["number"]},"optional":true,"description":"The x position to draw the Frame at, or the offset applied to the object.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y position to draw the Frame at, or the offset applied to the object.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value. Only used for Texture Frames and if not specified defaults to the `globalAlpha` property. Game Objects use their own current alpha value.","name":"alpha"},{"type":{"names":["number"]},"optional":true,"description":"WebGL only. The tint color value. Only used for Texture Frames and if not specified defaults to the `globalTint` property. Game Objects use their own current tint value.","name":"tint"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#draw","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":788,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Draws the Texture Frame to the Render Texture at the given position.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.\n\n```javascript\nvar rt = this.add.renderTexture(0, 0, 800, 600);\nrt.drawFrame(key, frame);\n```\n\nYou can optionally provide a position, alpha and tint value to apply to the frame\nbefore it is drawn.\n\nCalling this method will cause a batch flush, so if you've got a stack of things to draw\nin a tight loop, try using the `draw` method instead.\n\nIf you need to draw a Sprite to this Render Texture, use the `draw` method instead.","kind":"function","name":"drawFrame","since":"3.12.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position to draw the frame at.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position to draw the frame at.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The alpha to use. If not specified it uses the `globalAlpha` property.","name":"alpha"},{"type":{"names":["number"]},"optional":true,"description":"WebGL only. The tint color to use. If not specified it uses the `globalTint` property.","name":"tint"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#drawFrame","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":1094,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Takes a snapshot of the given area of this Render Texture.\n\nThe snapshot is taken immediately.\n\nTo capture the whole Render Texture see the `snapshot` method. To capture a specific pixel, see `snapshotPixel`.\n\nSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\nIt then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\nwhich is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\nwhich gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshotArea","since":"3.19.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate to grab from.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate to grab from.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the area to grab.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the area to grab.","name":"height"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#snapshotArea","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":1133,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Takes a snapshot of the whole of this Render Texture.\n\nThe snapshot is taken immediately.\n\nTo capture just a portion of the Render Texture see the `snapshotArea` method. To capture a specific pixel, see `snapshotPixel`.\n\nSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\nIt then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\nwhich is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\nwhich gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshot","since":"3.19.0","params":[{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#snapshot","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":1168,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Takes a snapshot of the given pixel from this Render Texture.\n\nThe snapshot is taken immediately.\n\nTo capture the whole Render Texture see the `snapshot` method. To capture a specific portion, see `snapshotArea`.\n\nUnlike the other two snapshot methods, this one will send your callback a `Color` object containing the color data for\nthe requested pixel. It doesn't need to create an internal Canvas or Image object, so is a lot faster to execute,\nusing less memory, than the other snapshot methods.","kind":"function","name":"snapshotPixel","since":"3.19.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel to get.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel to get.","name":"y"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot pixel data is extracted.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#snapshotPixel","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"RenderTextureCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RenderTextureCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Creates a new Render Texture Game Object and returns it.\n\nNote: This method will only be available if the Render Texture Game Object has been built into Phaser.","kind":"function","name":"renderTexture","since":"3.2.0","params":[{"type":{"names":["Phaser.Types.GameObjects.RenderTexture.RenderTextureConfig"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#renderTexture","scope":"instance","___s":true},{"meta":{"range":[180,231],"filename":"RenderTextureFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RenderTextureFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Creates a new Render Texture Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Render Texture Game Object has been built into Phaser.\n\nA Render Texture is a special texture that allows any number of Game Objects to be drawn to it. You can take many complex objects and\ndraw them all to this one texture, which can they be used as the texture for other Game Object's. It's a way to generate dynamic\ntextures at run-time that are WebGL friendly and don't invoke expensive GPU uploads.","kind":"function","name":"renderTexture","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The width of the Render Texture.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The height of the Render Texture.","name":"height"}],"properties":[{"type":{"names":["string"]},"optional":true,"description":"The texture key to make the RenderTexture from.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"the frame to make the RenderTexture from.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#renderTexture","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"RenderTextureRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"RenderTextureWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RenderTextureConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/typedefs"},"kind":"typedef","name":"RenderTextureConfig","type":{"names":["object"]},"since":"3.2.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the RenderTextures position.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the RenderTextures position.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The width of the RenderTexture.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of the RenderTexture.","name":"height"},{"type":{"names":["string"]},"optional":true,"description":"The texture key to make the RenderTexture from.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"the frame to make the RenderTexture from.","name":"frame"}],"memberof":"Phaser.Types.GameObjects.RenderTexture","longname":"Phaser.Types.GameObjects.RenderTexture.RenderTextureConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/typedefs"},"kind":"namespace","name":"RenderTexture","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.RenderTexture","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Rope.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Rope.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"classdesc":"A Rope Game Object.","kind":"class","name":"Rope","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible","Phaser.GameObjects.Components.ScrollFactor"],"memberof":"Phaser.GameObjects","since":"3.23.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer","null"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"},{"type":{"names":["Array."]},"optional":true,"description":"An array containing the vertices data for this Rope. If none is provided a simple quad is created. See `setPoints` to set this post-creation.","name":"points"},{"type":{"names":["Array."]},"optional":true,"description":"An optional array containing the color data for this Rope. You should provide one color value per pair of vertices.","name":"colors"},{"type":{"names":["Array."]},"optional":true,"description":"An optional array containing the alpha data for this Rope. You should provide one alpha value per pair of vertices.","name":"alphas"}],"scope":"static","longname":"Phaser.GameObjects.Rope","___s":true},{"meta":{"filename":"Rope.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"An array containing the points data for this Rope.\n\nEach point should be given as a Vector2Like object (i.e. a Vector2, Geom.Point or object with public x/y properties).\n\nThe point coordinates are given in local space, where 0 x 0 is the start of the Rope strip.\n\nYou can modify the contents of this array directly in real-time to create interesting effects.\nIf you do so, be sure to call `setDirty` _after_ modifying this array, so that the vertices data is\nupdated before the next render. Alternatively, you can use the `setPoints` method instead.\n\nShould you need to change the _size_ of this array, then you should always use the `setPoints` method.","name":"points","type":{"names":["Array."]},"since":"3.23.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#points","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rope.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"An array containing the vertices data for this Rope.\n\nThis data is calculated automatically in the `updateVertices` method, based on the points provided.","name":"vertices","type":{"names":["Float32Array"]},"since":"3.23.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#vertices","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rope.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"An array containing the uv data for this Rope.\n\nThis data is calculated automatically in the `setPoints` method, based on the points provided.","name":"uv","type":{"names":["Float32Array"]},"since":"3.23.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#uv","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rope.js","lineno":113,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"An array containing the color data for this Rope.\n\nColors should be given as numeric RGB values, such as 0xff0000.\nYou should provide _two_ color values for every point in the Rope, one for the top and one for the bottom of each quad.\n\nYou can modify the contents of this array directly in real-time, however, should you need to change the _size_\nof the array, then you should use the `setColors` method instead.","name":"colors","type":{"names":["Uint32Array"]},"since":"3.23.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#colors","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rope.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"An array containing the alpha data for this Rope.\n\nAlphas should be given as float values, such as 0.5.\nYou should provide _two_ alpha values for every point in the Rope, one for the top and one for the bottom of each quad.\n\nYou can modify the contents of this array directly in real-time, however, should you need to change the _size_\nof the array, then you should use the `setAlphas` method instead.","name":"alphas","type":{"names":["Float32Array"]},"since":"3.23.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#alphas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rope.js","lineno":143,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"Fill or additive mode used when blending the color values?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.23.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#tintFill","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rope.js","lineno":153,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"If the Rope is marked as `dirty` it will automatically recalculate its vertices\nthe next time it renders. You can also force this by calling `updateVertices`.","name":"dirty","type":{"names":["boolean"]},"since":"3.23.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rope.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"This method is left intentionally empty and does not do anything.\nIt is retained to allow a Rope to be added to a Container.\nYou should modify the alphas array values instead. See `setAlphas`.","kind":"function","name":"setAlpha","since":"3.23.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setAlpha","scope":"instance","___s":true},{"meta":{"filename":"Rope.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"Flags this Rope as being dirty. A dirty rope will recalculate all of its vertices data\nthe _next_ time it renders. You should set this rope as dirty if you update the points\narray directly.","kind":"function","name":"setDirty","since":"3.23.0","returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setDirty","scope":"instance","___s":true},{"meta":{"filename":"Rope.js","lineno":212,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"Swap this Game Object from using a fill-tint to an additive tint.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. See the `setColors` method for details of tinting the vertices.","kind":"function","name":"setTintFill","since":"3.23.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use tint fill (`true`) or an additive tint (`false`)","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setTintFill","scope":"instance","___s":true},{"meta":{"filename":"Rope.js","lineno":236,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"Set the alpha values used by the Rope during rendering.\n\nYou can provide the values in a number of ways:\n\n1) One single numeric value: `setAlphas(0.5)` - This will set a single alpha for the whole Rope.\n2) Two numeric value: `setAlphas(1, 0.5)` - This will set a 'top' and 'bottom' alpha value across the whole Rope.\n3) An array of values: `setAlphas([ 1, 0.5, 0.2 ])`\n\nIf you provide an array of values and the array has exactly the same number of values as `points` in the Rope, it\nwill use each alpha value per rope segment.\n\nIf the provided array has a different number of values than `points` then it will use the values in order, from\nthe first Rope segment and on, until it runs out of values. This allows you to control the alpha values at all\nvertices in the Rope.\n\nNote this method is called `setAlphas` (plural) and not `setAlpha`, which is a NOOP.","kind":"function","name":"setAlphas","since":"3.23.0","params":[{"type":{"names":["number","Array."]},"optional":true,"description":"Either a single alpha value, or an array of values. If nothing is provided alpha is reset to 1.","name":"alphas"},{"type":{"names":["number"]},"optional":true,"description":"An optional bottom alpha value. See the method description for details.","name":"bottomAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setAlphas","scope":"instance","___s":true},{"meta":{"filename":"Rope.js","lineno":335,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"Set the color values used by the Rope during rendering.\n\nColors are used to control the level of tint applied across the Rope texture.\n\nYou can provide the values in a number of ways:\n\n1) One single numeric value: `setColors(0xff0000)` - This will set a single color tint for the whole Rope.\n3) An array of values: `setColors([ 0xff0000, 0x00ff00, 0x0000ff ])`\n\nIf you provide an array of values and the array has exactly the same number of values as `points` in the Rope, it\nwill use each color per rope segment.\n\nIf the provided array has a different number of values than `points` then it will use the values in order, from\nthe first Rope segment and on, until it runs out of values. This allows you to control the color values at all\nvertices in the Rope.","kind":"function","name":"setColors","since":"3.23.0","params":[{"type":{"names":["number","Array."]},"optional":true,"description":"Either a single color value, or an array of values. If nothing is provided color is reset to 0xffffff.","name":"colors"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setColors","scope":"instance","___s":true},{"meta":{"filename":"Rope.js","lineno":420,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"Sets the points used by this Rope.\n\nThe points should be provided as an array of Vector2, or vector2-like objects (i.e. those with public x/y properties).\n\nEach point corresponds to one segment of the Rope. The more points in the array, the more segments the rope has.\n\nPoint coordinates are given in local-space, not world-space, and are directly related to the size of the texture\nthis Rope object is using.\n\nFor example, a Rope using a 512 px wide texture, split into 4 segments (128px each) would use the following points:\n\n```javascript\nrope.setPoints([\n { x: 0, y: 0 },\n { x: 128, y: 0 },\n { x: 256, y: 0 },\n { x: 384, y: 0 }\n]);\n```\n\nNote that calling this method with a different number of points than the Rope has currently will\n_reset_ the color and alpha values, unless you provide them as arguments to this method.\n\nSee also `Rope.split`.","kind":"function","name":"setPoints","since":"3.23.0","params":[{"type":{"names":["Array."]},"optional":true,"description":"An array of points to split the Rope into.","name":"points"},{"type":{"names":["number","Array."]},"optional":true,"description":"Either a single color value, or an array of values.","name":"colors"},{"type":{"names":["number","Array."]},"optional":true,"description":"Either a single alpha value, or an array of values.","name":"alphas"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setPoints","scope":"instance","___s":true},{"meta":{"filename":"Rope.js","lineno":500,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"Resizes all of the internal arrays: `vertices`, `uv`, `colors` and `alphas` to the new\ngiven Rope segment total.","kind":"function","name":"resizeArrays","since":"3.23.0","params":[{"type":{"names":["integer"]},"description":"The amount of segments to split the Rope in to.","name":"newSize"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#resizeArrays","scope":"instance","___s":true},{"meta":{"filename":"Rope.js","lineno":537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"Updates the vertices based on the Rope points.\n\nThis method is called automatically during rendering if `Rope.dirty` is `true`, which is set\nby the `setPoints` and `setDirty` methods. You should flag the Rope as being dirty if you modify\nthe Rope points directly.","kind":"function","name":"updateVertices","since":"3.23.0","returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#updateVertices","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"RopeCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RopeCreator.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"Creates a new Rope Game Object and returns it.\n\nNote: This method will only be available if the Rope Game Object and WebGL support have been built into Phaser.","kind":"function","name":"rope","since":"3.23.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#rope","scope":"instance","___s":true},{"meta":{"range":[180,204],"filename":"RopeFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"name":"Rope","longname":"Rope","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RopeFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"description":"Creates a new Rope Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Rope Game Object and WebGL support have been built into Phaser.","kind":"function","name":"mesh","since":"3.23.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"},{"type":{"names":["Array."]},"optional":true,"description":"An array containing the vertices data for this Rope. If none is provided a simple quad is created. See `setPoints` to set this post-creation.","name":"points"},{"type":{"names":["Array."]},"optional":true,"description":"An optional array containing the color data for this Rope. You should provide one color value per pair of vertices.","name":"colors"},{"type":{"names":["Array."]},"optional":true,"description":"An optional array containing the alpha data for this Rope. You should provide one alpha value per pair of vertices.","name":"alphas"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#mesh","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"RopeRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"RopeWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rope"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"Shader.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Shader.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"classdesc":"A Shader Game Object.\n\nThis Game Object allows you to easily add a quad with its own shader into the display list, and manipulate it\nas you would any other Game Object, including scaling, rotating, positioning and adding to Containers. Shaders\ncan be masked with either Bitmap or Geometry masks and can also be used as a Bitmap Mask for a Camera or other\nGame Object. They can also be made interactive and used for input events.\n\nIt works by taking a reference to a `Phaser.Display.BaseShader` instance, as found in the Shader Cache. These can\nbe created dynamically at runtime, or loaded in via the GLSL File Loader:\n\n```javascript\nfunction preload ()\n{\n this.load.glsl('fire', 'shaders/fire.glsl.js');\n}\n \nfunction create ()\n{\n this.add.shader('fire', 400, 300, 512, 512);\n}\n```\n\nPlease see the Phaser 3 Examples GitHub repo for examples of loading and creating shaders dynamically.\n\nDue to the way in which they work, you cannot directly change the alpha or blend mode of a Shader. This should\nbe handled via exposed uniforms in the shader code itself.\n\nBy default a Shader will be created with a standard set of uniforms. These were added to match those\nfound on sites such as ShaderToy or GLSLSandbox, and provide common functionality a shader may need,\nsuch as the timestamp, resolution or pointer position. You can replace them by specifying your own uniforms\nin the Base Shader.\n\nThese Shaders work by halting the current pipeline during rendering, creating a viewport matched to the\nsize of this Game Object and then renders a quad using the bound shader. At the end, the pipeline is restored.\n\nBecause it blocks the pipeline it means it will interrupt any batching that is currently going on, so you should\nuse these Game Objects sparingly. If you need to have a fully batched custom shader, then please look at using\na custom pipeline instead. However, for background or special masking effects, they are extremely effective.","kind":"class","name":"Shader","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.17.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["string","Phaser.Display.BaseShader"]},"description":"The key of the shader to use from the shader cache, or a BaseShader instance.","name":"key"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the Game Object.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the Game Object.","name":"height"},{"type":{"names":["Array."]},"optional":true,"description":"Optional array of texture keys to bind to the iChannel0...3 uniforms. The textures must already exist in the Texture Manager.","name":"textures"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data if you want to create shader with none NPOT textures.","name":"textureData"}],"scope":"static","longname":"Phaser.GameObjects.Shader","___s":true},{"meta":{"filename":"Shader.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The underlying shader object being used.\nEmpty by default and set during a call to the `setShader` method.","name":"shader","type":{"names":["Phaser.Display.BaseShader"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#shader","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A reference to the current renderer.\nShaders only work with the WebGL Renderer.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The WebGL context belonging to the renderer.","name":"gl","type":{"names":["WebGLRenderingContext"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#gl","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":150,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Raw byte buffer of vertices this Shader uses.","name":"vertexData","type":{"names":["ArrayBuffer"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#vertexData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The WebGL vertex buffer object this shader uses.","name":"vertexBuffer","type":{"names":["WebGLBuffer"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#vertexBuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The WebGL shader program this shader uses.","name":"program","type":{"names":["WebGLProgram"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#program","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Uint8 view to the vertex raw buffer. Used for uploading vertex buffer resources to the GPU.","name":"bytes","type":{"names":["Uint8Array"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#bytes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":186,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Float32 view of the array buffer containing the shaders vertices.","name":"vertexViewF32","type":{"names":["Float32Array"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#vertexViewF32","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":225,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The view matrix the shader uses during rendering.","name":"viewMatrix","type":{"names":["Float32Array"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#viewMatrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":235,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The projection matrix the shader uses during rendering.","name":"projectionMatrix","type":{"names":["Float32Array"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#projectionMatrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":245,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The default uniform mappings. These can be added to (or replaced) by specifying your own uniforms when\ncreating this shader game object. The uniforms are updated automatically during the render step.\n\nThe defaults are:\n\n`resolution` (2f) - Set to the size of this shader.\n`time` (1f) - The elapsed game time, in seconds.\n`mouse` (2f) - If a pointer has been bound (with `setPointer`), this uniform contains its position each frame.\n`date` (4fv) - A vec4 containing the year, month, day and time in seconds.\n`sampleRate` (1f) - Sound sample rate. 44100 by default.\n`iChannel0...3` (sampler2D) - Input channels 0 to 3. `null` by default.","name":"uniforms","type":{"names":["any"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#uniforms","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":264,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The pointer bound to this shader, if any.\nSet via the chainable `setPointer` method, or by modifying this property directly.","name":"pointer","type":{"names":["Phaser.Input.Pointer"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#pointer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":304,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A reference to the GL Frame Buffer this Shader is drawing to.\nThis property is only set if you have called `Shader.setRenderToTexture`.","name":"framebuffer","type":{"names":["WebGLFramebuffer"]},"nullable":true,"since":"3.19.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#framebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":314,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A reference to the WebGLTexture this Shader is rendering to.\nThis property is only set if you have called `Shader.setRenderToTexture`.","name":"glTexture","type":{"names":["WebGLTexture"]},"nullable":true,"since":"3.19.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#glTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":324,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A flag that indicates if this Shader has been set to render to a texture instead of the display list.\n\nThis property is `true` if you have called `Shader.setRenderToTexture`, otherwise it's `false`.\n\nA Shader that is rendering to a texture _does not_ appear on the display list.","name":"renderToTexture","type":{"names":["boolean"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#renderToTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":338,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A reference to the Phaser.Textures.Texture that has been stored in the Texture Manager for this Shader.\n\nThis property is only set if you have called `Shader.setRenderToTexture`, otherwise it is `null`.","name":"texture","type":{"names":["Phaser.Textures.Texture"]},"since":"3.19.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#willRender","scope":"instance","overrides":"Phaser.GameObjects.GameObject#willRender","___s":true},{"meta":{"filename":"Shader.js","lineno":378,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Changes this Shader so instead of rendering to the display list it renders to a\nWebGL Framebuffer and WebGL Texture instead. This allows you to use the output\nof this shader as an input for another shader, by mapping a sampler2D uniform\nto it.\n\nAfter calling this method the `Shader.framebuffer` and `Shader.glTexture` properties\nare populated.\n\nAdditionally, you can provide a key to this method. Doing so will create a Phaser Texture\nfrom this Shader and save it into the Texture Manager, allowing you to then use it for\nany texture-based Game Object, such as a Sprite or Image:\n\n```javascript\nvar shader = this.add.shader('myShader', x, y, width, height);\n\nshader.setRenderToTexture('doodle');\n\nthis.add.image(400, 300, 'doodle');\n```\n\nNote that it stores an active reference to this Shader. That means as this shader updates,\nso does the texture and any object using it to render with. Also, if you destroy this\nshader, be sure to clear any objects that may have been using it as a texture too.\n\nYou can access the Phaser Texture that is created via the `Shader.texture` property.\n\nBy default it will create a single base texture. You can add frames to the texture\nby using the `Texture.add` method. After doing this, you can then allow Game Objects\nto use a specific frame from a Render Texture.","kind":"function","name":"setRenderToTexture","since":"3.19.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The unique key to store the texture as within the global Texture Manager.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Does this texture need vertically flipping before rendering? This should usually be set to `true` if being fed from a buffer.","name":"flipY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setRenderToTexture","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":463,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Sets the fragment and, optionally, the vertex shader source code that this Shader will use.\nThis will immediately delete the active shader program, if set, and then create a new one\nwith the given source. Finally, the shader uniforms are initialized.","kind":"function","name":"setShader","since":"3.17.0","params":[{"type":{"names":["string","Phaser.Display.BaseShader"]},"description":"The key of the shader to use from the shader cache, or a BaseShader instance.","name":"key"},{"type":{"names":["Array."]},"optional":true,"description":"Optional array of texture keys to bind to the iChannel0...3 uniforms. The textures must already exist in the Texture Manager.","name":"textures"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setShader","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Binds a Phaser Pointer object to this Shader.\n\nThe screen position of the pointer will be set in to the shaders `mouse` uniform\nautomatically every frame. Call this method with no arguments to unbind the pointer.","kind":"function","name":"setPointer","since":"3.17.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"optional":true,"description":"The Pointer to bind to this shader.","name":"pointer"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setPointer","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":574,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Sets this shader to use an orthographic projection matrix.\nThis matrix is stored locally in the `projectionMatrix` property,\nas well as being bound to the `uProjectionMatrix` uniform.","kind":"function","name":"projOrtho","since":"3.17.0","params":[{"type":{"names":["number"]},"description":"The left value.","name":"left"},{"type":{"names":["number"]},"description":"The right value.","name":"right"},{"type":{"names":["number"]},"description":"The bottom value.","name":"bottom"},{"type":{"names":["number"]},"description":"The top value.","name":"top"}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#projOrtho","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":649,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Sets a sampler2D uniform on this shader where the source texture is a WebGLTexture.\n\nThis allows you to feed the output from one Shader into another:\n\n```javascript\nlet shader1 = this.add.shader(baseShader1, 0, 0, 512, 512).setRenderToTexture();\nlet shader2 = this.add.shader(baseShader2, 0, 0, 512, 512).setRenderToTexture('output');\n\nshader1.setSampler2DBuffer('iChannel0', shader2.glTexture, 512, 512);\nshader2.setSampler2DBuffer('iChannel0', shader1.glTexture, 512, 512);\n```\n\nIn the above code, the result of baseShader1 is fed into Shader2 as the `iChannel0` sampler2D uniform.\nThe result of baseShader2 is then fed back into shader1 again, creating a feedback loop.\n\nIf you wish to use an image from the Texture Manager as a sampler2D input for this shader,\nsee the `Shader.setSampler2D` method.","kind":"function","name":"setSampler2DBuffer","since":"3.19.0","params":[{"type":{"names":["string"]},"description":"The key of the sampler2D uniform to be updated, i.e. `iChannel0`.","name":"uniformKey"},{"type":{"names":["WebGLTexture"]},"description":"A WebGLTexture reference.","name":"texture"},{"type":{"names":["integer"]},"description":"The width of the texture.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the texture.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The texture index.","name":"textureIndex"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setSampler2DBuffer","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":701,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Sets a sampler2D uniform on this shader.\n\nThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\nfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.\n\nIf you wish to use another Shader as a sampler2D input for this shader, see the `Shader.setSampler2DBuffer` method.","kind":"function","name":"setSampler2D","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the sampler2D uniform to be updated, i.e. `iChannel0`.","name":"uniformKey"},{"type":{"names":["string"]},"description":"The key of the texture, as stored in the Texture Manager. Must already be loaded.","name":"textureKey"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The texture index.","name":"textureIndex"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setSampler2D","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":759,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Sets a property of a uniform already present on this shader.\n\nTo modify the value of a uniform such as a 1f or 1i use the `value` property directly:\n\n```javascript\nshader.setUniform('size.value', 16);\n```\n\nYou can use dot notation to access deeper values, for example:\n\n```javascript\nshader.setUniform('resolution.value.x', 512);\n```\n\nThe change to the uniform will take effect the next time the shader is rendered.","kind":"function","name":"setUniform","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the uniform to modify. Use dots for deep properties, i.e. `resolution.value.x`.","name":"key"},{"type":{"names":["any"]},"description":"The value to set into the uniform.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setUniform","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":791,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Returns the uniform object for the given key, or `null` if the uniform couldn't be found.","kind":"function","name":"getUniform","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the uniform to return the value for.","name":"key"}],"returns":[{"type":{"names":["any"]},"description":"A reference to the uniform object. This is not a copy, so modifying it will update the original object also."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getUniform","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":806,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A short-cut method that will directly set the texture being used by the `iChannel0` sampler2D uniform.\n\nThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\nfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.","kind":"function","name":"setChannel0","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the texture, as stored in the Texture Manager. Must already be loaded.","name":"textureKey"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setChannel0","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":825,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A short-cut method that will directly set the texture being used by the `iChannel1` sampler2D uniform.\n\nThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\nfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.","kind":"function","name":"setChannel1","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the texture, as stored in the Texture Manager. Must already be loaded.","name":"textureKey"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setChannel1","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":844,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A short-cut method that will directly set the texture being used by the `iChannel2` sampler2D uniform.\n\nThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\nfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.","kind":"function","name":"setChannel2","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the texture, as stored in the Texture Manager. Must already be loaded.","name":"textureKey"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setChannel2","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":863,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A short-cut method that will directly set the texture being used by the `iChannel3` sampler2D uniform.\n\nThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\nfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.","kind":"function","name":"setChannel3","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the texture, as stored in the Texture Manager. Must already be loaded.","name":"textureKey"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setChannel3","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":1028,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Called automatically during render.\n\nThis method performs matrix ITRS and then stores the resulting value in the `uViewMatrix` uniform.\nIt then sets up the vertex buffer and shader, updates and syncs the uniforms ready\nfor flush to be called.","kind":"function","name":"load","since":"3.17.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The transform matrix to use during rendering.","name":"matrix2D"}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#load","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":1099,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Called automatically during render.\n\nSets the active shader, loads the vertex buffer and then draws.","kind":"function","name":"flush","since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#flush","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"ShaderCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ShaderCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Creates a new Shader Game Object and returns it.\n\nNote: This method will only be available if the Shader Game Object and WebGL support have been built into Phaser.","kind":"function","name":"shader","since":"3.17.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#shader","scope":"instance","___s":true},{"meta":{"range":[180,208],"filename":"ShaderFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"name":"Shader","longname":"Shader","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ShaderFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Creates a new Shader Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Shader Game Object and WebGL support have been built into Phaser.","kind":"function","name":"shader","since":"3.17.0","params":[{"type":{"names":["string","Phaser.Display.BaseShader"]},"description":"The key of the shader to use from the shader cache, or a BaseShader instance.","name":"key"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the Game Object.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the Game Object.","name":"height"},{"type":{"names":["Array."]},"optional":true,"description":"Optional array of texture keys to bind to the iChannel0...3 uniforms. The textures must already exist in the Texture Manager.","name":"textures"},{"type":{"names":["object"]},"optional":true,"description":"Optional additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#shader","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"ShaderRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"FillPathWebGL.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"Shape.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Shape.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"classdesc":"The Shape Game Object is a base class for the various different shapes, such as the Arc, Star or Polygon.\nYou cannot add a Shape directly to your Scene, it is meant as a base for your own custom Shape classes.","kind":"class","name":"Shape","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.AlphaSingle","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["string"]},"optional":true,"description":"The internal type of the Shape.","name":"type"},{"type":{"names":["any"]},"optional":true,"description":"The data of the source shape geometry, if any.","name":"data"}],"scope":"static","longname":"Phaser.GameObjects.Shape","___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#data","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.GameObject#data","___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#pathData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#pathIndexes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#fillColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#fillAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#strokeColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#strokeAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#lineWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#isFilled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#isStroked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#closePath","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setFillStyle","scope":"instance","___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setStrokeStyle","scope":"instance","___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setClosePath","scope":"instance","___s":true},{"meta":{"range":[180,225],"filename":"StrokePathWebGL.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,214],"filename":"Arc.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"name":"ArcRender","longname":"ArcRender","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Arc.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"classdesc":"The Arc Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nWhen it renders it displays an arc shape. You can control the start and end angles of the arc,\nas well as if the angles are winding clockwise or anti-clockwise. With the default settings\nit renders as a complete circle. By changing the angles you can create other arc shapes,\nsuch as half-circles.\n\nArcs also have an `iterations` property and corresponding `setIterations` method. This allows\nyou to control how smooth the shape renders in WebGL, by controlling the number of iterations\nthat take place during construction.","kind":"class","name":"Arc","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The radius of the arc.","name":"radius"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The start angle of the arc, in degrees.","name":"startAngle"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":360,"description":"The end angle of the arc, in degrees.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The winding order of the start and end angles.","name":"anticlockwise"},{"type":{"names":["number"]},"optional":true,"description":"The color the arc will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the arc will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Arc","___s":true},{"meta":{"filename":"Arc.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"The number of iterations used when drawing the arc.\nIncrease this value for smoother arcs, at the cost of more polygons being rendered.\nModify this value by small amounts, such as 0.01.","name":"iterations","type":{"names":["number"]},"defaultvalue":"0.01","since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#iterations","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Arc.js","lineno":151,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"The radius of the arc.","name":"radius","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#radius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Arc.js","lineno":177,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"The start angle of the arc, in degrees.","name":"startAngle","type":{"names":["integer"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#startAngle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Arc.js","lineno":200,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"The end angle of the arc, in degrees.","name":"endAngle","type":{"names":["integer"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#endAngle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Arc.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"The winding order of the start and end angles.","name":"anticlockwise","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#anticlockwise","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Arc.js","lineno":246,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"Sets the radius of the arc.\nThis call can be chained.","kind":"function","name":"setRadius","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The value to set the radius to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setRadius","scope":"instance","___s":true},{"meta":{"filename":"Arc.js","lineno":264,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"Sets the number of iterations used when drawing the arc.\nIncrease this value for smoother arcs, at the cost of more polygons being rendered.\nModify this value by small amounts, such as 0.01.\nThis call can be chained.","kind":"function","name":"setIterations","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The value to set the iterations to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setIterations","scope":"instance","___s":true},{"meta":{"filename":"Arc.js","lineno":286,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"Sets the starting angle of the arc, in degrees.\nThis call can be chained.","kind":"function","name":"setStartAngle","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The value to set the starting angle to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setStartAngle","scope":"instance","___s":true},{"meta":{"filename":"Arc.js","lineno":309,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"Sets the ending angle of the arc, in degrees.\nThis call can be chained.","kind":"function","name":"setEndAngle","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The value to set the ending angle to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setEndAngle","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"ArcCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"name":"DegToRad","longname":"DegToRad","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,202],"filename":"ArcFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"name":"Arc","longname":"Arc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ArcFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"Creates a new Arc Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Arc Game Object has been built into Phaser.\n\nThe Arc Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nWhen it renders it displays an arc shape. You can control the start and end angles of the arc,\nas well as if the angles are winding clockwise or anti-clockwise. With the default settings\nit renders as a complete circle. By changing the angles you can create other arc shapes,\nsuch as half-circles.","kind":"function","name":"arc","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The radius of the arc.","name":"radius"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The start angle of the arc, in degrees.","name":"startAngle"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":360,"description":"The end angle of the arc, in degrees.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The winding order of the start and end angles.","name":"anticlockwise"},{"type":{"names":["number"]},"optional":true,"description":"The color the arc will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the arc will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#arc","scope":"instance","___s":true},{"meta":{"filename":"ArcFactory.js","lineno":46,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"Creates a new Circle Shape Game Object and adds it to the Scene.\n\nA Circle is an Arc with no defined start and end angle, making it render as a complete circle.\n\nNote: This method will only be available if the Arc Game Object has been built into Phaser.","kind":"function","name":"circle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The radius of the circle.","name":"radius"},{"type":{"names":["number"]},"optional":true,"description":"The color the circle will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the circle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#circle","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"ArcRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"ArcWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"name":"FillPathWebGL","longname":"FillPathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"Curve.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Curve.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"classdesc":"The Curve Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nTo render a Curve Shape you must first create a `Phaser.Curves.Curve` object, then pass it to\nthe Curve Shape in the constructor.\n\nThe Curve shape also has a `smoothness` property and corresponding `setSmoothness` method.\nThis allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\nthat take place during construction. Increase and decrease the default value for smoother, or more\njagged, shapes.","kind":"class","name":"Curve","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["Phaser.Curves.Curve"]},"optional":true,"description":"The Curve object to use to create the Shape.","name":"curve"},{"type":{"names":["number"]},"optional":true,"description":"The color the curve will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the curve will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Curve","___s":true},{"meta":{"filename":"Curve.js","lineno":94,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"description":"The smoothness of the curve. The number of points used when rendering it.\nIncrease this value for smoother curves, at the cost of more polygons being rendered.","name":"smoothness","type":{"names":["integer"]},"defaultvalue":"32","since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#smoothness","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":119,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"description":"Sets the smoothness of the curve. The number of points used when rendering it.\nIncrease this value for smoother curves, at the cost of more polygons being rendered.\nThis call can be chained.","kind":"function","name":"setSmoothness","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The value to set the smoothness to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setSmoothness","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"CurveCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"CurveFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CurveFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"description":"Creates a new Curve Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Curve Game Object has been built into Phaser.\n\nThe Curve Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nTo render a Curve Shape you must first create a `Phaser.Curves.Curve` object, then pass it to\nthe Curve Shape in the constructor.\n\nThe Curve shape also has a `smoothness` property and corresponding `setSmoothness` method.\nThis allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\nthat take place during construction. Increase and decrease the default value for smoother, or more\njagged, shapes.","kind":"function","name":"curve","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["Phaser.Curves.Curve"]},"optional":true,"description":"The Curve object to use to create the Shape.","name":"curve"},{"type":{"names":["number"]},"optional":true,"description":"The color the curve will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the curve will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#curve","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"CurveRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"CurveWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"name":"FillPathWebGL","longname":"FillPathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"Ellipse.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Ellipse.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"classdesc":"The Ellipse Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nWhen it renders it displays an ellipse shape. You can control the width and height of the ellipse.\nIf the width and height match it will render as a circle. If the width is less than the height,\nit will look more like an egg shape.\n\nThe Ellipse shape also has a `smoothness` property and corresponding `setSmoothness` method.\nThis allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\nthat take place during construction. Increase and decrease the default value for smoother, or more\njagged, shapes.","kind":"class","name":"Ellipse","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the ellipse. An ellipse with equal width and height renders as a circle.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the ellipse. An ellipse with equal width and height renders as a circle.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The color the ellipse will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the ellipse will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Ellipse","___s":true},{"meta":{"filename":"Ellipse.js","lineno":89,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"description":"The smoothness of the ellipse. The number of points used when rendering it.\nIncrease this value for a smoother ellipse, at the cost of more polygons being rendered.","name":"smoothness","type":{"names":["integer"]},"defaultvalue":"64","since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#smoothness","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"description":"Sets the size of the ellipse by changing the underlying geometry data, rather than scaling the object.\nThis call can be chained.","kind":"function","name":"setSize","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"description":"The height of the ellipse.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setSize","scope":"instance","overrides":"Phaser.GameObjects.Shape#setSize","___s":true},{"meta":{"filename":"Ellipse.js","lineno":133,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"description":"Sets the smoothness of the ellipse. The number of points used when rendering it.\nIncrease this value for a smoother ellipse, at the cost of more polygons being rendered.\nThis call can be chained.","kind":"function","name":"setSmoothness","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The value to set the smoothness to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setSmoothness","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"EllipseCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,210],"filename":"EllipseFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"name":"Ellipse","longname":"Ellipse","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"EllipseFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"description":"Creates a new Ellipse Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Ellipse Game Object has been built into Phaser.\n\nThe Ellipse Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nWhen it renders it displays an ellipse shape. You can control the width and height of the ellipse.\nIf the width and height match it will render as a circle. If the width is less than the height,\nit will look more like an egg shape.\n\nThe Ellipse shape also has a `smoothness` property and corresponding `setSmoothness` method.\nThis allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\nthat take place during construction. Increase and decrease the default value for smoother, or more\njagged, shapes.","kind":"function","name":"ellipse","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the ellipse. An ellipse with equal width and height renders as a circle.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the ellipse. An ellipse with equal width and height renders as a circle.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The color the ellipse will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the ellipse will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#ellipse","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"EllipseRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"EllipseWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"name":"FillPathWebGL","longname":"FillPathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"Grid.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Grid.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"classdesc":"The Grid Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only fill colors and cannot be stroked.\n\nA Grid Shape allows you to display a grid in your game, where you can control the size of the\ngrid as well as the width and height of the grid cells. You can set a fill color for each grid\ncell as well as an alternate fill color. When the alternate fill color is set then the grid\ncells will alternate the fill colors as they render, creating a chess-board effect. You can\nalso optionally have an outline fill color. If set, this draws lines between the grid cells\nin the given color. If you specify an outline color with an alpha of zero, then it will draw\nthe cells spaced out, but without the lines between them.","kind":"class","name":"Grid","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the grid.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the grid.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The width of one cell in the grid.","name":"cellWidth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of one cell in the grid.","name":"cellHeight"},{"type":{"names":["number"]},"optional":true,"description":"The color the grid cells will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"},{"type":{"names":["number"]},"optional":true,"description":"The color of the lines between the grid cells. See the `setOutline` method.","name":"outlineFillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha of the lines between the grid cells.","name":"outlineFillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Grid","___s":true},{"meta":{"filename":"Grid.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"The width of each grid cell.\nMust be a positive value.","name":"cellWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#cellWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"The height of each grid cell.\nMust be a positive value.","name":"cellHeight","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#cellHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Will the grid render its cells in the `fillColor`?","name":"showCells","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#showCells","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"The color of the lines between each grid cell.","name":"outlineFillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#outlineFillColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"The alpha value for the color of the lines between each grid cell.","name":"outlineFillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#outlineFillAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Will the grid display the lines between each cell when it renders?","name":"showOutline","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#showOutline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Will the grid render the alternating cells in the `altFillColor`?","name":"showAltCells","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#showAltCells","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"The color the alternating grid cells will be filled with, i.e. 0xff0000 for red.","name":"altFillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#altFillColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"The alpha the alternating grid cells will be filled with.\nYou can also set the alpha of the overall Shape using its `alpha` property.","name":"altFillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#altFillAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Sets the fill color and alpha level the grid cells will use when rendering.\n\nIf this method is called with no values then the grid cells will not be rendered, \nhowever the grid lines and alternating cells may still be.\n\nAlso see the `setOutlineStyle` and `setAltFillStyle` methods.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color the grid cells will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setFillStyle","scope":"instance","overrides":"Phaser.GameObjects.Shape#setFillStyle","___s":true},{"meta":{"filename":"Grid.js","lineno":203,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Sets the fill color and alpha level that the alternating grid cells will use.\n\nIf this method is called with no values then alternating grid cells will not be rendered in a different color.\n\nAlso see the `setOutlineStyle` and `setFillStyle` methods.\n\nThis call can be chained.","kind":"function","name":"setAltFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color the alternating grid cells will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha the alternating grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setAltFillStyle","scope":"instance","___s":true},{"meta":{"filename":"Grid.js","lineno":238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Sets the fill color and alpha level that the lines between each grid cell will use.\n\nIf this method is called with no values then the grid lines will not be rendered at all, however\nthe cells themselves may still be if they have colors set.\n\nAlso see the `setFillStyle` and `setAltFillStyle` methods.\n\nThis call can be chained.","kind":"function","name":"setOutlineStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color the lines between the grid cells will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha the lines between the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setOutlineStyle","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"GridCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"GridFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GridFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Creates a new Grid Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Grid Game Object has been built into Phaser.\n\nThe Grid Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only fill colors and cannot be stroked.\n\nA Grid Shape allows you to display a grid in your game, where you can control the size of the\ngrid as well as the width and height of the grid cells. You can set a fill color for each grid\ncell as well as an alternate fill color. When the alternate fill color is set then the grid\ncells will alternate the fill colors as they render, creating a chess-board effect. You can\nalso optionally have an outline fill color. If set, this draws lines between the grid cells\nin the given color. If you specify an outline color with an alpha of zero, then it will draw\nthe cells spaced out, but without the lines between them.","kind":"function","name":"grid","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the grid.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the grid.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The width of one cell in the grid.","name":"cellWidth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of one cell in the grid.","name":"cellHeight"},{"type":{"names":["number"]},"optional":true,"description":"The color the grid cells will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"},{"type":{"names":["number"]},"optional":true,"description":"The color of the lines between the grid cells.","name":"outlineFillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha of the lines between the grid cells.","name":"outlineFillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#grid","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"GridRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"GridWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,220],"filename":"IsoBox.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"name":"IsoBoxRender","longname":"IsoBoxRender","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IsoBox.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"classdesc":"The IsoBox Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only fill colors and cannot be stroked.\n\nAn IsoBox is an 'isometric' rectangle. Each face of it has a different fill color. You can set\nthe color of the top, left and right faces of the rectangle respectively. You can also choose\nwhich of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\n\nYou cannot view an IsoBox from under-neath, however you can change the 'angle' by setting\nthe `projection` property.","kind":"class","name":"IsoBox","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":48,"description":"The width of the iso box in pixels. The left and right faces will be exactly half this value.","name":"size"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of the iso box. The left and right faces will be this tall. The overall height of the isobox will be this value plus half the `size` value.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xeeeeee","description":"The fill color of the top face of the iso box.","name":"fillTop"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x999999","description":"The fill color of the left face of the iso box.","name":"fillLeft"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xcccccc","description":"The fill color of the right face of the iso box.","name":"fillRight"}],"scope":"static","longname":"Phaser.GameObjects.IsoBox","___s":true},{"meta":{"filename":"IsoBox.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"The projection level of the iso box. Change this to change the 'angle' at which you are looking at the box.","name":"projection","type":{"names":["integer"]},"defaultvalue":"4","since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#projection","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"The color used to fill in the top of the iso box.","name":"fillTop","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#fillTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"The color used to fill in the left-facing side of the iso box.","name":"fillLeft","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#fillLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"The color used to fill in the right-facing side of the iso box.","name":"fillRight","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#fillRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Controls if the top-face of the iso box be rendered.","name":"showTop","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#showTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Controls if the left-face of the iso box be rendered.","name":"showLeft","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#showLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Controls if the right-face of the iso box be rendered.","name":"showRight","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#showRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Sets the projection level of the iso box. Change this to change the 'angle' at which you are looking at the box.\nThis call can be chained.","kind":"function","name":"setProjection","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The value to set the projection to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setProjection","scope":"instance","___s":true},{"meta":{"filename":"IsoBox.js","lineno":157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Sets which faces of the iso box will be rendered.\nThis call can be chained.","kind":"function","name":"setFaces","since":"3.13.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Show the top-face of the iso box.","name":"showTop"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Show the left-face of the iso box.","name":"showLeft"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Show the right-face of the iso box.","name":"showRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setFaces","scope":"instance","___s":true},{"meta":{"filename":"IsoBox.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Sets the fill colors for each face of the iso box.\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill the top of the iso box.","name":"fillTop"},{"type":{"names":["number"]},"optional":true,"description":"The color used to fill in the left-facing side of the iso box.","name":"fillLeft"},{"type":{"names":["number"]},"optional":true,"description":"The color used to fill in the right-facing side of the iso box.","name":"fillRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setFillStyle","scope":"instance","overrides":"Phaser.GameObjects.Shape#setFillStyle","___s":true},{"meta":{"range":[180,227],"filename":"IsoBoxCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"IsoBoxFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IsoBoxFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Creates a new IsoBox Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the IsoBox Game Object has been built into Phaser.\n\nThe IsoBox Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only fill colors and cannot be stroked.\n\nAn IsoBox is an 'isometric' rectangle. Each face of it has a different fill color. You can set\nthe color of the top, left and right faces of the rectangle respectively. You can also choose\nwhich of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\n\nYou cannot view an IsoBox from under-neath, however you can change the 'angle' by setting\nthe `projection` property.","kind":"function","name":"isobox","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":48,"description":"The width of the iso box in pixels. The left and right faces will be exactly half this value.","name":"size"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of the iso box. The left and right faces will be this tall. The overall height of the isobox will be this value plus half the `size` value.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xeeeeee","description":"The fill color of the top face of the iso box.","name":"fillTop"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x999999","description":"The fill color of the left face of the iso box.","name":"fillLeft"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xcccccc","description":"The fill color of the right face of the iso box.","name":"fillRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#isobox","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"IsoBoxRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"IsoBoxWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"IsoTriangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"classdesc":"The IsoTriangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only fill colors and cannot be stroked.\n\nAn IsoTriangle is an 'isometric' triangle. Think of it like a pyramid. Each face has a different\nfill color. You can set the color of the top, left and right faces of the triangle respectively\nYou can also choose which of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\n\nYou cannot view an IsoTriangle from under-neath, however you can change the 'angle' by setting\nthe `projection` property. The `reversed` property controls if the IsoTriangle is rendered upside\ndown or not.","kind":"class","name":"IsoTriangle","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":48,"description":"The width of the iso triangle in pixels. The left and right faces will be exactly half this value.","name":"size"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of the iso triangle. The left and right faces will be this tall. The overall height of the iso triangle will be this value plus half the `size` value.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is the iso triangle upside down?","name":"reversed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xeeeeee","description":"The fill color of the top face of the iso triangle.","name":"fillTop"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x999999","description":"The fill color of the left face of the iso triangle.","name":"fillLeft"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xcccccc","description":"The fill color of the right face of the iso triangle.","name":"fillRight"}],"scope":"static","longname":"Phaser.GameObjects.IsoTriangle","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"The projection level of the iso box. Change this to change the 'angle' at which you are looking at the box.","name":"projection","type":{"names":["integer"]},"defaultvalue":"4","since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#projection","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"The color used to fill in the top of the iso triangle. This is only used if the triangle is reversed.","name":"fillTop","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#fillTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"The color used to fill in the left-facing side of the iso triangle.","name":"fillLeft","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#fillLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"The color used to fill in the right-facing side of the iso triangle.","name":"fillRight","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#fillRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Controls if the top-face of the iso triangle be rendered.","name":"showTop","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#showTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Controls if the left-face of the iso triangle be rendered.","name":"showLeft","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#showLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Controls if the right-face of the iso triangle be rendered.","name":"showRight","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#showRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Sets if the iso triangle will be rendered upside down or not.","name":"isReversed","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#isReversed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Sets the projection level of the iso triangle. Change this to change the 'angle' at which you are looking at the pyramid.\nThis call can be chained.","kind":"function","name":"setProjection","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The value to set the projection to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setProjection","scope":"instance","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Sets if the iso triangle will be rendered upside down or not.\nThis call can be chained.","kind":"function","name":"setReversed","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Sets if the iso triangle will be rendered upside down or not.","name":"reversed"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setReversed","scope":"instance","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Sets which faces of the iso triangle will be rendered.\nThis call can be chained.","kind":"function","name":"setFaces","since":"3.13.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Show the top-face of the iso triangle (only if `reversed` is true)","name":"showTop"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Show the left-face of the iso triangle.","name":"showLeft"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Show the right-face of the iso triangle.","name":"showRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setFaces","scope":"instance","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":214,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Sets the fill colors for each face of the iso triangle.\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill the top of the iso triangle.","name":"fillTop"},{"type":{"names":["number"]},"optional":true,"description":"The color used to fill in the left-facing side of the iso triangle.","name":"fillLeft"},{"type":{"names":["number"]},"optional":true,"description":"The color used to fill in the right-facing side of the iso triangle.","name":"fillRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setFillStyle","scope":"instance","overrides":"Phaser.GameObjects.Shape#setFillStyle","___s":true},{"meta":{"range":[180,227],"filename":"IsoTriangleCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"IsoTriangleFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IsoTriangleFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Creates a new IsoTriangle Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the IsoTriangle Game Object has been built into Phaser.\n\nThe IsoTriangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only fill colors and cannot be stroked.\n\nAn IsoTriangle is an 'isometric' triangle. Think of it like a pyramid. Each face has a different\nfill color. You can set the color of the top, left and right faces of the triangle respectively\nYou can also choose which of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\n\nYou cannot view an IsoTriangle from under-neath, however you can change the 'angle' by setting\nthe `projection` property. The `reversed` property controls if the IsoTriangle is rendered upside\ndown or not.","kind":"function","name":"isotriangle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":48,"description":"The width of the iso triangle in pixels. The left and right faces will be exactly half this value.","name":"size"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of the iso triangle. The left and right faces will be this tall. The overall height of the iso triangle will be this value plus half the `size` value.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is the iso triangle upside down?","name":"reversed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xeeeeee","description":"The fill color of the top face of the iso triangle.","name":"fillTop"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x999999","description":"The fill color of the left face of the iso triangle.","name":"fillLeft"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xcccccc","description":"The fill color of the right face of the iso triangle.","name":"fillRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#isotriangle","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"IsoTriangleRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"IsoTriangleWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"Line.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Line.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"classdesc":"The Line Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only stroke colors and cannot be filled.\n\nA Line Shape allows you to draw a line between two points in your game. You can control the\nstroke color and thickness of the line. In WebGL only you can also specify a different\nthickness for the start and end of the line, allowing you to render lines that taper-off.\n\nIf you need to draw multiple lines in a sequence you may wish to use the Polygon Shape instead.\n\nBe aware that as with all Game Objects the default origin is 0.5. If you need to draw a Line\nbetween two points and want the x1/y1 values to match the x/y values, then set the origin to 0.","kind":"class","name":"Line","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the start of the line.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the start of the line.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The horizontal position of the end of the line.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the end of the line.","name":"y2"},{"type":{"names":["number"]},"optional":true,"description":"The color the line will be drawn in, i.e. 0xff0000 for red.","name":"strokeColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the line will be drawn in. You can also set the alpha of the overall Shape using its `alpha` property.","name":"strokeAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Line","___s":true},{"meta":{"filename":"Line.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"description":"The width (or thickness) of the line.\nSee the setLineWidth method for extra details on changing this on WebGL.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#lineWidth","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Shape#lineWidth","___s":true},{"meta":{"filename":"Line.js","lineno":111,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"description":"Sets the width of the line.\n\nWhen using the WebGL renderer you can have different start and end widths.\nWhen using the Canvas renderer only the `startWidth` value is used. The `endWidth` is ignored.\n\nThis call can be chained.","kind":"function","name":"setLineWidth","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The start width of the line.","name":"startWidth"},{"type":{"names":["number"]},"optional":true,"description":"The end width of the line. Only used in WebGL.","name":"endWidth"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setLineWidth","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"description":"Sets the start and end coordinates of this Line.","kind":"function","name":"setTo","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the start of the line.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the start of the line.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the end of the line.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the end of the line.","name":"y2"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Line object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setTo","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"LineCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"name":"LineStyleCanvas","longname":"LineStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"LineFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LineFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"description":"Creates a new Line Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Line Game Object has been built into Phaser.\n\nThe Line Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only stroke colors and cannot be filled.\n\nA Line Shape allows you to draw a line between two points in your game. You can control the\nstroke color and thickness of the line. In WebGL only you can also specify a different\nthickness for the start and end of the line, allowing you to render lines that taper-off.\n\nIf you need to draw multiple lines in a sequence you may wish to use the Polygon Shape instead.","kind":"function","name":"line","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the start of the line.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the start of the line.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The horizontal position of the end of the line.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the end of the line.","name":"y2"},{"type":{"names":["number"]},"optional":true,"description":"The color the line will be drawn in, i.e. 0xff0000 for red.","name":"strokeColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the line will be drawn in. You can also set the alpha of the overall Shape using its `alpha` property.","name":"strokeAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#line","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"LineRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"LineWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,222],"filename":"Polygon.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"name":"PolygonRender","longname":"PolygonRender","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Polygon.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"classdesc":"The Polygon Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nThe Polygon Shape is created by providing a list of points, which are then used to create an\ninternal Polygon geometry object. The points can be set from a variety of formats:\n\n- A string containing paired values separated by a single space: `'40 0 40 20 100 20 100 80 40 80 40 100 0 50'`\n- An array of Point or Vector2 objects: `[new Phaser.Math.Vector2(x1, y1), ...]`\n- An array of objects with public x/y properties: `[obj1, obj2, ...]`\n- An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\n- An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\n\nBy default the `x` and `y` coordinates of this Shape refer to the center of it. However, depending\non the coordinates of the points provided, the final shape may be rendered offset from its origin.","kind":"class","name":"Polygon","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["any"]},"optional":true,"description":"The points that make up the polygon.","name":"points"},{"type":{"names":["number"]},"optional":true,"description":"The color the polygon will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the polygon will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Polygon","___s":true},{"meta":{"filename":"Polygon.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"description":"Smooths the polygon over the number of iterations specified.\nThe base polygon data will be updated and replaced with the smoothed values.\nThis call can be chained.","kind":"function","name":"smooth","since":"3.13.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The number of times to apply the polygon smoothing.","name":"iterations"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#smooth","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"PolygonCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"PolygonFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PolygonFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"description":"Creates a new Polygon Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Polygon Game Object has been built into Phaser.\n\nThe Polygon Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nThe Polygon Shape is created by providing a list of points, which are then used to create an\ninternal Polygon geometry object. The points can be set from a variety of formats:\n\n- An array of Point or Vector2 objects: `[new Phaser.Math.Vector2(x1, y1), ...]`\n- An array of objects with public x/y properties: `[obj1, obj2, ...]`\n- An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\n- An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\n\nBy default the `x` and `y` coordinates of this Shape refer to the center of it. However, depending\non the coordinates of the points provided, the final shape may be rendered offset from its origin.","kind":"function","name":"polygon","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["any"]},"optional":true,"description":"The points that make up the polygon.","name":"points"},{"type":{"names":["number"]},"optional":true,"description":"The color the polygon will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the polygon will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#polygon","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"PolygonRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"PolygonWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"name":"FillPathWebGL","longname":"FillPathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"Rectangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Rectangle.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"classdesc":"The Rectangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nYou can change the size of the rectangle by changing the `width` and `height` properties.","kind":"class","name":"Rectangle","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the rectangle.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The color the rectangle will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the rectangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Rectangle","___s":true},{"meta":{"range":[180,227],"filename":"RectangleCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"RectangleFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RectangleFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"description":"Creates a new Rectangle Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Rectangle Game Object has been built into Phaser.\n\nThe Rectangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nYou can change the size of the rectangle by changing the `width` and `height` properties.","kind":"function","name":"rectangle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the rectangle.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The color the rectangle will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the rectangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#rectangle","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"RectangleRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,227],"filename":"RectangleWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"name":"StrokePathWebGL","longname":"StrokePathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"Star.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"name":"StarRender","longname":"StarRender","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Star.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"classdesc":"The Star Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nAs the name implies, the Star shape will display a star in your game. You can control several\naspects of it including the number of points that constitute the star. The default is 5. If\nyou change it to 4 it will render as a diamond. If you increase them, you'll get a more spiky\nstar shape.\n\nYou can also control the inner and outer radius, which is how 'long' each point of the star is.\nModify these values to create more interesting shapes.","kind":"class","name":"Star","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":5,"description":"The number of points on the star.","name":"points"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The inner radius of the star.","name":"innerRadius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The outer radius of the star.","name":"outerRadius"},{"type":{"names":["number"]},"optional":true,"description":"The color the star will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the star will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Star","___s":true},{"meta":{"filename":"Star.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"Sets the number of points that make up the Star shape.\nThis call can be chained.","kind":"function","name":"setPoints","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The amount of points the Star will have.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setPoints","scope":"instance","___s":true},{"meta":{"filename":"Star.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"Sets the inner radius of the Star shape.\nThis call can be chained.","kind":"function","name":"setInnerRadius","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The amount to set the inner radius to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setInnerRadius","scope":"instance","___s":true},{"meta":{"filename":"Star.js","lineno":145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"Sets the outer radius of the Star shape.\nThis call can be chained.","kind":"function","name":"setOuterRadius","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The amount to set the outer radius to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setOuterRadius","scope":"instance","___s":true},{"meta":{"filename":"Star.js","lineno":163,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"The number of points that make up the Star shape.","name":"points","type":{"names":["integer"]},"defaultvalue":"5","since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#points","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Star.js","lineno":187,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"The inner radius of the Star shape.","name":"innerRadius","type":{"names":["number"]},"defaultvalue":"32","since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#innerRadius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Star.js","lineno":211,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"The outer radius of the Star shape.","name":"outerRadius","type":{"names":["number"]},"defaultvalue":"64","since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#outerRadius","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,227],"filename":"StarCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,204],"filename":"StarFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"name":"Star","longname":"Star","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"StarFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"Creates a new Star Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Star Game Object has been built into Phaser.\n\nThe Star Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nAs the name implies, the Star shape will display a star in your game. You can control several\naspects of it including the number of points that constitute the star. The default is 5. If\nyou change it to 4 it will render as a diamond. If you increase them, you'll get a more spiky\nstar shape.\n\nYou can also control the inner and outer radius, which is how 'long' each point of the star is.\nModify these values to create more interesting shapes.","kind":"function","name":"star","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":5,"description":"The number of points on the star.","name":"points"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The inner radius of the star.","name":"innerRadius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The outer radius of the star.","name":"outerRadius"},{"type":{"names":["number"]},"optional":true,"description":"The color the star will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the star will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#star","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"StarRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"StarWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"name":"FillPathWebGL","longname":"FillPathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"Triangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Triangle.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"classdesc":"The Triangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nThe Triangle consists of 3 lines, joining up to form a triangular shape. You can control the\nposition of each point of these lines. The triangle is always closed and cannot have an open\nface. If you require that, consider using a Polygon instead.","kind":"class","name":"Triangle","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the first point in the triangle.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The vertical position of the first point in the triangle.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The horizontal position of the second point in the triangle.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the second point in the triangle.","name":"y2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The horizontal position of the third point in the triangle.","name":"x3"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The vertical position of the third point in the triangle.","name":"y3"},{"type":{"names":["number"]},"optional":true,"description":"The color the triangle will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the triangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Triangle","___s":true},{"meta":{"filename":"Triangle.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"description":"Sets the data for the lines that make up this Triangle shape.","kind":"function","name":"setTo","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the first point in the triangle.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the first point in the triangle.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the second point in the triangle.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the second point in the triangle.","name":"y2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the third point in the triangle.","name":"x3"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the third point in the triangle.","name":"y3"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setTo","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"TriangleCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"TriangleFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TriangleFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"description":"Creates a new Triangle Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Triangle Game Object has been built into Phaser.\n\nThe Triangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nThe Triangle consists of 3 lines, joining up to form a triangular shape. You can control the\nposition of each point of these lines. The triangle is always closed and cannot have an open\nface. If you require that, consider using a Polygon instead.","kind":"function","name":"triangle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the first point in the triangle.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The vertical position of the first point in the triangle.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The horizontal position of the second point in the triangle.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the second point in the triangle.","name":"y2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The horizontal position of the third point in the triangle.","name":"x3"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The vertical position of the third point in the triangle.","name":"y3"},{"type":{"names":["number"]},"optional":true,"description":"The color the triangle will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the triangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#triangle","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"TriangleRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,227],"filename":"TriangleWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"name":"StrokePathWebGL","longname":"StrokePathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"Sprite.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Sprite.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"classdesc":"A Sprite Game Object.\n\nA Sprite Game Object is used for the display of both static and animated images in your game.\nSprites can have input events and physics bodies. They can also be tweened, tinted, scrolled\nand animated.\n\nThe main difference between a Sprite and an Image Game Object is that you cannot animate Images.\nAs such, Sprites take a fraction longer to process and have a larger API footprint due to the Animation\nComponent. If you do not require animation then you can safely use Images to replace Sprites in all cases.","kind":"class","name":"Sprite","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.TextureCrop","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.Sprite","___s":true},{"meta":{"filename":"Sprite.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"The Animation Controller of this Sprite.","name":"anims","type":{"names":["Phaser.GameObjects.Components.Animation"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#anims","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Sprite.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Start playing the given animation.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If an animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#play","scope":"instance","___s":true},{"meta":{"filename":"Sprite.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Build a JSON representation of this Sprite.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#toJSON","scope":"instance","overrides":"Phaser.GameObjects.GameObject#toJSON","___s":true},{"meta":{"range":[180,227],"filename":"SpriteCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SpriteCreator.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Creates a new Sprite Game Object and returns it.\n\nNote: This method will only be available if the Sprite Game Object has been built into Phaser.","kind":"function","name":"sprite","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Sprite.SpriteConfig"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#sprite","scope":"instance","___s":true},{"meta":{"range":[180,231],"filename":"SpriteFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SpriteFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Creates a new Sprite Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Sprite Game Object has been built into Phaser.","kind":"function","name":"sprite","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#sprite","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"SpriteRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SpriteConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/typedefs"},"kind":"typedef","name":"SpriteConfig","type":{"names":["object"]},"augments":["Phaser.Types.GameObjects.GameObjectConfig"],"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["number","string"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"memberof":"Phaser.Types.GameObjects.Sprite","longname":"Phaser.Types.GameObjects.Sprite.SpriteConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/typedefs"},"kind":"namespace","name":"Sprite","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.Sprite","scope":"static","___s":true},{"meta":{"filename":"GetTextSize.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Returns an object containing dimensions of the Text object.","kind":"function","name":"GetTextSize","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The Text object to calculate the size from.","name":"text"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextMetrics"]},"description":"The Text metrics to use when calculating the size.","name":"size"},{"type":{"names":["array"]},"description":"The lines of text to calculate the size from.","name":"lines"}],"returns":[{"type":{"names":["object"]},"description":"An object containing dimensions of the Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text.GetTextSize","scope":"static","___s":true},{"meta":{"range":[180,235],"filename":"MeasureText.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MeasureText.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Calculates the ascent, descent and fontSize of a given font style.","kind":"function","name":"MeasureText","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.TextStyle"]},"description":"The TextStyle object to measure.","name":"textStyle"}],"returns":[{"type":{"names":["Phaser.Types.GameObjects.Text.TextMetrics"]},"description":"An object containing the ascent, descent and fontSize of the TextStyle."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text.MeasureText","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"TextStyle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextStyle.js","lineno":43,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"classdesc":"A TextStyle class manages all of the style settings for a Text object.\n\nText Game Objects create a TextStyle instance automatically, which is\naccessed via the `Text.style` property. You do not normally need to\ninstantiate one yourself.","kind":"class","name":"TextStyle","memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The Text object that this TextStyle is styling.","name":"text"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextStyle"]},"description":"The style settings to set.","name":"style"}],"scope":"static","longname":"Phaser.GameObjects.TextStyle","___s":true},{"meta":{"filename":"TextStyle.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The Text object that this TextStyle is styling.","name":"parent","type":{"names":["Phaser.GameObjects.Text"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The font family.","name":"fontFamily","type":{"names":["string"]},"defaultvalue":"'Courier'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#fontFamily","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The font size.","name":"fontSize","type":{"names":["string"]},"defaultvalue":"'16px'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#fontSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The font style.","name":"fontStyle","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#fontStyle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The background color.","name":"backgroundColor","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#backgroundColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The text fill color.","name":"color","type":{"names":["string"]},"defaultvalue":"'#fff'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#color","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The text stroke color.","name":"stroke","type":{"names":["string"]},"defaultvalue":"'#fff'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#stroke","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The text stroke thickness.","name":"strokeThickness","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#strokeThickness","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The horizontal shadow offset.","name":"shadowOffsetX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#shadowOffsetX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The vertical shadow offset.","name":"shadowOffsetY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#shadowOffsetY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":162,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The shadow color.","name":"shadowColor","type":{"names":["string"]},"defaultvalue":"'#000'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#shadowColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":172,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The shadow blur radius.","name":"shadowBlur","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#shadowBlur","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":182,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Whether shadow stroke is enabled or not.","name":"shadowStroke","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#shadowStroke","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Whether shadow fill is enabled or not.","name":"shadowFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#shadowFill","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":202,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The text alignment.","name":"align","type":{"names":["string"]},"defaultvalue":"'left'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#align","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":212,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The maximum number of lines to draw.","name":"maxLines","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#maxLines","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":222,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The fixed width of the text.\n\n`0` means no fixed with.","name":"fixedWidth","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#fixedWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":234,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The fixed height of the text.\n\n`0` means no fixed height.","name":"fixedHeight","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#fixedHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":246,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The resolution the text is rendered to its internal canvas at.\nThe default is 0, which means it will use the resolution set in the Game Config.","name":"resolution","type":{"names":["number"]},"defaultvalue":"0","since":"3.12.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#resolution","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":257,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Whether the text should render right to left.","name":"rtl","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#rtl","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":267,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The test string to use when measuring the font.","name":"testString","type":{"names":["string"]},"defaultvalue":"'|MÉqgy'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#testString","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":277,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The amount of horizontal padding added to the width of the text when calculating the font metrics.","name":"baselineX","type":{"names":["number"]},"defaultvalue":"1.2","since":"3.3.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#baselineX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":287,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The amount of vertical padding added to the height of the text when calculating the font metrics.","name":"baselineY","type":{"names":["number"]},"defaultvalue":"1.4","since":"3.3.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#baselineY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":328,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the text style.","examples":["text.setStyle({\n fontSize: '64px',\n fontFamily: 'Arial',\n color: '#ffffff',\n align: 'center',\n backgroundColor: '#ff00ff'\n});"],"kind":"function","name":"setStyle","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Text.TextStyle"]},"description":"The style settings to set.","name":"style"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to update the text immediately.","name":"updateText"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use the default values is not set, or the local values.","name":"setDefaults"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setStyle","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":403,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Synchronize the font settings to the given Canvas Rendering Context.","kind":"function","name":"syncFont","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas Element.","name":"canvas"},{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context.","name":"context"}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#syncFont","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":417,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Synchronize the text style settings to the given Canvas Rendering Context.","kind":"function","name":"syncStyle","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas Element.","name":"canvas"},{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context.","name":"context"}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#syncStyle","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":438,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Synchronize the shadow settings to the given Canvas Rendering Context.","kind":"function","name":"syncShadow","since":"3.0.0","params":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context.","name":"context"},{"type":{"names":["boolean"]},"description":"Whether shadows are enabled or not.","name":"enabled"}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#syncShadow","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Update the style settings for the parent Text object.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether to recalculate font and text metrics.","name":"recalculateMetrics"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#update","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":487,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the font.\n\nIf a string is given, the font family is set.\n\nIf an object is given, the `fontFamily`, `fontSize` and `fontStyle`\nproperties of that object are set.","kind":"function","name":"setFont","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The font family or font settings to set.","name":"font"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to update the text immediately.","name":"updateText"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setFont","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":543,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the font family.","kind":"function","name":"setFontFamily","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The font family.","name":"family"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setFontFamily","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":565,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the font style.","kind":"function","name":"setFontStyle","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The font style.","name":"style"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setFontStyle","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the font size.","kind":"function","name":"setFontSize","since":"3.0.0","params":[{"type":{"names":["number","string"]},"description":"The font size.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setFontSize","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":614,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the test string to use when measuring the font.","kind":"function","name":"setTestString","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The test string to use when measuring the font.","name":"string"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setTestString","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":631,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set a fixed width and height for the text.\n\nPass in `0` for either of these parameters to disable fixed width or height respectively.","kind":"function","name":"setFixedSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The fixed width to set.","name":"width"},{"type":{"names":["number"]},"description":"The fixed height to set.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setFixedSize","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":662,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the background color.","kind":"function","name":"setBackgroundColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The background color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setBackgroundColor","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":679,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the text fill color.","kind":"function","name":"setFill","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text fill color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setFill","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":696,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the text fill color.","kind":"function","name":"setColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text fill color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setColor","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":713,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the resolution used by the Text object.\n\nBy default it will be set to match the resolution set in the Game Config,\nbut you can override it via this method. It allows for much clearer text on High DPI devices,\nat the cost of memory because it uses larger internal Canvas textures for the Text.\n\nPlease use with caution, as the more high res Text you have, the more memory it uses up.","kind":"function","name":"setResolution","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The resolution for this Text object to use.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setResolution","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":736,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the stroke settings.","kind":"function","name":"setStroke","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The stroke color.","name":"color"},{"type":{"names":["number"]},"description":"The stroke thickness.","name":"thickness"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setStroke","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":769,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the shadow settings.\n\nCalling this method always re-measures the parent Text object,\nso only call it when you actually change the shadow settings.","kind":"function","name":"setShadow","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal shadow offset.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical shadow offset.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#000'","description":"The shadow color.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The shadow blur radius.","name":"blur"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to stroke the shadow.","name":"shadowStroke"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to fill the shadow.","name":"shadowFill"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setShadow","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":806,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the shadow offset.","kind":"function","name":"setShadowOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal shadow offset.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical shadow offset.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setShadowOffset","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":828,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the shadow color.","kind":"function","name":"setShadowColor","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#000'","description":"The shadow color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setShadowColor","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":847,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the shadow blur radius.","kind":"function","name":"setShadowBlur","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The shadow blur radius.","name":"blur"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setShadowBlur","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":866,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Enable or disable shadow stroke.","kind":"function","name":"setShadowStroke","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether shadow stroke is enabled or not.","name":"enabled"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setShadowStroke","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":883,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Enable or disable shadow fill.","kind":"function","name":"setShadowFill","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether shadow fill is enabled or not.","name":"enabled"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setShadowFill","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":900,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the width (in pixels) to use for wrapping lines.\n\nPass in null to remove wrapping by width.","kind":"function","name":"setWordWrapWidth","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The maximum width of a line in pixels. Set to null to remove wrapping.","name":"width"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether or not to use the advanced wrapping\nalgorithm. If true, spaces are collapsed and whitespace is trimmed from lines. If false,\nspaces and whitespace are left as is.","name":"useAdvancedWrap"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setWordWrapWidth","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":925,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set a custom callback for wrapping lines.\n\nPass in null to remove wrapping by callback.","kind":"function","name":"setWordWrapCallback","since":"3.0.0","params":[{"type":{"names":["TextStyleWordWrapCallback"]},"description":"A custom function that will be responsible for wrapping the\ntext. It will receive two arguments: text (the string to wrap), textObject (this Text\ninstance). It should return the wrapped lines either as an array of lines or as a string with\nnewline characters in place to indicate where breaks should happen.","name":"callback"},{"type":{"names":["object"]},"optional":true,"defaultvalue":null,"description":"The scope that will be applied when the callback is invoked.","name":"scope"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setWordWrapCallback","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":951,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the alignment of the text in this Text object.\n\nThe argument can be one of: `left`, `right`, `center` or `justify`.\n\nAlignment only works if the Text object has more than one line of text.","kind":"function","name":"setAlign","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'left'","description":"The text alignment for multi-line text.","name":"align"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setAlign","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":974,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the maximum number of lines to draw.","kind":"function","name":"setMaxLines","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The maximum number of lines to draw.","name":"max"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setMaxLines","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":993,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Get the current text metrics.","kind":"function","name":"getTextMetrics","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.Text.TextMetrics"]},"description":"The text metrics."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#getTextMetrics","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":1012,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Build a JSON representation of this Text Style.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"A JSON representation of this Text Style."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#toJSON","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":1034,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Destroy this Text Style.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#destroy","scope":"instance","___s":true},{"meta":{"range":[180,223],"filename":"Text.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"name":"AddToDOM","longname":"AddToDOM","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Text.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"classdesc":"A Text Game Object.\n\nText objects work by creating their own internal hidden Canvas and then renders text to it using\nthe standard Canvas `fillText` API. It then creates a texture from this canvas which is rendered\nto your game during the render pass.\n\nBecause it uses the Canvas API you can take advantage of all the features this offers, such as\napplying gradient fills to the text, or strokes, shadows and more. You can also use custom fonts\nloaded externally, such as Google or TypeKit Web fonts.\n\n**Important:** If the font you wish to use has a space or digit in its name, such as\n'Press Start 2P' or 'Roboto Condensed', then you _must_ put the font name in quotes, either\nwhen creating the Text object, or when setting the font via `setFont` or `setFontFamily`. I.e.:\n\n```javascript\nthis.add.text(0, 0, 'Hello World', { fontFamily: '\"Roboto Condensed\"' });\n```\n\nEqually, if you wish to provide a list of fallback fonts, then you should ensure they are all\nquoted properly, too:\n\n```javascript\nthis.add.text(0, 0, 'Hello World', { fontFamily: 'Verdana, \"Times New Roman\", Tahoma, serif' });\n```\n\nYou can only display fonts that are currently loaded and available to the browser: therefore fonts must\nbe pre-loaded. Phaser does not do ths for you, so you will require the use of a 3rd party font loader,\nor have the fonts ready available in the CSS on the page in which your Phaser game resides.\n\nSee {@link http://www.jordanm.co.uk/tinytype this compatibility table} for the available default fonts\nacross mobile browsers.\n\nA note on performance: Every time the contents of a Text object changes, i.e. changing the text being\ndisplayed, or the style of the text, it needs to remake the Text canvas, and if on WebGL, re-upload the\nnew texture to the GPU. This can be an expensive operation if used often, or with large quantities of\nText objects in your game. If you run into performance issues you would be better off using Bitmap Text\ninstead, as it benefits from batching and avoids expensive Canvas API calls.","kind":"class","name":"Text","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Crop","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string","Array."]},"description":"The text this Text object will display.","name":"text"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextStyle"]},"description":"The text style configuration object.","name":"style"}],"scope":"static","longname":"Phaser.GameObjects.Text","___s":true},{"meta":{"filename":"Text.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The renderer in use by this Text object.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.12.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The canvas element that the text is rendered to.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":139,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The context of the canvas element that the text is rendered to.","name":"context","type":{"names":["CanvasRenderingContext2D"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The Text Style object.\n\nManages the style of this Text object.","name":"style","type":{"names":["Phaser.GameObjects.TextStyle"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#style","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Whether to automatically round line positions.","name":"autoRound","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#autoRound","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":169,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The Regular Expression that is used to split the text up into lines, in\nmulti-line text. By default this is `/(?:\\r\\n|\\r|\\n)/`.\nYou can change this RegExp to be anything else that you may need.","name":"splitRegExp","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#splitRegExp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":190,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Specify a padding value which is added to the line width and height when calculating the Text size.\nAllows you to add extra spacing if the browser is unable to accurately determine the true font dimensions.","name":"padding","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#padding","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":200,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The width of this Text object.","name":"width","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#width","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.ComputedSize#width","___s":true},{"meta":{"filename":"Text.js","lineno":210,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The height of this Text object.","name":"height","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#height","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.ComputedSize#height","___s":true},{"meta":{"filename":"Text.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The line spacing value.\nThis value is added to the font height to calculate the overall line height.\nOnly has an effect if this Text object contains multiple lines of text.\n\nIf you update this property directly, instead of using the `setLineSpacing` method, then\nbe sure to call `updateText` after, or you won't see the change reflected in the Text object.","name":"lineSpacing","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#lineSpacing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":234,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Whether the text or its settings have changed and need updating.","name":"dirty","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Initialize right to left text.","kind":"function","name":"initRTL","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#initRTL","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":329,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Greedy wrapping algorithm that will wrap words as the line grows longer than its horizontal\nbounds.","kind":"function","name":"runWordWrap","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text to perform word wrap detection against.","name":"text"}],"returns":[{"type":{"names":["string"]},"description":"The text after wrapping has been applied."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#runWordWrap","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Advanced wrapping algorithm that will wrap words as the line grows longer than its horizontal\nbounds. Consecutive spaces will be collapsed and replaced with a single space. Lines will be\ntrimmed of white space before processing. Throws an error if wordWrapWidth is less than a\nsingle character.","kind":"function","name":"advancedWordWrap","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text to perform word wrap detection against.","name":"text"},{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context.","name":"context"},{"type":{"names":["number"]},"description":"The word wrap width.","name":"wordWrapWidth"}],"returns":[{"type":{"names":["string"]},"description":"The wrapped text."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#advancedWordWrap","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Greedy wrapping algorithm that will wrap words as the line grows longer than its horizontal\nbounds. Spaces are not collapsed and whitespace is not trimmed.","kind":"function","name":"basicWordWrap","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text to perform word wrap detection against.","name":"text"},{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context.","name":"context"},{"type":{"names":["number"]},"description":"The word wrap width.","name":"wordWrapWidth"}],"returns":[{"type":{"names":["string"]},"description":"The wrapped text."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#basicWordWrap","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":559,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Runs the given text through this Text objects word wrapping and returns the results as an\narray, where each element of the array corresponds to a wrapped line of text.","kind":"function","name":"getWrappedText","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text for which the wrapping will be calculated. If unspecified, the Text objects current text will be used.","name":"text"}],"returns":[{"type":{"names":["Array."]},"description":"An array of strings with the pieces of wrapped text."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getWrappedText","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":581,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the text to display.\n\nAn array of strings will be joined with `\\n` line breaks.","kind":"function","name":"setText","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The string, or array of strings, to be set as the content of this Text object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setText","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":615,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the text style.","examples":["text.setStyle({\n fontSize: '64px',\n fontFamily: 'Arial',\n color: '#ffffff',\n align: 'center',\n backgroundColor: '#ff00ff'\n});"],"kind":"function","name":"setStyle","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The style settings to set.","name":"style"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setStyle","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":639,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the font.\n\nIf a string is given, the font family is set.\n\nIf an object is given, the `fontFamily`, `fontSize` and `fontStyle`\nproperties of that object are set.\n\n**Important:** If the font you wish to use has a space or digit in its name, such as\n'Press Start 2P' or 'Roboto Condensed', then you _must_ put the font name in quotes:\n\n```javascript\nText.setFont('\"Roboto Condensed\"');\n```\n\nEqually, if you wish to provide a list of fallback fonts, then you should ensure they are all\nquoted properly, too:\n\n```javascript\nText.setFont('Verdana, \"Times New Roman\", Tahoma, serif');\n```","kind":"function","name":"setFont","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The font family or font settings to set.","name":"font"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFont","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":673,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the font family.\n\n**Important:** If the font you wish to use has a space or digit in its name, such as\n'Press Start 2P' or 'Roboto Condensed', then you _must_ put the font name in quotes:\n\n```javascript\nText.setFont('\"Roboto Condensed\"');\n```\n\nEqually, if you wish to provide a list of fallback fonts, then you should ensure they are all\nquoted properly, too:\n\n```javascript\nText.setFont('Verdana, \"Times New Roman\", Tahoma, serif');\n```","kind":"function","name":"setFontFamily","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The font family.","name":"family"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFontFamily","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":702,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the font size.","kind":"function","name":"setFontSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The font size.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFontSize","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the font style.","kind":"function","name":"setFontStyle","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The font style.","name":"style"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFontStyle","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":732,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set a fixed width and height for the text.\n\nPass in `0` for either of these parameters to disable fixed width or height respectively.","kind":"function","name":"setFixedSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The fixed width to set. `0` disables fixed width.","name":"width"},{"type":{"names":["number"]},"description":"The fixed height to set. `0` disables fixed height.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFixedSize","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":750,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the background color.","kind":"function","name":"setBackgroundColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The background color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setBackgroundColor","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":765,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the fill style to be used by the Text object.\n\nThis can be any valid CanvasRenderingContext2D fillStyle value, such as\na color (in hex, rgb, rgba, hsl or named values), a gradient or a pattern.\n\nSee the [MDN fillStyle docs](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/fillStyle) for more details.","kind":"function","name":"setFill","since":"3.0.0","params":[{"type":{"names":["string","any"]},"description":"The text fill style. Can be any valid CanvasRenderingContext `fillStyle` value.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFill","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":785,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the text fill color.","kind":"function","name":"setColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text fill color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setColor","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":800,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the stroke settings.","kind":"function","name":"setStroke","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The stroke color.","name":"color"},{"type":{"names":["number"]},"description":"The stroke thickness.","name":"thickness"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setStroke","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":816,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the shadow settings.","kind":"function","name":"setShadow","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal shadow offset.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical shadow offset.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#000'","description":"The shadow color.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The shadow blur radius.","name":"blur"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to stroke the shadow.","name":"shadowStroke"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to fill the shadow.","name":"shadowFill"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setShadow","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":836,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the shadow offset.","kind":"function","name":"setShadowOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal shadow offset.","name":"x"},{"type":{"names":["number"]},"description":"The vertical shadow offset.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setShadowOffset","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":852,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the shadow color.","kind":"function","name":"setShadowColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The shadow color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setShadowColor","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":867,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the shadow blur radius.","kind":"function","name":"setShadowBlur","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The shadow blur radius.","name":"blur"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setShadowBlur","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":882,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Enable or disable shadow stroke.","kind":"function","name":"setShadowStroke","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether shadow stroke is enabled or not.","name":"enabled"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setShadowStroke","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":897,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Enable or disable shadow fill.","kind":"function","name":"setShadowFill","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether shadow fill is enabled or not.","name":"enabled"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setShadowFill","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":912,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the width (in pixels) to use for wrapping lines. Pass in null to remove wrapping by width.","kind":"function","name":"setWordWrapWidth","since":"3.0.0","params":[{"type":{"names":["number"]},"nullable":true,"description":"The maximum width of a line in pixels. Set to null to remove wrapping.","name":"width"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether or not to use the advanced wrapping\nalgorithm. If true, spaces are collapsed and whitespace is trimmed from lines. If false,\nspaces and whitespace are left as is.","name":"useAdvancedWrap"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setWordWrapWidth","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":930,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set a custom callback for wrapping lines. Pass in null to remove wrapping by callback.","kind":"function","name":"setWordWrapCallback","since":"3.0.0","params":[{"type":{"names":["TextStyleWordWrapCallback"]},"description":"A custom function that will be responsible for wrapping the\ntext. It will receive two arguments: text (the string to wrap), textObject (this Text\ninstance). It should return the wrapped lines either as an array of lines or as a string with\nnewline characters in place to indicate where breaks should happen.","name":"callback"},{"type":{"names":["object"]},"optional":true,"defaultvalue":null,"description":"The scope that will be applied when the callback is invoked.","name":"scope"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setWordWrapCallback","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":949,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the alignment of the text in this Text object.\n\nThe argument can be one of: `left`, `right`, `center` or `justify`.\n\nAlignment only works if the Text object has more than one line of text.","kind":"function","name":"setAlign","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'left'","description":"The text alignment for multi-line text.","name":"align"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setAlign","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":968,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the resolution used by this Text object.\n\nBy default it will be set to match the resolution set in the Game Config,\nbut you can override it via this method, or by specifying it in the Text style configuration object.\n\nIt allows for much clearer text on High DPI devices, at the cost of memory because it uses larger\ninternal Canvas textures for the Text.\n\nTherefore, please use with caution, as the more high res Text you have, the more memory it uses.","kind":"function","name":"setResolution","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The resolution for this Text object to use.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setResolution","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":991,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Sets the line spacing value.\n\nThis value is _added_ to the height of the font when calculating the overall line height.\nThis only has an effect if this Text object consists of multiple lines of text.","kind":"function","name":"setLineSpacing","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The amount to add to the font height to achieve the overall line height.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setLineSpacing","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":1011,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the text padding.\n\n'left' can be an object.\n\nIf only 'left' and 'top' are given they are treated as 'x' and 'y'.","kind":"function","name":"setPadding","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Types.GameObjects.Text.TextPadding"]},"description":"The left padding value, or a padding config object.","name":"left"},{"type":{"names":["number"]},"description":"The top padding value.","name":"top"},{"type":{"names":["number"]},"description":"The right padding value.","name":"right"},{"type":{"names":["number"]},"description":"The bottom padding value.","name":"bottom"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setPadding","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":1077,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the maximum number of lines to draw.","kind":"function","name":"setMaxLines","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The maximum number of lines to draw.","name":"max"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setMaxLines","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":1092,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Update the displayed text.","kind":"function","name":"updateText","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#updateText","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":1293,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Get the current text metrics.","kind":"function","name":"getTextMetrics","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"The text metrics."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getTextMetrics","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":1306,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The text string being rendered by this Text Game Object.","name":"text","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#text","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":1327,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Build a JSON representation of the Text object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#toJSON","scope":"instance","overrides":"Phaser.GameObjects.GameObject#toJSON","___s":true},{"meta":{"range":[180,230],"filename":"TextCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Creates a new Text Game Object and returns it.\n\nNote: This method will only be available if the Text Game Object has been built into Phaser.","kind":"function","name":"text","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#text","scope":"instance","___s":true},{"meta":{"range":[180,204],"filename":"TextFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"name":"Text","longname":"Text","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Creates a new Text Game Object and adds it to the Scene.\n\nA Text Game Object.\n\nText objects work by creating their own internal hidden Canvas and then renders text to it using\nthe standard Canvas `fillText` API. It then creates a texture from this canvas which is rendered\nto your game during the render pass.\n\nBecause it uses the Canvas API you can take advantage of all the features this offers, such as\napplying gradient fills to the text, or strokes, shadows and more. You can also use custom fonts\nloaded externally, such as Google or TypeKit Web fonts.\n\nYou can only display fonts that are currently loaded and available to the browser: therefore fonts must\nbe pre-loaded. Phaser does not do ths for you, so you will require the use of a 3rd party font loader,\nor have the fonts ready available in the CSS on the page in which your Phaser game resides.\n\nSee {@link http://www.jordanm.co.uk/tinytype this compatibility table} for the available default fonts\nacross mobile browsers.\n\nA note on performance: Every time the contents of a Text object changes, i.e. changing the text being\ndisplayed, or the style of the text, it needs to remake the Text canvas, and if on WebGL, re-upload the\nnew texture to the GPU. This can be an expensive operation if used often, or with large quantities of\nText objects in your game. If you run into performance issues you would be better off using Bitmap Text\ninstead, as it benefits from batching and avoids expensive Canvas API calls.\n\nNote: This method will only be available if the Text Game Object has been built into Phaser.","kind":"function","name":"text","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string","Array."]},"description":"The text this Text object will display.","name":"text"},{"type":{"names":["object"]},"optional":true,"description":"The Text style configuration object.","name":"style"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#text","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"TextRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"TextWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextMetrics.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"description":"Font metrics for a Text Style object.","kind":"typedef","name":"TextMetrics","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The ascent of the font.","name":"ascent"},{"type":{"names":["number"]},"description":"The descent of the font.","name":"descent"},{"type":{"names":["number"]},"description":"The size of the font.","name":"fontSize"}],"memberof":"Phaser.Types.GameObjects.Text","longname":"Phaser.Types.GameObjects.Text.TextMetrics","scope":"static","___s":true},{"meta":{"filename":"TextPadding.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"description":"A Text Padding configuration object as used by the Text Style.","kind":"typedef","name":"TextPadding","type":{"names":["object"]},"since":"3.18.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"If set this value is used for both the left and right padding.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"If set this value is used for both the top and bottom padding.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The amount of padding added to the left of the Text object.","name":"left"},{"type":{"names":["number"]},"optional":true,"description":"The amount of padding added to the right of the Text object.","name":"right"},{"type":{"names":["number"]},"optional":true,"description":"The amount of padding added to the top of the Text object.","name":"top"},{"type":{"names":["number"]},"optional":true,"description":"The amount of padding added to the bottom of the Text object.","name":"bottom"}],"memberof":"Phaser.Types.GameObjects.Text","longname":"Phaser.Types.GameObjects.Text.TextPadding","scope":"static","___s":true},{"meta":{"filename":"TextShadow.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"description":"A Text Shadow configuration object as used by the Text Style.","kind":"typedef","name":"TextShadow","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal offset of the shadow.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical offset of the shadow.","name":"offsetY"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#000'","description":"The color of the shadow, given as a CSS string value.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The amount of blur applied to the shadow. Leave as zero for a hard shadow.","name":"blur"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Apply the shadow to the stroke effect on the Text object?","name":"stroke"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Apply the shadow to the fill effect on the Text object?","name":"fill"}],"memberof":"Phaser.Types.GameObjects.Text","longname":"Phaser.Types.GameObjects.Text.TextShadow","scope":"static","___s":true},{"meta":{"filename":"TextStyle.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"description":"A Text Style configuration object as used by the Text Game Object.","kind":"typedef","name":"TextStyle","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'Courier'","description":"The font the Text object will render with. This is a Canvas style font string.","name":"fontFamily"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'16px'","description":"The font size, as a CSS size string.","name":"fontSize"},{"type":{"names":["string"]},"optional":true,"description":"Any addition font styles, such as 'strong'.","name":"fontStyle"},{"type":{"names":["string"]},"optional":true,"description":"A solid fill color that is rendered behind the Text object. Given as a CSS string color such as `#ff0`.","name":"backgroundColor"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#fff'","description":"The color the Text is drawn in. Given as a CSS string color such as `#fff` or `rgb()`.","name":"color"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#fff'","description":"The color used to stroke the Text if the `strokeThickness` property is greater than zero.","name":"stroke"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The thickness of the stroke around the Text. Set to zero for no stroke.","name":"strokeThickness"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextShadow"]},"optional":true,"description":"The Text shadow configuration object.","name":"shadow"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextPadding"]},"optional":true,"description":"A Text Padding object.","name":"padding"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'left'","description":"The alignment of the Text. This only impacts multi-line text. Either `left`, `right`, `center` or `justify`.","name":"align"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The maximum number of lines to display within the Text object.","name":"maxLines"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Force the Text object to have the exact width specified in this property. Leave as zero for it to change accordingly to content.","name":"fixedWidth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Force the Text object to have the exact height specified in this property. Leave as zero for it to change accordingly to content.","name":"fixedHeight"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets the resolution (DPI setting) of the Text object. Leave at zero for it to use the game resolution.","name":"resolution"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Set to `true` if this Text object should render from right-to-left.","name":"rtl"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'|MÉqgy'","description":"This is the string used to aid Canvas in calculating the height of the font.","name":"testString"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1.2,"description":"The amount of horizontal padding added to the width of the text when calculating the font metrics.","name":"baselineX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1.4,"description":"The amount of vertical padding added to the height of the text when calculating the font metrics.","name":"baselineY"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextWordWrap"]},"optional":true,"description":"The Text Word wrap configuration object.","name":"wordWrap"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextMetrics"]},"optional":true,"description":"A Text Metrics object. Use this to avoid expensive font size calculations in text heavy games.","name":"metrics"}],"memberof":"Phaser.Types.GameObjects.Text","longname":"Phaser.Types.GameObjects.Text.TextStyle","scope":"static","___s":true},{"meta":{"filename":"TextWordWrap.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"description":"A Text Word Wrap configuration object as used by the Text Style configuration.","kind":"typedef","name":"TextWordWrap","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"The width at which text should be considered for word-wrapping.","name":"width"},{"type":{"names":["TextStyleWordWrapCallback"]},"optional":true,"description":"Provide a custom callback when word wrapping is enabled.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the word wrap callback is invoked.","name":"callbackScope"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use basic or advanced word wrapping?","name":"useAdvancedWrap"}],"memberof":"Phaser.Types.GameObjects.Text","longname":"Phaser.Types.GameObjects.Text.TextWordWrap","scope":"static","___s":true},{"meta":{"filename":"TextWordWrap.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"description":"A custom function that will be responsible for wrapping the text.","kind":"typedef","name":"TextStyleWordWrapCallback","type":{"names":["function"]},"params":[{"type":{"names":["string"]},"description":"The string to wrap.","name":"text"},{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The Text instance.","name":"textObject"}],"returns":[{"type":{"names":["string","Array."]},"description":"Should return the wrapped lines either as an array of lines or as a string with\nnewline characters in place to indicate where breaks should happen."}],"longname":"TextStyleWordWrapCallback","scope":"global","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"kind":"namespace","name":"Text","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.Text","scope":"static","___s":true},{"meta":{"range":[180,235],"filename":"TileSprite.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TileSprite.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"classdesc":"A TileSprite is a Sprite that has a repeating texture.\n\nThe texture can be scrolled and scaled independently of the TileSprite itself. Textures will automatically wrap and\nare designed so that you can create game backdrops using seamless textures as a source.\n\nYou shouldn't ever create a TileSprite any larger than your actual canvas size. If you want to create a large repeating background\nthat scrolls across the whole map of your game, then you create a TileSprite that fits the canvas size and then use the `tilePosition`\nproperty to scroll the texture as the player moves. If you create a TileSprite that is thousands of pixels in size then it will \nconsume huge amounts of memory and cause performance issues. Remember: use `tilePosition` to scroll your texture and `tileScale` to\nadjust the scale of the texture - don't resize the sprite itself or make it larger than it needs.\n\nAn important note about Tile Sprites and NPOT textures: Internally, TileSprite textures use GL_REPEAT to provide\nseamless repeating of the textures. This, combined with the way in which the textures are handled in WebGL, means\nthey need to be POT (power-of-two) sizes in order to wrap. If you provide a NPOT (non power-of-two) texture to a\nTileSprite it will generate a POT sized canvas and draw your texture to it, scaled up to the POT size. It's then\nscaled back down again during rendering to the original dimensions. While this works, in that it allows you to use\nany size texture for a Tile Sprite, it does mean that NPOT textures are going to appear anti-aliased when rendered,\ndue to the interpolation that took place when it was resized into a POT texture. This is especially visible in\npixel art graphics. If you notice it and it becomes an issue, the only way to avoid it is to ensure that you\nprovide POT textures for Tile Sprites.","kind":"class","name":"TileSprite","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Crop","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the Game Object. If zero it will use the size of the texture frame.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the Game Object. If zero it will use the size of the texture frame.","name":"height"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"textureKey"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frameKey"}],"scope":"static","longname":"Phaser.GameObjects.TileSprite","___s":true},{"meta":{"filename":"TileSprite.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Whether the Tile Sprite has changed in some way, requiring an re-render of its tile texture.\n\nSuch changes include the texture frame and scroll position of the Tile Sprite.","name":"dirty","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The renderer in use by this Tile Sprite.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The Canvas element that the TileSprite renders its fill pattern in to.\nOnly used in Canvas mode.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"nullable":true,"since":"3.12.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The Context of the Canvas element that the TileSprite renders its fill pattern in to.\nOnly used in Canvas mode.","name":"context","type":{"names":["CanvasRenderingContext2D"]},"since":"3.12.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":207,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#texture","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Crop#texture","___s":true},{"meta":{"filename":"TileSprite.js","lineno":216,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#frame","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Crop#frame","___s":true},{"meta":{"filename":"TileSprite.js","lineno":225,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The next power of two value from the width of the Fill Pattern frame.","name":"potWidth","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#potWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":234,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The next power of two value from the height of the Fill Pattern frame.","name":"potHeight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#potHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":243,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The Canvas that the TileSprites texture is rendered to.\nThis is used to create a WebGL texture from.","name":"fillCanvas","type":{"names":["HTMLCanvasElement"]},"since":"3.12.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#fillCanvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":253,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The Canvas Context used to render the TileSprites texture.","name":"fillContext","type":{"names":["CanvasRenderingContext2D"]},"since":"3.12.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#fillContext","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":262,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The texture that the Tile Sprite is rendered to, which is then rendered to a Scene.\nIn WebGL this is a WebGLTexture. In Canvas it's a Canvas Fill Pattern.","name":"fillPattern","type":{"names":["WebGLTexture","CanvasPattern"]},"nullable":true,"since":"3.12.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#fillPattern","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":289,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setTexture","scope":"instance","___s":true},{"meta":{"filename":"TileSprite.js","lineno":309,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setFrame","scope":"instance","___s":true},{"meta":{"filename":"TileSprite.js","lineno":351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Sets {@link Phaser.GameObjects.TileSprite#tilePositionX} and {@link Phaser.GameObjects.TileSprite#tilePositionY}.","kind":"function","name":"setTilePosition","since":"3.3.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x position of this sprite's tiling texture.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y position of this sprite's tiling texture.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Tile Sprite instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setTilePosition","scope":"instance","___s":true},{"meta":{"filename":"TileSprite.js","lineno":377,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Sets {@link Phaser.GameObjects.TileSprite#tileScaleX} and {@link Phaser.GameObjects.TileSprite#tileScaleY}.","kind":"function","name":"setTileScale","since":"3.12.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The horizontal scale of the tiling texture. If not given it will use the current `tileScaleX` value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of the tiling texture. If not given it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Tile Sprite instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setTileScale","scope":"instance","___s":true},{"meta":{"filename":"TileSprite.js","lineno":552,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The horizontal scroll position of the Tile Sprite.","name":"tilePositionX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tilePositionX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":575,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The vertical scroll position of the Tile Sprite.","name":"tilePositionY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tilePositionY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":598,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The horizontal scale of the Tile Sprite texture.","name":"tileScaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.11.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tileScaleX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":621,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The vertical scale of the Tile Sprite texture.","name":"tileScaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.11.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tileScaleY","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,227],"filename":"TileSpriteCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TileSpriteCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Creates a new TileSprite Game Object and returns it.\n\nNote: This method will only be available if the TileSprite Game Object has been built into Phaser.","kind":"function","name":"tileSprite","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.TileSprite.TileSpriteConfig"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#tileSprite","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"TileSpriteFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"name":"TileSprite","longname":"TileSprite","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TileSpriteFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Creates a new TileSprite Game Object and adds it to the Scene.\n\nNote: This method will only be available if the TileSprite Game Object has been built into Phaser.","kind":"function","name":"tileSprite","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the Game Object. If zero it will use the size of the texture frame.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the Game Object. If zero it will use the size of the texture frame.","name":"height"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#tileSprite","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"TileSpriteRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"TileSpriteWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TileSpriteConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/typedefs"},"kind":"typedef","name":"TileSpriteConfig","type":{"names":["object"]},"augments":["Phaser.Types.GameObjects.GameObjectConfig"],"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the Tile Sprite.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the Tile Sprite.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":512,"description":"The width of the Tile Sprite. If zero it will use the size of the texture frame.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":512,"description":"The height of the Tile Sprite. If zero it will use the size of the texture frame.","name":"height"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The key of the Texture this Tile Sprite will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"An optional frame from the Texture this Tile Sprite is rendering with.","name":"frame"}],"memberof":"Phaser.Types.GameObjects.TileSprite","longname":"Phaser.Types.GameObjects.TileSprite.TileSpriteConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/typedefs"},"kind":"namespace","name":"TileSprite","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.TileSprite","scope":"static","___s":true},{"meta":{"filename":"GameObjectConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/typedefs"},"kind":"typedef","name":"GameObjectConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the Game Object.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The depth of the GameObject.","name":"depth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The horizontally flipped state of the Game Object.","name":"flipX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The vertically flipped state of the Game Object.","name":"flipY"},{"type":{"names":["number","object"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"The scale of the GameObject.","name":"scale"},{"type":{"names":["number","object"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"The scroll factor of the GameObject.","name":"scrollFactor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation angle of the Game Object, in radians.","name":"rotation"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"The rotation angle of the Game Object, in degrees.","name":"angle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha (opacity) of the Game Object.","name":"alpha"},{"type":{"names":["number","object"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"The origin of the Game Object.","name":"origin"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"ScaleModes.DEFAULT","description":"The scale mode of the GameObject.","name":"scaleMode"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"BlendModes.DEFAULT","description":"The blend mode of the GameObject.","name":"blendMode"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The visible state of the Game Object.","name":"visible"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Add the GameObject to the scene.","name":"add"}],"memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.GameObjectConfig","scope":"static","___s":true},{"meta":{"filename":"JSONGameObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/typedefs"},"kind":"typedef","name":"JSONGameObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The name of this Game Object.","name":"name"},{"type":{"names":["string"]},"description":"A textual representation of this Game Object, i.e. `sprite`.","name":"type"},{"type":{"names":["number"]},"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of this Game Object.","name":"y"},{"type":{"names":["object"]},"description":"The scale of this Game Object","name":"scale"},{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"scale.x"},{"type":{"names":["number"]},"description":"The vertical scale of this Game Object.","name":"scale.y"},{"type":{"names":["object"]},"description":"The origin of this Game Object.","name":"origin"},{"type":{"names":["number"]},"description":"The horizontal origin of this Game Object.","name":"origin.x"},{"type":{"names":["number"]},"description":"The vertical origin of this Game Object.","name":"origin.y"},{"type":{"names":["boolean"]},"description":"The horizontally flipped state of the Game Object.","name":"flipX"},{"type":{"names":["boolean"]},"description":"The vertically flipped state of the Game Object.","name":"flipY"},{"type":{"names":["number"]},"description":"The angle of this Game Object in radians.","name":"rotation"},{"type":{"names":["number"]},"description":"The alpha value of the Game Object.","name":"alpha"},{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"visible"},{"type":{"names":["integer"]},"description":"The Scale Mode being used by this Game Object.","name":"scaleMode"},{"type":{"names":["integer","string"]},"description":"Sets the Blend Mode being used by this Game Object.","name":"blendMode"},{"type":{"names":["string"]},"description":"The texture key of this Game Object.","name":"textureKey"},{"type":{"names":["string"]},"description":"The frame key of this Game Object.","name":"frameKey"},{"type":{"names":["object"]},"description":"The data of this Game Object.","name":"data"}],"memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.JSONGameObject","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/typedefs"},"kind":"namespace","name":"GameObjects","memberof":"Phaser.Types","longname":"Phaser.Types.GameObjects","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Video.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Video.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"classdesc":"A Video Game Object.\n\nThis Game Object is capable of handling playback of a previously loaded video from the Phaser Video Cache,\nor playing a video based on a given URL. Videos can be either local, or streamed.\n\n```javascript\npreload () {\n this.load.video('pixar', 'nemo.mp4');\n}\n\ncreate () {\n this.add.video(400, 300, 'pixar');\n}\n```\n\nTo all intents and purposes, a video is a standard Game Object, just like a Sprite. And as such, you can do\nall the usual things to it, such as scaling, rotating, cropping, tinting, making interactive, giving a\nphysics body, etc.\n\nTransparent videos are also possible via the WebM file format. Providing the video file has was encoded with\nan alpha channel, and providing the browser supports WebM playback (not all of them do), then it will render\nin-game with full transparency.\n\n### Autoplaying Videos\n\nVideos can only autoplay if the browser has been unlocked with an interaction, or satisfies the MEI settings.\nThe policies that control autoplaying are vast and vary between browser.\nYou can, ahd should, read more about it here: https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide\n\nIf your video doesn't contain any audio, then set the `noAudio` parameter to `true` when the video is _loaded_,\nand it will often allow the video to play immediately:\n\n```javascript\npreload () {\n this.load.video('pixar', 'nemo.mp4', 'loadeddata', false, true);\n}\n```\n\nThe 5th parameter in the load call tells Phaser that the video doesn't contain any audio tracks. Video without\naudio can autoplay without requiring a user interaction. Video with audio cannot do this unless it satisfies\nthe browsers MEI settings. See the MDN Autoplay Guide for further details.\n\nNote that due to a bug in IE11 you cannot play a video texture to a Sprite in WebGL. For IE11 force Canvas mode.\n\nMore details about video playback and the supported media formats can be found on MDN:\n\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement\nhttps://developer.mozilla.org/en-US/docs/Web/Media/Formats","kind":"class","name":"Video","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.TextureCrop","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.20.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"description":"Optional key of the Video this Game Object will play, as stored in the Video Cache.","name":"key"}],"scope":"static","longname":"Phaser.GameObjects.Video","___s":true},{"meta":{"filename":"Video.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"A reference to the HTML Video Element this Video Game Object is playing.\nWill be `null` until a video is loaded for playback.","name":"video","type":{"names":["HTMLVideoElement"]},"nullable":true,"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#video","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"The Phaser Texture this Game Object is using to render the video to.\nWill be `null` until a video is loaded for playback.","name":"videoTexture","type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#videoTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":143,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"A reference to the TextureSource belong to the `videoTexture` Texture object.\nWill be `null` until a video is loaded for playback.","name":"videoTextureSource","type":{"names":["Phaser.Textures.TextureSource"]},"nullable":true,"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#videoTextureSource","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":153,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"A Phaser CanvasTexture instance that holds the most recent snapshot taken from the video.\nThis will only be set if `snapshot` or `snapshotArea` have been called, and will be `null` until that point.","name":"snapshotTexture","type":{"names":["Phaser.Textures.CanvasTexture"]},"nullable":true,"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#snapshotTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":163,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"If you have saved this video to a texture via the `saveTexture` method, this controls if the video\nis rendered with `flipY` in WebGL or not. You often need to set this if you wish to use the video texture\nas the input source for a shader. If you find your video is appearing upside down within a shader or\ncustom pipeline, flip this property.","name":"flipY","type":{"names":["boolean"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#flipY","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Video.js","lineno":185,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"An internal flag holding the current state of the video lock, should document interaction be required\nbefore playback can begin.","name":"touchLocked","type":{"names":["boolean"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#touchLocked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":195,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Should the video auto play when document interaction is required and happens?","name":"playWhenUnlocked","type":{"names":["boolean"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#playWhenUnlocked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":204,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"When starting playback of a video Phaser will monitor its `readyState` using a `setTimeout` call.\nThe `setTimeout` happens once every `Video.retryInterval` ms. It will carry on monitoring the video\nstate in this manner until the `retryLimit` is reached and then abort.","name":"retryLimit","type":{"names":["integer"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#retryLimit","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"The current retry attempt.","name":"retry","type":{"names":["integer"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#retry","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":224,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"The number of ms between each retry while monitoring the ready state of a downloading video.","name":"retryInterval","type":{"names":["integer"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#retryInterval","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":310,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"An object containing in and out markers for sequence playback.","name":"markers","type":{"names":["any"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#markers","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":369,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Should the Video element that this Video is using, be removed from the DOM\nwhen this Video is destroyed?","name":"removeVideoElementOnDestroy","type":{"names":["boolean"]},"since":"3.21.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#removeVideoElementOnDestroy","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":400,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Starts this video playing.\n\nIf the video is already playing, or has been queued to play with `changeSource` then this method just returns.\n\nVideos can only autoplay if the browser has been unlocked. This happens if you have interacted with the browser, i.e.\nby clicking on it or pressing a key, or due to server settings. The policies that control autoplaying are vast and\nvary between browser. You can read more here: https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide\n\nIf your video doesn't contain any audio, then set the `noAudio` parameter to `true` when the video is loaded,\nand it will often allow the video to play immediately:\n\n```javascript\npreload () {\n this.load.video('pixar', 'nemo.mp4', 'loadeddata', false, true);\n}\n```\n\nThe 5th parameter in the load call tells Phaser that the video doesn't contain any audio tracks. Video without\naudio can autoplay without requiring a user interaction. Video with audio cannot do this unless it satisfies\nthe browsers MEI settings. See the MDN Autoplay Guide for details.\n\nIf you need audio in your videos, then you'll have to consider the fact that the video cannot start playing until the\nuser has interacted with the browser, into your game flow.","kind":"function","name":"play","since":"3.20.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the video loop automatically when it reaches the end? Please note that not all browsers support _seamless_ video looping for all encoding formats.","name":"loop"},{"type":{"names":["integer"]},"optional":true,"description":"Optional in marker time, in seconds, for playback of a sequence of the video.","name":"markerIn"},{"type":{"names":["integer"]},"optional":true,"description":"Optional out marker time, in seconds, for playback of a sequence of the video.","name":"markerOut"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#play","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":503,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"This method allows you to change the source of the current video element. It works by first stopping the\ncurrent video, if playing. Then deleting the video texture, if one has been created. Finally, it makes a\nnew video texture and starts playback of the new source through the existing video element.\n\nThe reason you may wish to do this is because videos that require interaction to unlock, remain in an unlocked\nstate, even if you change the source of the video. By changing the source to a new video you avoid having to\ngo through the unlock process again.","kind":"function","name":"changeSource","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"The key of the Video this Game Object will swap to playing, as stored in the Video Cache.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the video start playing immediately, once the swap is complete?","name":"autoplay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the video loop automatically when it reaches the end? Please note that not all browsers support _seamless_ video looping for all encoding formats.","name":"loop"},{"type":{"names":["integer"]},"optional":true,"description":"Optional in marker time, in seconds, for playback of a sequence of the video.","name":"markerIn"},{"type":{"names":["integer"]},"optional":true,"description":"Optional out marker time, in seconds, for playback of a sequence of the video.","name":"markerOut"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#changeSource","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":581,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Adds a sequence marker to this video.\n\nMarkers allow you to split a video up into sequences, delineated by a start and end time, given in seconds.\n\nYou can then play back specific markers via the `playMarker` method.\n\nNote that marker timing is _not_ frame-perfect. You should construct your videos in such a way that you allow for\nplenty of extra padding before and after each sequence to allow for discrepancies in browser seek and currentTime accuracy.\n\nSee https://github.com/w3c/media-and-entertainment/issues/4 for more details about this issue.","kind":"function","name":"addMarker","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"A unique name to give this marker.","name":"key"},{"type":{"names":["integer"]},"description":"The time, in seconds, representing the start of this marker.","name":"markerIn"},{"type":{"names":["integer"]},"description":"The time, in seconds, representing the end of this marker.","name":"markerOut"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#addMarker","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":612,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Plays a pre-defined sequence in this video.\n\nMarkers allow you to split a video up into sequences, delineated by a start and end time, given in seconds and\nspecified via the `addMarker` method.\n\nNote that marker timing is _not_ frame-perfect. You should construct your videos in such a way that you allow for\nplenty of extra padding before and after each sequence to allow for discrepancies in browser seek and currentTime accuracy.\n\nSee https://github.com/w3c/media-and-entertainment/issues/4 for more details about this issue.","kind":"function","name":"playMarker","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"The name of the marker sequence to play.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the video loop automatically when it reaches the end? Please note that not all browsers support _seamless_ video looping for all encoding formats.","name":"loop"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#playMarker","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":643,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Removes a previously set marker from this video.\n\nIf the marker is currently playing it will _not_ stop playback.","kind":"function","name":"removeMarker","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"The name of the marker to remove.","name":"key"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#removeMarker","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":662,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Takes a snapshot of the current frame of the video and renders it to a CanvasTexture object,\nwhich is then returned. You can optionally resize the grab by passing a width and height.\n\nThis method returns a reference to the `Video.snapshotTexture` object. Calling this method\nmultiple times will overwrite the previous snapshot with the most recent one.","kind":"function","name":"snapshot","since":"3.20.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The width of the resulting CanvasTexture.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the resulting CanvasTexture.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]}}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#snapshot","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":685,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Takes a snapshot of the specified area of the current frame of the video and renders it to a CanvasTexture object,\nwhich is then returned. You can optionally resize the grab by passing a different `destWidth` and `destHeight`.\n\nThis method returns a reference to the `Video.snapshotTexture` object. Calling this method\nmultiple times will overwrite the previous snapshot with the most recent one.","kind":"function","name":"snapshotArea","since":"3.20.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The horizontal location of the top-left of the area to grab from.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The vertical location of the top-left of the area to grab from.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of area to grab from the video. If not given it will grab the full video dimensions.","name":"srcWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The height of area to grab from the video. If not given it will grab the full video dimensions.","name":"srcHeight"},{"type":{"names":["integer"]},"optional":true,"description":"The destination width of the grab, allowing you to resize it.","name":"destWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The destination height of the grab, allowing you to resize it.","name":"destHeight"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]}}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#snapshotArea","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":740,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Stores a copy of this Videos `snapshotTexture` in the Texture Manager using the given key.\n\nThis texture is created when the `snapshot` or `snapshotArea` methods are called.\n\nAfter doing this, any texture based Game Object, such as a Sprite, can use the contents of the\nsnapshot by using the texture key:\n\n```javascript\nvar vid = this.add.video(0, 0, 'intro');\n\nvid.snapshot();\n\nvid.saveSnapshotTexture('doodle');\n\nthis.add.image(400, 300, 'doodle');\n```\n\nUpdating the contents of the `snapshotTexture`, for example by calling `snapshot` again,\nwill automatically update _any_ Game Object that is using it as a texture.\nCalling `saveSnapshotTexture` again will not save another copy of the same texture,\nit will just rename the existing one.\n\nBy default it will create a single base texture. You can add frames to the texture\nby using the `Texture.add` method. After doing this, you can then allow Game Objects\nto use a specific frame.","kind":"function","name":"saveSnapshotTexture","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"The unique key to store the texture as within the global Texture Manager.","name":"key"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"The Texture that was saved."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#saveSnapshotTexture","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":788,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Loads a Video from the given URL, ready for playback with the `Video.play` method.\n\nYou can control at what point the browser determines the video as being ready for playback via\nthe `loadEvent` parameter. See https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement\nfor more details.","kind":"function","name":"loadURL","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"The URL of the video to load or be streamed.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'loadeddata'","description":"The load event to listen for. Either `loadeddata`, `canplay` or `canplaythrough`.","name":"loadEvent"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Does the video have an audio track? If not you can enable auto-playing on it.","name":"noAudio"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#loadURL","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":885,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Called when the video emits a `playing` event during load.\n\nThis is only listened for if the browser doesn't support Promises.","kind":"function","name":"playHandler","fires":["Phaser.GameObjects.Events#event:VIDEO_PLAY"],"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#playHandler","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":949,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Called when the video completes playback, i.e. reaches an `ended` state.\n\nThis will never happen if the video is coming from a live stream, where the duration is `Infinity`.","kind":"function","name":"completeHandler","fires":["Phaser.GameObjects.Events#event:VIDEO_COMPLETE"],"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#completeHandler","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":963,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Called when the video emits a `timeUpdate` event during playback.\n\nThis event is too slow and irregular to be used for actual video timing or texture updating,\nbut we can use it to determine if a video has looped.","kind":"function","name":"timeUpdateHandler","fires":["Phaser.GameObjects.Events#event:VIDEO_LOOP"],"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#timeUpdateHandler","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1058,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Internal method that is called when enough video data has been received in order to create a texture\nfrom it. The texture is assigned to the `Video.videoTexture` property and given a base frame that\nencompases the whole video size.","kind":"function","name":"updateTexture","since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#updateTexture","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns the key of the currently played video, as stored in the Video Cache.\nIf the video did not come from the cache this will return an empty string.","kind":"function","name":"getVideoKey","since":"3.20.0","returns":[{"type":{"names":["string"]},"description":"The key of the video being played from the Video Cache, if any."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getVideoKey","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Seeks to a given point in the video. The value is given as a float between 0 and 1,\nwhere 0 represents the start of the video and 1 represents the end.\n\nSeeking only works if the video has a duration, so will not work for live streams.\n\nWhen seeking begins, this video will emit a `seeking` event. When the video completes\nseeking (i.e. reaches its designated timestamp) it will emit a `seeked` event.\n\nIf you wish to seek based on time instead, use the `Video.setCurrentTime` method.","kind":"function","name":"seekTo","since":"3.20.0","params":[{"type":{"names":["number"]},"description":"The point in the video to seek to. A value between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#seekTo","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1151,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"A double-precision floating-point value indicating the current playback time in seconds.\nIf the media has not started to play and has not been seeked, this value is the media's initial playback time.","kind":"function","name":"getCurrentTime","since":"3.20.0","returns":[{"type":{"names":["number"]},"description":"A double-precision floating-point value indicating the current playback time in seconds."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getCurrentTime","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1165,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Seeks to a given playback time in the video. The value is given in _seconds_ or as a string.\n\nSeeking only works if the video has a duration, so will not work for live streams.\n\nWhen seeking begins, this video will emit a `seeking` event. When the video completes\nseeking (i.e. reaches its designated timestamp) it will emit a `seeked` event.\n\nYou can provide a string prefixed with either a `+` or a `-`, such as `+2.5` or `-2.5`.\nIn this case it will seek to +/- the value given, relative to the _current time_.\n\nIf you wish to seek based on a duration percentage instead, use the `Video.seekTo` method.","kind":"function","name":"setCurrentTime","since":"3.20.0","params":[{"type":{"names":["string","number"]},"description":"The playback time to seek to in seconds. Can be expressed as a string, such as `+2` to seek 2 seconds ahead from the current time.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setCurrentTime","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1214,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a boolean indicating if this Video is currently seeking, or not.","kind":"function","name":"isSeeking","since":"3.20.0","returns":[{"type":{"names":["boolean"]},"description":"A boolean indicating if this Video is currently seeking, or not."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#isSeeking","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1264,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns the current progress of the video. Progress is defined as a value between 0 (the start)\nand 1 (the end).\n\nProgress can only be returned if the video has a duration, otherwise it will always return zero.","kind":"function","name":"getProgress","since":"3.20.0","returns":[{"type":{"names":["number"]},"description":"The current progress of playback. If the video has no duration, will always return zero."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getProgress","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1293,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"A double-precision floating-point value which indicates the duration (total length) of the media in seconds,\non the media's timeline. If no media is present on the element, or the media is not valid, the returned value is NaN.\n\nIf the media has no known end (such as for live streams of unknown duration, web radio, media incoming from WebRTC,\nand so forth), this value is +Infinity.","kind":"function","name":"getDuration","since":"3.20.0","returns":[{"type":{"names":["number"]},"description":"A double-precision floating-point value indicating the duration of the media in seconds."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getDuration","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Sets the muted state of the currently playing video, if one is loaded.","kind":"function","name":"setMute","since":"3.20.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The mute value. `true` if the video should be muted, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setMute","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1336,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a boolean indicating if this Video is currently muted.","kind":"function","name":"isMuted","since":"3.20.0","returns":[{"type":{"names":["boolean"]},"description":"A boolean indicating if this Video is currently muted, or not."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#isMuted","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1405,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Sets the paused state of the currently loaded video.\n\nIf the video is playing, calling this method with `true` will pause playback.\nIf the video is paused, calling this method with `false` will resume playback.\n\nIf no video is loaded, this method does nothing.","kind":"function","name":"setPaused","since":"3.20.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The paused value. `true` if the video should be paused, `false` to resume it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setPaused","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).","kind":"function","name":"getVolume","since":"3.20.0","returns":[{"type":{"names":["number"]},"description":"A double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest)."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getVolume","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1462,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Sets the volume of the currently playing video.\n\nThe value given is a double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).","kind":"function","name":"setVolume","since":"3.20.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setVolume","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1486,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a double that indicates the rate at which the media is being played back.","kind":"function","name":"getPlaybackRate","since":"3.20.0","returns":[{"type":{"names":["number"]},"description":"A double that indicates the rate at which the media is being played back."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getPlaybackRate","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1499,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Sets the playback rate of the current video.\n\nThe value given is a double that indicates the rate at which the media is being played back.","kind":"function","name":"setPlaybackRate","since":"3.20.0","params":[{"type":{"names":["number"]},"optional":true,"description":"A double that indicates the rate at which the media is being played back.","name":"rate"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setPlaybackRate","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1521,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a boolean which indicates whether the media element should start over when it reaches the end.","kind":"function","name":"getLoop","since":"3.20.0","returns":[{"type":{"names":["boolean"]},"description":"A boolean which indicates whether the media element will start over when it reaches the end."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getLoop","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1534,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Sets the loop state of the current video.\n\nThe value given is a boolean which indicates whether the media element will start over when it reaches the end.\n\nNot all videos can loop, for example live streams.\n\nPlease note that not all browsers support _seamless_ video looping for all encoding formats.","kind":"function","name":"setLoop","since":"3.20.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"A boolean which indicates whether the media element will start over when it reaches the end.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setLoop","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1562,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a boolean which indicates whether the video is currently playing.","kind":"function","name":"isPlaying","since":"3.20.0","returns":[{"type":{"names":["boolean"]},"description":"A boolean which indicates whether the video is playing, or not."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#isPlaying","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1575,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a boolean which indicates whether the video is currently paused.","kind":"function","name":"isPaused","since":"3.20.0","returns":[{"type":{"names":["boolean"]},"description":"A boolean which indicates whether the video is paused, or not."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#isPaused","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1588,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Stores this Video in the Texture Manager using the given key as a dynamic texture,\nwhich any texture-based Game Object, such as a Sprite, can use as its texture:\n\n```javascript\nvar vid = this.add.video(0, 0, 'intro');\n\nvid.play();\n\nvid.saveTexture('doodle');\n\nthis.add.image(400, 300, 'doodle');\n```\n\nThe saved texture is automatically updated as the video plays. If you pause this video,\nor change its source, then the saved texture updates instantly.\n\nCalling `saveTexture` again will not save another copy of the same texture, it will just rename the existing one.\n\nBy default it will create a single base texture. You can add frames to the texture\nby using the `Texture.add` method. After doing this, you can then allow Game Objects\nto use a specific frame.\n\nIf you intend to save the texture so you can use it as the input for a Shader, you may need to set the\n`flipY` parameter to `true` if you find the video renders upside down in your shader.","kind":"function","name":"saveTexture","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"The unique key to store the texture as within the global Texture Manager.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y` during upload?","name":"flipY"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"The Texture that was saved."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#saveTexture","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1643,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Stops the video playing and clears all internal event listeners.\n\nIf you only wish to pause playback of the video, and resume it a later time, use the `Video.pause` method instead.\n\nIf the video hasn't finished downloading, calling this method will not abort the download. To do that you need to\ncall `destroy` instead.","kind":"function","name":"stop","fires":["Phaser.GameObjects.Events#event:VIDEO_STOP"],"since":"3.20.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#stop","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Removes the Video element from the DOM by calling parentNode.removeChild on itself.\n\nAlso removes the autoplay and src attributes and nulls the Video reference.\n\nYou should not call this method if you were playing a video from the Video Cache that\nyou wish to play again in your game, or if another Video object is also using the same\nvideo.\n\nIf you loaded an external video via `Video.loadURL` then you should call this function\nto clear up once you are done with the instance.","kind":"function","name":"removeVideoElement","since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#removeVideoElement","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"VideoCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"VideoCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Creates a new Video Game Object and returns it.\n\nNote: This method will only be available if the Video Game Object has been built into Phaser.","kind":"function","name":"video","since":"3.20.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#video","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"VideoFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"name":"Video","longname":"Video","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"VideoFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Creates a new Image Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Image Game Object has been built into Phaser.","kind":"function","name":"video","since":"3.20.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#video","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"VideoRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,229],"filename":"Zone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"name":"BlendModes","longname":"BlendModes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Zone.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"classdesc":"A Zone Game Object.\n\nA Zone is a non-rendering rectangular Game Object that has a position and size.\nIt has no texture and never displays, but does live on the display list and\ncan be moved, scaled and rotated like any other Game Object.\n\nIts primary use is for creating Drop Zones and Input Hit Areas and it has a couple of helper methods\nspecifically for this. It is also useful for object overlap checks, or as a base for your own\nnon-displaying Game Objects.\nThe default origin is 0.5, the center of the Zone, the same as with Game Objects.","kind":"class","name":"Zone","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The width of the Game Object.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The height of the Game Object.","name":"height"}],"scope":"static","longname":"Phaser.GameObjects.Zone","___s":true},{"meta":{"filename":"Zone.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"The native (un-scaled) width of this Game Object.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zone.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"The native (un-scaled) height of this Game Object.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zone.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"The Blend Mode of the Game Object.\nAlthough a Zone never renders, it still has a blend mode to allow it to fit seamlessly into\ndisplay lists without causing a batch flush.","name":"blendMode","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#blendMode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zone.js","lineno":105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"The displayed width of this Game Object.\nThis value takes into account the scale factor.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#displayWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zone.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"The displayed height of this Game Object.\nThis value takes into account the scale factor.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#displayHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zone.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Sets the size of this Game Object.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If this Zone has a Rectangle for a hit area this argument will resize the hit area as well.","name":"resizeInput"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setSize","scope":"instance","___s":true},{"meta":{"filename":"Zone.js","lineno":181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Sets the display size of this Game Object.\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setDisplaySize","scope":"instance","___s":true},{"meta":{"filename":"Zone.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Sets this Zone to be a Circular Drop Zone.\nThe circle is centered on this Zones `x` and `y` coordinates.","kind":"function","name":"setCircleDropZone","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the Circle that will form the Drop Zone.","name":"radius"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setCircleDropZone","scope":"instance","___s":true},{"meta":{"filename":"Zone.js","lineno":217,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Sets this Zone to be a Rectangle Drop Zone.\nThe rectangle is centered on this Zones `x` and `y` coordinates.","kind":"function","name":"setRectangleDropZone","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the rectangle drop zone.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle drop zone.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setRectangleDropZone","scope":"instance","___s":true},{"meta":{"filename":"Zone.js","lineno":234,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Allows you to define your own Geometry shape to be used as a Drop Zone.","kind":"function","name":"setDropZone","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"A Geometry shape instance, such as Phaser.Geom.Ellipse, or your own custom shape.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"A function that will return `true` if the given x/y coords it is sent are within the shape.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setDropZone","scope":"instance","___s":true},{"meta":{"range":[180,231],"filename":"ZoneCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"name":"GameObjectCreator","longname":"GameObjectCreator","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ZoneCreator.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Creates a new Zone Game Object and returns it.\n\nNote: This method will only be available if the Zone Game Object has been built into Phaser.","kind":"function","name":"zone","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#zone","scope":"instance","___s":true},{"meta":{"range":[180,204],"filename":"ZoneFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"name":"Zone","longname":"Zone","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ZoneFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Creates a new Zone Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Zone Game Object has been built into Phaser.","kind":"function","name":"zone","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"description":"The width of the Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of the Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#zone","scope":"instance","___s":true},{"meta":{"filename":"Area.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Calculates the area of the circle.","kind":"function","name":"Area","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get the area of.","name":"circle"}],"returns":[{"type":{"names":["number"]},"description":"The area of the Circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Area","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Circle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Circle.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"classdesc":"A Circle object.\n\nThis is a geometry object, containing numerical values and related methods to inspect and modify them.\nIt is not a Game Object, in that you cannot add it to the display list, and it has no texture.\nTo render a Circle you should look at the capabilities of the Graphics class.","kind":"class","name":"Circle","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the center of the circle.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the center of the circle.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The radius of the circle.","name":"radius"}],"scope":"static","longname":"Phaser.Geom.Circle","___s":true},{"meta":{"filename":"Circle.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The geometry constant type of this object: `GEOM_CONST.CIRCLE`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The x position of the center of the circle.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The y position of the center of the circle.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Check to see if the Circle contains the given x / y coordinates.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to check within the circle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to check within the circle.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the coordinates are within the circle, otherwise false."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#contains","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns a Point object containing the coordinates of a point on the circumference of the Circle\nbased on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\nat 180 degrees around the circle.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the circle.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An object to store the return values in. If not given a Point object will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point, or point-like object, containing the coordinates of the point around the circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#getPoint","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns an array of Point objects containing the coordinates of the points around the circumference of the Circle,\nbased on the given quantity or stepRate values.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Sets the quantity by getting the circumference of the circle and dividing it by the stepRate.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to insert the points in to. If not provided a new array will be created.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Point objects pertaining to the points around the circumference of the circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns a uniformly distributed random point from anywhere within the Circle.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"A Point or point-like object to set the random `x` and `y` values in.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object with the random values set in the `x` and `y` properties."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Sets the x, y and radius of this circle.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the center of the circle.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the center of the circle.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The radius of the circle.","name":"radius"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"This Circle object."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#setTo","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Sets this Circle to be empty with a radius of zero.\nDoes not change its position.","kind":"function","name":"setEmpty","since":"3.0.0","returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"This Circle object."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#setEmpty","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":205,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Sets the position of this Circle.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the center of the circle.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the center of the circle.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"This Circle object."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":226,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Checks to see if the Circle is empty: has a radius of zero.","kind":"function","name":"isEmpty","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if the Circle is empty, otherwise false."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#isEmpty","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":239,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The radius of the Circle.","name":"radius","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#radius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":261,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The diameter of the Circle.","name":"diameter","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#diameter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":283,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The left position of the Circle.","name":"left","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":304,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The right position of the Circle.","name":"right","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":325,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The top position of the Circle.","name":"top","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":346,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The bottom position of the Circle.","name":"bottom","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circumference.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns the circumference of the given Circle.","kind":"function","name":"Circumference","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get the circumference of.","name":"circle"}],"returns":[{"type":{"names":["number"]},"description":"The circumference of the Circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Circumference","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"CircumferencePoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CircumferencePoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns a Point object containing the coordinates of a point on the circumference of the Circle based on the given angle.","kind":"function","name":"CircumferencePoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get the circumference point on.","name":"circle"},{"type":{"names":["number"]},"description":"The angle from the center of the Circle to the circumference to return the point from. Given in radians.","name":"angle"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"A Point, or point-like object, to store the results in. If not given a Point will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object where the `x` and `y` properties are the point on the circumference."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.CircumferencePoint","scope":"static","___s":true},{"meta":{"range":[180,208],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Circle","longname":"Circle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Creates a new Circle instance based on the values contained in the given source.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle","object"]},"description":"The Circle to be cloned. Can be an instance of a Circle or a circle-like object, with x, y and radius properties.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"A clone of the source Circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Clone","scope":"static","___s":true},{"meta":{"filename":"Contains.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Check to see if the Circle contains the given x / y coordinates.","kind":"function","name":"Contains","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to check.","name":"circle"},{"type":{"names":["number"]},"description":"The x coordinate to check within the circle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to check within the circle.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the coordinates are within the circle, otherwise false."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Contains","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Check to see if the Circle contains the given Point object.","kind":"function","name":"ContainsPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to check.","name":"circle"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The Point object to check if it's within the Circle or not.","name":"point"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Point coordinates are within the circle, otherwise false."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.ContainsPoint","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsRect.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsRect.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Check to see if the Circle contains all four points of the given Rectangle object.","kind":"function","name":"ContainsRect","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to check.","name":"circle"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The Rectangle object to check if it's within the Circle or not.","name":"rect"}],"returns":[{"type":{"names":["boolean"]},"description":"True if all of the Rectangle coordinates are within the circle, otherwise false."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.ContainsRect","scope":"static","___s":true},{"meta":{"filename":"CopyFrom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Copies the `x`, `y` and `radius` properties from the `source` Circle\ninto the given `dest` Circle, then returns the `dest` Circle.","kind":"function","name":"CopyFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The source Circle to copy the values from.","name":"source"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The destination Circle to copy the values to.","name":"dest"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The destination Circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.CopyFrom","scope":"static","___s":true},{"meta":{"filename":"Equals.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Compares the `x`, `y` and `radius` properties of the two given Circles.\nReturns `true` if they all match, otherwise returns `false`.","kind":"function","name":"Equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The first Circle to compare.","name":"circle"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The second Circle to compare.","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two Circles equal each other, otherwise `false`."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Equals","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"GetBounds.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetBounds.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns the bounds of the Circle object.","kind":"function","name":"GetBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get the bounds from.","name":"circle"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"A Rectangle, or rectangle-like object, to store the circle bounds in. If not given a new Rectangle will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The Rectangle object containing the Circles bounds."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.GetBounds","scope":"static","___s":true},{"meta":{"range":[180,232],"filename":"GetPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"CircumferencePoint","longname":"CircumferencePoint","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoint.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns a Point object containing the coordinates of a point on the circumference of the Circle\nbased on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\nat 180 degrees around the circle.","kind":"function","name":"GetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get the circumference point on.","name":"circle"},{"type":{"names":["number"]},"description":"A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the circle.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An object to store the return values in. If not given a Point object will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point, or point-like object, containing the coordinates of the point around the circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.GetPoint","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"GetPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Circumference","longname":"Circumference","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoints.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns an array of Point objects containing the coordinates of the points around the circumference of the Circle,\nbased on the given quantity or stepRate values.","kind":"function","name":"GetPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get the points from.","name":"circle"},{"type":{"names":["integer"]},"description":"The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Sets the quantity by getting the circumference of the circle and dividing it by the stepRate.","name":"stepRate"},{"type":{"names":["array"]},"optional":true,"description":"An array to insert the points in to. If not provided a new array will be created.","name":"output"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Point objects pertaining to the points around the circumference of the circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.GetPoints","scope":"static","___s":true},{"meta":{"filename":"Offset.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Offsets the Circle by the values given.","kind":"function","name":"Offset","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to be offset (translated.)","name":"circle"},{"type":{"names":["number"]},"description":"The amount to horizontally offset the Circle by.","name":"x"},{"type":{"names":["number"]},"description":"The amount to vertically offset the Circle by.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle that was offset."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Offset","scope":"static","___s":true},{"meta":{"filename":"OffsetPoint.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Offsets the Circle by the values given in the `x` and `y` properties of the Point object.","kind":"function","name":"OffsetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to be offset (translated.)","name":"circle"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The Point object containing the values to offset the Circle by.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle that was offset."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.OffsetPoint","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Random.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Random.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns a uniformly distributed random point from anywhere within the given Circle.","kind":"function","name":"Random","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get a random point from.","name":"circle"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"A Point or point-like object to set the random `x` and `y` values in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object with the random values set in the `x` and `y` properties."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Random","scope":"static","___s":true},{"meta":{"range":[180,208],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Circle","longname":"Circle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,1287],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"name":"GEOM_CONST","longname":"GEOM_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"A Circle Geometry object type.","name":"CIRCLE","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.CIRCLE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"An Ellipse Geometry object type.","name":"ELLIPSE","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.ELLIPSE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"A Line Geometry object type.","name":"LINE","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.LINE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"A Point Geometry object type.","name":"POINT","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.POINT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"A Polygon Geometry object type.","name":"POLYGON","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.POLYGON","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"A Rectangle Geometry object type.","name":"RECTANGLE","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.RECTANGLE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"A Triangle Geometry object type.","name":"TRIANGLE","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.TRIANGLE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"Area.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Calculates the area of the Ellipse.","kind":"function","name":"Area","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get the area of.","name":"ellipse"}],"returns":[{"type":{"names":["number"]},"description":"The area of the Ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Area","scope":"static","___s":true},{"meta":{"filename":"Circumference.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns the circumference of the given Ellipse.","kind":"function","name":"Circumference","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get the circumference of.","name":"ellipse"}],"returns":[{"type":{"names":["number"]},"description":"The circumference of th Ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Circumference","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"CircumferencePoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CircumferencePoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns a Point object containing the coordinates of a point on the circumference of the Ellipse based on the given angle.","kind":"function","name":"CircumferencePoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get the circumference point on.","name":"ellipse"},{"type":{"names":["number"]},"description":"The angle from the center of the Ellipse to the circumference to return the point from. Given in radians.","name":"angle"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"A Point, or point-like object, to store the results in. If not given a Point will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object where the `x` and `y` properties are the point on the circumference."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.CircumferencePoint","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Ellipse","longname":"Ellipse","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Creates a new Ellipse instance based on the values contained in the given source.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to be cloned. Can be an instance of an Ellipse or a ellipse-like object, with x, y, width and height properties.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"A clone of the source Ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Clone","scope":"static","___s":true},{"meta":{"filename":"Contains.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Check to see if the Ellipse contains the given x / y coordinates.","kind":"function","name":"Contains","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to check.","name":"ellipse"},{"type":{"names":["number"]},"description":"The x coordinate to check within the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to check within the ellipse.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the coordinates are within the ellipse, otherwise false."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Contains","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Check to see if the Ellipse contains the given Point object.","kind":"function","name":"ContainsPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to check.","name":"ellipse"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The Point object to check if it's within the Circle or not.","name":"point"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Point coordinates are within the circle, otherwise false."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.ContainsPoint","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsRect.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsRect.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Check to see if the Ellipse contains all four points of the given Rectangle object.","kind":"function","name":"ContainsRect","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to check.","name":"ellipse"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The Rectangle object to check if it's within the Ellipse or not.","name":"rect"}],"returns":[{"type":{"names":["boolean"]},"description":"True if all of the Rectangle coordinates are within the ellipse, otherwise false."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.ContainsRect","scope":"static","___s":true},{"meta":{"filename":"CopyFrom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Copies the `x`, `y`, `width` and `height` properties from the `source` Ellipse\ninto the given `dest` Ellipse, then returns the `dest` Ellipse.","kind":"function","name":"CopyFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The source Ellipse to copy the values from.","name":"source"},{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The destination Ellipse to copy the values to.","name":"dest"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The destination Ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.CopyFrom","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Ellipse.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Ellipse.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"classdesc":"An Ellipse object.\n\nThis is a geometry object, containing numerical values and related methods to inspect and modify them.\nIt is not a Game Object, in that you cannot add it to the display list, and it has no texture.\nTo render an Ellipse you should look at the capabilities of the Graphics class.","kind":"class","name":"Ellipse","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the center of the ellipse.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the center of the ellipse.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The height of the ellipse.","name":"height"}],"scope":"static","longname":"Phaser.Geom.Ellipse","___s":true},{"meta":{"filename":"Ellipse.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The geometry constant type of this object: `GEOM_CONST.ELLIPSE`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The x position of the center of the ellipse.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The y position of the center of the ellipse.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The width of the ellipse.","name":"width","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The height of the ellipse.","name":"height","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":95,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Check to see if the Ellipse contains the given x / y coordinates.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to check within the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to check within the ellipse.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the coordinates are within the ellipse, otherwise false."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#contains","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":111,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns a Point object containing the coordinates of a point on the circumference of the Ellipse\nbased on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\nat 180 degrees around the circle.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the ellipse.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An object to store the return values in. If not given a Point object will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point, or point-like object, containing the coordinates of the point around the ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#getPoint","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns an array of Point objects containing the coordinates of the points around the circumference of the Ellipse,\nbased on the given quantity or stepRate values.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Sets the quantity by getting the circumference of the ellipse and dividing it by the stepRate.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to insert the points in to. If not provided a new array will be created.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Point objects pertaining to the points around the circumference of the ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":151,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns a uniformly distributed random point from anywhere within the given Ellipse.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"A Point or point-like object to set the random `x` and `y` values in.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object with the random values set in the `x` and `y` properties."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":168,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Sets the x, y, width and height of this ellipse.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the center of the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the center of the ellipse.","name":"y"},{"type":{"names":["number"]},"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"description":"The height of the ellipse.","name":"height"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"This Ellipse object."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#setTo","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Sets this Ellipse to be empty with a width and height of zero.\nDoes not change its position.","kind":"function","name":"setEmpty","since":"3.0.0","returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"This Ellipse object."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#setEmpty","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Sets the position of this Ellipse.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the center of the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the center of the ellipse.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"This Ellipse object."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Sets the size of this Ellipse.\nDoes not change its position.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height of the ellipse.","name":"height"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"This Ellipse object."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#setSize","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":251,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Checks to see if the Ellipse is empty: has a width or height equal to zero.","kind":"function","name":"isEmpty","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if the Ellipse is empty, otherwise false."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#isEmpty","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":264,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns the minor radius of the ellipse. Also known as the Semi Minor Axis.","kind":"function","name":"getMinorRadius","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The minor radius."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#getMinorRadius","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":277,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns the major radius of the ellipse. Also known as the Semi Major Axis.","kind":"function","name":"getMajorRadius","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The major radius."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#getMajorRadius","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":290,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The left position of the Ellipse.","name":"left","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":311,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The right position of the Ellipse.","name":"right","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The top position of the Ellipse.","name":"top","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":353,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The bottom position of the Ellipse.","name":"bottom","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Equals.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Compares the `x`, `y`, `width` and `height` properties of the two given Ellipses.\nReturns `true` if they all match, otherwise returns `false`.","kind":"function","name":"Equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The first Ellipse to compare.","name":"ellipse"},{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The second Ellipse to compare.","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two Ellipse equal each other, otherwise `false`."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Equals","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"GetBounds.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetBounds.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns the bounds of the Ellipse object.","kind":"function","name":"GetBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get the bounds from.","name":"ellipse"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"A Rectangle, or rectangle-like object, to store the ellipse bounds in. If not given a new Rectangle will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The Rectangle object containing the Ellipse bounds."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.GetBounds","scope":"static","___s":true},{"meta":{"range":[180,232],"filename":"GetPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"CircumferencePoint","longname":"CircumferencePoint","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoint.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns a Point object containing the coordinates of a point on the circumference of the Ellipse\nbased on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\nat 180 degrees around the circle.","kind":"function","name":"GetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get the circumference point on.","name":"ellipse"},{"type":{"names":["number"]},"description":"A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the ellipse.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An object to store the return values in. If not given a Point object will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point, or point-like object, containing the coordinates of the point around the ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.GetPoint","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"GetPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Circumference","longname":"Circumference","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoints.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns an array of Point objects containing the coordinates of the points around the circumference of the Ellipse,\nbased on the given quantity or stepRate values.","kind":"function","name":"GetPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get the points from.","name":"ellipse"},{"type":{"names":["integer"]},"description":"The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Sets the quantity by getting the circumference of the ellipse and dividing it by the stepRate.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to insert the points in to. If not provided a new array will be created.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Point objects pertaining to the points around the circumference of the ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.GetPoints","scope":"static","___s":true},{"meta":{"filename":"Offset.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Offsets the Ellipse by the values given.","kind":"function","name":"Offset","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to be offset (translated.)","name":"ellipse"},{"type":{"names":["number"]},"description":"The amount to horizontally offset the Ellipse by.","name":"x"},{"type":{"names":["number"]},"description":"The amount to vertically offset the Ellipse by.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse that was offset."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Offset","scope":"static","___s":true},{"meta":{"filename":"OffsetPoint.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Offsets the Ellipse by the values given in the `x` and `y` properties of the Point object.","kind":"function","name":"OffsetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to be offset (translated.)","name":"ellipse"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The Point object containing the values to offset the Ellipse by.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse that was offset."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.OffsetPoint","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Random.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Random.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns a uniformly distributed random point from anywhere within the given Ellipse.","kind":"function","name":"Random","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get a random point from.","name":"ellipse"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"A Point or point-like object to set the random `x` and `y` values in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object with the random values set in the `x` and `y` properties."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Random","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Ellipse","longname":"Ellipse","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"kind":"namespace","name":"Geom","memberof":"Phaser","longname":"Phaser.Geom","scope":"static","___s":true},{"meta":{"range":[180,244],"filename":"CircleToCircle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"DistanceBetween","longname":"DistanceBetween","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CircleToCircle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Circles intersect.","kind":"function","name":"CircleToCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The first Circle to check for intersection.","name":"circleA"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The second Circle to check for intersection.","name":"circleB"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two Circles intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.CircleToCircle","scope":"static","___s":true},{"meta":{"filename":"CircleToRectangle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between a circle and a rectangle.","kind":"function","name":"CircleToRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The circle to be checked.","name":"circle"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle to be checked.","name":"rect"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two objects intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.CircleToRectangle","scope":"static","___s":true},{"meta":{"range":[192,225],"filename":"GetCircleToCircle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetCircleToCircle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Circles intersect and returns the intersection points as a Point object array.","kind":"function","name":"GetCircleToCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The first Circle to check for intersection.","name":"circleA"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The second Circle to check for intersection.","name":"circleB"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetCircleToCircle","scope":"static","___s":true},{"meta":{"range":[192,238],"filename":"GetCircleToRectangle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"GetLineToCircle","longname":"GetLineToCircle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetCircleToRectangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between a circle and a rectangle,\nand returns the intersection points as a Point object array.","kind":"function","name":"GetCircleToRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The circle to be checked.","name":"circle"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle to be checked.","name":"rect"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetCircleToRectangle","scope":"static","___s":true},{"meta":{"range":[192,225],"filename":"GetLineToCircle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetLineToCircle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between the line segment and circle,\nand returns the intersection points as a Point object array.","kind":"function","name":"GetLineToCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line segment to check.","name":"line"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The circle to check against the line.","name":"circle"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetLineToCircle","scope":"static","___s":true},{"meta":{"range":[192,225],"filename":"GetLineToRectangle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetLineToRectangle.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between the Line and a Rectangle shape,\nand returns the intersection points as a Point object array.","kind":"function","name":"GetLineToRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to check for intersection.","name":"line"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The Rectangle to check for intersection.","name":"rect"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetLineToRectangle","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"GetRectangleIntersection.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetRectangleIntersection.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Rectangle shapes intersect and returns the area of this intersection as Rectangle object.\n\nIf optional `output` parameter is omitted, new Rectangle object is created and returned. If there is intersection, it will contain intersection area. If there is no intersection, it wil be empty Rectangle (all values set to zero).\n\nIf Rectangle object is passed as `output` and there is intersection, then intersection area data will be loaded into it and it will be returned. If there is no intersection, it will be returned without any change.","kind":"function","name":"GetRectangleIntersection","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle object.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle object.","name":"rectB"},{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"Optional Rectangle object. If given, the intersection data will be loaded into it (in case of no intersection, it will be left unchanged). Otherwise, new Rectangle object will be created and returned with either intersection data or empty (all values set to zero), if there is no intersection.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A rectangle object with intersection data."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetRectangleIntersection","scope":"static","___s":true},{"meta":{"range":[192,244],"filename":"GetRectangleToRectangle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"GetLineToRectangle","longname":"GetLineToRectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetRectangleToRectangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Rectangles intersect and returns the intersection points as a Point object array.\n\nA Rectangle intersects another Rectangle if any part of its bounds is within the other Rectangle's bounds. As such, the two Rectangles are considered \"solid\". A Rectangle with no width or no height will never intersect another Rectangle.","kind":"function","name":"GetRectangleToRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle to check for intersection.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle to check for intersection.","name":"rectB"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetRectangleToRectangle","scope":"static","___s":true},{"meta":{"range":[192,246],"filename":"GetRectangleToTriangle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"RectangleToTriangle","longname":"RectangleToTriangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetRectangleToTriangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between Rectangle shape and Triangle shape,\nand returns the intersection points as a Point object array.","kind":"function","name":"GetRectangleToTriangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Rectangle object to test.","name":"rect"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"Triangle object to test.","name":"triangle"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetRectangleToTriangle","scope":"static","___s":true},{"meta":{"range":[192,238],"filename":"GetTriangleToCircle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"GetLineToCircle","longname":"GetLineToCircle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetTriangleToCircle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if a Triangle and a Circle intersect, and returns the intersection points as a Point object array.\n\nA Circle intersects a Triangle if its center is located within it or if any of the Triangle's sides intersect the Circle. As such, the Triangle and the Circle are considered \"solid\" for the intersection.","kind":"function","name":"GetTriangleToCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to check for intersection.","name":"triangle"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to check for intersection.","name":"circle"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetTriangleToCircle","scope":"static","___s":true},{"meta":{"range":[192,225],"filename":"GetTriangleToLine.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetTriangleToLine.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if a Triangle and a Line intersect, and returns the intersection points as a Point object array.\n\nThe Line intersects the Triangle if it starts inside of it, ends inside of it, or crosses any of the Triangle's sides. Thus, the Triangle is considered \"solid\".","kind":"function","name":"GetTriangleToLine","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to check with.","name":"triangle"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to check with.","name":"line"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetTriangleToLine","scope":"static","___s":true},{"meta":{"range":[192,244],"filename":"GetTriangleToTriangle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"TriangleToTriangle","longname":"TriangleToTriangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetTriangleToTriangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Triangles intersect, and returns the intersection points as a Point object array.\n\nA Triangle intersects another Triangle if any pair of their lines intersects or if any point of one Triangle is within the other Triangle. Thus, the Triangles are considered \"solid\".","kind":"function","name":"GetTriangleToTriangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The first Triangle to check for intersection.","name":"triangleA"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The second Triangle to check for intersection.","name":"triangleB"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetTriangleToTriangle","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"LineToCircle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LineToCircle.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between the line segment and circle.\n\nBased on code by [Matt DesLauriers](https://github.com/mattdesl/line-circle-collision/blob/master/LICENSE.md).","kind":"function","name":"LineToCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line segment to check.","name":"line"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The circle to check against the line.","name":"circle"},{"type":{"names":["Phaser.Geom.Point","any"]},"optional":true,"description":"An optional Point-like object. If given the closest point on the Line where the circle intersects will be stored in this object.","name":"nearest"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two objects intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.LineToCircle","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"LineToLine.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LineToLine.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Lines intersect. If the Lines are identical, they will be treated as parallel and thus non-intersecting.","kind":"function","name":"LineToLine","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The first Line to check.","name":"line1"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The second Line to check.","name":"line2"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"A Point in which to optionally store the point of intersection.","name":"out"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two Lines intersect, and the `out` object will be populated, if given. Otherwise, `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.LineToLine","scope":"static","___s":true},{"meta":{"filename":"LineToRectangle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between the Line and a Rectangle shape, or a rectangle-like\nobject, with public `x`, `y`, `right` and `bottom` properties, such as a Sprite or Body.\n\nAn intersection is considered valid if:\n\nThe line starts within, or ends within, the Rectangle.\nThe line segment intersects one of the 4 rectangle edges.\n\nThe for the purposes of this function rectangles are considered 'solid'.","kind":"function","name":"LineToRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to check for intersection.","name":"line"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The Rectangle to check for intersection.","name":"rect"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Line and the Rectangle intersect, `false` otherwise."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.LineToRectangle","scope":"static","___s":true},{"meta":{"filename":"PointToLine.js","lineno":8,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if the a Point falls between the two end-points of a Line, based on the given line thickness.\n\nAssumes that the line end points are circular, not square.","kind":"function","name":"PointToLine","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","any"]},"description":"The point, or point-like object to check.","name":"point"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The line segment to test for intersection on.","name":"line"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The line thickness. Assumes that the line end points are circular.","name":"lineThickness"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Point falls on the Line, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.PointToLine","scope":"static","___s":true},{"meta":{"range":[180,218],"filename":"PointToLineSegment.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"PointToLine","longname":"PointToLine","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PointToLineSegment.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if a Point is located on the given line segment.","kind":"function","name":"PointToLineSegment","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to check for intersection.","name":"point"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The line segment to check for intersection.","name":"line"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Point is on the given line segment, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.PointToLineSegment","scope":"static","___s":true},{"meta":{"filename":"RectangleToRectangle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Rectangles intersect.\n\nA Rectangle intersects another Rectangle if any part of its bounds is within the other Rectangle's bounds.\nAs such, the two Rectangles are considered \"solid\".\nA Rectangle with no width or no height will never intersect another Rectangle.","kind":"function","name":"RectangleToRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle to check for intersection.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle to check for intersection.","name":"rectB"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two Rectangles intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.RectangleToRectangle","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"RectangleToTriangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"LineToLine","longname":"LineToLine","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RectangleToTriangle.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between Rectangle shape and Triangle shape.","kind":"function","name":"RectangleToTriangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Rectangle object to test.","name":"rect"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"Triangle object to test.","name":"triangle"}],"returns":[{"type":{"names":["boolean"]},"description":"A value of `true` if objects intersect; otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.RectangleToTriangle","scope":"static","___s":true},{"meta":{"filename":"RectangleToValues.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Check if rectangle intersects with values.","kind":"function","name":"RectangleToValues","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle object","name":"rect"},{"type":{"names":["number"]},"description":"The x coordinate of the left of the Rectangle.","name":"left"},{"type":{"names":["number"]},"description":"The x coordinate of the right of the Rectangle.","name":"right"},{"type":{"names":["number"]},"description":"The y coordinate of the top of the Rectangle.","name":"top"},{"type":{"names":["number"]},"description":"The y coordinate of the bottom of the Rectangle.","name":"bottom"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Tolerance allowed in the calculation, expressed in pixels.","name":"tolerance"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns true if there is an intersection."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.RectangleToValues","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"TriangleToCircle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"LineToCircle","longname":"LineToCircle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TriangleToCircle.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if a Triangle and a Circle intersect.\n\nA Circle intersects a Triangle if its center is located within it or if any of the Triangle's sides intersect the Circle. As such, the Triangle and the Circle are considered \"solid\" for the intersection.","kind":"function","name":"TriangleToCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to check for intersection.","name":"triangle"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to check for intersection.","name":"circle"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Triangle and the `Circle` intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.TriangleToCircle","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"TriangleToLine.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TriangleToLine.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if a Triangle and a Line intersect.\n\nThe Line intersects the Triangle if it starts inside of it, ends inside of it, or crosses any of the Triangle's sides. Thus, the Triangle is considered \"solid\".","kind":"function","name":"TriangleToLine","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to check with.","name":"triangle"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to check with.","name":"line"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Triangle and the Line intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.TriangleToLine","scope":"static","___s":true},{"meta":{"range":[180,232],"filename":"TriangleToTriangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"ContainsArray","longname":"ContainsArray","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TriangleToTriangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Triangles intersect.\n\nA Triangle intersects another Triangle if any pair of their lines intersects or if any point of one Triangle is within the other Triangle. Thus, the Triangles are considered \"solid\".","kind":"function","name":"TriangleToTriangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The first Triangle to check for intersection.","name":"triangleA"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The second Triangle to check for intersection.","name":"triangleB"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Triangles intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.TriangleToTriangle","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"kind":"namespace","name":"Intersects","memberof":"Phaser.Geom","longname":"Phaser.Geom.Intersects","scope":"static","___s":true},{"meta":{"filename":"Angle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the angle of the line in radians.","kind":"function","name":"Angle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the angle of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The angle of the line, in radians."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Angle","scope":"static","___s":true},{"meta":{"filename":"BresenhamPoints.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Using Bresenham's line algorithm this will return an array of all coordinates on this line.\n\nThe `start` and `end` points are rounded before this runs as the algorithm works on integers.","kind":"function","name":"BresenhamPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line.","name":"line"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The optional step rate for the points on the line.","name":"stepRate"},{"type":{"names":["Array."]},"optional":true,"description":"An optional array to push the resulting coordinates into.","name":"results"}],"returns":[{"type":{"names":["Array."]},"description":"The array of coordinates on the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.BresenhamPoints","scope":"static","___s":true},{"meta":{"filename":"CenterOn.js","lineno":8,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Center a line on the given coordinates.","kind":"function","name":"CenterOn","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to center.","name":"line"},{"type":{"names":["number"]},"description":"The horizontal coordinate to center the line on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to center the line on.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The centered line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.CenterOn","scope":"static","___s":true},{"meta":{"range":[180,204],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Line","longname":"Line","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Clone the given line.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The source line to clone.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The cloned line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Clone","scope":"static","___s":true},{"meta":{"filename":"CopyFrom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Copy the values of one line to a destination line.","kind":"function","name":"CopyFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The source line to copy the values from.","name":"source"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The destination line to copy the values to.","name":"dest"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The destination line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.CopyFrom","scope":"static","___s":true},{"meta":{"filename":"Equals.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Compare two lines for strict equality.","kind":"function","name":"Equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The first line to compare.","name":"line"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The second line to compare.","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the two lines are equal."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Equals","scope":"static","___s":true},{"meta":{"range":[180,208],"filename":"Extend.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Length","longname":"Length","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Extend.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Extends the start and end points of a Line by the given amounts.\n\nThe amounts can be positive or negative. Positive points will increase the length of the line,\nwhile negative ones will decrease it.\n\nIf no `right` value is provided it will extend the length of the line equally in both directions.\n\nPass a value of zero to leave the start or end point unchanged.","kind":"function","name":"Extend","since":"3.16.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line instance to extend.","name":"line"},{"type":{"names":["number"]},"description":"The amount to extend the start of the line by.","name":"left"},{"type":{"names":["number"]},"optional":true,"description":"The amount to extend the end of the line by. If not given it will be set to the `left` value.","name":"right"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The modified Line instance."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Extend","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"GetMidPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetMidPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get the midpoint of the given line.","kind":"function","name":"GetMidPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to get the midpoint of.","name":"line"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An optional point object to store the midpoint in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The midpoint of the Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.GetMidPoint","scope":"static","___s":true},{"meta":{"range":[213,246],"filename":"GetNearestPoint.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetNearestPoint.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get the nearest point on a line perpendicular to the given point.","kind":"function","name":"GetNearestPoint","since":"3.16.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to get the nearest point on.","name":"line"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point to get the nearest point to.","name":"point"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An optional point, or point-like object, to store the coordinates of the nearest point on the line.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The nearest point on the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.GetNearestPoint","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"GetNormal.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetNormal.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the normal of the given line.\n\nThe normal of a line is a vector that points perpendicular from it.","kind":"function","name":"GetNormal","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the normal of.","name":"line"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An optional point object to store the normal in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The normal of the Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.GetNormal","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"GetPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get a point on a line that's a given percentage along its length.","kind":"function","name":"GetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line.","name":"line"},{"type":{"names":["number"]},"description":"A value between 0 and 1, where 0 is the start, 0.5 is the middle and 1 is the end of the line.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An optional point, or point-like object, to store the coordinates of the point on the line.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point on the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.GetPoint","scope":"static","___s":true},{"meta":{"range":[180,208],"filename":"GetPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Length","longname":"Length","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoints.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get a number of points along a line's length.\n\nProvide a `quantity` to get an exact number of points along the line.\n\nProvide a `stepRate` to ensure a specific distance between each point on the line. Set `quantity` to `0` when\nproviding a `stepRate`.","kind":"function","name":"GetPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line.","name":"line"},{"type":{"names":["integer"]},"description":"The number of points to place on the line. Set to `0` to use `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"The distance between each point on the line. When set, `quantity` is implied and should be set to `0`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array of Points, or point-like objects, to store the coordinates of the points on the line.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points, or point-like objects, containing the coordinates of the points on the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.GetPoints","scope":"static","___s":true},{"meta":{"filename":"GetShortestDistance.js","lineno":8,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get the shortest distance from a Line to the given Point.","kind":"function","name":"GetShortestDistance","since":"3.16.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to get the distance from.","name":"line"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point to get the shortest distance to.","name":"point"}],"returns":[{"type":{"names":["number"]},"description":"The shortest distance from the line to the point."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.GetShortestDistance","scope":"static","___s":true},{"meta":{"filename":"Height.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the height of the given line.","kind":"function","name":"Height","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the height of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The height of the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Height","scope":"static","___s":true},{"meta":{"filename":"Length.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the length of the given line.","kind":"function","name":"Length","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the length of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The length of the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Length","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Line.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Line.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"classdesc":"Defines a Line segment, a part of a line between two endpoints.","kind":"class","name":"Line","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the lines starting point.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the lines starting point.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the lines ending point.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the lines ending point.","name":"y2"}],"scope":"static","longname":"Phaser.Geom.Line","___s":true},{"meta":{"filename":"Line.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The geometry constant type of this object: `GEOM_CONST.LINE`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The x coordinate of the lines starting point.","name":"x1","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#x1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The y coordinate of the lines starting point.","name":"y1","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#y1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The x coordinate of the lines ending point.","name":"x2","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#x2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The y coordinate of the lines ending point.","name":"y2","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#y2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get a point on a line that's a given percentage along its length.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1, where 0 is the start, 0.5 is the middle and 1 is the end of the line.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An optional point, or point-like object, to store the coordinates of the point on the line.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point, or point-like object, containing the coordinates of the point on the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#getPoint","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get a number of points along a line's length.\n\nProvide a `quantity` to get an exact number of points along the line.\n\nProvide a `stepRate` to ensure a specific distance between each point on the line. Set `quantity` to `0` when\nproviding a `stepRate`.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The number of points to place on the line. Set to `0` to use `stepRate` instead.","name":"quantity"},{"type":{"names":["integer"]},"optional":true,"description":"The distance between each point on the line. When set, `quantity` is implied and should be set to `0`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array of Points, or point-like objects, to store the coordinates of the points on the line.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points, or point-like objects, containing the coordinates of the points on the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get a random Point on the Line.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An instance of a Point to be modified.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"A random Point on the Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":146,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Set new coordinates for the line endpoints.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the lines starting point.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the lines starting point.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the lines ending point.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the lines ending point.","name":"y2"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"This Line object."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#setTo","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Returns a Vector2 object that corresponds to the start of this Line.","kind":"function","name":"getPointA","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to set the results in. If `undefined` a new Vector2 will be created.","name":"vec2"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector2 object that corresponds to the start of this Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#getPointA","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":196,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Returns a Vector2 object that corresponds to the end of this Line.","kind":"function","name":"getPointB","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to set the results in. If `undefined` a new Vector2 will be created.","name":"vec2"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector2 object that corresponds to the end of this Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#getPointB","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":217,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The left position of the Line.","name":"left","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The right position of the Line.","name":"right","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The top position of the Line.","name":"top","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":301,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The bottom position of the Line.","name":"bottom","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,220],"filename":"NormalAngle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NormalAngle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get the angle of the normal of the given line in radians.","kind":"function","name":"NormalAngle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the angle of the normal of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The angle of the normal of the line in radians."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.NormalAngle","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"NormalX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NormalX.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"[description]","kind":"function","name":"NormalX","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line object to get the normal value from.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.NormalX","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"NormalY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NormalY.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The Y value of the normal of the given line.\nThe normal of a line is a vector that points perpendicular from it.","kind":"function","name":"NormalY","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the normal of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The Y value of the normal of the Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.NormalY","scope":"static","___s":true},{"meta":{"filename":"Offset.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Offset a line by the given amount.","kind":"function","name":"Offset","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to offset.","name":"line"},{"type":{"names":["number"]},"description":"The horizontal offset to add to the line.","name":"x"},{"type":{"names":["number"]},"description":"The vertical offset to add to the line.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The offset line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Offset","scope":"static","___s":true},{"meta":{"filename":"PerpSlope.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the perpendicular slope of the given line.","kind":"function","name":"PerpSlope","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the perpendicular slope of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The perpendicular slope of the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.PerpSlope","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Random.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Random.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Returns a random point on a given Line.","kind":"function","name":"Random","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to calculate the random Point on.","name":"line"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An instance of a Point to be modified.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A random Point on the Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Random","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"ReflectAngle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Angle","longname":"Angle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ReflectAngle.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the reflected angle between two lines.\n\nThis is the outgoing angle based on the angle of Line 1 and the normalAngle of Line 2.","kind":"function","name":"ReflectAngle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The first line.","name":"lineA"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The second line.","name":"lineB"}],"returns":[{"type":{"names":["number"]},"description":"The reflected angle between each line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.ReflectAngle","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"Rotate.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"RotateAroundXY","longname":"RotateAroundXY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Rotate.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Rotate a line around its midpoint by the given angle in radians.","kind":"function","name":"Rotate","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to rotate.","name":"line"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The rotated line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Rotate","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"RotateAroundPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"RotateAroundXY","longname":"RotateAroundXY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateAroundPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Rotate a line around a point by the given angle in radians.","kind":"function","name":"RotateAroundPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to rotate.","name":"line"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point to rotate the line around.","name":"point"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The rotated line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.RotateAroundPoint","scope":"static","___s":true},{"meta":{"filename":"RotateAroundXY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Rotate a line around the given coordinates by the given angle in radians.","kind":"function","name":"RotateAroundXY","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to rotate.","name":"line"},{"type":{"names":["number"]},"description":"The horizontal coordinate to rotate the line around.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to rotate the line around.","name":"y"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The rotated line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.RotateAroundXY","scope":"static","___s":true},{"meta":{"filename":"SetToAngle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Set a line to a given position, angle and length.","kind":"function","name":"SetToAngle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to set.","name":"line"},{"type":{"names":["number"]},"description":"The horizontal start position of the line.","name":"x"},{"type":{"names":["number"]},"description":"The vertical start position of the line.","name":"y"},{"type":{"names":["number"]},"description":"The angle of the line in radians.","name":"angle"},{"type":{"names":["number"]},"description":"The length of the line.","name":"length"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The updated line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.SetToAngle","scope":"static","___s":true},{"meta":{"filename":"Slope.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the slope of the given line.","kind":"function","name":"Slope","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the slope of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The slope of the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Slope","scope":"static","___s":true},{"meta":{"filename":"Width.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the width of the given line.","kind":"function","name":"Width","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the width of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The width of the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Width","scope":"static","___s":true},{"meta":{"range":[180,204],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Line","longname":"Line","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Ceil.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Apply `Math.ceil()` to each coordinate of the given Point.","kind":"function","name":"Ceil","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to ceil.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point with `Math.ceil()` applied to its coordinates."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Ceil","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Clone the given Point.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The source Point to clone.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The cloned Point."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Clone","scope":"static","___s":true},{"meta":{"filename":"CopyFrom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Copy the values of one Point to a destination Point.","kind":"function","name":"CopyFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The source Point to copy the values from.","name":"source"},{"type":{"names":["Phaser.Geom.Point"]},"description":"The destination Point to copy the values to.","name":"dest"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The destination Point."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.CopyFrom","scope":"static","___s":true},{"meta":{"filename":"Equals.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"A comparison of two `Point` objects to see if they are equal.","kind":"function","name":"Equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The original `Point` to compare against.","name":"point"},{"type":{"names":["Phaser.Geom.Point"]},"description":"The second `Point` to compare.","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns true if the both `Point` objects are equal."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Equals","scope":"static","___s":true},{"meta":{"filename":"Floor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Apply `Math.ceil()` to each coordinate of the given Point.","kind":"function","name":"Floor","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to floor.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point with `Math.floor()` applied to its coordinates."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Floor","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"GetCentroid.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetCentroid.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Get the centroid or geometric center of a plane figure (the arithmetic mean position of all the points in the figure).\nInformally, it is the point at which a cutout of the shape could be perfectly balanced on the tip of a pin.","kind":"function","name":"GetCentroid","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"[description]","name":"points"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]"}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.GetCentroid","scope":"static","___s":true},{"meta":{"filename":"GetMagnitude.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Calculate the magnitude of the point, which equivalent to the length of the line from the origin to this point.","kind":"function","name":"GetMagnitude","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The point to calculate the magnitude for","name":"point"}],"returns":[{"type":{"names":["number"]},"description":"The resulting magnitude"}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.GetMagnitude","scope":"static","___s":true},{"meta":{"filename":"GetMagnitudeSq.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Calculates the square of magnitude of given point.(Can be used for fast magnitude calculation of point)","kind":"function","name":"GetMagnitudeSq","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"Returns square of the magnitude/length of given point.","name":"point"}],"returns":[{"type":{"names":["number"]},"description":"Returns square of the magnitude of given point."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.GetMagnitudeSq","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"GetRectangleFromPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetRectangleFromPoints.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Calculates the Axis Aligned Bounding Box (or aabb) from an array of points.","kind":"function","name":"GetRectangleFromPoints","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"[description]","name":"points"},{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"[description]"}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.GetRectangleFromPoints","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"Interpolate.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Interpolate.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"[description]","kind":"function","name":"Interpolate","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The starting `Point` for the interpolation.","name":"pointA"},{"type":{"names":["Phaser.Geom.Point"]},"description":"The target `Point` for the interpolation.","name":"pointB"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The amount to interpolate between the two points. Generally, a value between 0 (returns the starting `Point`) and 1 (returns the target `Point`). If omitted, 0 is used.","name":"t"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An optional `Point` object whose `x` and `y` values will be set to the result of the interpolation (can also be any object with `x` and `y` properties). If omitted, a new `Point` created and returned.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"Either the object from the `out` argument with the properties `x` and `y` set to the result of the interpolation or a newly created `Point` object."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Interpolate","scope":"static","___s":true},{"meta":{"filename":"Invert.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Swaps the X and the Y coordinate of a point.","kind":"function","name":"Invert","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to modify.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The modified `point`."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Invert","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"Negative.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Negative.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Inverts a Point's coordinates.","kind":"function","name":"Negative","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to invert.","name":"point"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"The Point to return the inverted coordinates in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The modified `out` Point, or a new Point if none was provided."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Negative","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Point.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Point.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"classdesc":"Defines a Point in 2D space, with an x and y component.","kind":"class","name":"Point","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of this Point.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y coordinate of this Point.","name":"y"}],"scope":"static","longname":"Phaser.Geom.Point","___s":true},{"meta":{"filename":"Point.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"The geometry constant type of this object: `GEOM_CONST.POINT`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Point.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"The x coordinate of this Point.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Point.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"The y coordinate of this Point.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Point.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Set the x and y coordinates of the point to the given values.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of this Point.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y coordinate of this Point.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"This Point object."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point#setTo","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"Project.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Project.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"[description]","kind":"function","name":"Project","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]","name":"pointA"},{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]","name":"pointB"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]"}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Project","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"ProjectUnit.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ProjectUnit.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"[description]","kind":"function","name":"ProjectUnit","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]","name":"pointA"},{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]","name":"pointB"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]"}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.ProjectUnit","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"SetMagnitude.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"GetMagnitude","longname":"GetMagnitude","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetMagnitude.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Changes the magnitude (length) of a two-dimensional vector without changing its direction.","kind":"function","name":"SetMagnitude","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to treat as the end point of the vector.","name":"point"},{"type":{"names":["number"]},"description":"The new magnitude of the vector.","name":"magnitude"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The modified Point."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.SetMagnitude","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,210],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Polygon","longname":"Polygon","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Create a new polygon which is a copy of the specified polygon","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The polygon to create a clone of","name":"polygon"}],"returns":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"A new separate Polygon cloned from the specified polygon, based on the same points."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.Clone","scope":"static","___s":true},{"meta":{"filename":"Contains.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Checks if a point is within the bounds of a Polygon.","kind":"function","name":"Contains","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The Polygon to check against.","name":"polygon"},{"type":{"names":["number"]},"description":"The X coordinate of the point to check.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the point to check.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the point is within the bounds of the Polygon, otherwise `false`."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.Contains","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"[description]","kind":"function","name":"ContainsPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"[description]","name":"polygon"},{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]","name":"point"}],"returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.ContainsPoint","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"GetAABB.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetAABB.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Calculates the bounding AABB rectangle of a polygon.","kind":"function","name":"GetAABB","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The polygon that should be calculated.","name":"polygon"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"The rectangle or object that has x, y, width, and height properties to store the result. Optional.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The resulting rectangle or object that is passed in with position and dimensions of the polygon's AABB."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.GetAABB","scope":"static","___s":true},{"meta":{"filename":"GetNumberArray.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Stores all of the points of a Polygon into a flat array of numbers following the sequence [ x,y, x,y, x,y ],\ni.e. each point of the Polygon, in the order it's defined, corresponds to two elements of the resultant\narray for the point's X and Y coordinate.","kind":"function","name":"GetNumberArray","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The Polygon whose points to export.","name":"polygon"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to which the points' coordinates should be appended.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"The modified `output` array, or a new array if none was given."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.GetNumberArray","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"GetPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Length","longname":"Length","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoints.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Returns an array of Point objects containing the coordinates of the points around the perimeter of the Polygon,\nbased on the given quantity or stepRate values.","kind":"function","name":"GetPoints","since":"3.12.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The Polygon to get the points from.","name":"polygon"},{"type":{"names":["integer"]},"description":"The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Sets the quantity by getting the perimeter of the Polygon and dividing it by the stepRate.","name":"stepRate"},{"type":{"names":["array"]},"optional":true,"description":"An array to insert the points in to. If not provided a new array will be created.","name":"output"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Point objects pertaining to the points around the perimeter of the Polygon."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.GetPoints","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Perimeter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Length","longname":"Length","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Perimeter.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Returns the perimeter of the given Polygon.","kind":"function","name":"Perimeter","since":"3.12.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The Polygon to get the perimeter of.","name":"polygon"}],"returns":[{"type":{"names":["number"]},"description":"The perimeter of the Polygon."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.Perimeter","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Polygon.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Polygon.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"classdesc":"A Polygon object\n\nThe polygon is a closed shape consists of a series of connected straight lines defined by list of ordered points.\nSeveral formats are supported to define the list of points, check the setTo method for details. \nThis is a geometry object allowing you to define and inspect the shape.\nIt is not a Game Object, in that you cannot add it to the display list, and it has no texture.\nTo render a Polygon you should look at the capabilities of the Graphics class.","kind":"class","name":"Polygon","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["Array."]},"optional":true,"description":"List of points defining the perimeter of this Polygon. Several formats are supported: \n- A string containing paired x y values separated by a single space: `'40 0 40 20 100 20 100 80 40 80 40 100 0 50'`\n- An array of Point objects: `[new Phaser.Point(x1, y1), ...]`\n- An array of objects with public x y properties: `[obj1, obj2, ...]`\n- An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\n- An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`","name":"points"}],"scope":"static","longname":"Phaser.Geom.Polygon","___s":true},{"meta":{"filename":"Polygon.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"The geometry constant type of this object: `GEOM_CONST.POLYGON`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Polygon.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"The area of this Polygon.","name":"area","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#area","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Polygon.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"An array of number pair objects that make up this polygon. I.e. [ {x,y}, {x,y}, {x,y} ]","name":"points","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#points","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Polygon.js","lineno":76,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Check to see if the Polygon contains the given x / y coordinates.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to check within the polygon.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to check within the polygon.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the coordinates are within the polygon, otherwise `false`."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#contains","scope":"instance","___s":true},{"meta":{"filename":"Polygon.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Sets this Polygon to the given points.\n\nThe points can be set from a variety of formats:\n\n- A string containing paired values separated by a single space: `'40 0 40 20 100 20 100 80 40 80 40 100 0 50'`\n- An array of Point objects: `[new Phaser.Point(x1, y1), ...]`\n- An array of objects with public x/y properties: `[obj1, obj2, ...]`\n- An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\n- An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\n\n`setTo` may also be called without any arguments to remove all points.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"Points defining the perimeter of this polygon. Please check function description above for the different supported formats.","name":"points"}],"returns":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"This Polygon object."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#setTo","scope":"instance","___s":true},{"meta":{"filename":"Polygon.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Calculates the area of the Polygon. This is available in the property Polygon.area","kind":"function","name":"calculateArea","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The area of the polygon."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#calculateArea","scope":"instance","___s":true},{"meta":{"filename":"Polygon.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Returns an array of Point objects containing the coordinates of the points around the perimeter of the Polygon,\nbased on the given quantity or stepRate values.","kind":"function","name":"getPoints","since":"3.12.0","params":[{"type":{"names":["integer"]},"description":"The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Sets the quantity by getting the perimeter of the Polygon and dividing it by the stepRate.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to insert the points in to. If not provided a new array will be created.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Point objects pertaining to the points around the perimeter of the Polygon."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Reverse.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Reverses the order of the points of a Polygon.","kind":"function","name":"Reverse","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The Polygon to modify.","name":"polygon"}],"returns":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The modified Polygon."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.Reverse","scope":"static","___s":true},{"meta":{"range":[260,345],"filename":"Smooth.js","lineno":11,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"ignore":true,"name":"copy","longname":"copy","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"filename":"Smooth.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Takes a Polygon object and applies Chaikin's smoothing algorithm on its points.","kind":"function","name":"Smooth","since":"3.13.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The polygon to be smoothed. The polygon will be modified in-place and returned.","name":"polygon"}],"returns":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The input polygon."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.Smooth","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Polygon","longname":"Polygon","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Area.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Calculates the area of the given Rectangle object.","kind":"function","name":"Area","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle to calculate the area of.","name":"rect"}],"returns":[{"type":{"names":["number"]},"description":"The area of the Rectangle object."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Area","scope":"static","___s":true},{"meta":{"filename":"Ceil.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Rounds a Rectangle's position up to the smallest integer greater than or equal to each current coordinate.","kind":"function","name":"Ceil","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to adjust.","name":"rect"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The adjusted Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Ceil","scope":"static","___s":true},{"meta":{"filename":"CeilAll.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Rounds a Rectangle's position and size up to the smallest integer greater than or equal to each respective value.","kind":"function","name":"CeilAll","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to modify.","name":"rect"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.CeilAll","scope":"static","___s":true},{"meta":{"filename":"CenterOn.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Moves the top-left corner of a Rectangle so that its center is at the given coordinates.","kind":"function","name":"CenterOn","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to be centered.","name":"rect"},{"type":{"names":["number"]},"description":"The X coordinate of the Rectangle's center.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the Rectangle's center.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The centered rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.CenterOn","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Creates a new Rectangle which is identical to the given one.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to clone.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The newly created Rectangle, which is separate from the given one."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Clone","scope":"static","___s":true},{"meta":{"filename":"Contains.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Checks if a given point is inside a Rectangle's bounds.","kind":"function","name":"Contains","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to check.","name":"rect"},{"type":{"names":["number"]},"description":"The X coordinate of the point to check.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the point to check.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the point is within the Rectangle's bounds, otherwise `false`."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Contains","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Determines whether the specified point is contained within the rectangular region defined by this Rectangle object.","kind":"function","name":"ContainsPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle object.","name":"rect"},{"type":{"names":["Phaser.Geom.Point"]},"description":"The point object to be checked. Can be a Phaser Point object or any object with x and y values.","name":"point"}],"returns":[{"type":{"names":["boolean"]},"description":"A value of true if the Rectangle object contains the specified point, otherwise false."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.ContainsPoint","scope":"static","___s":true},{"meta":{"filename":"ContainsRect.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Tests if one rectangle fully contains another.","kind":"function","name":"ContainsRect","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first rectangle.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second rectangle.","name":"rectB"}],"returns":[{"type":{"names":["boolean"]},"description":"True only if rectA fully contains rectB."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.ContainsRect","scope":"static","___s":true},{"meta":{"filename":"CopyFrom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Copy the values of one Rectangle to a destination Rectangle.","kind":"function","name":"CopyFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The source Rectangle to copy the values from.","name":"source"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The destination Rectangle to copy the values to.","name":"dest"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The destination Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.CopyFrom","scope":"static","___s":true},{"meta":{"filename":"Decompose.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Create an array of points for each corner of a Rectangle\nIf an array is specified, each point object will be added to the end of the array, otherwise a new array will be created.","kind":"function","name":"Decompose","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle object to be decomposed.","name":"rect"},{"type":{"names":["array"]},"optional":true,"description":"If provided, each point will be added to this array.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"Will return the array you specified or a new array containing the points of the Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Decompose","scope":"static","___s":true},{"meta":{"filename":"Equals.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Compares the `x`, `y`, `width` and `height` properties of two rectangles.","kind":"function","name":"Equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Rectangle A","name":"rect"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Rectangle B","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the rectangles' properties are an exact match, otherwise `false`."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Equals","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"FitInside.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"GetAspectRatio","longname":"GetAspectRatio","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FitInside.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Adjusts the target rectangle, changing its width, height and position,\nso that it fits inside the area of the source rectangle, while maintaining its original\naspect ratio.\n\nUnlike the `FitOutside` function, there may be some space inside the source area not covered.","kind":"function","name":"FitInside","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The target rectangle to adjust.","name":"target"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The source rectangle to envelop the target in.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified target rectangle instance."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.FitInside","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"FitOutside.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"GetAspectRatio","longname":"GetAspectRatio","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FitOutside.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Adjusts the target rectangle, changing its width, height and position,\nso that it fully covers the area of the source rectangle, while maintaining its original\naspect ratio.\n\nUnlike the `FitInside` function, the target rectangle may extend further out than the source.","kind":"function","name":"FitOutside","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The target rectangle to adjust.","name":"target"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The source rectangle to envelope the target in.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified target rectangle instance."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.FitOutside","scope":"static","___s":true},{"meta":{"filename":"Floor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Rounds down (floors) the top left X and Y coordinates of the given Rectangle to the largest integer less than or equal to them","kind":"function","name":"Floor","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle to floor the top left X and Y coordinates of","name":"rect"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle that was passed to this function with its coordinates floored."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Floor","scope":"static","___s":true},{"meta":{"filename":"FloorAll.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Rounds a Rectangle's position and size down to the largest integer less than or equal to each current coordinate or dimension.","kind":"function","name":"FloorAll","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to adjust.","name":"rect"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The adjusted Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.FloorAll","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"FromPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FromPoints.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Constructs new Rectangle or repositions and resizes an existing Rectangle so that all of the given points are on or within its bounds.","kind":"function","name":"FromPoints","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"An array of points (either arrays with two elements corresponding to the X and Y coordinate or an object with public `x` and `y` properties) which should be surrounded by the Rectangle.","name":"points"},{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"Optional Rectangle to adjust.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The adjusted `out` Rectangle, or a new Rectangle if none was provided."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.FromPoints","scope":"static","___s":true},{"meta":{"filename":"GetAspectRatio.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Calculates the width/height ratio of a rectangle.","kind":"function","name":"GetAspectRatio","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle.","name":"rect"}],"returns":[{"type":{"names":["number"]},"description":"The width/height ratio of the rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.GetAspectRatio","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"GetCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetCenter.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns the center of a Rectangle as a Point.","kind":"function","name":"GetCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to get the center of.","name":"rect"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"Optional point-like object to update with the center coordinates.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The modified `out` object, or a new Point if none was provided."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.GetCenter","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"GetPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Perimeter","longname":"Perimeter","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoint.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Position is a value between 0 and 1 where 0 = the top-left of the rectangle and 0.5 = the bottom right.","kind":"function","name":"GetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"[description]","name":"rectangle"},{"type":{"names":["number"]},"description":"[description]","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]"}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.GetPoint","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"GetPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"GetPoint","longname":"GetPoint","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoints.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Return an array of points from the perimeter of the rectangle, each spaced out based on the quantity or step required.","kind":"function","name":"GetPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle object to get the points from.","name":"rectangle"},{"type":{"names":["number"]},"description":"Step between points. Used to calculate the number of points to return when quantity is falsey. Ignored if quantity is positive.","name":"step"},{"type":{"names":["integer"]},"description":"The number of evenly spaced points from the rectangles perimeter to return. If falsey, step param will be used to calculate the number of points.","name":"quantity"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the perimeter of the rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.GetPoints","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"GetSize.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetSize.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The size of the Rectangle object, expressed as a Point object\n with the values of the width and height properties.","kind":"function","name":"GetSize","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"[description]","name":"rect"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"[description]"}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.GetSize","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"Inflate.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"CenterOn","longname":"CenterOn","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Inflate.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Increases the size of a Rectangle by a specified amount.\n\nThe center of the Rectangle stays the same. The amounts are added to each side, so the actual increase in width or height is two times bigger than the respective argument.","kind":"function","name":"Inflate","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to inflate.","name":"rect"},{"type":{"names":["number"]},"description":"How many pixels the left and the right side should be moved by horizontally.","name":"x"},{"type":{"names":["number"]},"description":"How many pixels the top and the bottom side should be moved by vertically.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The inflated Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Inflate","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Intersection.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Intersection.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Takes two Rectangles and first checks to see if they intersect.\nIf they intersect it will return the area of intersection in the `out` Rectangle.\nIf they do not intersect, the `out` Rectangle will have a width and height of zero.","kind":"function","name":"Intersection","since":"3.11.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle to get the intersection from.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle to get the intersection from.","name":"rectB"},{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"A Rectangle to store the intersection results in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The intersection result. If the width and height are zero, no intersection occurred."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Intersection","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"MarchingAnts.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Perimeter","longname":"Perimeter","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MarchingAnts.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Return an array of points from the perimeter of the rectangle\n each spaced out based on the quantity or step required","kind":"function","name":"MarchingAnts","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"[description]","name":"rect"},{"type":{"names":["number"]},"description":"[description]","name":"step"},{"type":{"names":["integer"]},"description":"[description]","name":"quantity"},{"type":{"names":["array","Array."]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"[description]"}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.MarchingAnts","scope":"static","___s":true},{"meta":{"filename":"MergePoints.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Merges a Rectangle with a list of points by repositioning and/or resizing it such that all points are located on or within its bounds.","kind":"function","name":"MergePoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle which should be merged.","name":"target"},{"type":{"names":["Array."]},"description":"An array of Points (or any object with public `x` and `y` properties) which should be merged with the Rectangle.","name":"points"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.MergePoints","scope":"static","___s":true},{"meta":{"filename":"MergeRect.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Merges the source rectangle into the target rectangle and returns the target.\nNeither rectangle should have a negative width or height.","kind":"function","name":"MergeRect","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Target rectangle. Will be modified to include source rectangle.","name":"target"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Rectangle that will be merged into target rectangle.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Modified target rectangle that contains source rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.MergeRect","scope":"static","___s":true},{"meta":{"filename":"MergeXY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Merges a Rectangle with a point by repositioning and/or resizing it so that the point is on or within its bounds.","kind":"function","name":"MergeXY","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle which should be merged and modified.","name":"target"},{"type":{"names":["number"]},"description":"The X coordinate of the point which should be merged.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the point which should be merged.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified `target` Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.MergeXY","scope":"static","___s":true},{"meta":{"filename":"Offset.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Nudges (translates) the top left corner of a Rectangle by a given offset.","kind":"function","name":"Offset","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to adjust.","name":"rect"},{"type":{"names":["number"]},"description":"The distance to move the Rectangle horizontally.","name":"x"},{"type":{"names":["number"]},"description":"The distance to move the Rectangle vertically.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The adjusted Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Offset","scope":"static","___s":true},{"meta":{"filename":"OffsetPoint.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Nudges (translates) the top-left corner of a Rectangle by the coordinates of a point (translation vector).","kind":"function","name":"OffsetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to adjust.","name":"rect"},{"type":{"names":["Phaser.Geom.Point","Phaser.Math.Vector2"]},"description":"The point whose coordinates should be used as an offset.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The adjusted Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.OffsetPoint","scope":"static","___s":true},{"meta":{"filename":"Overlaps.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Checks if two Rectangles overlap. If a Rectangle is within another Rectangle, the two will be considered overlapping. Thus, the Rectangles are treated as \"solid\".","kind":"function","name":"Overlaps","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle to check.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle to check.","name":"rectB"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two Rectangles overlap, `false` otherwise."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Overlaps","scope":"static","___s":true},{"meta":{"filename":"Perimeter.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Calculates the perimeter of a Rectangle.","kind":"function","name":"Perimeter","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to use.","name":"rect"}],"returns":[{"type":{"names":["number"]},"description":"The perimeter of the Rectangle, equal to `(width * 2) + (height * 2)`."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Perimeter","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"PerimeterPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PerimeterPoint.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"[description]","kind":"function","name":"PerimeterPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"[description]","name":"rectangle"},{"type":{"names":["integer"]},"description":"[description]","name":"angle"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]"}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.PerimeterPoint","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Random.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Random.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns a random point within a Rectangle.","kind":"function","name":"Random","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to return a point from.","name":"rect"},{"type":{"names":["Phaser.Geom.Point"]},"description":"The object to update with the point's coordinates.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The modified `out` object, or a new Point if none was provided."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Random","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"RandomOutside.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Between","longname":"Between","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomOutside.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Calculates a random point that lies within the `outer` Rectangle, but outside of the `inner` Rectangle.\nThe inner Rectangle must be fully contained within the outer rectangle.","kind":"function","name":"RandomOutside","since":"3.10.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The outer Rectangle to get the random point within.","name":"outer"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The inner Rectangle to exclude from the returned point.","name":"inner"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"A Point, or Point-like object to store the result in. If not specified, a new Point will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"A Point object containing the random values in its `x` and `y` properties."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.RandomOutside","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Rectangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Rectangle.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"classdesc":"Encapsulates a 2D rectangle defined by its corner point in the top-left and its extends in x (width) and y (height)","kind":"class","name":"Rectangle","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The X coordinate of the top left corner of the Rectangle.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The Y coordinate of the top left corner of the Rectangle.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The width of the Rectangle.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The height of the Rectangle.","name":"height"}],"scope":"static","longname":"Phaser.Geom.Rectangle","___s":true},{"meta":{"filename":"Rectangle.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The geometry constant type of this object: `GEOM_CONST.RECTANGLE`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The X coordinate of the top left corner of the Rectangle.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The Y coordinate of the top left corner of the Rectangle.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The width of the Rectangle, i.e. the distance between its left side (defined by `x`) and its right side.","name":"width","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The height of the Rectangle, i.e. the distance between its top side (defined by `y`) and its bottom side.","name":"height","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Checks if the given point is inside the Rectangle's bounds.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the point to check.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the point to check.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the point is within the Rectangle's bounds, otherwise `false`."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#contains","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Calculates the coordinates of a point at a certain `position` on the Rectangle's perimeter.\n\nThe `position` is a fraction between 0 and 1 which defines how far into the perimeter the point is.\n\nA value of 0 or 1 returns the point at the top left corner of the rectangle, while a value of 0.5 returns the point at the bottom right corner of the rectangle. Values between 0 and 0.5 are on the top or the right side and values between 0.5 and 1 are on the bottom or the left side.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The normalized distance into the Rectangle's perimeter to return.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An object to update with the `x` and `y` coordinates of the point.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The updated `output` object, or a new Point if no `output` object was given."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getPoint","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":130,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns an array of points from the perimeter of the Rectangle, each spaced out based on the quantity or step required.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The number of points to return. Set to `false` or 0 to return an arbitrary number of points (`perimeter / stepRate`) evenly spaced around the Rectangle based on the `stepRate`.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"If `quantity` is 0, determines the normalized distance between each returned point.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to which to append the points.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"The modified `output` array, or a new array if none was provided."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns a random point within the Rectangle's bounds.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"The object in which to store the `x` and `y` coordinates of the point.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The updated `point`, or a new Point if none was provided."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Sets the position, width, and height of the Rectangle.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the top left corner of the Rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the top left corner of the Rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the Rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the Rectangle.","name":"height"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"This Rectangle object."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#setTo","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Resets the position, width, and height of the Rectangle to 0.","kind":"function","name":"setEmpty","since":"3.0.0","returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"This Rectangle object."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#setEmpty","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Sets the position of the Rectangle.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the top left corner of the Rectangle.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The Y coordinate of the top left corner of the Rectangle.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"This Rectangle object."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Sets the width and height of the Rectangle.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width to set the Rectangle to.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height to set the Rectangle to.","name":"height"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"This Rectangle object."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#setSize","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":244,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Determines if the Rectangle is empty. A Rectangle is empty if its width or height is less than or equal to 0.","kind":"function","name":"isEmpty","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Rectangle is empty. A Rectangle object is empty if its width or height is less than or equal to 0."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#isEmpty","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns a Line object that corresponds to the top of this Rectangle.","kind":"function","name":"getLineA","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to the top of this Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getLineA","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns a Line object that corresponds to the right of this Rectangle.","kind":"function","name":"getLineB","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to the right of this Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getLineB","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":299,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns a Line object that corresponds to the bottom of this Rectangle.","kind":"function","name":"getLineC","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to the bottom of this Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getLineC","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":320,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns a Line object that corresponds to the left of this Rectangle.","kind":"function","name":"getLineD","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to the left of this Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getLineD","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":341,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The x coordinate of the left of the Rectangle.\nChanging the left property of a Rectangle object has no effect on the y and height properties. However it does affect the width property, whereas changing the x value does not affect the width property.","name":"left","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The sum of the x and width properties.\nChanging the right property of a Rectangle object has no effect on the x, y and height properties, however it does affect the width property.","name":"right","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":401,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The y coordinate of the top of the Rectangle. Changing the top property of a Rectangle object has no effect on the x and width properties.\nHowever it does affect the height property, whereas changing the y value does not affect the height property.","name":"top","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The sum of the y and height properties.\nChanging the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.","name":"bottom","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":461,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The x coordinate of the center of the Rectangle.","name":"centerX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#centerX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":482,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The y coordinate of the center of the Rectangle.","name":"centerY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#centerY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SameDimensions.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Determines if the two objects (either Rectangles or Rectangle-like) have the same width and height values under strict equality.","kind":"function","name":"SameDimensions","since":"3.15.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle object.","name":"rect"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle object.","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the objects have equivalent values for the `width` and `height` properties, otherwise `false`."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.SameDimensions","scope":"static","___s":true},{"meta":{"filename":"Scale.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Scales the width and height of this Rectangle by the given amounts.","kind":"function","name":"Scale","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The `Rectangle` object that will be scaled by the specified amount(s).","name":"rect"},{"type":{"names":["number"]},"description":"The factor by which to scale the rectangle horizontally.","name":"x"},{"type":{"names":["number"]},"description":"The amount by which to scale the rectangle vertically. If this is not specified, the rectangle will be scaled by the factor `x` in both directions.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle object with updated `width` and `height` properties as calculated from the scaling factor(s)."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Scale","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Union.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Union.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Creates a new Rectangle or repositions and/or resizes an existing Rectangle so that it encompasses the two given Rectangles, i.e. calculates their union.","kind":"function","name":"Union","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle to use.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle to use.","name":"rectB"},{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the union in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified `out` Rectangle, or a new Rectangle if none was provided."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Union","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Area.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns the area of a Triangle.","kind":"function","name":"Area","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to use.","name":"triangle"}],"returns":[{"type":{"names":["number"]},"description":"The area of the Triangle, always non-negative."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Area","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"BuildEquilateral.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Triangle","longname":"Triangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BuildEquilateral.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Builds an equilateral triangle. In the equilateral triangle, all the sides are the same length (congruent) and all the angles are the same size (congruent).\nThe x/y specifies the top-middle of the triangle (x1/y1) and length is the length of each side.","kind":"function","name":"BuildEquilateral","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"x coordinate of the top point of the triangle.","name":"x"},{"type":{"names":["number"]},"description":"y coordinate of the top point of the triangle.","name":"y"},{"type":{"names":["number"]},"description":"Length of each side of the triangle.","name":"length"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle object of the given size."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.BuildEquilateral","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"BuildFromPolygon.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"EarCut","longname":"EarCut","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BuildFromPolygon.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"[description]","kind":"function","name":"BuildFromPolygon","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"A flat array of vertex coordinates like [x0,y0, x1,y1, x2,y2, ...]","name":"data"},{"type":{"names":["array"]},"optional":true,"defaultvalue":null,"description":"An array of hole indices if any (e.g. [5, 8] for a 12-vertex input would mean one hole with vertices 5–7 and another with 8–11).","name":"holes"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"[description]","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"[description]","name":"scaleY"},{"type":{"names":["array","Array."]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"[description]"}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.BuildFromPolygon","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"BuildRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Triangle","longname":"Triangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BuildRight.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Builds a right triangle, i.e. one which has a 90-degree angle and two acute angles.","kind":"function","name":"BuildRight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the right angle, which will also be the first X coordinate of the constructed Triangle.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the right angle, which will also be the first Y coordinate of the constructed Triangle.","name":"y"},{"type":{"names":["number"]},"description":"The length of the side which is to the left or to the right of the right angle.","name":"width"},{"type":{"names":["number"]},"description":"The length of the side which is above or below the right angle.","name":"height"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The constructed right Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.BuildRight","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"CenterOn.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Centroid","longname":"Centroid","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CenterOn.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"kind":"typedef","name":"CenterFunction","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to return the center coordinates of.","name":"triangle"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The center point of the Triangle according to the function."}],"longname":"CenterFunction","scope":"global","___s":true},{"meta":{"filename":"CenterOn.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Positions the Triangle so that it is centered on the given coordinates.","kind":"function","name":"CenterOn","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The triangle to be positioned.","name":"triangle"},{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"},{"type":{"names":["CenterFunction"]},"optional":true,"description":"The function used to center the triangle. Defaults to Centroid centering.","name":"centerFunc"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle that was centered."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.CenterOn","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Centroid.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Centroid.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Calculates the position of a Triangle's centroid, which is also its center of mass (center of gravity).\n\nThe centroid is the point in a Triangle at which its three medians (the lines drawn from the vertices to the bisectors of the opposite sides) meet. It divides each one in a 2:1 ratio.","kind":"function","name":"Centroid","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to use.","name":"triangle"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An object to store the coordinates in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The `out` object with modified `x` and `y` properties, or a new Point if none was provided."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Centroid","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"CircumCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Vector2","longname":"Vector2","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CircumCenter.js","lineno":30,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Computes the circumcentre of a triangle. The circumcentre is the centre of\nthe circumcircle, the smallest circle which encloses the triangle. It is also\nthe common intersection point of the perpendicular bisectors of the sides of\nthe triangle, and is the only point which has equal distance to all three\nvertices of the triangle.","kind":"function","name":"CircumCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"[description]","name":"triangle"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"[description]"}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.CircumCenter","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"CircumCircle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Circle","longname":"Circle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CircumCircle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Finds the circumscribed circle (circumcircle) of a Triangle object. The circumcircle is the circle which touches all of the triangle's vertices.","kind":"function","name":"CircumCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to use as input.","name":"triangle"},{"type":{"names":["Phaser.Geom.Circle"]},"optional":true,"description":"An optional Circle to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The updated `out` Circle, or a new Circle if none was provided."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.CircumCircle","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Triangle","longname":"Triangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Clones a Triangle object.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to clone.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"A new Triangle identical to the given one but separate from it."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Clone","scope":"static","___s":true},{"meta":{"filename":"Contains.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Checks if a point (as a pair of coordinates) is inside a Triangle's bounds.","kind":"function","name":"Contains","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to check.","name":"triangle"},{"type":{"names":["number"]},"description":"The X coordinate of the point to check.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the point to check.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the point is inside the Triangle, otherwise `false`."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Contains","scope":"static","___s":true},{"meta":{"filename":"ContainsArray.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Filters an array of point-like objects to only those contained within a triangle.\nIf `returnFirst` is true, will return an array containing only the first point in the provided array that is within the triangle (or an empty array if there are no such points).","kind":"function","name":"ContainsArray","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The triangle that the points are being checked in.","name":"triangle"},{"type":{"names":["Array."]},"description":"An array of point-like objects (objects that have an `x` and `y` property)","name":"points"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true`, return an array containing only the first point found that is within the triangle.","name":"returnFirst"},{"type":{"names":["array"]},"optional":true,"description":"If provided, the points that are within the triangle will be appended to this array instead of being added to a new array. If `returnFirst` is true, only the first point found within the triangle will be appended. This array will also be returned by this function.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing all the points from `points` that are within the triangle, if an array was provided as `out`, points will be appended to that array and it will also be returned here."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.ContainsArray","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Tests if a triangle contains a point.","kind":"function","name":"ContainsPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The triangle.","name":"triangle"},{"type":{"names":["Phaser.Geom.Point","Phaser.Math.Vector2","any"]},"description":"The point to test, or any point-like object with public `x` and `y` properties.","name":"point"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the point is within the triangle, otherwise `false`."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.ContainsPoint","scope":"static","___s":true},{"meta":{"filename":"CopyFrom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Copy the values of one Triangle to a destination Triangle.","kind":"function","name":"CopyFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The source Triangle to copy the values from.","name":"source"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The destination Triangle to copy the values to.","name":"dest"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The destination Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.CopyFrom","scope":"static","___s":true},{"meta":{"filename":"Decompose.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Decomposes a Triangle into an array of its points.","kind":"function","name":"Decompose","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to decompose.","name":"triangle"},{"type":{"names":["array"]},"optional":true,"description":"An array to store the points into.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"The provided `out` array, or a new array if none was provided, with three objects with `x` and `y` properties representing each point of the Triangle appended to it."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Decompose","scope":"static","___s":true},{"meta":{"filename":"Equals.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns true if two triangles have the same coordinates.","kind":"function","name":"Equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The first triangle to check.","name":"triangle"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The second triangle to check.","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two given triangles have the exact same coordinates, otherwise `false`."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Equals","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"GetPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoint.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns a Point from around the perimeter of a Triangle.","kind":"function","name":"GetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to get the point on its perimeter from.","name":"triangle"},{"type":{"names":["number"]},"description":"The position along the perimeter of the triangle. A value between 0 and 1.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An option Point, or Point-like object to store the value in. If not given a new Point will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object containing the given position from the perimeter of the triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.GetPoint","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"GetPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Length","longname":"Length","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoints.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns an array of evenly spaced points on the perimeter of a Triangle.","kind":"function","name":"GetPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to get the points from.","name":"triangle"},{"type":{"names":["integer"]},"description":"The number of evenly spaced points to return. Set to 0 to return an arbitrary number of points based on the `stepRate`.","name":"quantity"},{"type":{"names":["number"]},"description":"If `quantity` is 0, the distance between each returned point.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to which the points should be appended.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"The modified `out` array, or a new array if none was provided."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.GetPoints","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"InCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"InCenter.js","lineno":21,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Calculates the position of the incenter of a Triangle object. This is the point where its three angle bisectors meet and it's also the center of the incircle, which is the circle inscribed in the triangle.","kind":"function","name":"InCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to find the incenter of.","name":"triangle"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"An optional Point in which to store the coordinates.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"Point (x, y) of the center pixel of the triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.InCenter","scope":"static","___s":true},{"meta":{"filename":"Offset.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Moves each point (vertex) of a Triangle by a given offset, thus moving the entire Triangle by that offset.","kind":"function","name":"Offset","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to move.","name":"triangle"},{"type":{"names":["number"]},"description":"The horizontal offset (distance) by which to move each point. Can be positive or negative.","name":"x"},{"type":{"names":["number"]},"description":"The vertical offset (distance) by which to move each point. Can be positive or negative.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The modified Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Offset","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Perimeter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Length","longname":"Length","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Perimeter.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Gets the length of the perimeter of the given triangle.","kind":"function","name":"Perimeter","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"[description]","name":"triangle"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Perimeter","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Random.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Random.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"[description]","kind":"function","name":"Random","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"[description]","name":"triangle"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]"}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Random","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"Rotate.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"RotateAroundXY","longname":"RotateAroundXY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Rotate.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Rotates a Triangle about its incenter, which is the point at which its three angle bisectors meet.","kind":"function","name":"Rotate","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to rotate.","name":"triangle"},{"type":{"names":["number"]},"description":"The angle by which to rotate the Triangle, in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The rotated Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Rotate","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"RotateAroundPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"RotateAroundXY","longname":"RotateAroundXY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateAroundPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Rotates a Triangle at a certain angle about a given Point or object with public `x` and `y` properties.","kind":"function","name":"RotateAroundPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to rotate.","name":"triangle"},{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to rotate the Triangle about.","name":"point"},{"type":{"names":["number"]},"description":"The angle by which to rotate the Triangle, in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The rotated Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.RotateAroundPoint","scope":"static","___s":true},{"meta":{"filename":"RotateAroundXY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Rotates an entire Triangle at a given angle about a specific point.","kind":"function","name":"RotateAroundXY","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to rotate.","name":"triangle"},{"type":{"names":["number"]},"description":"The X coordinate of the point to rotate the Triangle about.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the point to rotate the Triangle about.","name":"y"},{"type":{"names":["number"]},"description":"The angle by which to rotate the Triangle, in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The rotated Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.RotateAroundXY","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Triangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Triangle.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"classdesc":"A triangle is a plane created by connecting three points.\nThe first two arguments specify the first point, the middle two arguments\nspecify the second point, and the last two arguments specify the third point.","kind":"class","name":"Triangle","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`x` coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`y` coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`x` coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`y` coordinate of the second point.","name":"y2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`x` coordinate of the third point.","name":"x3"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`y` coordinate of the third point.","name":"y3"}],"scope":"static","longname":"Phaser.Geom.Triangle","___s":true},{"meta":{"filename":"Triangle.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"The geometry constant type of this object: `GEOM_CONST.TRIANGLE`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"`x` coordinate of the first point.","name":"x1","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#x1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"`y` coordinate of the first point.","name":"y1","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#y1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"`x` coordinate of the second point.","name":"x2","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#x2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"`y` coordinate of the second point.","name":"y2","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#y2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"`x` coordinate of the third point.","name":"x3","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#x3","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"`y` coordinate of the third point.","name":"y3","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#y3","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":118,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Checks whether a given points lies within the triangle.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the point to check.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the point to check.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the coordinate pair is within the triangle, otherwise `false`."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#contains","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns a specific point on the triangle.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Position as float within `0` and `1`. `0` equals the first point.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"Optional Point, or point-like object, that the calculated point will be written to.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"Calculated `Point` that represents the requested position. It is the same as `output` when this parameter has been given."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#getPoint","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Calculates a list of evenly distributed points on the triangle. It is either possible to pass an amount of points to be generated (`quantity`) or the distance between two points (`stepRate`).","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"Number of points to be generated. Can be falsey when `stepRate` should be used. All points have the same distance along the triangle.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Distance between two points. Will only be used when `quantity` is falsey.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"Optional Array for writing the calculated points into. Otherwise a new array will be created.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"Returns a list of calculated `Point` instances or the filled array passed as parameter `output`."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":171,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns a random point along the triangle.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"Optional `Point` that should be modified. Otherwise a new one will be created.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"Random `Point`. When parameter `point` has been provided it will be returned."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Sets all three points of the triangle. Leaving out any coordinate sets it to be `0`.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`x` coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`y` coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`x` coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`y` coordinate of the second point.","name":"y2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`x` coordinate of the third point.","name":"x3"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`y` coordinate of the third point.","name":"y3"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"This Triangle object."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#setTo","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":224,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns a Line object that corresponds to Line A of this Triangle.","kind":"function","name":"getLineA","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to line A of this Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#getLineA","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns a Line object that corresponds to Line B of this Triangle.","kind":"function","name":"getLineB","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to line B of this Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#getLineB","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":266,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns a Line object that corresponds to Line C of this Triangle.","kind":"function","name":"getLineC","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to line C of this Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#getLineC","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Left most X coordinate of the triangle. Setting it moves the triangle on the X axis accordingly.","name":"left","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":325,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Right most X coordinate of the triangle. Setting it moves the triangle on the X axis accordingly.","name":"right","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":363,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Top most Y coordinate of the triangle. Setting it moves the triangle on the Y axis accordingly.","name":"top","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":401,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Bottom most Y coordinate of the triangle. Setting it moves the triangle on the Y axis accordingly.","name":"bottom","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,212],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Triangle","longname":"Triangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CreateInteractiveObject.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Creates a new Interactive Object.\n\nThis is called automatically by the Input Manager when you enable a Game Object for input.\n\nThe resulting Interactive Object is mapped to the Game Object's `input` property.","kind":"function","name":"CreateInteractiveObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to which this Interactive Object is bound.","name":"gameObject"},{"type":{"names":["any"]},"description":"The hit area for this Interactive Object. Typically a geometry shape, like a Rectangle or Circle.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"The 'contains' check callback that the hit area shape will use for all hit tests.","name":"hitAreaCallback"}],"returns":[{"type":{"names":["Phaser.Types.Input.InteractiveObject"]},"description":"The new Interactive Object."}],"memberof":"Phaser.Input","longname":"Phaser.Input.CreateInteractiveObject","scope":"static","___s":true},{"meta":{"filename":"CreatePixelPerfectHandler.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Creates a new Pixel Perfect Handler function.\n\nAccess via `InputPlugin.makePixelPerfect` rather than calling it directly.","kind":"function","name":"CreatePixelPerfectHandler","since":"3.10.0","params":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"A reference to the Texture Manager.","name":"textureManager"},{"type":{"names":["integer"]},"description":"The alpha level that the pixel should be above to be included as a successful interaction.","name":"alphaTolerance"}],"returns":[{"type":{"names":["function"]},"description":"The new Pixel Perfect Handler function."}],"memberof":"Phaser.Input","longname":"Phaser.Input.CreatePixelPerfectHandler","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"InputManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"InputManager.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"classdesc":"The Input Manager is responsible for handling the pointer related systems in a single Phaser Game instance.\n\nBased on the Game Config it will create handlers for mouse and touch support.\n\nKeyboard and Gamepad are plugins, handled directly by the InputPlugin class.\n\nIt then manages the events, pointer creation and general hit test related operations.\n\nYou rarely need to interact with the Input Manager directly, and as such, all of its properties and methods\nshould be considered private. Instead, you should use the Input Plugin, which is a Scene level system, responsible\nfor dealing with all input events for a Scene.","kind":"class","name":"InputManager","memberof":"Phaser.Input","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Game instance that owns the Input Manager.","name":"game"},{"type":{"names":["object"]},"description":"The Input Configuration object, as set in the Game Config.","name":"config"}],"scope":"static","longname":"Phaser.Input.InputManager","___s":true},{"meta":{"filename":"InputManager.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The Game instance that owns the Input Manager.\nA Game only maintains on instance of the Input Manager at any time.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the global Game Scale Manager.\nUsed for all bounds checks and pointer scaling.","name":"scaleManager","type":{"names":["Phaser.Scale.ScaleManager"]},"since":"3.16.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#scaleManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The Canvas that is used for all DOM event input listeners.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The Game Configuration object, as set during the game boot.","name":"config","type":{"names":["Phaser.Core.Config"]},"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If set, the Input Manager will run its update loop every frame.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The Event Emitter instance that the Input Manager uses to emit events from.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Are any mouse or touch pointers currently over the game canvas?\nThis is updated automatically by the canvas over and out handlers.","name":"isOver","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#isOver","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The default CSS cursor to be used when interacting with your game.\n\nSee the `setDefaultCursor` method for more details.","name":"defaultCursor","type":{"names":["string"]},"since":"3.10.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#defaultCursor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Keyboard Manager class, if enabled via the `input.keyboard` Game Config property.","name":"keyboard","type":{"names":["Phaser.Input.Keyboard.KeyboardManager"]},"nullable":true,"since":"3.16.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#keyboard","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Mouse Manager class, if enabled via the `input.mouse` Game Config property.","name":"mouse","type":{"names":["Phaser.Input.Mouse.MouseManager"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#mouse","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":145,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Touch Manager class, if enabled via the `input.touch` Game Config property.","name":"touch","type":{"names":["Phaser.Input.Touch.TouchManager"]},"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#touch","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":154,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"An array of Pointers that have been added to the game.\nThe first entry is reserved for the Mouse Pointer, the rest are Touch Pointers.\n\nBy default there is 1 touch pointer enabled. If you need more use the `addPointer` method to start them,\nor set the `input.activePointers` property in the Game Config.","name":"pointers","type":{"names":["Array."]},"since":"3.10.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#pointers","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The number of touch objects activated and being processed each update.\n\nYou can change this by either calling `addPointer` at run-time, or by\nsetting the `input.activePointers` property in the Game Config.","name":"pointersTotal","type":{"names":["integer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#pointersTotal","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":194,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The mouse has its own unique Pointer object, which you can reference directly if making a _desktop specific game_.\nIf you are supporting both desktop and touch devices then do not use this property, instead use `activePointer`\nwhich will always map to the most recently interacted pointer.","name":"mousePointer","type":{"names":["Phaser.Input.Pointer"]},"nullable":true,"since":"3.10.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#mousePointer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The most recently active Pointer object.\n\nIf you've only 1 Pointer in your game then this will accurately be either the first finger touched, or the mouse.\n\nIf your game doesn't need to support multi-touch then you can safely use this property in all of your game\ncode and it will adapt to be either the mouse or the touch, based on device.","name":"activePointer","type":{"names":["Phaser.Input.Pointer"]},"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#activePointer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":219,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the top-most Scene in the Scene List receives an input it will stop input from\npropagating any lower down the scene list, i.e. if you have a UI Scene at the top\nand click something on it, that click will not then be passed down to any other\nScene below. Disable this to have input events passed through all Scenes, all the time.","name":"globalTopOnly","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#globalTopOnly","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":232,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The time this Input Manager was last updated.\nThis value is populated by the Game Step each frame.","name":"time","type":{"names":["number"]},"readonly":true,"since":"3.16.2","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#time","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Tells the Input system to set a custom cursor.\n\nThis cursor will be the default cursor used when interacting with the game canvas.\n\nIf an Interactive Object also sets a custom cursor, this is the cursor that is reset after its use.\n\nAny valid CSS cursor value is allowed, including paths to image files, i.e.:\n\n```javascript\nthis.input.setDefaultCursor('url(assets/cursors/sword.cur), pointer');\n```\n\nPlease read about the differences between browsers when it comes to the file formats and sizes they support:\n\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/cursor\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/CSS_User_Interface/Using_URL_values_for_the_cursor_property\n\nIt's up to you to pick a suitable cursor format that works across the range of browsers you need to support.","kind":"function","name":"setDefaultCursor","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"The CSS to be used when setting the default cursor.","name":"cursor"}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#setDefaultCursor","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":467,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Adds new Pointer objects to the Input Manager.\n\nBy default Phaser creates 2 pointer objects: `mousePointer` and `pointer1`.\n\nYou can create more either by calling this method, or by setting the `input.activePointers` property\nin the Game Config, up to a maximum of 10 pointers.\n\nThe first 10 pointers are available via the `InputPlugin.pointerX` properties, once they have been added\nvia this method.","kind":"function","name":"addPointer","since":"3.10.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The number of new Pointers to create. A maximum of 10 is allowed in total.","name":"quantity"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing all of the new Pointer objects that were created."}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#addPointer","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":514,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Internal method that gets a list of all the active Input Plugins in the game\nand updates each of them in turn, in reverse order (top to bottom), to allow\nfor DOM top-level event handling simulation.","kind":"function","name":"updateInputPlugins","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The type of event to process.","name":"type"},{"type":{"names":["Array."]},"description":"An array of Pointers on which the event occurred.","name":"pointers"}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#updateInputPlugins","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":838,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Performs a hit test using the given Pointer and camera, against an array of interactive Game Objects.\n\nThe Game Objects are culled against the camera, and then the coordinates are translated into the local camera space\nand used to determine if they fall within the remaining Game Objects hit areas or not.\n\nIf nothing is matched an empty array is returned.\n\nThis method is called automatically by InputPlugin.hitTestPointer and doesn't usually need to be invoked directly.","kind":"function","name":"hitTest","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer to test against.","name":"pointer"},{"type":{"names":["array"]},"description":"An array of interactive Game Objects to check.","name":"gameObjects"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera which is being tested against.","name":"camera"},{"type":{"names":["array"]},"optional":true,"description":"An array to store the results in. If not given, a new empty array is created.","name":"output"}],"returns":[{"type":{"names":["array"]},"description":"An array of the Game Objects that were hit during this hit test."}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#hitTest","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":923,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks if the given x and y coordinate are within the hit area of the Game Object.\n\nThis method assumes that the coordinate values have already been translated into the space of the Game Object.\n\nIf the coordinates are within the hit area they are set into the Game Objects Input `localX` and `localY` properties.","kind":"function","name":"pointWithinHitArea","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object to check against.","name":"gameObject"},{"type":{"names":["number"]},"description":"The translated x coordinate for the hit test.","name":"x"},{"type":{"names":["number"]},"description":"The translated y coordinate for the hit test.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the coordinates were inside the Game Objects hit area, otherwise `false`."}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#pointWithinHitArea","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":960,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks if the given x and y coordinate are within the hit area of the Interactive Object.\n\nThis method assumes that the coordinate values have already been translated into the space of the Interactive Object.\n\nIf the coordinates are within the hit area they are set into the Interactive Objects Input `localX` and `localY` properties.","kind":"function","name":"pointWithinInteractiveObject","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InteractiveObject"]},"description":"The Interactive Object to check against.","name":"object"},{"type":{"names":["number"]},"description":"The translated x coordinate for the hit test.","name":"x"},{"type":{"names":["number"]},"description":"The translated y coordinate for the hit test.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the coordinates were inside the Game Objects hit area, otherwise `false`."}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#pointWithinInteractiveObject","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":993,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Transforms the pageX and pageY values of a Pointer into the scaled coordinate space of the Input Manager.","kind":"function","name":"transformPointer","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer to transform the values for.","name":"pointer"},{"type":{"names":["number"]},"description":"The Page X value.","name":"pageX"},{"type":{"names":["number"]},"description":"The Page Y value.","name":"pageY"},{"type":{"names":["boolean"]},"description":"Are we transforming the Pointer from a move event, or an up / down event?","name":"wasMove"}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#transformPointer","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":1033,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Destroys the Input Manager and all of its systems.\n\nThere is no way to recover from doing this.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#destroy","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"InputPlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"name":"Circle","longname":"Circle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"InputPlugin.js","lineno":29,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"classdesc":"The Input Plugin belongs to a Scene and handles all input related events and operations for it.\n\nYou can access it from within a Scene using `this.input`.\n\nIt emits events directly. For example, you can do:\n\n```javascript\nthis.input.on('pointerdown', callback, context);\n```\n\nTo listen for a pointer down event anywhere on the game canvas.\n\nGame Objects can be enabled for input by calling their `setInteractive` method. After which they\nwill directly emit input events:\n\n```javascript\nvar sprite = this.add.sprite(x, y, texture);\nsprite.setInteractive();\nsprite.on('pointerdown', callback, context);\n```\n\nThere are lots of game configuration options available relating to input.\nSee the [Input Config object]{@linkcode Phaser.Types.Core.InputConfig} for more details, including how to deal with Phaser\nlistening for input events outside of the canvas, how to set a default number of pointers, input\ncapture settings and more.\n\nPlease also see the Input examples and tutorials for further information.","kind":"class","name":"InputPlugin","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Input","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that this Input Plugin is responsible for.","name":"scene"}],"scope":"static","longname":"Phaser.Input.InputPlugin","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Scene that this Input Plugin is responsible for.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Scene Systems class.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Scene Systems Settings.","name":"settings","type":{"names":["Phaser.Types.Scenes.SettingsObject"]},"since":"3.5.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#settings","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Game Input Manager.","name":"manager","type":{"names":["Phaser.Input.InputManager"]},"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If `true` this Input Plugin will process DOM input events.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.5.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Scene Display List. This property is set during the `boot` method.","name":"displayList","type":{"names":["Phaser.GameObjects.DisplayList"]},"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#displayList","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Scene Cameras Manager. This property is set during the `boot` method.","name":"cameras","type":{"names":["Phaser.Cameras.Scene2D.CameraManager"]},"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#cameras","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":154,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Mouse Manager.\n\nThis property is only set if Mouse support has been enabled in your Game Configuration file.\n\nIf you just wish to get access to the mouse pointer, use the `mousePointer` property instead.","name":"mouse","type":{"names":["Phaser.Input.Mouse.MouseManager"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#mouse","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"When set to `true` (the default) the Input Plugin will emulate DOM behavior by only emitting events from\nthe top-most Game Objects in the Display List.\n\nIf set to `false` it will emit events from all Game Objects below a Pointer, not just the top one.","name":"topOnly","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#topOnly","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":180,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"How often should the Pointers be checked?\n\nThe value is a time, given in ms, and is the time that must have elapsed between game steps before\nthe Pointers will be polled again. When a pointer is polled it runs a hit test to see which Game\nObjects are currently below it, or being interacted with it.\n\nPointers will *always* be checked if they have been moved by the user, or press or released.\n\nThis property only controls how often they will be polled if they have not been updated.\nYou should set this if you want to have Game Objects constantly check against the pointers, even\nif the pointer didn't itself move.\n\nSet to 0 to poll constantly. Set to -1 to only poll on user movement.","name":"pollRate","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pollRate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":240,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The distance, in pixels, a pointer has to move while being held down, before it thinks it is being dragged.","name":"dragDistanceThreshold","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#dragDistanceThreshold","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":250,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The amount of time, in ms, a pointer has to be held down before it thinks it is dragging.\n\nThe default polling rate is to poll only on move so once the time threshold is reached the\ndrag event will not start until you move the mouse. If you want it to start immediately\nwhen the time threshold is reached, you must increase the polling rate by calling\n[setPollAlways]{@linkcode Phaser.Input.InputPlugin#setPollAlways} or\n[setPollRate]{@linkcode Phaser.Input.InputPlugin#setPollRate}.","name":"dragTimeThreshold","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#dragTimeThreshold","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":522,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if both this plugin and the Scene to which it belongs is active.","kind":"function","name":"isActive","since":"3.10.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the plugin and the Scene it belongs to is active."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#isActive","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":535,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"This is called automatically by the Input Manager.\nIt emits events for plugins to listen to and also handles polling updates, if enabled.","kind":"function","name":"updatePoll","since":"3.18.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the plugin and the Scene it belongs to is active."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#updatePoll","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":757,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Clears a Game Object so it no longer has an Interactive Object associated with it.\nThe Game Object is then queued for removal from the Input Plugin on the next update.","kind":"function","name":"clear","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will have its Interactive Object removed.","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip adding this Game Object into the removal queue?","name":"skipQueue"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that had its Interactive Object removed."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#clear","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":821,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Disables Input on a single Game Object.\n\nAn input disabled Game Object still retains its Interactive Object component and can be re-enabled\nat any time, by passing it to `InputPlugin.enable`.","kind":"function","name":"disable","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to have its input system disabled.","name":"gameObject"}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#disable","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":837,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Enable a Game Object for interaction.\n\nIf the Game Object already has an Interactive Object component, it is enabled and returned.\n\nOtherwise, a new Interactive Object component is created and assigned to the Game Object's `input` property.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"enable","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to be enabled for input.","name":"gameObject"},{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The 'contains' function to invoke to check if the pointer is within the hit area.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object a drop zone or not?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This Input Plugin."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#enable","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":887,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Takes the given Pointer and performs a hit test against it, to see which interactive Game Objects\nit is currently above.\n\nThe hit test is performed against which-ever Camera the Pointer is over. If it is over multiple\ncameras, it starts checking the camera at the top of the camera list, and if nothing is found, iterates down the list.","kind":"function","name":"hitTestPointer","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer to check against the Game Objects.","name":"pointer"}],"returns":[{"type":{"names":["Array."]},"description":"An array of all the interactive Game Objects the Pointer was above."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#hitTestPointer","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":1012,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Returns the drag state of the given Pointer for this Input Plugin.\n\nThe state will be one of the following:\n\n0 = Not dragging anything\n1 = Primary button down and objects below, so collect a draglist\n2 = Pointer being checked if meets drag criteria\n3 = Pointer meets criteria, notify the draglist\n4 = Pointer actively dragging the draglist and has moved\n5 = Pointer actively dragging but has been released, notify draglist","kind":"function","name":"getDragState","since":"3.16.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer to get the drag state for.","name":"pointer"}],"returns":[{"type":{"names":["integer"]},"description":"The drag state of the given Pointer."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#getDragState","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":1036,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the drag state of the given Pointer for this Input Plugin.\n\nThe state must be one of the following values:\n\n0 = Not dragging anything\n1 = Primary button down and objects below, so collect a draglist\n2 = Pointer being checked if meets drag criteria\n3 = Pointer meets criteria, notify the draglist\n4 = Pointer actively dragging the draglist and has moved\n5 = Pointer actively dragging but has been released, notify draglist","kind":"function","name":"setDragState","since":"3.16.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer to set the drag state for.","name":"pointer"},{"type":{"names":["integer"]},"description":"The drag state value. An integer between 0 and 5.","name":"state"}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setDragState","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2012,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the draggable state of the given array of Game Objects.\n\nThey can either be set to be draggable, or can have their draggable state removed by passing `false`.\n\nA Game Object will not fire drag events unless it has been specifically enabled for drag.","kind":"function","name":"setDraggable","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to change the draggable state on.","name":"gameObjects"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Set to `true` if the Game Objects should be made draggable, `false` if they should be unset.","name":"value"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setDraggable","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2057,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Creates a function that can be passed to `setInteractive`, `enable` or `setHitArea` that will handle\npixel-perfect input detection on an Image or Sprite based Game Object, or any custom class that extends them.\n\nThe following will create a sprite that is clickable on any pixel that has an alpha value >= 1.\n\n```javascript\nthis.add.sprite(x, y, key).setInteractive(this.input.makePixelPerfect());\n```\n\nThe following will create a sprite that is clickable on any pixel that has an alpha value >= 150.\n\n```javascript\nthis.add.sprite(x, y, key).setInteractive(this.input.makePixelPerfect(150));\n```\n\nOnce you have made an Interactive Object pixel perfect it impacts all input related events for it: down, up,\ndragstart, drag, etc.\n\nAs a pointer interacts with the Game Object it will constantly poll the texture, extracting a single pixel from\nthe given coordinates and checking its color values. This is an expensive process, so should only be enabled on\nGame Objects that really need it.\n\nYou cannot make non-texture based Game Objects pixel perfect. So this will not work on Graphics, BitmapText,\nRender Textures, Text, Tilemaps, Containers or Particles.","kind":"function","name":"makePixelPerfect","since":"3.10.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The alpha level that the pixel should be above to be included as a successful interaction.","name":"alphaTolerance"}],"returns":[{"type":{"names":["function"]},"description":"A Pixel Perfect Handler for use as a hitArea shape callback."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#makePixelPerfect","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2099,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the hit area for the given array of Game Objects.\n\nA hit area is typically one of the geometric shapes Phaser provides, such as a `Phaser.Geom.Rectangle`\nor `Phaser.Geom.Circle`. However, it can be any object as long as it works with the provided callback.\n\nIf no hit area is provided a Rectangle is created based on the size of the Game Object, if possible\nto calculate.\n\nThe hit area callback is the function that takes an `x` and `y` coordinate and returns a boolean if\nthose values fall within the area of the shape or not. All of the Phaser geometry objects provide this,\nsuch as `Phaser.Geom.Rectangle.Contains`.","kind":"function","name":"setHitArea","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to set the hit area on.","name":"gameObjects"},{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The 'contains' function to invoke to check if the pointer is within the hit area.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setHitArea","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2203,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Circle` shape, using\nthe given coordinates and radius to control its position and size.","kind":"function","name":"setHitAreaCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to set as having a circle hit area.","name":"gameObjects"},{"type":{"names":["number"]},"description":"The center of the circle.","name":"x"},{"type":{"names":["number"]},"description":"The center of the circle.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The hit area callback. If undefined it uses Circle.Contains.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setHitAreaCircle","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Ellipse` shape, using\nthe given coordinates and dimensions to control its position and size.","kind":"function","name":"setHitAreaEllipse","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to set as having an ellipse hit area.","name":"gameObjects"},{"type":{"names":["number"]},"description":"The center of the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The center of the ellipse.","name":"y"},{"type":{"names":["number"]},"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"description":"The height of the ellipse.","name":"height"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The hit area callback. If undefined it uses Ellipse.Contains.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setHitAreaEllipse","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Rectangle` shape, using\nthe Game Objects texture frame to define the position and size of the hit area.","kind":"function","name":"setHitAreaFromTexture","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to set as having an ellipse hit area.","name":"gameObjects"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The hit area callback. If undefined it uses Rectangle.Contains.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setHitAreaFromTexture","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Rectangle` shape, using\nthe given coordinates and dimensions to control its position and size.","kind":"function","name":"setHitAreaRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to set as having a rectangular hit area.","name":"gameObjects"},{"type":{"names":["number"]},"description":"The top-left of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The top-left of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"height"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The hit area callback. If undefined it uses Rectangle.Contains.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setHitAreaRectangle","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2335,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Triangle` shape, using\nthe given coordinates to control the position of its points.","kind":"function","name":"setHitAreaTriangle","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to set as having a triangular hit area.","name":"gameObjects"},{"type":{"names":["number"]},"description":"The x coordinate of the first point of the triangle.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point of the triangle.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point of the triangle.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point of the triangle.","name":"y2"},{"type":{"names":["number"]},"description":"The x coordinate of the third point of the triangle.","name":"x3"},{"type":{"names":["number"]},"description":"The y coordinate of the third point of the triangle.","name":"y3"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The hit area callback. If undefined it uses Triangle.Contains.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setHitAreaTriangle","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2362,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Creates an Input Debug Shape for the given Game Object.\n\nThe Game Object must have _already_ been enabled for input prior to calling this method.\n\nThis is intended to assist you during development and debugging.\n\nDebug Shapes can only be created for Game Objects that are using standard Phaser Geometry for input,\nincluding: Circle, Ellipse, Line, Polygon, Rectangle and Triangle.\n\nGame Objects that are using their automatic hit areas are using Rectangles by default, so will also work.\n\nThe Debug Shape is created and added to the display list and is then kept in sync with the Game Object\nit is connected with. Should you need to modify it yourself, such as to hide it, you can access it via\nthe Game Object property: `GameObject.input.hitAreaDebug`.\n\nCalling this method on a Game Object that already has a Debug Shape will first destroy the old shape,\nbefore creating a new one. If you wish to remove the Debug Shape entirely, you should call the\nmethod `InputPlugin.removeDebug`.\n\nNote that the debug shape will only show the outline of the input area. If the input test is using a\npixel perfect check, for example, then this is not displayed. If you are using a custom shape, that\ndoesn't extend one of the base Phaser Geometry objects, as your hit area, then this method will not\nwork.","kind":"function","name":"enableDebug","since":"3.19.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to create the input debug shape for.","name":"gameObject"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x00ff00","description":"The outline color of the debug shape.","name":"color"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This Input Plugin."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#enableDebug","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2479,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Removes an Input Debug Shape from the given Game Object.\n\nThe shape is destroyed immediately and the `hitAreaDebug` property is set to `null`.","kind":"function","name":"removeDebug","since":"3.19.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to remove the input debug shape from.","name":"gameObject"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This Input Plugin."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#removeDebug","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2509,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the Pointers to always poll.\n\nWhen a pointer is polled it runs a hit test to see which Game Objects are currently below it,\nor being interacted with it, regardless if the Pointer has actually moved or not.\n\nYou should enable this if you want objects in your game to fire over / out events, and the objects\nare constantly moving, but the pointer may not have. Polling every frame has additional computation\ncosts, especially if there are a large number of interactive objects in your game.","kind":"function","name":"setPollAlways","since":"3.0.0","returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setPollAlways","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the Pointers to only poll when they are moved or updated.\n\nWhen a pointer is polled it runs a hit test to see which Game Objects are currently below it,\nor being interacted with it.","kind":"function","name":"setPollOnMove","since":"3.0.0","returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setPollOnMove","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the poll rate value. This is the amount of time that should have elapsed before a pointer\nwill be polled again. See the `setPollAlways` and `setPollOnMove` methods.","kind":"function","name":"setPollRate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of time, in ms, that should elapsed before re-polling the pointers.","name":"value"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setPollRate","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2564,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"When set to `true` the global Input Manager will emulate DOM behavior by only emitting events from\nthe top-most Scene in the Scene List. By default, if a Scene receives an input event it will then stop the event\nfrom flowing down to any Scenes below it in the Scene list. To disable this behavior call this method with `false`.","kind":"function","name":"setGlobalTopOnly","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` to stop processing input events on the Scene that receives it, or `false` to let the event continue down the Scene list.","name":"value"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setGlobalTopOnly","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2583,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"When set to `true` this Input Plugin will emulate DOM behavior by only emitting events from\nthe top-most Game Objects in the Display List.\n\nIf set to `false` it will emit events from all Game Objects below a Pointer, not just the top one.","kind":"function","name":"setTopOnly","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to only include the top-most Game Object, or `false` to include all Game Objects in a hit test.","name":"value"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setTopOnly","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2603,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Given an array of Game Objects, sort the array and return it, so that the objects are in depth index order\nwith the lowest at the bottom.","kind":"function","name":"sortGameObjects","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of Game Objects to be sorted.","name":"gameObjects"}],"returns":[{"type":{"names":["Array."]},"description":"The sorted array of Game Objects."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#sortGameObjects","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2690,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"This method should be called from within an input event handler, such as `pointerdown`.\n\nWhen called, it stops the Input Manager from allowing _this specific event_ to be processed by any other Scene\nnot yet handled in the scene list.","kind":"function","name":"stopPropagation","since":"3.0.0","returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#stopPropagation","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2708,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Adds new Pointer objects to the Input Manager.\n\nBy default Phaser creates 2 pointer objects: `mousePointer` and `pointer1`.\n\nYou can create more either by calling this method, or by setting the `input.activePointers` property\nin the Game Config, up to a maximum of 10 pointers.\n\nThe first 10 pointers are available via the `InputPlugin.pointerX` properties, once they have been added\nvia this method.","kind":"function","name":"addPointer","since":"3.10.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The number of new Pointers to create. A maximum of 10 is allowed in total.","name":"quantity"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing all of the new Pointer objects that were created."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#addPointer","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2731,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Tells the Input system to set a custom cursor.\n\nThis cursor will be the default cursor used when interacting with the game canvas.\n\nIf an Interactive Object also sets a custom cursor, this is the cursor that is reset after its use.\n\nAny valid CSS cursor value is allowed, including paths to image files, i.e.:\n\n```javascript\nthis.input.setDefaultCursor('url(assets/cursors/sword.cur), pointer');\n```\n\nPlease read about the differences between browsers when it comes to the file formats and sizes they support:\n\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/cursor\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/CSS_User_Interface/Using_URL_values_for_the_cursor_property\n\nIt's up to you to pick a suitable cursor format that works across the range of browsers you need to support.","kind":"function","name":"setDefaultCursor","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"The CSS to be used when setting the default cursor.","name":"cursor"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This Input instance."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setDefaultCursor","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2873,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The x coordinates of the ActivePointer based on the first camera in the camera list.\nThis is only safe to use if your game has just 1 non-transformed camera and doesn't use multi-touch.","name":"x","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2891,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The y coordinates of the ActivePointer based on the first camera in the camera list.\nThis is only safe to use if your game has just 1 non-transformed camera and doesn't use multi-touch.","name":"y","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2909,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Are any mouse or touch pointers currently over the game canvas?","name":"isOver","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#isOver","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2926,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The mouse has its own unique Pointer object, which you can reference directly if making a _desktop specific game_.\nIf you are supporting both desktop and touch devices then do not use this property, instead use `activePointer`\nwhich will always map to the most recently interacted pointer.","name":"mousePointer","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#mousePointer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2945,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The current active input Pointer.","name":"activePointer","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#activePointer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2962,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer1","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2980,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer2","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2998,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer3","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer3","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3016,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer4","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer4","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3034,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer5","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer5","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3052,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer6","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer6","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3070,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer7","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer7","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer8","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer8","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer9","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer9","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3124,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer10","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer10","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,226],"filename":"InputPluginCache.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"name":"GetValue","longname":"GetValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"InputPluginCache.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"kind":"namespace","name":"InputPluginCache","memberof":"Phaser.Input","longname":"Phaser.Input.InputPluginCache","scope":"static","___s":true},{"meta":{"filename":"InputPluginCache.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Static method called directly by the Core internal Plugins.\nKey is a reference used to get the plugin from the plugins object (i.e. InputPlugin)\nPlugin is the object to instantiate to create the plugin\nMapping is what the plugin is injected into the Scene.Systems as (i.e. input)","kind":"function","name":"register","scope":"static","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"A reference used to get this plugin from the plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"The plugin to be stored. Should be the core object, not instantiated.","name":"plugin"},{"type":{"names":["string"]},"description":"If this plugin is to be injected into the Input Plugin, this is the property key used.","name":"mapping"},{"type":{"names":["string"]},"description":"The key in the Scene Settings to check to see if this plugin should install or not.","name":"settingsKey"},{"type":{"names":["string"]},"description":"The key in the Game Config to check to see if this plugin should install or not.","name":"configKey"}],"memberof":"Phaser.Input.InputPluginCache","longname":"Phaser.Input.InputPluginCache.register","___s":true},{"meta":{"filename":"InputPluginCache.js","lineno":40,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Returns the input plugin object from the cache based on the given key.","kind":"function","name":"getCore","scope":"static","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"The key of the input plugin to get.","name":"key"}],"returns":[{"type":{"names":["Phaser.Types.Input.InputPluginContainer"]},"description":"The input plugin object."}],"memberof":"Phaser.Input.InputPluginCache","longname":"Phaser.Input.InputPluginCache.getCore","___s":true},{"meta":{"filename":"InputPluginCache.js","lineno":56,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Installs all of the registered Input Plugins into the given target.","kind":"function","name":"install","scope":"static","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"The target InputPlugin to install the plugins into.","name":"target"}],"memberof":"Phaser.Input.InputPluginCache","longname":"Phaser.Input.InputPluginCache.install","___s":true},{"meta":{"filename":"InputPluginCache.js","lineno":85,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Removes an input plugin based on the given key.","kind":"function","name":"remove","scope":"static","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"The key of the input plugin to remove.","name":"key"}],"memberof":"Phaser.Input.InputPluginCache","longname":"Phaser.Input.InputPluginCache.remove","___s":true},{"meta":{"range":[180,220],"filename":"Pointer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"name":"Angle","longname":"Angle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Pointer.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"classdesc":"A Pointer object encapsulates both mouse and touch input within Phaser.\n\nBy default, Phaser will create 2 pointers for your game to use. If you require more, i.e. for a multi-touch\ngame, then use the `InputPlugin.addPointer` method to do so, rather than instantiating this class directly,\notherwise it won't be managed by the input system.\n\nYou can reference the current active pointer via `InputPlugin.activePointer`. You can also use the properties\n`InputPlugin.pointer1` through to `pointer10`, for each pointer you have enabled in your game.\n\nThe properties of this object are set by the Input Plugin during processing. This object is then sent in all\ninput related events that the Input Plugin emits, so you can reference properties from it directly in your\ncallbacks.","kind":"class","name":"Pointer","memberof":"Phaser.Input","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.InputManager"]},"description":"A reference to the Input Manager.","name":"manager"},{"type":{"names":["integer"]},"description":"The internal ID of this Pointer.","name":"id"}],"scope":"static","longname":"Phaser.Input.Pointer","___s":true},{"meta":{"filename":"Pointer.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Input Manager.","name":"manager","type":{"names":["Phaser.Input.InputManager"]},"since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The internal ID of this Pointer.","name":"id","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#id","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The most recent native DOM Event this Pointer has processed.","name":"event","type":{"names":["TouchEvent","MouseEvent"]},"since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#event","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The DOM element the Pointer was pressed down on, taken from the DOM event.\nIn a default set-up this will be the Canvas that Phaser is rendering to, or the Window element.","name":"downElement","type":{"names":["any"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#downElement","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The DOM element the Pointer was released on, taken from the DOM event.\nIn a default set-up this will be the Canvas that Phaser is rendering to, or the Window element.","name":"upElement","type":{"names":["any"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#upElement","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The camera the Pointer interacted with during its last update.\n\nA Pointer can only ever interact with one camera at once, which will be the top-most camera\nin the list should multiple cameras be positioned on-top of each other.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A read-only property that indicates which button was pressed, or released, on the pointer\nduring the most recent event. It is only set during `up` and `down` events.\n\nOn Touch devices the value is always 0.\n\nUsers may change the configuration of buttons on their pointing device so that if an event's button property\nis zero, it may not have been caused by the button that is physically left–most on the pointing device;\nhowever, it should behave as if the left button was clicked in the standard button layout.","name":"button","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.18.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#button","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"0: No button or un-initialized\n1: Left button\n2: Right button\n4: Wheel button or middle button\n8: 4th button (typically the \"Browser Back\" button)\n16: 5th button (typically the \"Browser Forward\" button)\n\nFor a mouse configured for left-handed use, the button actions are reversed.\nIn this case, the values are read from right to left.","name":"buttons","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#buttons","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The position of the Pointer in screen space.","name":"position","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#position","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The previous position of the Pointer in screen space.\n\nThe old x and y values are stored in here during the InputManager.transformPointer call.\n\nUse the properties `velocity`, `angle` and `distance` to create your own gesture recognition.","name":"prevPosition","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#prevPosition","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":176,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The current velocity of the Pointer, based on its current and previous positions.\n\nThis value is smoothed out each frame, according to the `motionFactor` property.\n\nThis property is updated whenever the Pointer moves, regardless of any button states. In other words,\nit changes based on movement alone - a button doesn't have to be pressed first.","name":"velocity","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#velocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":191,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The current angle the Pointer is moving, in radians, based on its previous and current position.\n\nThe angle is based on the old position facing to the current position.\n\nThis property is updated whenever the Pointer moves, regardless of any button states. In other words,\nit changes based on movement alone - a button doesn't have to be pressed first.","name":"angle","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":206,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The distance the Pointer has moved, based on its previous and current position.\n\nThis value is smoothed out each frame, according to the `motionFactor` property.\n\nThis property is updated whenever the Pointer moves, regardless of any button states. In other words,\nit changes based on movement alone - a button doesn't have to be pressed first.\n\nIf you need the total distance travelled since the primary buttons was pressed down,\nthen use the `Pointer.getDistance` method.","name":"distance","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#distance","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":224,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The smoothing factor to apply to the Pointer position.\n\nDue to their nature, pointer positions are inherently noisy. While this is fine for lots of games, if you need cleaner positions\nthen you can set this value to apply an automatic smoothing to the positions as they are recorded.\n\nThe default value of zero means 'no smoothing'.\nSet to a small value, such as 0.2, to apply an average level of smoothing between positions. You can do this by changing this\nvalue directly, or by setting the `input.smoothFactor` property in the Game Config.\n\nPositions are only smoothed when the pointer moves. If the primary button on this Pointer enters an Up or Down state, then the position\nis always precise, and not smoothed.","name":"smoothFactor","type":{"names":["number"]},"defaultvalue":"0","since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#smoothFactor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":244,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The factor applied to the motion smoothing each frame.\n\nThis value is passed to the Smooth Step Interpolation that is used to calculate the velocity,\nangle and distance of the Pointer. It's applied every frame, until the midPoint reaches the current\nposition of the Pointer. 0.2 provides a good average but can be increased if you need a\nquicker update and are working in a high performance environment. Never set this value to\nzero.","name":"motionFactor","type":{"names":["number"]},"defaultvalue":"0.2","since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#motionFactor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":260,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The x position of this Pointer, translated into the coordinate space of the most recent Camera it interacted with.\n\nIf you wish to use this value _outside_ of an input event handler then you should update it first by calling\nthe `Pointer.updateWorldPoint` method.","name":"worldX","type":{"names":["number"]},"defaultvalue":"0","since":"3.10.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#worldX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The y position of this Pointer, translated into the coordinate space of the most recent Camera it interacted with.\n\nIf you wish to use this value _outside_ of an input event handler then you should update it first by calling\nthe `Pointer.updateWorldPoint` method.","name":"worldY","type":{"names":["number"]},"defaultvalue":"0","since":"3.10.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#worldY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":286,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Time when this Pointer was most recently moved (regardless of the state of its buttons, if any)","name":"moveTime","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#moveTime","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":296,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"X coordinate of the Pointer when Button 1 (left button), or Touch, was pressed, used for dragging objects.","name":"downX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#downX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":306,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Y coordinate of the Pointer when Button 1 (left button), or Touch, was pressed, used for dragging objects.","name":"downY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#downY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":316,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Time when Button 1 (left button), or Touch, was pressed, used for dragging objects.","name":"downTime","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#downTime","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":326,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"X coordinate of the Pointer when Button 1 (left button), or Touch, was released, used for dragging objects.","name":"upX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#upX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":336,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Y coordinate of the Pointer when Button 1 (left button), or Touch, was released, used for dragging objects.","name":"upY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#upY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":346,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Time when Button 1 (left button), or Touch, was released, used for dragging objects.","name":"upTime","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#upTime","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":356,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Is the primary button down? (usually button 0, the left mouse button)","name":"primaryDown","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#primaryDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":366,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Is _any_ button on this pointer considered as being down?","name":"isDown","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#isDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":376,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Did the previous input event come from a Touch input (true) or Mouse? (false)","name":"wasTouch","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#wasTouch","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":386,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Did this Pointer get canceled by a touchcancel event?\n\nNote: \"canceled\" is the American-English spelling of \"cancelled\". Please don't submit PRs correcting it!","name":"wasCanceled","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.15.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#wasCanceled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":398,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the mouse is locked, the horizontal relative movement of the Pointer in pixels since last frame.","name":"movementX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#movementX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":408,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the mouse is locked, the vertical relative movement of the Pointer in pixels since last frame.","name":"movementY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#movementY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":418,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The identifier property of the Pointer as set by the DOM event when this Pointer is started.","name":"identifier","type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#identifier","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":427,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The pointerId property of the Pointer as set by the DOM event when this Pointer is started.\nThe browser can and will recycle this value.","name":"pointerId","type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#pointerId","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":437,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"An active Pointer is one that is currently pressed down on the display.\nA Mouse is always considered as active.","name":"active","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":447,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Is this pointer Pointer Locked?\n\nOnly a mouse pointer can be locked and it only becomes locked when requested via\nthe browsers Pointer Lock API.\n\nYou can request this by calling the `this.input.mouse.requestPointerLock()` method from\na `pointerdown` or `pointerup` event handler.","name":"locked","readonly":true,"type":{"names":["boolean"]},"since":"3.19.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#locked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":463,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaX","type":{"names":["number"]},"defaultvalue":"0","since":"3.18.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#deltaX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":473,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The vertical scroll amount that occurred due to the user moving a mouse wheel or similar input device.\nThis value will typically be less than 0 if the user scrolls up and greater than zero if scrolling down.","name":"deltaY","type":{"names":["number"]},"defaultvalue":"0","since":"3.18.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#deltaY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":484,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The z-axis scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaZ","type":{"names":["number"]},"defaultvalue":"0","since":"3.18.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#deltaZ","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":495,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Takes a Camera and updates this Pointer's `worldX` and `worldY` values so they are\nthe result of a translation through the given Camera.\n\nNote that the values will be automatically replaced the moment the Pointer is\nupdated by an input event, such as a mouse move, so should be used immediately.","kind":"function","name":"updateWorldPoint","since":"3.19.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera which is being tested against.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"This Pointer object."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#updateWorldPoint","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Takes a Camera and returns a Vector2 containing the translated position of this Pointer\nwithin that Camera. This can be used to convert this Pointers position into camera space.","kind":"function","name":"positionToCamera","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to use for the translation.","name":"camera"},{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"A Vector2-like object in which to store the translated position.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"A Vector2 containing the translated coordinates of this Pointer, based on the given camera."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#positionToCamera","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":870,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if any buttons are being held down on this Pointer.","kind":"function","name":"noButtonDown","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if no buttons are being held down."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#noButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":883,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the left button is being held down on this Pointer.","kind":"function","name":"leftButtonDown","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the left button is being held down."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#leftButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":896,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the right button is being held down on this Pointer.","kind":"function","name":"rightButtonDown","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the right button is being held down."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#rightButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":909,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the middle button is being held down on this Pointer.","kind":"function","name":"middleButtonDown","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the middle button is being held down."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#middleButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":922,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the back button is being held down on this Pointer.","kind":"function","name":"backButtonDown","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the back button is being held down."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#backButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":935,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the forward button is being held down on this Pointer.","kind":"function","name":"forwardButtonDown","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the forward button is being held down."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#forwardButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":948,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the left button was just released on this Pointer.","kind":"function","name":"leftButtonReleased","since":"3.18.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the left button was just released."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#leftButtonReleased","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":961,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the right button was just released on this Pointer.","kind":"function","name":"rightButtonReleased","since":"3.18.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the right button was just released."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#rightButtonReleased","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":974,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the middle button was just released on this Pointer.","kind":"function","name":"middleButtonReleased","since":"3.18.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the middle button was just released."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#middleButtonReleased","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":987,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the back button was just released on this Pointer.","kind":"function","name":"backButtonReleased","since":"3.18.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the back button was just released."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#backButtonReleased","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1000,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the forward button was just released on this Pointer.","kind":"function","name":"forwardButtonReleased","since":"3.18.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the forward button was just released."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#forwardButtonReleased","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1013,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the Pointer has a button pressed down at the time this method is called, it will return the\ndistance between the Pointer's `downX` and `downY` values and the current position.\n\nIf no button is held down, it will return the last recorded distance, based on where\nthe Pointer was when the button was released.\n\nIf you wish to get the distance being travelled currently, based on the velocity of the Pointer,\nthen see the `Pointer.distance` property.","kind":"function","name":"getDistance","since":"3.13.0","returns":[{"type":{"names":["number"]},"description":"The distance the Pointer moved."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#getDistance","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1040,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the Pointer has a button pressed down at the time this method is called, it will return the\nhorizontal distance between the Pointer's `downX` and `downY` values and the current position.\n\nIf no button is held down, it will return the last recorded horizontal distance, based on where\nthe Pointer was when the button was released.","kind":"function","name":"getDistanceX","since":"3.16.0","returns":[{"type":{"names":["number"]},"description":"The horizontal distance the Pointer moved."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#getDistanceX","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1064,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the Pointer has a button pressed down at the time this method is called, it will return the\nvertical distance between the Pointer's `downX` and `downY` values and the current position.\n\nIf no button is held down, it will return the last recorded vertical distance, based on where\nthe Pointer was when the button was released.","kind":"function","name":"getDistanceY","since":"3.16.0","returns":[{"type":{"names":["number"]},"description":"The vertical distance the Pointer moved."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#getDistanceY","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the Pointer has a button pressed down at the time this method is called, it will return the\nduration since the button was pressed down.\n\nIf no button is held down, it will return the last recorded duration, based on the time\nthe Pointer button was released.","kind":"function","name":"getDuration","since":"3.16.0","returns":[{"type":{"names":["number"]},"description":"The duration the Pointer was held down for in milliseconds."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#getDuration","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1112,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the Pointer has a button pressed down at the time this method is called, it will return the\nangle between the Pointer's `downX` and `downY` values and the current position.\n\nIf no button is held down, it will return the last recorded angle, based on where\nthe Pointer was when the button was released.\n\nThe angle is based on the old position facing to the current position.\n\nIf you wish to get the current angle, based on the velocity of the Pointer, then\nsee the `Pointer.angle` property.","kind":"function","name":"getAngle","since":"3.16.0","returns":[{"type":{"names":["number"]},"description":"The angle between the Pointer's coordinates in radians."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#getAngle","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1141,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Takes the previous and current Pointer positions and then generates an array of interpolated values between\nthe two. The array will be populated up to the size of the `steps` argument.\n\n```javaScript\nvar points = pointer.getInterpolatedPosition(4);\n\n// points[0] = { x: 0, y: 0 }\n// points[1] = { x: 2, y: 1 }\n// points[2] = { x: 3, y: 2 }\n// points[3] = { x: 6, y: 3 }\n```\n\nUse this if you need to get smoothed values between the previous and current pointer positions. DOM pointer\nevents can often fire faster than the main browser loop, and this will help you avoid janky movement\nespecially if you have an object following a Pointer.\n\nNote that if you provide an output array it will only be populated up to the number of steps provided.\nIt will not clear any previous data that may have existed beyond the range of the steps count.\n\nInternally it uses the Smooth Step interpolation calculation.","kind":"function","name":"getInterpolatedPosition","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The number of interpolation steps to use.","name":"steps"},{"type":{"names":["array"]},"optional":true,"description":"An array to store the results in. If not provided a new one will be created.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array of interpolated values."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#getInterpolatedPosition","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1192,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Destroys this Pointer instance and resets its external references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#destroy","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1205,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The x position of this Pointer.\nThe value is in screen space.\nSee `worldX` to get a camera converted position.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":1228,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The y position of this Pointer.\nThe value is in screen space.\nSee `worldY` to get a camera converted position.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":1251,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Time when this Pointer was most recently updated by a DOM Event.\nThis comes directly from the `event.timeStamp` property.\nIf no event has yet taken place, it will return zero.","name":"time","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#time","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,1721],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"name":"INPUT_CONST","longname":"INPUT_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The mouse pointer is being held down.","name":"MOUSE_DOWN","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.MOUSE_DOWN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The mouse pointer is being moved.","name":"MOUSE_MOVE","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.MOUSE_MOVE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The mouse pointer is released.","name":"MOUSE_UP","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.MOUSE_UP","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch pointer has been started.","name":"TOUCH_START","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.TOUCH_START","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch pointer has been started.","name":"TOUCH_MOVE","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.TOUCH_MOVE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch pointer has been started.","name":"TOUCH_END","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.TOUCH_END","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The pointer lock has changed.","name":"POINTER_LOCK_CHANGE","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.POINTER_LOCK_CHANGE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch pointer has been been cancelled by the browser.","name":"TOUCH_CANCEL","type":{"names":["integer"]},"since":"3.15.0","memberof":"Phaser.Input","longname":"Phaser.Input.TOUCH_CANCEL","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The mouse wheel changes.","name":"MOUSE_WHEEL","type":{"names":["integer"]},"since":"3.18.0","memberof":"Phaser.Input","longname":"Phaser.Input.MOUSE_WHEEL","scope":"static","kind":"member","___s":true},{"meta":{"filename":"BOOT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Boot Event.\n\nThis internal event is dispatched by the Input Plugin when it boots, signalling to all of its systems to create themselves.","kind":"event","name":"BOOT","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:BOOT","scope":"instance","___s":true},{"meta":{"filename":"DESTROY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Destroy Event.\n\nThis internal event is dispatched by the Input Plugin when it is destroyed, signalling to all of its systems to destroy themselves.","kind":"event","name":"DESTROY","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DESTROY","scope":"instance","___s":true},{"meta":{"filename":"DRAG_END_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drag End Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer stops dragging a Game Object.\n\nListen to this event from within a Scene using: `this.input.on('dragend', listener)`.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_END]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_END} event instead.","kind":"event","name":"DRAG_END","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer stopped dragging.","name":"gameObject"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DRAG_END","scope":"instance","___s":true},{"meta":{"filename":"DRAG_ENTER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drag Enter Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object into a Drag Target.\n\nListen to this event from within a Scene using: `this.input.on('dragenter', listener)`.\n\nA Pointer can only drag a single Game Object at once.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_ENTER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_ENTER} event instead.","kind":"event","name":"DRAG_ENTER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer is dragging.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The drag target that this pointer has moved into.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DRAG_ENTER","scope":"instance","___s":true},{"meta":{"filename":"DRAG_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drag Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves while dragging a Game Object.\n\nListen to this event from within a Scene using: `this.input.on('drag', listener)`.\n\nA Pointer can only drag a single Game Object at once.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG} event instead.","kind":"event","name":"DRAG","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer is dragging.","name":"gameObject"},{"type":{"names":["number"]},"description":"The x coordinate where the Pointer is currently dragging the Game Object, in world space.","name":"dragX"},{"type":{"names":["number"]},"description":"The y coordinate where the Pointer is currently dragging the Game Object, in world space.","name":"dragY"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DRAG","scope":"instance","___s":true},{"meta":{"filename":"DRAG_LEAVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drag Leave Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object out of a Drag Target.\n\nListen to this event from within a Scene using: `this.input.on('dragleave', listener)`.\n\nA Pointer can only drag a single Game Object at once.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_LEAVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_LEAVE} event instead.","kind":"event","name":"DRAG_LEAVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer is dragging.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The drag target that this pointer has left.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DRAG_LEAVE","scope":"instance","___s":true},{"meta":{"filename":"DRAG_OVER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drag Over Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object over a Drag Target.\n\nWhen the Game Object first enters the drag target it will emit a `dragenter` event. If it then moves while within\nthe drag target, it will emit this event instead.\n\nListen to this event from within a Scene using: `this.input.on('dragover', listener)`.\n\nA Pointer can only drag a single Game Object at once.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_OVER} event instead.","kind":"event","name":"DRAG_OVER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer is dragging.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The drag target that this pointer has moved over.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DRAG_OVER","scope":"instance","___s":true},{"meta":{"filename":"DRAG_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drag Start Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer starts to drag any Game Object.\n\nListen to this event from within a Scene using: `this.input.on('dragstart', listener)`.\n\nA Pointer can only drag a single Game Object at once.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_START]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_START} event instead.","kind":"event","name":"DRAG_START","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer is dragging.","name":"gameObject"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DRAG_START","scope":"instance","___s":true},{"meta":{"filename":"DROP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drop Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer drops a Game Object on a Drag Target.\n\nListen to this event from within a Scene using: `this.input.on('drop', listener)`.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DROP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DROP} event instead.","kind":"event","name":"DROP","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer was dragging.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Drag Target the `gameObject` has been dropped on.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DROP","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Down Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down on _any_ interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('gameobjectdown', listener)`.\n\nTo receive this event, the Game Objects must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN} event instead.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\n2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\n3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_DOWN","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the pointer was pressed down on.","name":"gameObject"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DOWN","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DRAG_END_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drag End Event.\n\nThis event is dispatched by an interactive Game Object if a pointer stops dragging it.\n\nListen to this event from a Game Object using: `gameObject.on('dragend', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive](Phaser.GameObjects.GameObject#setInteractive) for more details.","kind":"event","name":"GAMEOBJECT_DRAG_END","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate where the Pointer stopped dragging the Game Object, in world space.","name":"dragX"},{"type":{"names":["number"]},"description":"The y coordinate where the Pointer stopped dragging the Game Object, in world space.","name":"dragY"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DRAG_END","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DRAG_ENTER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drag Enter Event.\n\nThis event is dispatched by an interactive Game Object if a pointer drags it into a drag target.\n\nListen to this event from a Game Object using: `gameObject.on('dragenter', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.","kind":"event","name":"GAMEOBJECT_DRAG_ENTER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The drag target that this pointer has moved into.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DRAG_ENTER","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DRAG_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drag Event.\n\nThis event is dispatched by an interactive Game Object if a pointer moves while dragging it.\n\nListen to this event from a Game Object using: `gameObject.on('drag', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.","kind":"event","name":"GAMEOBJECT_DRAG","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate where the Pointer is currently dragging the Game Object, in world space.","name":"dragX"},{"type":{"names":["number"]},"description":"The y coordinate where the Pointer is currently dragging the Game Object, in world space.","name":"dragY"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DRAG","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DRAG_LEAVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drag Leave Event.\n\nThis event is dispatched by an interactive Game Object if a pointer drags it out of a drag target.\n\nListen to this event from a Game Object using: `gameObject.on('dragleave', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.","kind":"event","name":"GAMEOBJECT_DRAG_LEAVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The drag target that this pointer has left.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DRAG_LEAVE","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DRAG_OVER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drag Over Event.\n\nThis event is dispatched by an interactive Game Object if a pointer drags it over a drag target.\n\nWhen the Game Object first enters the drag target it will emit a `dragenter` event. If it then moves while within\nthe drag target, it will emit this event instead.\n\nListen to this event from a Game Object using: `gameObject.on('dragover', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.","kind":"event","name":"GAMEOBJECT_DRAG_OVER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The drag target that this pointer has moved over.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DRAG_OVER","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DRAG_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drag Start Event.\n\nThis event is dispatched by an interactive Game Object if a pointer starts to drag it.\n\nListen to this event from a Game Object using: `gameObject.on('dragstart', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThere are lots of useful drag related properties that are set within the Game Object when dragging occurs.\nFor example, `gameObject.input.dragStartX`, `dragStartY` and so on.","kind":"event","name":"GAMEOBJECT_DRAG_START","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate where the Pointer is currently dragging the Game Object, in world space.","name":"dragX"},{"type":{"names":["number"]},"description":"The y coordinate where the Pointer is currently dragging the Game Object, in world space.","name":"dragY"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DRAG_START","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DROP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drop Event.\n\nThis event is dispatched by an interactive Game Object if a pointer drops it on a Drag Target.\n\nListen to this event from a Game Object using: `gameObject.on('drop', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.","kind":"event","name":"GAMEOBJECT_DROP","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Drag Target the `gameObject` has been dropped on.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DROP","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_MOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Move Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is moved across _any_ interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('gameobjectmove', listener)`.\n\nTo receive this event, the Game Objects must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE} event instead.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE}\n2. [GAMEOBJECT_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_MOVE}\n3. [POINTER_MOVE]{@linkcode Phaser.Input.Events#event:POINTER_MOVE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_MOVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the pointer was moved on.","name":"gameObject"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_MOVE","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_OUT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Out Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves out of _any_ interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('gameobjectout', listener)`.\n\nTo receive this event, the Game Objects must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT} event instead.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT}\n2. [GAMEOBJECT_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OUT}\n3. [POINTER_OUT]{@linkcode Phaser.Input.Events#event:POINTER_OUT}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_OUT","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the pointer moved out of.","name":"gameObject"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_OUT","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_OVER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Over Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves over _any_ interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('gameobjectover', listener)`.\n\nTo receive this event, the Game Objects must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER} event instead.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER}\n2. [GAMEOBJECT_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OVER}\n3. [POINTER_OVER]{@linkcode Phaser.Input.Events#event:POINTER_OVER}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_OVER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the pointer moved over.","name":"gameObject"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_OVER","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_POINTER_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Pointer Down Event.\n\nThis event is dispatched by an interactive Game Object if a pointer is pressed down on it.\n\nListen to this event from a Game Object using: `gameObject.on('pointerdown', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\n2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\n3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_POINTER_DOWN","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localX"},{"type":{"names":["number"]},"description":"The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localY"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_POINTER_MOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Pointer Move Event.\n\nThis event is dispatched by an interactive Game Object if a pointer is moved while over it.\n\nListen to this event from a Game Object using: `gameObject.on('pointermove', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE}\n2. [GAMEOBJECT_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_MOVE}\n3. [POINTER_MOVE]{@linkcode Phaser.Input.Events#event:POINTER_MOVE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_POINTER_MOVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localX"},{"type":{"names":["number"]},"description":"The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localY"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_POINTER_OUT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Pointer Out Event.\n\nThis event is dispatched by an interactive Game Object if a pointer moves out of it.\n\nListen to this event from a Game Object using: `gameObject.on('pointerout', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT}\n2. [GAMEOBJECT_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OUT}\n3. [POINTER_OUT]{@linkcode Phaser.Input.Events#event:POINTER_OUT}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_POINTER_OUT","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_POINTER_OVER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Pointer Over Event.\n\nThis event is dispatched by an interactive Game Object if a pointer moves over it.\n\nListen to this event from a Game Object using: `gameObject.on('pointerover', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER}\n2. [GAMEOBJECT_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OVER}\n3. [POINTER_OVER]{@linkcode Phaser.Input.Events#event:POINTER_OVER}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_POINTER_OVER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localX"},{"type":{"names":["number"]},"description":"The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localY"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_POINTER_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Pointer Up Event.\n\nThis event is dispatched by an interactive Game Object if a pointer is released while over it.\n\nListen to this event from a Game Object using: `gameObject.on('pointerup', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\n2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\n3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_POINTER_UP","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localX"},{"type":{"names":["number"]},"description":"The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localY"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_POINTER_WHEEL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Pointer Wheel Event.\n\nThis event is dispatched by an interactive Game Object if a pointer has its wheel moved while over it.\n\nListen to this event from a Game Object using: `gameObject.on('wheel', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL}\n2. [GAMEOBJECT_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_WHEEL}\n3. [POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:POINTER_WHEEL}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_POINTER_WHEEL","since":"3.18.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaX"},{"type":{"names":["number"]},"description":"The vertical scroll amount that occurred due to the user moving a mouse wheel or similar input device. This value will typically be less than 0 if the user scrolls up and greater than zero if scrolling down.","name":"deltaY"},{"type":{"names":["number"]},"description":"The z-axis scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaZ"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Up Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is released while over _any_ interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('gameobjectup', listener)`.\n\nTo receive this event, the Game Objects must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP} event instead.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\n2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\n3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_UP","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the pointer was over when released.","name":"gameObject"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_UP","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_WHEEL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Wheel Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer has its wheel moved while over _any_ interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('gameobjectwheel', listener)`.\n\nTo receive this event, the Game Objects must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL} event instead.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL}\n2. [GAMEOBJECT_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_WHEEL}\n3. [POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:POINTER_WHEEL}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_WHEEL","since":"3.18.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the pointer was over when the wheel changed.","name":"gameObject"},{"type":{"names":["number"]},"description":"The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaX"},{"type":{"names":["number"]},"description":"The vertical scroll amount that occurred due to the user moving a mouse wheel or similar input device. This value will typically be less than 0 if the user scrolls up and greater than zero if scrolling down.","name":"deltaY"},{"type":{"names":["number"]},"description":"The z-axis scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaZ"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_WHEEL","scope":"instance","___s":true},{"meta":{"filename":"GAME_OUT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Game Out Event.\n\nThis event is dispatched by the Input Plugin if the active pointer leaves the game canvas and is now\noutside of it, elsewhere on the web page.\n\nListen to this event from within a Scene using: `this.input.on('gameout', listener)`.","kind":"event","name":"GAME_OUT","since":"3.16.1","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["MouseEvent","TouchEvent"]},"description":"The DOM Event that triggered the canvas out.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAME_OUT","scope":"instance","___s":true},{"meta":{"filename":"GAME_OVER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Game Over Event.\n\nThis event is dispatched by the Input Plugin if the active pointer enters the game canvas and is now\nover of it, having previously been elsewhere on the web page.\n\nListen to this event from within a Scene using: `this.input.on('gameover', listener)`.","kind":"event","name":"GAME_OVER","since":"3.16.1","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["MouseEvent","TouchEvent"]},"description":"The DOM Event that triggered the canvas over.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAME_OVER","scope":"instance","___s":true},{"meta":{"filename":"MANAGER_BOOT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Manager Boot Event.\n\nThis internal event is dispatched by the Input Manager when it boots.","kind":"event","name":"MANAGER_BOOT","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:MANAGER_BOOT","scope":"instance","___s":true},{"meta":{"filename":"MANAGER_PROCESS_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Manager Process Event.\n\nThis internal event is dispatched by the Input Manager when not using the legacy queue system,\nand it wants the Input Plugins to update themselves.","kind":"event","name":"MANAGER_PROCESS","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:MANAGER_PROCESS","scope":"instance","___s":true},{"meta":{"filename":"MANAGER_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Manager Update Event.\n\nThis internal event is dispatched by the Input Manager as part of its update step.","kind":"event","name":"MANAGER_UPDATE","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:MANAGER_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"POINTERLOCK_CHANGE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Manager Pointer Lock Change Event.\n\nThis event is dispatched by the Input Manager when it is processing a native Pointer Lock Change DOM Event.","kind":"event","name":"POINTERLOCK_CHANGE","since":"3.0.0","params":[{"type":{"names":["Event"]},"description":"The native DOM Event.","name":"event"},{"type":{"names":["boolean"]},"description":"The locked state of the Mouse Pointer.","name":"locked"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTERLOCK_CHANGE","scope":"instance","___s":true},{"meta":{"filename":"POINTER_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Down Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down anywhere.\n\nListen to this event from within a Scene using: `this.input.on('pointerdown', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\n2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\n3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_DOWN","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Array."]},"description":"An array containing all interactive Game Objects that the pointer was over when the event was created.","name":"currentlyOver"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_DOWN","scope":"instance","___s":true},{"meta":{"filename":"POINTER_DOWN_OUTSIDE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Down Outside Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down anywhere outside of the game canvas.\n\nListen to this event from within a Scene using: `this.input.on('pointerdownoutside', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\n2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\n3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_DOWN_OUTSIDE","since":"3.16.1","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE","scope":"instance","___s":true},{"meta":{"filename":"POINTER_MOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Move Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is moved anywhere.\n\nListen to this event from within a Scene using: `this.input.on('pointermove', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE}\n2. [GAMEOBJECT_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_MOVE}\n3. [POINTER_MOVE]{@linkcode Phaser.Input.Events#event:POINTER_MOVE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_MOVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Array."]},"description":"An array containing all interactive Game Objects that the pointer was over when the event was created.","name":"currentlyOver"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_MOVE","scope":"instance","___s":true},{"meta":{"filename":"POINTER_OUT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Out Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves out of any interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('pointerout', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT}\n2. [GAMEOBJECT_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OUT}\n3. [POINTER_OUT]{@linkcode Phaser.Input.Events#event:POINTER_OUT}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_OUT","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Array."]},"description":"An array containing all interactive Game Objects that the pointer moved out of when the event was created.","name":"justOut"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_OUT","scope":"instance","___s":true},{"meta":{"filename":"POINTER_OVER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Over Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves over any interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('pointerover', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER}\n2. [GAMEOBJECT_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OVER}\n3. [POINTER_OVER]{@linkcode Phaser.Input.Events#event:POINTER_OVER}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_OVER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Array."]},"description":"An array containing all interactive Game Objects that the pointer moved over when the event was created.","name":"justOver"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_OVER","scope":"instance","___s":true},{"meta":{"filename":"POINTER_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Up Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is released anywhere.\n\nListen to this event from within a Scene using: `this.input.on('pointerup', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\n2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\n3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_UP","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Array."]},"description":"An array containing all interactive Game Objects that the pointer was over when the event was created.","name":"currentlyOver"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_UP","scope":"instance","___s":true},{"meta":{"filename":"POINTER_UP_OUTSIDE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Up Outside Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is released anywhere outside of the game canvas.\n\nListen to this event from within a Scene using: `this.input.on('pointerupoutside', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\n2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\n3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_UP_OUTSIDE","since":"3.16.1","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_UP_OUTSIDE","scope":"instance","___s":true},{"meta":{"filename":"POINTER_WHEEL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Wheel Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer has its wheel updated.\n\nListen to this event from within a Scene using: `this.input.on('wheel', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL}\n2. [GAMEOBJECT_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_WHEEL}\n3. [POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:POINTER_WHEEL}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_WHEEL","since":"3.18.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Array."]},"description":"An array containing all interactive Game Objects that the pointer was over when the event was created.","name":"currentlyOver"},{"type":{"names":["number"]},"description":"The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaX"},{"type":{"names":["number"]},"description":"The vertical scroll amount that occurred due to the user moving a mouse wheel or similar input device. This value will typically be less than 0 if the user scrolls up and greater than zero if scrolling down.","name":"deltaY"},{"type":{"names":["number"]},"description":"The z-axis scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaZ"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_WHEEL","scope":"instance","___s":true},{"meta":{"filename":"PRE_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Pre-Update Event.\n\nThis internal event is dispatched by the Input Plugin at the start of its `preUpdate` method.\nThis hook is designed specifically for input plugins, but can also be listened to from user-land code.","kind":"event","name":"PRE_UPDATE","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:PRE_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"SHUTDOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Shutdown Event.\n\nThis internal event is dispatched by the Input Plugin when it shuts down, signalling to all of its systems to shut themselves down.","kind":"event","name":"SHUTDOWN","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:SHUTDOWN","scope":"instance","___s":true},{"meta":{"filename":"START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Start Event.\n\nThis internal event is dispatched by the Input Plugin when it has finished setting-up,\nsignalling to all of its internal systems to start.","kind":"event","name":"START","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:START","scope":"instance","___s":true},{"meta":{"filename":"UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Update Event.\n\nThis internal event is dispatched by the Input Plugin at the start of its `update` method.\nThis hook is designed specifically for input plugins, but can also be listened to from user-land code.","kind":"event","name":"UPDATE","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:UPDATE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Input","longname":"Phaser.Input.Events","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Axis.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Axis.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"classdesc":"Contains information about a specific Gamepad Axis.\nAxis objects are created automatically by the Gamepad as they are needed.","kind":"class","name":"Axis","memberof":"Phaser.Input.Gamepad","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"A reference to the Gamepad that this Axis belongs to.","name":"pad"},{"type":{"names":["integer"]},"description":"The index of this Axis.","name":"index"}],"scope":"static","longname":"Phaser.Input.Gamepad.Axis","___s":true},{"meta":{"filename":"Axis.js","lineno":28,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the Gamepad that this Axis belongs to.","name":"pad","type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#pad","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Axis.js","lineno":37,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An event emitter to use to emit the axis events.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Axis.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"The index of this Axis.","name":"index","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#index","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Axis.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"The raw axis value, between -1 and 1 with 0 being dead center.\nUse the method `getValue` to get a normalized value with the threshold applied.","name":"value","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#value","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Axis.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Movement tolerance threshold below which axis values are ignored in `getValue`.","name":"threshold","type":{"names":["number"]},"defaultvalue":"0.1","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#threshold","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Axis.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Applies the `threshold` value to the axis and returns it.","kind":"function","name":"getValue","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The axis value, adjusted for the movement threshold."}],"memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#getValue","scope":"instance","___s":true},{"meta":{"filename":"Axis.js","lineno":105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Destroys this Axis instance and releases external references it holds.","kind":"function","name":"destroy","since":"3.10.0","memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"Button.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Button.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"classdesc":"Contains information about a specific button on a Gamepad.\nButton objects are created automatically by the Gamepad as they are needed.","kind":"class","name":"Button","memberof":"Phaser.Input.Gamepad","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"A reference to the Gamepad that this Button belongs to.","name":"pad"},{"type":{"names":["integer"]},"description":"The index of this Button.","name":"index"}],"scope":"static","longname":"Phaser.Input.Gamepad.Button","___s":true},{"meta":{"filename":"Button.js","lineno":29,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the Gamepad that this Button belongs to.","name":"pad","type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#pad","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Button.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An event emitter to use to emit the button events.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Button.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"The index of this Button.","name":"index","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#index","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Button.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Between 0 and 1.","name":"value","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#value","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Button.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Can be set for analogue buttons to enable a 'pressure' threshold,\nbefore a button is considered as being 'pressed'.","name":"threshold","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#threshold","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Button.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Button being pressed down or not?","name":"pressed","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#pressed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Button.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Destroys this Button instance and releases external references it holds.","kind":"function","name":"destroy","since":"3.10.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#destroy","scope":"instance","___s":true},{"meta":{"range":[180,204],"filename":"Gamepad.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"name":"Axis","longname":"Axis","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Gamepad.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"classdesc":"A single Gamepad.\n\nThese are created, updated and managed by the Gamepad Plugin.","kind":"class","name":"Gamepad","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Input.Gamepad","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"A reference to the Gamepad Plugin.","name":"manager"},{"type":{"names":["Phaser.Types.Input.Gamepad.Pad"]},"description":"The Gamepad object, as extracted from GamepadEvent.","name":"pad"}],"scope":"static","longname":"Phaser.Input.Gamepad.Gamepad","___s":true},{"meta":{"filename":"Gamepad.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the Gamepad Plugin.","name":"manager","type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the native Gamepad object that is connected to the browser.","name":"pad","type":{"names":["any"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#pad","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A string containing some information about the controller.\n\nThis is not strictly specified, but in Firefox it will contain three pieces of information\nseparated by dashes (-): two 4-digit hexadecimal strings containing the USB vendor and\nproduct id of the controller, and the name of the controller as provided by the driver.\nIn Chrome it will contain the name of the controller as provided by the driver,\nfollowed by vendor and product 4-digit hexadecimal strings.","name":"id","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#id","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An integer that is unique for each Gamepad currently connected to the system.\nThis can be used to distinguish multiple controllers.\nNote that disconnecting a device and then connecting a new device may reuse the previous index.","name":"index","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#index","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An array of Gamepad Button objects, corresponding to the different buttons available on the Gamepad.","name":"buttons","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#buttons","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An array of Gamepad Axis objects, corresponding to the different axes available on the Gamepad, if any.","name":"axes","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#axes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"The Gamepad's Haptic Actuator (Vibration / Rumble support).\nThis is highly experimental and only set if both present on the device,\nand exposed by both the hardware and browser.","name":"vibration","type":{"names":["GamepadHapticActuator"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#vibration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":291,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A Vector2 containing the most recent values from the Gamepad's left axis stick.\nThis is updated automatically as part of the Gamepad.update cycle.\nThe H Axis is mapped to the `Vector2.x` property, and the V Axis to the `Vector2.y` property.\nThe values are based on the Axis thresholds.\nIf the Gamepad does not have a left axis stick, the values will always be zero.","name":"leftStick","type":{"names":["Phaser.Math.Vector2"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#leftStick","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":304,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A Vector2 containing the most recent values from the Gamepad's right axis stick.\nThis is updated automatically as part of the Gamepad.update cycle.\nThe H Axis is mapped to the `Vector2.x` property, and the V Axis to the `Vector2.y` property.\nThe values are based on the Axis thresholds.\nIf the Gamepad does not have a right axis stick, the values will always be zero.","name":"rightStick","type":{"names":["Phaser.Math.Vector2"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#rightStick","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Gets the total number of axis this Gamepad claims to support.","kind":"function","name":"getAxisTotal","since":"3.10.0","returns":[{"type":{"names":["integer"]},"description":"The total number of axes this Gamepad claims to support."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#getAxisTotal","scope":"instance","___s":true},{"meta":{"filename":"Gamepad.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Gets the value of an axis based on the given index.\nThe index must be valid within the range of axes supported by this Gamepad.\nThe return value will be a float between 0 and 1.","kind":"function","name":"getAxisValue","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The index of the axes to get the value for.","name":"index"}],"returns":[{"type":{"names":["number"]},"description":"The value of the axis, between 0 and 1."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#getAxisValue","scope":"instance","___s":true},{"meta":{"filename":"Gamepad.js","lineno":348,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Sets the threshold value of all axis on this Gamepad.\nThe value is a float between 0 and 1 and is the amount below which the axis is considered as not having been moved.","kind":"function","name":"setAxisThreshold","since":"3.10.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1.","name":"value"}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#setAxisThreshold","scope":"instance","___s":true},{"meta":{"filename":"Gamepad.js","lineno":365,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Gets the total number of buttons this Gamepad claims to have.","kind":"function","name":"getButtonTotal","since":"3.10.0","returns":[{"type":{"names":["integer"]},"description":"The total number of buttons this Gamepad claims to have."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#getButtonTotal","scope":"instance","___s":true},{"meta":{"filename":"Gamepad.js","lineno":378,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Gets the value of a button based on the given index.\nThe index must be valid within the range of buttons supported by this Gamepad.\n\nThe return value will be either 0 or 1 for an analogue button, or a float between 0 and 1\nfor a pressure-sensitive digital button, such as the shoulder buttons on a Dual Shock.","kind":"function","name":"getButtonValue","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The index of the button to get the value for.","name":"index"}],"returns":[{"type":{"names":["number"]},"description":"The value of the button, between 0 and 1."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#getButtonValue","scope":"instance","___s":true},{"meta":{"filename":"Gamepad.js","lineno":397,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Returns if the button is pressed down or not.\nThe index must be valid within the range of buttons supported by this Gamepad.","kind":"function","name":"isButtonDown","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The index of the button to get the value for.","name":"index"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the button is considered as being pressed down, otherwise `false`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#isButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Gamepad.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Destroys this Gamepad instance, its buttons and axes, and releases external references it holds.","kind":"function","name":"destroy","since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"Gamepad.js","lineno":489,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is this Gamepad currently connected or not?","name":"connected","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#connected","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":506,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A timestamp containing the most recent time this Gamepad was updated.","name":"timestamp","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#timestamp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":522,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's Left button being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nThis is the d-pad left button under standard Gamepad mapping.","name":"left","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":540,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's Right button being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nThis is the d-pad right button under standard Gamepad mapping.","name":"right","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":558,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's Up button being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nThis is the d-pad up button under standard Gamepad mapping.","name":"up","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#up","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":576,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's Down button being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nThis is the d-pad down button under standard Gamepad mapping.","name":"down","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#down","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":594,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's bottom button in the right button cluster being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nOn a Dual Shock controller it's the X button.\nOn an XBox controller it's the A button.","name":"A","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#A","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":613,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's top button in the right button cluster being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nOn a Dual Shock controller it's the Triangle button.\nOn an XBox controller it's the Y button.","name":"Y","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#Y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's left button in the right button cluster being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nOn a Dual Shock controller it's the Square button.\nOn an XBox controller it's the X button.","name":"X","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#X","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":651,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's right button in the right button cluster being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nOn a Dual Shock controller it's the Circle button.\nOn an XBox controller it's the B button.","name":"B","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#B","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":670,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Returns the value of the Gamepad's top left shoulder button.\nIf the Gamepad doesn't have this button it will always return zero.\nThe value is a float between 0 and 1, corresponding to how depressed the button is.\nOn a Dual Shock controller it's the L1 button.\nOn an XBox controller it's the LB button.","name":"L1","type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#L1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":690,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Returns the value of the Gamepad's bottom left shoulder button.\nIf the Gamepad doesn't have this button it will always return zero.\nThe value is a float between 0 and 1, corresponding to how depressed the button is.\nOn a Dual Shock controller it's the L2 button.\nOn an XBox controller it's the LT button.","name":"L2","type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#L2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":710,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Returns the value of the Gamepad's top right shoulder button.\nIf the Gamepad doesn't have this button it will always return zero.\nThe value is a float between 0 and 1, corresponding to how depressed the button is.\nOn a Dual Shock controller it's the R1 button.\nOn an XBox controller it's the RB button.","name":"R1","type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#R1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":730,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Returns the value of the Gamepad's bottom right shoulder button.\nIf the Gamepad doesn't have this button it will always return zero.\nThe value is a float between 0 and 1, corresponding to how depressed the button is.\nOn a Dual Shock controller it's the R2 button.\nOn an XBox controller it's the RT button.","name":"R2","type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#R2","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"GamepadPlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"classdesc":"The Gamepad Plugin is an input plugin that belongs to the Scene-owned Input system.\n\nIts role is to listen for native DOM Gamepad Events and then process them.\n\nYou do not need to create this class directly, the Input system will create an instance of it automatically.\n\nYou can access it from within a Scene using `this.input.gamepad`.\n\nTo listen for a gamepad being connected:\n\n```javascript\nthis.input.gamepad.once('connected', function (pad) {\n // 'pad' is a reference to the gamepad that was just connected\n});\n```\n\nNote that the browser may require you to press a button on a gamepad before it will allow you to access it,\nthis is for security reasons. However, it may also trust the page already, in which case you won't get the\n'connected' event and instead should check `GamepadPlugin.total` to see if it thinks there are any gamepads\nalready connected.\n\nOnce you have received the connected event, or polled the gamepads and found them enabled, you can access\nthem via the built-in properties `GamepadPlugin.pad1` to `pad4`, for up to 4 game pads. With a reference\nto the gamepads you can poll its buttons and axis sticks. See the properties and methods available on\nthe `Gamepad` class for more details.\n\nFor more information about Gamepad support in browsers see the following resources:\n\nhttps://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API\nhttps://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API/Using_the_Gamepad_API\nhttps://www.smashingmagazine.com/2015/11/gamepad-api-in-web-games/\nhttp://html5gamepad.com/","kind":"class","name":"GamepadPlugin","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Input.Gamepad","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"A reference to the Scene Input Plugin that the KeyboardPlugin belongs to.","name":"sceneInputPlugin"}],"scope":"static","longname":"Phaser.Input.Gamepad.GamepadPlugin","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the Scene that this Input Plugin is responsible for.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the Scene Systems Settings.","name":"settings","type":{"names":["Phaser.Types.Scenes.SettingsObject"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#settings","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the Scene Input Plugin that created this Keyboard Plugin.","name":"sceneInputPlugin","type":{"names":["Phaser.Input.InputPlugin"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#sceneInputPlugin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A boolean that controls if the Gamepad Manager is enabled or not.\nCan be toggled on the fly.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"The Gamepad Event target, as defined in the Game Config.\nTypically the browser window, but can be any interactive DOM element.","name":"target","type":{"names":["any"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#target","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An array of the connected Gamepads.","name":"gamepads","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#gamepads","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Checks to see if both this plugin and the Scene to which it belongs is active.","kind":"function","name":"isActive","since":"3.10.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the plugin and the Scene it belongs to is active."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#isActive","scope":"instance","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Disconnects all current Gamepads.","kind":"function","name":"disconnectAll","since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#disconnectAll","scope":"instance","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":387,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Returns an array of all currently connected Gamepads.","kind":"function","name":"getAll","since":"3.10.0","returns":[{"type":{"names":["Array."]},"description":"An array of all currently connected Gamepads."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#getAll","scope":"instance","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Looks-up a single Gamepad based on the given index value.","kind":"function","name":"getPad","since":"3.10.0","params":[{"type":{"names":["number"]},"description":"The index of the Gamepad to get.","name":"index"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"The Gamepad matching the given index, or undefined if none were found."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#getPad","scope":"instance","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":524,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"The total number of connected game pads.","name":"total","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#total","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":540,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the first connected Gamepad.\n\nThis will be undefined if either no pads are connected, or the browser\nhas not yet issued a gamepadconnect, which can happen even if a Gamepad\nis plugged in, but hasn't yet had any buttons pressed on it.","name":"pad1","type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#pad1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":560,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the second connected Gamepad.\n\nThis will be undefined if either no pads are connected, or the browser\nhas not yet issued a gamepadconnect, which can happen even if a Gamepad\nis plugged in, but hasn't yet had any buttons pressed on it.","name":"pad2","type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#pad2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":580,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the third connected Gamepad.\n\nThis will be undefined if either no pads are connected, or the browser\nhas not yet issued a gamepadconnect, which can happen even if a Gamepad\nis plugged in, but hasn't yet had any buttons pressed on it.","name":"pad3","type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#pad3","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":600,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the fourth connected Gamepad.\n\nThis will be undefined if either no pads are connected, or the browser\nhas not yet issued a gamepadconnect, which can happen even if a Gamepad\nis plugged in, but hasn't yet had any buttons pressed on it.","name":"pad4","type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#pad4","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":622,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An instance of the Gamepad Plugin class, if enabled via the `input.gamepad` Scene or Game Config property.\nUse this to create access Gamepads connected to the browser and respond to gamepad buttons.","name":"gamepad","type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"nullable":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#gamepad","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SNES_USB_Controller.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs"},"description":"Tatar SNES USB Controller Gamepad Configuration.\nUSB Gamepad (STANDARD GAMEPAD Vendor: 0079 Product: 0011)","name":"SNES_USB","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Configs","longname":"Phaser.Input.Gamepad.Configs.SNES_USB","scope":"static","kind":"member","___s":true},{"meta":{"filename":"Sony_PlayStation_DualShock_4.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs"},"description":"PlayStation DualShock 4 Gamepad Configuration.\nSony PlayStation DualShock 4 (v2) wireless controller","name":"DUALSHOCK_4","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Configs","longname":"Phaser.Input.Gamepad.Configs.DUALSHOCK_4","scope":"static","kind":"member","___s":true},{"meta":{"filename":"XBox360_Controller.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs"},"description":"XBox 360 Gamepad Configuration.","name":"XBOX_360","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Configs","longname":"Phaser.Input.Gamepad.Configs.XBOX_360","scope":"static","kind":"member","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs"},"kind":"namespace","name":"Configs","memberof":"Phaser.Input.Gamepad","longname":"Phaser.Input.Gamepad.Configs","scope":"static","___s":true},{"meta":{"filename":"BUTTON_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"description":"The Gamepad Button Down Event.\n\nThis event is dispatched by the Gamepad Plugin when a button has been pressed on any active Gamepad.\n\nListen to this event from within a Scene using: `this.input.gamepad.on('down', listener)`.\n\nYou can also listen for a DOWN event from a Gamepad instance. See the [GAMEPAD_BUTTON_DOWN]{@linkcode Phaser.Input.Gamepad.Events#event:GAMEPAD_BUTTON_DOWN} event for details.","kind":"event","name":"BUTTON_DOWN","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.Gamepad"]},"description":"A reference to the Gamepad on which the button was pressed.","name":"pad"},{"type":{"names":["Phaser.Input.Gamepad.Button"]},"description":"A reference to the Button which was pressed.","name":"button"},{"type":{"names":["number"]},"description":"The value of the button at the time it was pressed. Between 0 and 1. Some Gamepads have pressure-sensitive buttons.","name":"value"}],"memberof":"Phaser.Input.Gamepad.Events","longname":"Phaser.Input.Gamepad.Events#event:BUTTON_DOWN","scope":"instance","___s":true},{"meta":{"filename":"BUTTON_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"description":"The Gamepad Button Up Event.\n\nThis event is dispatched by the Gamepad Plugin when a button has been released on any active Gamepad.\n\nListen to this event from within a Scene using: `this.input.gamepad.on('up', listener)`.\n\nYou can also listen for an UP event from a Gamepad instance. See the [GAMEPAD_BUTTON_UP]{@linkcode Phaser.Input.Gamepad.Events#event:GAMEPAD_BUTTON_UP} event for details.","kind":"event","name":"BUTTON_UP","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.Gamepad"]},"description":"A reference to the Gamepad on which the button was released.","name":"pad"},{"type":{"names":["Phaser.Input.Gamepad.Button"]},"description":"A reference to the Button which was released.","name":"button"},{"type":{"names":["number"]},"description":"The value of the button at the time it was released. Between 0 and 1. Some Gamepads have pressure-sensitive buttons.","name":"value"}],"memberof":"Phaser.Input.Gamepad.Events","longname":"Phaser.Input.Gamepad.Events#event:BUTTON_UP","scope":"instance","___s":true},{"meta":{"filename":"CONNECTED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"description":"The Gamepad Connected Event.\n\nThis event is dispatched by the Gamepad Plugin when a Gamepad has been connected.\n\nListen to this event from within a Scene using: `this.input.gamepad.once('connected', listener)`.\n\nNote that the browser may require you to press a button on a gamepad before it will allow you to access it,\nthis is for security reasons. However, it may also trust the page already, in which case you won't get the\n'connected' event and instead should check `GamepadPlugin.total` to see if it thinks there are any gamepads\nalready connected.","kind":"event","name":"CONNECTED","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Gamepad"]},"description":"A reference to the Gamepad which was connected.","name":"pad"},{"type":{"names":["Event"]},"description":"The native DOM Event that triggered the connection.","name":"event"}],"memberof":"Phaser.Input.Gamepad.Events","longname":"Phaser.Input.Gamepad.Events#event:CONNECTED","scope":"instance","___s":true},{"meta":{"filename":"DISCONNECTED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"description":"The Gamepad Disconnected Event.\n\nThis event is dispatched by the Gamepad Plugin when a Gamepad has been disconnected.\n\nListen to this event from within a Scene using: `this.input.gamepad.once('disconnected', listener)`.","kind":"event","name":"DISCONNECTED","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Gamepad"]},"description":"A reference to the Gamepad which was disconnected.","name":"pad"},{"type":{"names":["Event"]},"description":"The native DOM Event that triggered the disconnection.","name":"event"}],"memberof":"Phaser.Input.Gamepad.Events","longname":"Phaser.Input.Gamepad.Events#event:DISCONNECTED","scope":"instance","___s":true},{"meta":{"filename":"GAMEPAD_BUTTON_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"description":"The Gamepad Button Down Event.\n\nThis event is dispatched by a Gamepad instance when a button has been pressed on it.\n\nListen to this event from a Gamepad instance. Once way to get this is from the `pad1`, `pad2`, etc properties on the Gamepad Plugin:\n`this.input.gamepad.pad1.on('down', listener)`.\n\nNote that you will not receive any Gamepad button events until the browser considers the Gamepad as being 'connected'.\n\nYou can also listen for a DOWN event from the Gamepad Plugin. See the [BUTTON_DOWN]{@linkcode Phaser.Input.Gamepad.Events#event:BUTTON_DOWN} event for details.","kind":"event","name":"GAMEPAD_BUTTON_DOWN","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The index of the button that was pressed.","name":"index"},{"type":{"names":["number"]},"description":"The value of the button at the time it was pressed. Between 0 and 1. Some Gamepads have pressure-sensitive buttons.","name":"value"},{"type":{"names":["Phaser.Input.Gamepad.Button"]},"description":"A reference to the Button which was pressed.","name":"button"}],"memberof":"Phaser.Input.Gamepad.Events","longname":"Phaser.Input.Gamepad.Events#event:GAMEPAD_BUTTON_DOWN","scope":"instance","___s":true},{"meta":{"filename":"GAMEPAD_BUTTON_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"description":"The Gamepad Button Up Event.\n\nThis event is dispatched by a Gamepad instance when a button has been released on it.\n\nListen to this event from a Gamepad instance. Once way to get this is from the `pad1`, `pad2`, etc properties on the Gamepad Plugin:\n`this.input.gamepad.pad1.on('up', listener)`.\n\nNote that you will not receive any Gamepad button events until the browser considers the Gamepad as being 'connected'.\n\nYou can also listen for an UP event from the Gamepad Plugin. See the [BUTTON_UP]{@linkcode Phaser.Input.Gamepad.Events#event:BUTTON_UP} event for details.","kind":"event","name":"GAMEPAD_BUTTON_UP","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The index of the button that was released.","name":"index"},{"type":{"names":["number"]},"description":"The value of the button at the time it was released. Between 0 and 1. Some Gamepads have pressure-sensitive buttons.","name":"value"},{"type":{"names":["Phaser.Input.Gamepad.Button"]},"description":"A reference to the Button which was released.","name":"button"}],"memberof":"Phaser.Input.Gamepad.Events","longname":"Phaser.Input.Gamepad.Events#event:GAMEPAD_BUTTON_UP","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Input.Gamepad","longname":"Phaser.Input.Gamepad.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"kind":"namespace","name":"Gamepad","memberof":"Phaser.Input","longname":"Phaser.Input.Gamepad","scope":"static","___s":true},{"meta":{"filename":"Pad.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/typedefs"},"description":"The Gamepad object, as extracted from GamepadEvent.","kind":"typedef","name":"Pad","type":{"names":["object"]},"since":"3.10.0","properties":[{"type":{"names":["string"]},"description":"The ID of the Gamepad.","name":"id"},{"type":{"names":["integer"]},"description":"The index of the Gamepad.","name":"index"}],"memberof":"Phaser.Types.Input.Gamepad","longname":"Phaser.Types.Input.Gamepad.Pad","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/typedefs"},"kind":"namespace","name":"Gamepad","memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.Gamepad","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"kind":"namespace","name":"Input","memberof":"Phaser","longname":"Phaser.Input","scope":"static","___s":true},{"meta":{"range":[180,229],"filename":"KeyboardManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"name":"ArrayRemove","longname":"ArrayRemove","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"classdesc":"The Keyboard Manager is a helper class that belongs to the global Input Manager.\n\nIts role is to listen for native DOM Keyboard Events and then store them for further processing by the Keyboard Plugin.\n\nYou do not need to create this class directly, the Input Manager will create an instance of it automatically if keyboard\ninput has been enabled in the Game Config.","kind":"class","name":"KeyboardManager","memberof":"Phaser.Input.Keyboard","since":"3.16.0","params":[{"type":{"names":["Phaser.Input.InputManager"]},"description":"A reference to the Input Manager.","name":"inputManager"}],"scope":"static","longname":"Phaser.Input.Keyboard.KeyboardManager","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A reference to the Input Manager.","name":"manager","type":{"names":["Phaser.Input.InputManager"]},"since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A flag that controls if the non-modified keys, matching those stored in the `captures` array,\nhave `preventDefault` called on them or not.\n\nA non-modified key is one that doesn't have a modifier key held down with it. The modifier keys are\nshift, control, alt and the meta key (Command on a Mac, the Windows Key on Windows).\nTherefore, if the user presses shift + r, it won't prevent this combination, because of the modifier.\nHowever, if the user presses just the r key on its own, it will have its event prevented.\n\nIf you wish to stop capturing the keys, for example switching out to a DOM based element, then\nyou can toggle this property at run-time.","name":"preventDefault","type":{"names":["boolean"]},"since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#preventDefault","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"An array of Key Code values that will automatically have `preventDefault` called on them,\nas long as the `KeyboardManager.preventDefault` boolean is set to `true`.\n\nBy default the array is empty.\n\nThe key must be non-modified when pressed in order to be captured.\n\nA non-modified key is one that doesn't have a modifier key held down with it. The modifier keys are\nshift, control, alt and the meta key (Command on a Mac, the Windows Key on Windows).\nTherefore, if the user presses shift + r, it won't prevent this combination, because of the modifier.\nHowever, if the user presses just the r key on its own, it will have its event prevented.\n\nIf you wish to stop capturing the keys, for example switching out to a DOM based element, then\nyou can toggle the `KeyboardManager.preventDefault` boolean at run-time.\n\nIf you need more specific control, you can create Key objects and set the flag on each of those instead.\n\nThis array can be populated via the Game Config by setting the `input.keyboard.capture` array, or you\ncan call the `addCapture` method. See also `removeCapture` and `clearCaptures`.","name":"captures","type":{"names":["Array."]},"since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#captures","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":100,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A boolean that controls if the Keyboard Manager is enabled or not.\nCan be toggled on the fly.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"The Keyboard Event target, as defined in the Game Config.\nTypically the window in which the game is rendering, but can be any interactive DOM element.","name":"target","type":{"names":["any"]},"since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#target","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"The Key Down Event handler.\nThis function is sent the native DOM KeyEvent.\nInitially empty and bound in the `startListeners` method.","name":"onKeyDown","type":{"names":["function"]},"since":"3.16.00","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#onKeyDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"The Key Up Event handler.\nThis function is sent the native DOM KeyEvent.\nInitially empty and bound in the `startListeners` method.","name":"onKeyUp","type":{"names":["function"]},"since":"3.16.00","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#onKeyUp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Starts the Keyboard Event listeners running.\nThis is called automatically and does not need to be manually invoked.","kind":"function","name":"startListeners","since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#startListeners","scope":"instance","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":243,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Stops the Key Event listeners.\nThis is called automatically and does not need to be manually invoked.","kind":"function","name":"stopListeners","since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#stopListeners","scope":"instance","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"By default when a key is pressed Phaser will not stop the event from propagating up to the browser.\nThere are some keys this can be annoying for, like the arrow keys or space bar, which make the browser window scroll.\n\nThis `addCapture` method enables consuming keyboard event for specific keys so it doesn't bubble up to the the browser\nand cause the default browser behavior.\n\nPlease note that keyboard captures are global. This means that if you call this method from within a Scene, to say prevent\nthe SPACE BAR from triggering a page scroll, then it will prevent it for any Scene in your game, not just the calling one.\n\nYou can pass in a single key code value, or an array of key codes, or a string:\n\n```javascript\nthis.input.keyboard.addCapture(62);\n```\n\nAn array of key codes:\n\n```javascript\nthis.input.keyboard.addCapture([ 62, 63, 64 ]);\n```\n\nOr a string:\n\n```javascript\nthis.input.keyboard.addCapture('W,S,A,D');\n```\n\nTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\n\nYou can also provide an array mixing both strings and key code integers.\n\nIf there are active captures after calling this method, the `preventDefault` property is set to `true`.","kind":"function","name":"addCapture","since":"3.16.0","params":[{"type":{"names":["string","integer","Array.","Array."]},"description":"The Key Codes to enable capture for, preventing them reaching the browser.","name":"keycode"}],"memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#addCapture","scope":"instance","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":344,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Removes an existing key capture.\n\nPlease note that keyboard captures are global. This means that if you call this method from within a Scene, to remove\nthe capture of a key, then it will remove it for any Scene in your game, not just the calling one.\n\nYou can pass in a single key code value, or an array of key codes, or a string:\n\n```javascript\nthis.input.keyboard.removeCapture(62);\n```\n\nAn array of key codes:\n\n```javascript\nthis.input.keyboard.removeCapture([ 62, 63, 64 ]);\n```\n\nOr a string:\n\n```javascript\nthis.input.keyboard.removeCapture('W,S,A,D');\n```\n\nTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\n\nYou can also provide an array mixing both strings and key code integers.\n\nIf there are no captures left after calling this method, the `preventDefault` property is set to `false`.","kind":"function","name":"removeCapture","since":"3.16.0","params":[{"type":{"names":["string","integer","Array.","Array."]},"description":"The Key Codes to disable capture for, allowing them reaching the browser again.","name":"keycode"}],"memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#removeCapture","scope":"instance","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":408,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Removes all keyboard captures and sets the `preventDefault` property to `false`.","kind":"function","name":"clearCaptures","since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#clearCaptures","scope":"instance","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":421,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Destroys this Keyboard Manager instance.","kind":"function","name":"destroy","since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"KeyboardPlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"classdesc":"The Keyboard Plugin is an input plugin that belongs to the Scene-owned Input system.\n\nIts role is to listen for native DOM Keyboard Events and then process them.\n\nYou do not need to create this class directly, the Input system will create an instance of it automatically.\n\nYou can access it from within a Scene using `this.input.keyboard`. For example, you can do:\n\n```javascript\nthis.input.keyboard.on('keydown', callback, context);\n```\n\nOr, to listen for a specific key:\n\n```javascript\nthis.input.keyboard.on('keydown-A', callback, context);\n```\n\nYou can also create Key objects, which you can then poll in your game loop:\n\n```javascript\nvar spaceBar = this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.SPACE);\n```\n\nIf you have multiple parallel Scenes, each trying to get keyboard input, be sure to disable capture on them to stop them from\nstealing input from another Scene in the list. You can do this with `this.input.keyboard.enabled = false` within the\nScene to stop all input, or `this.input.keyboard.preventDefault = false` to stop a Scene halting input on another Scene.\n\n_Note_: Many keyboards are unable to process certain combinations of keys due to hardware limitations known as ghosting.\nSee http://www.html5gamedevs.com/topic/4876-impossible-to-use-more-than-2-keyboard-input-buttons-at-the-same-time/ for more details.\n\nAlso please be aware that certain browser extensions can disable or override Phaser keyboard handling.\nFor example the Chrome extension vimium is known to disable Phaser from using the D key, while EverNote disables the backtick key.\nAnd there are others. So, please check your extensions before opening Phaser issues about keys that don't work.","kind":"class","name":"KeyboardPlugin","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Input.Keyboard","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"A reference to the Scene Input Plugin that the KeyboardPlugin belongs to.","name":"sceneInputPlugin"}],"scope":"static","longname":"Phaser.Input.Keyboard.KeyboardPlugin","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A reference to the core game, so we can listen for visibility events.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A reference to the Scene that this Input Plugin is responsible for.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.10.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A reference to the Scene Systems Settings.","name":"settings","type":{"names":["Phaser.Types.Scenes.SettingsObject"]},"since":"3.10.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#settings","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A reference to the Scene Input Plugin that created this Keyboard Plugin.","name":"sceneInputPlugin","type":{"names":["Phaser.Input.InputPlugin"]},"since":"3.10.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#sceneInputPlugin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A reference to the global Keyboard Manager.","name":"manager","type":{"names":["Phaser.Input.InputPlugin"]},"since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A boolean that controls if this Keyboard Plugin is enabled or not.\nCan be toggled on the fly.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.10.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"An array of Key objects to process.","name":"keys","type":{"names":["Array."]},"since":"3.10.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#keys","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":140,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"An array of KeyCombo objects to process.","name":"combos","type":{"names":["Array."]},"since":"3.10.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#combos","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Checks to see if both this plugin and the Scene to which it belongs is active.","kind":"function","name":"isActive","since":"3.10.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the plugin and the Scene it belongs to is active."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#isActive","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"By default when a key is pressed Phaser will not stop the event from propagating up to the browser.\nThere are some keys this can be annoying for, like the arrow keys or space bar, which make the browser window scroll.\n\nThis `addCapture` method enables consuming keyboard events for specific keys, so they don't bubble up the browser\nand cause the default behaviors.\n\nPlease note that keyboard captures are global. This means that if you call this method from within a Scene, to say prevent\nthe SPACE BAR from triggering a page scroll, then it will prevent it for any Scene in your game, not just the calling one.\n\nYou can pass a single key code value:\n\n```javascript\nthis.input.keyboard.addCapture(62);\n```\n\nAn array of key codes:\n\n```javascript\nthis.input.keyboard.addCapture([ 62, 63, 64 ]);\n```\n\nOr, a comma-delimited string:\n\n```javascript\nthis.input.keyboard.addCapture('W,S,A,D');\n```\n\nTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\n\nYou can also provide an array mixing both strings and key code integers.","kind":"function","name":"addCapture","since":"3.16.0","params":[{"type":{"names":["string","integer","Array.","Array."]},"description":"The Key Codes to enable event capture for.","name":"keycode"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#addCapture","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":261,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Removes an existing key capture.\n\nPlease note that keyboard captures are global. This means that if you call this method from within a Scene, to remove\nthe capture of a key, then it will remove it for any Scene in your game, not just the calling one.\n\nYou can pass a single key code value:\n\n```javascript\nthis.input.keyboard.removeCapture(62);\n```\n\nAn array of key codes:\n\n```javascript\nthis.input.keyboard.removeCapture([ 62, 63, 64 ]);\n```\n\nOr, a comma-delimited string:\n\n```javascript\nthis.input.keyboard.removeCapture('W,S,A,D');\n```\n\nTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\n\nYou can also provide an array mixing both strings and key code integers.","kind":"function","name":"removeCapture","since":"3.16.0","params":[{"type":{"names":["string","integer","Array.","Array."]},"description":"The Key Codes to disable event capture for.","name":"keycode"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#removeCapture","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":303,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Returns an array that contains all of the keyboard captures currently enabled.","kind":"function","name":"getCaptures","since":"3.16.0","returns":[{"type":{"names":["Array."]},"description":"An array of all the currently capturing key codes."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#getCaptures","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":316,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Allows Phaser to prevent any key captures you may have defined from bubbling up the browser.\nYou can use this to re-enable event capturing if you had paused it via `disableGlobalCapture`.","kind":"function","name":"enableGlobalCapture","since":"3.16.0","returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#enableGlobalCapture","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Disables Phaser from preventing any key captures you may have defined, without actually removing them.\nYou can use this to temporarily disable event capturing if, for example, you swap to a DOM element.","kind":"function","name":"disableGlobalCapture","since":"3.16.0","returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#disableGlobalCapture","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":348,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Removes all keyboard captures.\n\nNote that this is a global change. It will clear all event captures across your game, not just for this specific Scene.","kind":"function","name":"clearCaptures","since":"3.16.0","returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#clearCaptures","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":365,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Creates and returns an object containing 4 hotkeys for Up, Down, Left and Right, and also Space Bar and shift.","kind":"function","name":"createCursorKeys","since":"3.10.0","returns":[{"type":{"names":["Phaser.Types.Input.Keyboard.CursorKeys"]},"description":"An object containing the properties: `up`, `down`, `left`, `right`, `space` and `shift`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#createCursorKeys","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A practical way to create an object containing user selected hotkeys.\n\nFor example:\n\n```javascript\nthis.input.keyboard.addKeys({ 'up': Phaser.Input.Keyboard.KeyCodes.W, 'down': Phaser.Input.Keyboard.KeyCodes.S });\n```\n\nwould return an object containing the properties (`up` and `down`) mapped to W and S {@link Phaser.Input.Keyboard.Key} objects.\n\nYou can also pass in a comma-separated string:\n\n```javascript\nthis.input.keyboard.addKeys('W,S,A,D');\n```\n\nWhich will return an object with the properties W, S, A and D mapped to the relevant Key objects.\n\nTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.","kind":"function","name":"addKeys","since":"3.10.0","params":[{"type":{"names":["object","string"]},"description":"An object containing Key Codes, or a comma-separated string.","name":"keys"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Automatically call `preventDefault` on the native DOM browser event for the key codes being added.","name":"enableCapture"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Controls if the Key will continuously emit a 'down' event while being held down (true), or emit the event just once (false, the default).","name":"emitOnRepeat"}],"returns":[{"type":{"names":["object"]},"description":"An object containing Key objects mapped to the input properties."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#addKeys","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":447,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Adds a Key object to this Keyboard Plugin.\n\nThe given argument can be either an existing Key object, a string, such as `A` or `SPACE`, or a key code value.\n\nIf a Key object is given, and one already exists matching the same key code, the existing one is replaced with the new one.","kind":"function","name":"addKey","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key","string","integer"]},"description":"Either a Key object, a string, such as `A` or `SPACE`, or a key code value.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Automatically call `preventDefault` on the native DOM browser event for the key codes being added.","name":"enableCapture"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Controls if the Key will continuously emit a 'down' event while being held down (true), or emit the event just once (false, the default).","name":"emitOnRepeat"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The newly created Key object, or a reference to it if it already existed in the keys array."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#addKey","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Removes a Key object from this Keyboard Plugin.\n\nThe given argument can be either a Key object, a string, such as `A` or `SPACE`, or a key code value.","kind":"function","name":"removeKey","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key","string","integer"]},"description":"Either a Key object, a string, such as `A` or `SPACE`, or a key code value.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Call `Key.destroy` on the removed Key object?","name":"destroy"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#removeKey","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":569,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Creates a new KeyCombo.\n\nA KeyCombo will listen for a specific string of keys from the Keyboard, and when it receives them\nit will emit a `keycombomatch` event from this Keyboard Plugin.\n\nThe keys to be listened for can be defined as:\n\nA string (i.e. 'ATARI')\nAn array of either integers (key codes) or strings, or a mixture of both\nAn array of objects (such as Key objects) with a public 'keyCode' property\n\nFor example, to listen for the Konami code (up, up, down, down, left, right, left, right, b, a, enter)\nyou could pass the following array of key codes:\n\n```javascript\nthis.input.keyboard.createCombo([ 38, 38, 40, 40, 37, 39, 37, 39, 66, 65, 13 ], { resetOnMatch: true });\n\nthis.input.keyboard.on('keycombomatch', function (event) {\n console.log('Konami Code entered!');\n});\n```\n\nOr, to listen for the user entering the word PHASER:\n\n```javascript\nthis.input.keyboard.createCombo('PHASER');\n```","kind":"function","name":"createCombo","since":"3.10.0","params":[{"type":{"names":["string","Array.","Array."]},"description":"The keys that comprise this combo.","name":"keys"},{"type":{"names":["Phaser.Types.Input.Keyboard.KeyComboConfig"]},"optional":true,"description":"A Key Combo configuration object.","name":"config"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyCombo"]},"description":"The new KeyCombo object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#createCombo","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":611,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Checks if the given Key object is currently being held down.\n\nThe difference between this method and checking the `Key.isDown` property directly is that you can provide\na duration to this method. For example, if you wanted a key press to fire a bullet, but you only wanted\nit to be able to fire every 100ms, then you can call this method with a `duration` of 100 and it\nwill only return `true` every 100ms.\n\nIf the Keyboard Plugin has been disabled, this method will always return `false`.","kind":"function","name":"checkDown","since":"3.11.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"A Key object.","name":"key"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The duration which must have elapsed before this Key is considered as being down.","name":"duration"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Key is down within the duration specified, otherwise `false`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#checkDown","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":759,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Resets all Key objects created by _this_ Keyboard Plugin back to their default un-pressed states.\nThis can only reset keys created via the `addKey`, `addKeys` or `createCursorKeys` methods.\nIf you have created a Key object directly you'll need to reset it yourself.\n\nThis method is called automatically when the Keyboard Plugin shuts down, but can be\ninvoked directly at any time you require.","kind":"function","name":"resetKeys","since":"3.15.0","returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#resetKeys","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":870,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"An instance of the Keyboard Plugin class, if enabled via the `input.keyboard` Scene or Game Config property.\nUse this to create Key objects and listen for keyboard specific events.","name":"keyboard","type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"nullable":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#keyboard","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,219],"filename":"KeyCombo.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"KeyCombo.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"classdesc":"A KeyCombo will listen for a specific string of keys from the Keyboard, and when it receives them\nit will emit a `keycombomatch` event from the Keyboard Manager.\n\nThe keys to be listened for can be defined as:\n\nA string (i.e. 'ATARI')\nAn array of either integers (key codes) or strings, or a mixture of both\nAn array of objects (such as Key objects) with a public 'keyCode' property\n\nFor example, to listen for the Konami code (up, up, down, down, left, right, left, right, b, a, enter)\nyou could pass the following array of key codes:\n\n```javascript\nthis.input.keyboard.createCombo([ 38, 38, 40, 40, 37, 39, 37, 39, 66, 65, 13 ], { resetOnMatch: true });\n\nthis.input.keyboard.on('keycombomatch', function (event) {\n console.log('Konami Code entered!');\n});\n```\n\nOr, to listen for the user entering the word PHASER:\n\n```javascript\nthis.input.keyboard.createCombo('PHASER');\n```","kind":"class","name":"KeyCombo","memberof":"Phaser.Input.Keyboard","listens":["Phaser.Input.Keyboard.Events#event:ANY_KEY_DOWN"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"A reference to the Keyboard Plugin.","name":"keyboardPlugin"},{"type":{"names":["string","Array.","Array."]},"description":"The keys that comprise this combo.","name":"keys"},{"type":{"names":["Phaser.Types.Input.Keyboard.KeyComboConfig"]},"optional":true,"description":"A Key Combo configuration object.","name":"config"}],"scope":"static","longname":"Phaser.Input.Keyboard.KeyCombo","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"A reference to the Keyboard Manager","name":"manager","type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"A flag that controls if this Key Combo is actively processing keys or not.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"An array of the keycodes that comprise this combo.","name":"keyCodes","type":{"names":["array"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#keyCodes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"The current keyCode the combo is waiting for.","name":"current","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#current","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"The current index of the key being waited for in the 'keys' string.","name":"index","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#index","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"The length of this combo (in keycodes)","name":"size","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#size","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"The time the previous key in the combo was matched.","name":"timeLastMatched","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#timeLastMatched","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"Has this Key Combo been matched yet?","name":"matched","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#matched","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":162,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"The time the entire combo was matched.","name":"timeMatched","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#timeMatched","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":172,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"If they press the wrong key do we reset the combo?","name":"resetOnWrongKey","type":{"names":["boolean"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#resetOnWrongKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":182,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"The max delay in ms between each key press. Above this the combo is reset. 0 means disabled.","name":"maxKeyDelay","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#maxKeyDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"If previously matched and they press the first key of the combo again, will it reset?","name":"resetOnMatch","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#resetOnMatch","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":202,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"If the combo matches, will it delete itself?","name":"deleteOnMatch","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#deleteOnMatch","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"How far complete is this combo? A value between 0 and 1.","name":"progress","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"Destroys this Key Combo and all of its references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#destroy","scope":"instance","___s":true},{"meta":{"range":[180,226],"filename":"ProcessKeyCombo.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"name":"AdvanceKeyCombo","longname":"AdvanceKeyCombo","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ANY_KEY_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Global Key Down Event.\n\nThis event is dispatched by the Keyboard Plugin when any key on the keyboard is pressed down.\n\nListen to this event from within a Scene using: `this.input.keyboard.on('keydown', listener)`.\n\nYou can also listen for a specific key being pressed. See [Keyboard.Events.KEY_DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:KEY_DOWN} for details.\n\nFinally, you can create Key objects, which you can also listen for events from. See [Keyboard.Events.DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:DOWN} for details.\n\n_Note_: Many keyboards are unable to process certain combinations of keys due to hardware limitations known as ghosting.\nRead [this article on ghosting]{@link http://www.html5gamedevs.com/topic/4876-impossible-to-use-more-than-2-keyboard-input-buttons-at-the-same-time/} for details.\n\nAlso, please be aware that some browser extensions can disable or override Phaser keyboard handling.\nFor example, the Chrome extension vimium is known to disable Phaser from using the D key, while EverNote disables the backtick key.\nThere are others. So, please check your extensions if you find you have specific keys that don't work.","kind":"event","name":"ANY_KEY_DOWN","since":"3.0.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event. You can inspect this to learn more about the key that was pressed, any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:ANY_KEY_DOWN","scope":"instance","___s":true},{"meta":{"filename":"ANY_KEY_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Global Key Up Event.\n\nThis event is dispatched by the Keyboard Plugin when any key on the keyboard is released.\n\nListen to this event from within a Scene using: `this.input.keyboard.on('keyup', listener)`.\n\nYou can also listen for a specific key being released. See [Keyboard.Events.KEY_UP]{@linkcode Phaser.Input.Keyboard.Events#event:KEY_UP} for details.\n\nFinally, you can create Key objects, which you can also listen for events from. See [Keyboard.Events.UP]{@linkcode Phaser.Input.Keyboard.Events#event:UP} for details.","kind":"event","name":"ANY_KEY_UP","since":"3.0.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event. You can inspect this to learn more about the key that was released, any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:ANY_KEY_UP","scope":"instance","___s":true},{"meta":{"filename":"COMBO_MATCH_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Key Combo Match Event.\n\nThis event is dispatched by the Keyboard Plugin when a [Key Combo]{@link Phaser.Input.Keyboard.KeyCombo} is matched.\n\nListen for this event from the Key Plugin after a combo has been created:\n\n```javascript\nthis.input.keyboard.createCombo([ 38, 38, 40, 40, 37, 39, 37, 39, 66, 65, 13 ], { resetOnMatch: true });\n\nthis.input.keyboard.on('keycombomatch', function (event) {\n console.log('Konami Code entered!');\n});\n```","kind":"event","name":"COMBO_MATCH","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.KeyCombo"]},"description":"The Key Combo object that was matched.","name":"keycombo"},{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event of the final key in the combo. You can inspect this to learn more about any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:COMBO_MATCH","scope":"instance","___s":true},{"meta":{"filename":"DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Key Down Event.\n\nThis event is dispatched by a [Key]{@link Phaser.Input.Keyboard.Key} object when it is pressed.\n\nListen for this event from the Key object instance directly:\n\n```javascript\nvar spaceBar = this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.SPACE);\n\nspaceBar.on('down', listener)\n```\n\nYou can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_DOWN} for details.","kind":"event","name":"DOWN","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The Key object that was pressed.","name":"key"},{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event. You can inspect this to learn more about any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:DOWN","scope":"instance","___s":true},{"meta":{"filename":"KEY_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Key Down Event.\n\nThis event is dispatched by the Keyboard Plugin when any key on the keyboard is pressed down.\n\nUnlike the `ANY_KEY_DOWN` event, this one has a special dynamic event name. For example, to listen for the `A` key being pressed\nuse the following from within a Scene: `this.input.keyboard.on('keydown-A', listener)`. You can replace the `-A` part of the event\nname with any valid [Key Code string]{@link Phaser.Input.Keyboard.KeyCodes}. For example, this will listen for the space bar: \n`this.input.keyboard.on('keydown-SPACE', listener)`.\n\nYou can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_DOWN} for details.\n\nFinally, you can create Key objects, which you can also listen for events from. See [Keyboard.Events.DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:DOWN} for details.\n\n_Note_: Many keyboards are unable to process certain combinations of keys due to hardware limitations known as ghosting.\nRead [this article on ghosting]{@link http://www.html5gamedevs.com/topic/4876-impossible-to-use-more-than-2-keyboard-input-buttons-at-the-same-time/} for details.\n\nAlso, please be aware that some browser extensions can disable or override Phaser keyboard handling.\nFor example, the Chrome extension vimium is known to disable Phaser from using the D key, while EverNote disables the backtick key.\nThere are others. So, please check your extensions if you find you have specific keys that don't work.","kind":"event","name":"KEY_DOWN","since":"3.0.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event. You can inspect this to learn more about the key that was pressed, any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:KEY_DOWN","scope":"instance","___s":true},{"meta":{"filename":"KEY_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Key Up Event.\n\nThis event is dispatched by the Keyboard Plugin when any key on the keyboard is released.\n\nUnlike the `ANY_KEY_UP` event, this one has a special dynamic event name. For example, to listen for the `A` key being released\nuse the following from within a Scene: `this.input.keyboard.on('keyup-A', listener)`. You can replace the `-A` part of the event\nname with any valid [Key Code string]{@link Phaser.Input.Keyboard.KeyCodes}. For example, this will listen for the space bar: \n`this.input.keyboard.on('keyup-SPACE', listener)`.\n\nYou can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_UP]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_UP} for details.\n\nFinally, you can create Key objects, which you can also listen for events from. See [Keyboard.Events.UP]{@linkcode Phaser.Input.Keyboard.Events#event:UP} for details.","kind":"event","name":"KEY_UP","since":"3.0.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event. You can inspect this to learn more about the key that was released, any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:KEY_UP","scope":"instance","___s":true},{"meta":{"filename":"UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Key Up Event.\n\nThis event is dispatched by a [Key]{@link Phaser.Input.Keyboard.Key} object when it is released.\n\nListen for this event from the Key object instance directly:\n\n```javascript\nvar spaceBar = this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.SPACE);\n\nspaceBar.on('up', listener)\n```\n\nYou can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_UP]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_UP} for details.","kind":"event","name":"UP","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The Key object that was released.","name":"key"},{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event. You can inspect this to learn more about any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:UP","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Input.Keyboard","longname":"Phaser.Input.Keyboard.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"kind":"namespace","name":"Keyboard","memberof":"Phaser.Input","longname":"Phaser.Input.Keyboard","scope":"static","___s":true},{"meta":{"filename":"DownDuration.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Returns `true` if the Key was pressed down within the `duration` value given, based on the current\ngame clock time. Or `false` if it either isn't down, or was pressed down longer ago than the given duration.","kind":"function","name":"DownDuration","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The Key object to test.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":50,"description":"The duration, in ms, within which the key must have been pressed down.","name":"duration"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Key was pressed down within `duration` ms ago, otherwise `false`."}],"memberof":"Phaser.Input.Keyboard","longname":"Phaser.Input.Keyboard.DownDuration","scope":"static","___s":true},{"meta":{"filename":"JustDown.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The justDown value allows you to test if this Key has just been pressed down or not.\n\nWhen you check this value it will return `true` if the Key is down, otherwise `false`.\n\nYou can only call justDown once per key press. It will only return `true` once, until the Key is released and pressed down again.\nThis allows you to use it in situations where you want to check if this key is down without using an event, such as in a core game loop.","kind":"function","name":"JustDown","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The Key to check to see if it's just down or not.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Key was just pressed, otherwise `false`."}],"memberof":"Phaser.Input.Keyboard","longname":"Phaser.Input.Keyboard.JustDown","scope":"static","___s":true},{"meta":{"filename":"JustUp.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The justUp value allows you to test if this Key has just been released or not.\n\nWhen you check this value it will return `true` if the Key is up, otherwise `false`.\n\nYou can only call JustUp once per key release. It will only return `true` once, until the Key is pressed down and released again.\nThis allows you to use it in situations where you want to check if this key is up without using an event, such as in a core game loop.","kind":"function","name":"JustUp","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The Key to check to see if it's just up or not.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Key was just released, otherwise `false`."}],"memberof":"Phaser.Input.Keyboard","longname":"Phaser.Input.Keyboard.JustUp","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"Key.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Key.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"classdesc":"A generic Key object which can be passed to the Process functions (and so on)\nkeycode must be an integer","kind":"class","name":"Key","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Input.Keyboard","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"The Keyboard Plugin instance that owns this Key object.","name":"plugin"},{"type":{"names":["integer"]},"description":"The keycode of this key.","name":"keyCode"}],"scope":"static","longname":"Phaser.Input.Keyboard.Key","___s":true},{"meta":{"filename":"Key.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The Keyboard Plugin instance that owns this Key object.","name":"plugin","type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"since":"3.17.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#plugin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The keycode of this key.","name":"keyCode","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#keyCode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The original DOM event.","name":"originalEvent","type":{"names":["KeyboardEvent"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#originalEvent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Can this Key be processed?","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The \"down\" state of the key. This will remain `true` for as long as the keyboard thinks this key is held down.","name":"isDown","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#isDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The \"up\" state of the key. This will remain `true` for as long as the keyboard thinks this key is up.","name":"isUp","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#isUp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The down state of the ALT key, if pressed at the same time as this key.","name":"altKey","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#altKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The down state of the CTRL key, if pressed at the same time as this key.","name":"ctrlKey","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#ctrlKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The down state of the SHIFT key, if pressed at the same time as this key.","name":"shiftKey","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#shiftKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The down state of the Meta key, if pressed at the same time as this key.\nOn a Mac the Meta Key is the Command key. On Windows keyboards, it's the Windows key.","name":"metaKey","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.16.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#metaKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The location of the modifier key. 0 for standard (or unknown), 1 for left, 2 for right, 3 for numpad.","name":"location","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#location","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":143,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The timestamp when the key was last pressed down.","name":"timeDown","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#timeDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":153,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The number of milliseconds this key was held down for in the previous down - up sequence.\nThis value isn't updated every game step, only when the Key changes state.\nTo get the current duration use the `getDuration` method.","name":"duration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The timestamp when the key was last released.","name":"timeUp","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#timeUp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":175,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"When a key is held down should it continuously fire the `down` event each time it repeats?\n\nBy default it will emit the `down` event just once, but if you wish to receive the event\nfor each repeat as well, enable this property.","name":"emitOnRepeat","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.16.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#emitOnRepeat","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":188,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"If a key is held down this holds down the number of times the key has 'repeated'.","name":"repeats","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#repeats","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Controls if this Key will continuously emit a `down` event while being held down (true),\nor emit the event just once, on first press, and then skip future events (false).","kind":"function","name":"setEmitOnRepeat","since":"3.16.0","params":[{"type":{"names":["boolean"]},"description":"Emit `down` events on repeated key down actions, or just once?","name":"value"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"This Key instance."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#setEmitOnRepeat","scope":"instance","___s":true},{"meta":{"filename":"Key.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Processes the Key Down action for this Key.\nCalled automatically by the Keyboard Plugin.","kind":"function","name":"onDown","fires":["Phaser.Input.Keyboard.Events#event:DOWN"],"since":"3.16.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard event.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#onDown","scope":"instance","___s":true},{"meta":{"filename":"Key.js","lineno":293,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Processes the Key Up action for this Key.\nCalled automatically by the Keyboard Plugin.","kind":"function","name":"onUp","fires":["Phaser.Input.Keyboard.Events#event:UP"],"since":"3.16.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard event.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#onUp","scope":"instance","___s":true},{"meta":{"filename":"Key.js","lineno":325,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Resets this Key object back to its default un-pressed state.","kind":"function","name":"reset","since":"3.6.0","returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"This Key instance."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#reset","scope":"instance","___s":true},{"meta":{"filename":"Key.js","lineno":354,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Returns the duration, in ms, that the Key has been held down for.\n\nIf the key is not currently down it will return zero.\n\nThe get the duration the Key was held down for in the previous up-down cycle,\nuse the `Key.duration` property value instead.","kind":"function","name":"getDuration","since":"3.17.0","returns":[{"type":{"names":["number"]},"description":"The duration, in ms, that the Key has been held down for if currently down."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#getDuration","scope":"instance","___s":true},{"meta":{"filename":"Key.js","lineno":379,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Removes any bound event handlers and removes local references.","kind":"function","name":"destroy","since":"3.16.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Keyboard Codes.","kind":"namespace","name":"KeyCodes","memberof":"Phaser.Input.Keyboard","since":"3.0.0","longname":"Phaser.Input.Keyboard.KeyCodes","scope":"static","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The BACKSPACE key.","name":"BACKSPACE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.BACKSPACE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":26,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The TAB key.","name":"TAB","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.TAB","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The ENTER key.","name":"ENTER","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.ENTER","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The SHIFT key.","name":"SHIFT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.SHIFT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The CTRL key.","name":"CTRL","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.CTRL","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":62,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The ALT key.","name":"ALT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.ALT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The PAUSE key.","name":"PAUSE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.PAUSE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The CAPS_LOCK key.","name":"CAPS_LOCK","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.CAPS_LOCK","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":89,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The ESC key.","name":"ESC","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.ESC","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The SPACE key.","name":"SPACE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.SPACE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The PAGE_UP key.","name":"PAGE_UP","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.PAGE_UP","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":116,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The PAGE_DOWN key.","name":"PAGE_DOWN","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.PAGE_DOWN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The END key.","name":"END","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.END","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The HOME key.","name":"HOME","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.HOME","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":143,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The LEFT key.","name":"LEFT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.LEFT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The UP key.","name":"UP","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.UP","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":161,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The RIGHT key.","name":"RIGHT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.RIGHT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The DOWN key.","name":"DOWN","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.DOWN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":179,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The PRINT_SCREEN key.","name":"PRINT_SCREEN","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.PRINT_SCREEN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The INSERT key.","name":"INSERT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.INSERT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The DELETE key.","name":"DELETE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.DELETE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The ZERO key.","name":"ZERO","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.ZERO","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The ONE key.","name":"ONE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.ONE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":224,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The TWO key.","name":"TWO","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.TWO","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":233,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The THREE key.","name":"THREE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.THREE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The FOUR key.","name":"FOUR","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.FOUR","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":251,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The FIVE key.","name":"FIVE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.FIVE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The SIX key.","name":"SIX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.SIX","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The SEVEN key.","name":"SEVEN","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.SEVEN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The EIGHT key.","name":"EIGHT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.EIGHT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NINE key.","name":"NINE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NINE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":296,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_ZERO key.","name":"NUMPAD_ZERO","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_ZERO","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":305,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_ONE key.","name":"NUMPAD_ONE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_ONE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_TWO key.","name":"NUMPAD_TWO","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_TWO","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":323,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_THREE key.","name":"NUMPAD_THREE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_THREE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_FOUR key.","name":"NUMPAD_FOUR","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_FOUR","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":341,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_FIVE key.","name":"NUMPAD_FIVE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_FIVE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_SIX key.","name":"NUMPAD_SIX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_SIX","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_SEVEN key.","name":"NUMPAD_SEVEN","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_SEVEN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":368,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_EIGHT key.","name":"NUMPAD_EIGHT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_EIGHT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":377,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_NINE key.","name":"NUMPAD_NINE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_NINE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":386,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The Numpad Addition (+) key.","name":"NUMPAD_ADD","type":{"names":["integer"]},"since":"3.21.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_ADD","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":395,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The Numpad Subtraction (-) key.","name":"NUMPAD_SUBTRACT","type":{"names":["integer"]},"since":"3.21.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_SUBTRACT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":404,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The A key.","name":"A","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.A","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":413,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The B key.","name":"B","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.B","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":422,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The C key.","name":"C","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.C","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The D key.","name":"D","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.D","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":440,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The E key.","name":"E","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.E","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F key.","name":"F","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":458,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The G key.","name":"G","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.G","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":467,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The H key.","name":"H","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.H","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The I key.","name":"I","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.I","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The J key.","name":"J","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.J","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The K key.","name":"K","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.K","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":503,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The L key.","name":"L","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.L","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":512,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The M key.","name":"M","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.M","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":521,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The N key.","name":"N","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.N","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":530,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The O key.","name":"O","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.O","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":539,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The P key.","name":"P","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.P","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":548,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The Q key.","name":"Q","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.Q","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":557,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The R key.","name":"R","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.R","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":566,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The S key.","name":"S","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.S","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":575,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The T key.","name":"T","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.T","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":584,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The U key.","name":"U","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.U","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":593,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The V key.","name":"V","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.V","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":602,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The W key.","name":"W","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.W","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":611,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The X key.","name":"X","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.X","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":620,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The Y key.","name":"Y","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.Y","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":629,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The Z key.","name":"Z","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.Z","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":638,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F1 key.","name":"F1","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F1","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":647,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F2 key.","name":"F2","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F2","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":656,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F3 key.","name":"F3","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F3","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":665,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F4 key.","name":"F4","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F4","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":674,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F5 key.","name":"F5","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F5","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F6 key.","name":"F6","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F6","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":692,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F7 key.","name":"F7","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F7","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":701,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F8 key.","name":"F8","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F8","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":710,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F9 key.","name":"F9","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F9","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":719,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F10 key.","name":"F10","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F10","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":728,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F11 key.","name":"F11","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F11","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":737,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F12 key.","name":"F12","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F12","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":746,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The SEMICOLON key.","name":"SEMICOLON","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.SEMICOLON","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":755,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The PLUS key.","name":"PLUS","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.PLUS","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":764,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The COMMA key.","name":"COMMA","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.COMMA","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":773,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The MINUS key.","name":"MINUS","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.MINUS","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":782,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The PERIOD key.","name":"PERIOD","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.PERIOD","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":791,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The FORWARD_SLASH key.","name":"FORWARD_SLASH","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.FORWARD_SLASH","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":800,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The BACK_SLASH key.","name":"BACK_SLASH","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.BACK_SLASH","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":809,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The QUOTES key.","name":"QUOTES","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.QUOTES","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":818,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The BACKTICK key.","name":"BACKTICK","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.BACKTICK","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":827,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The OPEN_BRACKET key.","name":"OPEN_BRACKET","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.OPEN_BRACKET","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":836,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The CLOSED_BRACKET key.","name":"CLOSED_BRACKET","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.CLOSED_BRACKET","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":845,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The SEMICOLON_FIREFOX key.","name":"SEMICOLON_FIREFOX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.SEMICOLON_FIREFOX","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":854,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The COLON key.","name":"COLON","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.COLON","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":863,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The COMMA_FIREFOX_WINDOWS key.","name":"COMMA_FIREFOX_WINDOWS","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.COMMA_FIREFOX_WINDOWS","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":872,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The COMMA_FIREFOX key.","name":"COMMA_FIREFOX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.COMMA_FIREFOX","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":881,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The BRACKET_RIGHT_FIREFOX key.","name":"BRACKET_RIGHT_FIREFOX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.BRACKET_RIGHT_FIREFOX","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":890,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The BRACKET_LEFT_FIREFOX key.","name":"BRACKET_LEFT_FIREFOX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.BRACKET_LEFT_FIREFOX","scope":"static","kind":"member","___s":true},{"meta":{"range":[180,212],"filename":"KeyMap.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"name":"KeyCodes","longname":"KeyCodes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"UpDuration.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Returns `true` if the Key was released within the `duration` value given, based on the current\ngame clock time. Or returns `false` if it either isn't up, or was released longer ago than the given duration.","kind":"function","name":"UpDuration","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The Key object to test.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":50,"description":"The duration, in ms, within which the key must have been released.","name":"duration"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Key was released within `duration` ms ago, otherwise `false`."}],"memberof":"Phaser.Input.Keyboard","longname":"Phaser.Input.Keyboard.UpDuration","scope":"static","___s":true},{"meta":{"filename":"CursorKeys.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs"},"kind":"typedef","name":"CursorKeys","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"A Key object mapping to the UP arrow key.","name":"up"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"A Key object mapping to the DOWN arrow key.","name":"down"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"A Key object mapping to the LEFT arrow key.","name":"left"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"A Key object mapping to the RIGHT arrow key.","name":"right"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"A Key object mapping to the SPACE BAR key.","name":"space"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"A Key object mapping to the SHIFT key.","name":"shift"}],"memberof":"Phaser.Types.Input.Keyboard","longname":"Phaser.Types.Input.Keyboard.CursorKeys","scope":"static","___s":true},{"meta":{"filename":"KeyComboConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs"},"kind":"typedef","name":"KeyComboConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If they press the wrong key do we reset the combo?","name":"resetOnWrongKey"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The max delay in ms between each key press. Above this the combo is reset. 0 means disabled.","name":"maxKeyDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If previously matched and they press the first key of the combo again, will it reset?","name":"resetOnMatch"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If the combo matches, will it delete itself?","name":"deleteOnMatch"}],"memberof":"Phaser.Types.Input.Keyboard","longname":"Phaser.Types.Input.Keyboard.KeyComboConfig","scope":"static","___s":true},{"meta":{"filename":"KeyboardKeydownCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs"},"kind":"typedef","name":"KeyboardKeydownCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The Keyboard Event.","name":"event"}],"memberof":"Phaser.Types.Input.Keyboard","longname":"Phaser.Types.Input.Keyboard.KeyboardKeydownCallback","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs"},"kind":"namespace","name":"Keyboard","memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.Keyboard","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"MouseManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MouseManager.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"classdesc":"The Mouse Manager is a helper class that belongs to the Input Manager.\n\nIts role is to listen for native DOM Mouse Events and then pass them onto the Input Manager for further processing.\n\nYou do not need to create this class directly, the Input Manager will create an instance of it automatically.","kind":"class","name":"MouseManager","memberof":"Phaser.Input.Mouse","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.InputManager"]},"description":"A reference to the Input Manager.","name":"inputManager"}],"scope":"static","longname":"Phaser.Input.Mouse.MouseManager","___s":true},{"meta":{"filename":"MouseManager.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"A reference to the Input Manager.","name":"manager","type":{"names":["Phaser.Input.InputManager"]},"since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"If true the DOM mouse events will have event.preventDefault applied to them, if false they will propagate fully.","name":"capture","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#capture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"A boolean that controls if the Mouse Manager is enabled or not.\nCan be toggled on the fly.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse target, as defined in the Game Config.\nTypically the canvas to which the game is rendering, but can be any interactive DOM element.","name":"target","type":{"names":["any"]},"since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#target","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"If the mouse has been pointer locked successfully this will be set to true.","name":"locked","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#locked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Move Event handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseMove","type":{"names":["function"]},"since":"3.10.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseMove","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Down Event handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseDown","type":{"names":["function"]},"since":"3.10.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Up Event handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseUp","type":{"names":["function"]},"since":"3.10.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseUp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Down Event handler specifically for events on the Window.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseDownWindow","type":{"names":["function"]},"since":"3.17.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseDownWindow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Up Event handler specifically for events on the Window.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseUpWindow","type":{"names":["function"]},"since":"3.17.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseUpWindow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Over Event handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseOver","type":{"names":["function"]},"since":"3.16.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseOver","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Out Event handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseOut","type":{"names":["function"]},"since":"3.16.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseOut","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":163,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Wheel Event handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseWheel","type":{"names":["function"]},"since":"3.18.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseWheel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"Internal pointerLockChange handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"pointerLockChange","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#pointerLockChange","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"Attempts to disable the context menu from appearing if you right-click on the browser.\n\nWorks by listening for the `contextmenu` event and prevent defaulting it.\n\nUse this if you need to enable right-button mouse support in your game, and the browser\nmenu keeps getting in the way.","kind":"function","name":"disableContextMenu","since":"3.0.0","returns":[{"type":{"names":["Phaser.Input.Mouse.MouseManager"]},"description":"This Mouse Manager instance."}],"memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#disableContextMenu","scope":"instance","___s":true},{"meta":{"filename":"MouseManager.js","lineno":247,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"If the browser supports it, you can request that the pointer be locked to the browser window.\n\nThis is classically known as 'FPS controls', where the pointer can't leave the browser until\nthe user presses an exit key.\n\nIf the browser successfully enters a locked state, a `POINTER_LOCK_CHANGE_EVENT` will be dispatched,\nfrom the games Input Manager, with an `isPointerLocked` property.\n\nIt is important to note that pointer lock can only be enabled after an 'engagement gesture',\nsee: https://w3c.github.io/pointerlock/#dfn-engagement-gesture.","kind":"function","name":"requestPointerLock","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#requestPointerLock","scope":"instance","___s":true},{"meta":{"filename":"MouseManager.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"If the browser supports pointer lock, this will request that the pointer lock is released. If\nthe browser successfully enters a locked state, a 'POINTER_LOCK_CHANGE_EVENT' will be\ndispatched - from the game's input manager - with an `isPointerLocked` property.","kind":"function","name":"releasePointerLock","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#releasePointerLock","scope":"instance","___s":true},{"meta":{"filename":"MouseManager.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"Starts the Mouse Event listeners running.\nThis is called automatically and does not need to be manually invoked.","kind":"function","name":"startListeners","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#startListeners","scope":"instance","___s":true},{"meta":{"filename":"MouseManager.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"Stops the Mouse Event listeners.\nThis is called automatically and does not need to be manually invoked.","kind":"function","name":"stopListeners","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#stopListeners","scope":"instance","___s":true},{"meta":{"filename":"MouseManager.js","lineno":463,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"Destroys this Mouse Manager instance.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"kind":"namespace","name":"Mouse","memberof":"Phaser.Input","longname":"Phaser.Input.Mouse","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"TouchManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TouchManager.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"classdesc":"The Touch Manager is a helper class that belongs to the Input Manager.\n\nIts role is to listen for native DOM Touch Events and then pass them onto the Input Manager for further processing.\n\nYou do not need to create this class directly, the Input Manager will create an instance of it automatically.","kind":"class","name":"TouchManager","memberof":"Phaser.Input.Touch","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.InputManager"]},"description":"A reference to the Input Manager.","name":"inputManager"}],"scope":"static","longname":"Phaser.Input.Touch.TouchManager","___s":true},{"meta":{"filename":"TouchManager.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"A reference to the Input Manager.","name":"manager","type":{"names":["Phaser.Input.InputManager"]},"since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"If true the DOM events will have event.preventDefault applied to them, if false they will propagate fully.","name":"capture","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#capture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"A boolean that controls if the Touch Manager is enabled or not.\nCan be toggled on the fly.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Event target, as defined in the Game Config.\nTypically the canvas to which the game is rendering, but can be any interactive DOM element.","name":"target","type":{"names":["any"]},"since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#target","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Start event handler function.\nInitially empty and bound in the `startListeners` method.","name":"onTouchStart","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchStart","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Start event handler function specifically for events on the Window.\nInitially empty and bound in the `startListeners` method.","name":"onTouchStartWindow","type":{"names":["function"]},"since":"3.17.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchStartWindow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Move event handler function.\nInitially empty and bound in the `startListeners` method.","name":"onTouchMove","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchMove","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch End event handler function.\nInitially empty and bound in the `startListeners` method.","name":"onTouchEnd","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchEnd","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch End event handler function specifically for events on the Window.\nInitially empty and bound in the `startListeners` method.","name":"onTouchEndWindow","type":{"names":["function"]},"since":"3.17.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchEndWindow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Cancel event handler function.\nInitially empty and bound in the `startListeners` method.","name":"onTouchCancel","type":{"names":["function"]},"since":"3.15.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchCancel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Cancel event handler function specifically for events on the Window.\nInitially empty and bound in the `startListeners` method.","name":"onTouchCancelWindow","type":{"names":["function"]},"since":"3.18.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchCancelWindow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":146,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Over event handler function.\nInitially empty and bound in the `startListeners` method.","name":"onTouchOver","type":{"names":["function"]},"since":"3.16.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchOver","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Out event handler function.\nInitially empty and bound in the `startListeners` method.","name":"onTouchOut","type":{"names":["function"]},"since":"3.16.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchOut","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":200,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"Attempts to disable the context menu from appearing if you touch-hold on the browser.\n\nWorks by listening for the `contextmenu` event and prevent defaulting it.\n\nUse this if you need to disable the OS context menu on mobile.","kind":"function","name":"disableContextMenu","since":"3.20.0","returns":[{"type":{"names":["Phaser.Input.Touch.TouchManager"]},"description":"This Touch Manager instance."}],"memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#disableContextMenu","scope":"instance","___s":true},{"meta":{"filename":"TouchManager.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"Starts the Touch Event listeners running as long as an input target is set.\n\nThis method is called automatically if Touch Input is enabled in the game config,\nwhich it is by default. However, you can call it manually should you need to\ndelay input capturing until later in the game.","kind":"function","name":"startListeners","since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#startListeners","scope":"instance","___s":true},{"meta":{"filename":"TouchManager.js","lineno":365,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"Stops the Touch Event listeners.\nThis is called automatically and does not need to be manually invoked.","kind":"function","name":"stopListeners","since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#stopListeners","scope":"instance","___s":true},{"meta":{"filename":"TouchManager.js","lineno":390,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"Destroys this Touch Manager instance.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"kind":"namespace","name":"Touch","memberof":"Phaser.Input","longname":"Phaser.Input.Touch","scope":"static","___s":true},{"meta":{"filename":"EventData.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/typedefs"},"description":"A Phaser Input Event Data object.\n\nThis object is passed to the registered event listeners and allows you to stop any further propagation.","kind":"typedef","name":"EventData","type":{"names":["object"]},"since":"3.15.1","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The cancelled state of this Event.","name":"cancelled"},{"type":{"names":["function"]},"description":"Call this method to stop this event from passing any further down the event chain.","name":"stopPropagation"}],"memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.EventData","scope":"static","___s":true},{"meta":{"filename":"HitAreaCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/typedefs"},"kind":"typedef","name":"HitAreaCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["any"]},"description":"The hit area object.","name":"hitArea"},{"type":{"names":["number"]},"description":"The translated x coordinate of the hit test event.","name":"x"},{"type":{"names":["number"]},"description":"The translated y coordinate of the hit test event.","name":"y"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that invoked the hit test.","name":"gameObject"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the coordinates fall within the space of the hitArea, otherwise `false`."}],"memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.HitAreaCallback","scope":"static","___s":true},{"meta":{"filename":"InputConfiguration.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/typedefs"},"kind":"typedef","name":"InputConfiguration","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["any"]},"optional":true,"description":"The object / shape to use as the Hit Area. If not given it will try to create a Rectangle based on the texture frame.","name":"hitArea"},{"type":{"names":["function"]},"optional":true,"description":"The callback that determines if the pointer is within the Hit Area shape or not.","name":"hitAreaCallback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the Interactive Object will be set to be draggable and emit drag events.","name":"draggable"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the Interactive Object will be set to be a drop zone for draggable objects.","name":"dropZone"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the Interactive Object will set the `pointer` hand cursor when a pointer is over it. This is a short-cut for setting `cursor: 'pointer'`.","name":"useHandCursor"},{"type":{"names":["string"]},"optional":true,"description":"The CSS string to be used when the cursor is over this Interactive Object.","name":"cursor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the a pixel perfect function will be set for the hit area callback. Only works with texture based Game Objects.","name":"pixelPerfect"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"If `pixelPerfect` is set, this is the alpha tolerance threshold value used in the callback.","name":"alphaTolerance"}],"memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.InputConfiguration","scope":"static","___s":true},{"meta":{"filename":"InputPluginContainer.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/typedefs"},"kind":"typedef","name":"InputPluginContainer","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The unique name of this plugin in the input plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"The plugin to be stored. Should be the source object, not instantiated.","name":"plugin"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Input Plugin, this is the property key map used.","name":"mapping"}],"memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.InputPluginContainer","scope":"static","___s":true},{"meta":{"filename":"InteractiveObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/typedefs"},"kind":"typedef","name":"InteractiveObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to which this Interactive Object is bound.","name":"gameObject"},{"type":{"names":["boolean"]},"description":"Is this Interactive Object currently enabled for input events?","name":"enabled"},{"type":{"names":["boolean"]},"description":"An Interactive Object that is 'always enabled' will receive input even if the parent object is invisible or won't render.","name":"alwaysEnabled"},{"type":{"names":["boolean"]},"description":"Is this Interactive Object draggable? Enable with `InputPlugin.setDraggable`.","name":"draggable"},{"type":{"names":["boolean"]},"description":"Is this Interactive Object a drag-targets drop zone? Set when the object is created.","name":"dropZone"},{"type":{"names":["boolean","string"]},"description":"Should this Interactive Object change the cursor (via css) when over? (desktop only)","name":"cursor"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"description":"An optional drop target for a draggable Interactive Object.","name":"target"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The most recent Camera to be tested against this Interactive Object.","name":"camera"},{"type":{"names":["any"]},"description":"The hit area for this Interactive Object. Typically a geometry shape, like a Rectangle or Circle.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"The 'contains' check callback that the hit area shape will use for all hit tests.","name":"hitAreaCallback"},{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"If this Interactive Object has been enabled for debug, via `InputPlugin.enableDebug` then this property holds its debug shape.","name":"hitAreaDebug"},{"type":{"names":["boolean"]},"description":"Was the hitArea for this Interactive Object created based on texture size (false), or a custom shape? (true)","name":"customHitArea"},{"type":{"names":["number"]},"description":"The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localX"},{"type":{"names":["number"]},"description":"The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localY"},{"type":{"names":["0","1","2"]},"description":"The current drag state of this Interactive Object. 0 = Not being dragged, 1 = being checked for drag, or 2 = being actively dragged.","name":"dragState"},{"type":{"names":["number"]},"description":"The x coordinate of the Game Object that owns this Interactive Object when the drag started.","name":"dragStartX"},{"type":{"names":["number"]},"description":"The y coordinate of the Game Object that owns this Interactive Object when the drag started.","name":"dragStartY"},{"type":{"names":["number"]},"description":"The x coordinate that the Pointer started dragging this Interactive Object from.","name":"dragStartXGlobal"},{"type":{"names":["number"]},"description":"The y coordinate that the Pointer started dragging this Interactive Object from.","name":"dragStartYGlobal"},{"type":{"names":["number"]},"description":"The x coordinate that this Interactive Object is currently being dragged to.","name":"dragX"},{"type":{"names":["number"]},"description":"The y coordinate that this Interactive Object is currently being dragged to.","name":"dragY"}],"memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.InteractiveObject","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/typedefs"},"kind":"namespace","name":"Input","memberof":"Phaser.Types","longname":"Phaser.Types.Input","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"File.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"File.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"classdesc":"The base File class used by all File Types that the Loader can support.\nYou shouldn't create an instance of a File directly, but should extend it with your own class, setting a custom type and processing methods.","kind":"class","name":"File","memberof":"Phaser.Loader","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader that is going to load this File.","name":"loader"},{"type":{"names":["Phaser.Types.Loader.FileConfig"]},"description":"The file configuration object, as created by the file type.","name":"fileConfig"}],"scope":"static","longname":"Phaser.Loader.File","___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#loader","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#cache","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#url","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#src","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#xhrSettings","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#xhrLoader","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#state","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#bytesTotal","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#bytesLoaded","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#percentComplete","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#crossOrigin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#multiFile","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#linkFile","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#setLink","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#resetXHR","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#load","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#onLoad","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#onError","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#onProgress","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Usually overridden by the FileTypes and is called by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data, for example a JSON file will parse itself during this stage.","kind":"function","name":"onProcess","since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#onProcess","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#onProcessComplete","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#onProcessError","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#hasCacheConflict","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#addToCache","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#pendingDestroy","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#destroy","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":483,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Static method for creating object URL using URL API and setting it as image 'src' attribute.\nIf URL API is not supported (usually on old browsers) it falls back to creating Base64 encoded url using FileReader.","kind":"function","name":"createObjectURL","scope":"static","since":"3.7.0","params":[{"type":{"names":["HTMLImageElement"]},"description":"Image object which 'src' attribute should be set to object URL.","name":"image"},{"type":{"names":["Blob"]},"description":"A Blob object to create an object URL for.","name":"blob"},{"type":{"names":["string"]},"description":"Default mime type used if blob type is not available.","name":"defaultType"}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File.createObjectURL","___s":true},{"meta":{"filename":"File.js","lineno":517,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Static method for releasing an existing object URL which was previously created\nby calling {@link File#createObjectURL} method.","kind":"function","name":"revokeObjectURL","scope":"static","since":"3.7.0","params":[{"type":{"names":["HTMLImageElement"]},"description":"Image object which 'src' attribute should be revoked.","name":"image"}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File.revokeObjectURL","___s":true},{"meta":{"range":[180,190],"filename":"FileTypesManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"types","longname":"types","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FileTypesManager.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"kind":"namespace","name":"FileTypesManager","memberof":"Phaser.Loader","longname":"Phaser.Loader.FileTypesManager","scope":"static","___s":true},{"meta":{"filename":"FileTypesManager.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Static method called when a LoaderPlugin is created.\n\nLoops through the local types object and injects all of them as\nproperties into the LoaderPlugin instance.","kind":"function","name":"install","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The LoaderPlugin to install the types into.","name":"loader"}],"memberof":"Phaser.Loader.FileTypesManager","longname":"Phaser.Loader.FileTypesManager.install","scope":"static","___s":true},{"meta":{"filename":"FileTypesManager.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Static method called directly by the File Types.\n\nThe key is a reference to the function used to load the files via the Loader, i.e. `image`.","kind":"function","name":"register","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key that will be used as the method name in the LoaderPlugin.","name":"key"},{"type":{"names":["function"]},"description":"The function that will be called when LoaderPlugin.key is invoked.","name":"factoryFunction"}],"memberof":"Phaser.Loader.FileTypesManager","longname":"Phaser.Loader.FileTypesManager.register","scope":"static","___s":true},{"meta":{"filename":"FileTypesManager.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Removed all associated file types.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Loader.FileTypesManager","longname":"Phaser.Loader.FileTypesManager.destroy","scope":"static","___s":true},{"meta":{"filename":"GetURL.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Given a File and a baseURL value this returns the URL the File will use to download from.","kind":"function","name":"GetURL","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File object.","name":"file"},{"type":{"names":["string"]},"description":"A default base URL.","name":"baseURL"}],"returns":[{"type":{"names":["string"]},"description":"The URL the File will use."}],"memberof":"Phaser.Loader","longname":"Phaser.Loader.GetURL","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"LoaderPlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"classdesc":"The Loader handles loading all external content such as Images, Sounds, Texture Atlases and data files.\nYou typically interact with it via `this.load` in your Scene. Scenes can have a `preload` method, which is always\ncalled before the Scenes `create` method, allowing you to preload assets that the Scene may need.\n\nIf you call any `this.load` methods from outside of `Scene.preload` then you need to start the Loader going\nyourself by calling `Loader.start()`. It's only automatically started during the Scene preload.\n\nThe Loader uses a combination of tag loading (eg. Audio elements) and XHR and provides progress and completion events.\nFiles are loaded in parallel by default. The amount of concurrent connections can be controlled in your Game Configuration.\n\nOnce the Loader has started loading you are still able to add files to it. These can be injected as a result of a loader\nevent, the type of file being loaded (such as a pack file) or other external events. As long as the Loader hasn't finished\nsimply adding a new file to it, while running, will ensure it's added into the current queue.\n\nEvery Scene has its own instance of the Loader and they are bound to the Scene in which they are created. However,\nassets loaded by the Loader are placed into global game-level caches. For example, loading an XML file will place that\nfile inside `Game.cache.xml`, which is accessible from every Scene in your game, no matter who was responsible\nfor loading it. The same is true of Textures. A texture loaded in one Scene is instantly available to all other Scenes\nin your game.\n\nThe Loader works by using custom File Types. These are stored in the FileTypesManager, which injects them into the Loader\nwhen it's instantiated. You can create your own custom file types by extending either the File or MultiFile classes.\nSee those files for more details.","kind":"class","name":"LoaderPlugin","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Loader","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene which owns this Loader instance.","name":"scene"}],"scope":"static","longname":"Phaser.Loader.LoaderPlugin","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Scene which owns this Loader instance.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Scene Systems.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the global Cache Manager.","name":"cacheManager","type":{"names":["Phaser.Cache.CacheManager"]},"since":"3.7.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#cacheManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the global Texture Manager.","name":"textureManager","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#textureManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"An optional prefix that is automatically prepended to the start of every file key.\nIf prefix was `MENU.` and you load an image with the key 'Background' the resulting key would be `MENU.Background`.\nYou can set this directly, or call `Loader.setPrefix()`. It will then affect every file added to the Loader\nfrom that point on. It does _not_ change any file already in the load queue.","name":"prefix","type":{"names":["string"]},"defaultvalue":"''","since":"3.7.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#prefix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The value of `path`, if set, is placed before any _relative_ file path given. For example:\n\n```javascript\nthis.load.path = \"images/sprites/\";\nthis.load.image(\"ball\", \"ball.png\");\nthis.load.image(\"tree\", \"level1/oaktree.png\");\nthis.load.image(\"boom\", \"http://server.com/explode.png\");\n```\n\nWould load the `ball` file from `images/sprites/ball.png` and the tree from\n`images/sprites/level1/oaktree.png` but the file `boom` would load from the URL\ngiven as it's an absolute URL.\n\nPlease note that the path is added before the filename but *after* the baseURL (if set.)\n\nIf you set this property directly then it _must_ end with a \"/\". Alternatively, call `setPath()` and it'll do it for you.","name":"path","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#path","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If you want to append a URL before the path of any asset you can set this here.\n\nUseful if allowing the asset base url to be configured outside of the game code.\n\nIf you set this property directly then it _must_ end with a \"/\". Alternatively, call `setBaseURL()` and it'll do it for you.","name":"baseURL","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#baseURL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":172,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of concurrent / parallel resources to try and fetch at once.\n\nOld browsers limit 6 requests per domain; modern ones, especially those with HTTP/2 don't limit it at all.\n\nThe default is 32 but you can change this in your Game Config, or by changing this property before the Loader starts.","name":"maxParallelDownloads","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#maxParallelDownloads","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":185,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"xhr specific global settings (can be overridden on a per-file basis)","name":"xhr","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#xhr","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":200,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The crossOrigin value applied to loaded images. Very often this needs to be set to 'anonymous'.","name":"crossOrigin","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#crossOrigin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":209,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total number of files to load. It may not always be accurate because you may add to the Loader during the process\nof loading, especially if you load a Pack File. Therefore this value can change, but in most cases remains static.","name":"totalToLoad","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#totalToLoad","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The progress of the current load queue, as a float value between 0 and 1.\nThis is updated automatically as files complete loading.\nNote that it is possible for this value to go down again if you add content to the current load queue during a load.","name":"progress","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":232,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Files are placed in this Set when they're added to the Loader via `addFile`.\n\nThey are moved to the `inflight` Set when they start loading, and assuming a successful\nload, to the `queue` Set for further processing.\n\nBy the end of the load process this Set will be empty.","name":"list","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#list","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":246,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Files are stored in this Set while they're in the process of being loaded.\n\nUpon a successful load they are moved to the `queue` Set.\n\nBy the end of the load process this Set will be empty.","name":"inflight","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#inflight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":259,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Files are stored in this Set while they're being processed.\n\nIf the process is successful they are moved to their final destination, which could be\na Cache or the Texture Manager.\n\nAt the end of the load process this Set will be empty.","name":"queue","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#queue","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":284,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total number of files that failed to load during the most recent load.\nThis value is reset when you call `Loader.start`.","name":"totalFailed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#totalFailed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":295,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total number of files that successfully loaded during the most recent load.\nThis value is reset when you call `Loader.start`.","name":"totalComplete","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#totalComplete","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":306,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the Loader.","name":"state","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#state","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":357,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If you want to append a URL before the path of any asset you can set this here.\n\nUseful if allowing the asset base url to be configured outside of the game code.\n\nOnce a base URL is set it will affect every file loaded by the Loader from that point on. It does _not_ change any\nfile _already_ being loaded. To reset it, call this method with no arguments.","kind":"function","name":"setBaseURL","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The URL to use. Leave empty to reset.","name":"url"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"This Loader object."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#setBaseURL","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":386,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The value of `path`, if set, is placed before any _relative_ file path given. For example:\n\n```javascript\nthis.load.setPath(\"images/sprites/\");\nthis.load.image(\"ball\", \"ball.png\");\nthis.load.image(\"tree\", \"level1/oaktree.png\");\nthis.load.image(\"boom\", \"http://server.com/explode.png\");\n```\n\nWould load the `ball` file from `images/sprites/ball.png` and the tree from\n`images/sprites/level1/oaktree.png` but the file `boom` would load from the URL\ngiven as it's an absolute URL.\n\nPlease note that the path is added before the filename but *after* the baseURL (if set.)\n\nOnce a path is set it will then affect every file added to the Loader from that point on. It does _not_ change any\nfile _already_ in the load queue. To reset it, call this method with no arguments.","kind":"function","name":"setPath","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The path to use. Leave empty to reset.","name":"path"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"This Loader object."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#setPath","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"An optional prefix that is automatically prepended to the start of every file key.\n\nIf prefix was `MENU.` and you load an image with the key 'Background' the resulting key would be `MENU.Background`.\n\nOnce a prefix is set it will then affect every file added to the Loader from that point on. It does _not_ change any\nfile _already_ in the load queue. To reset it, call this method with no arguments.","kind":"function","name":"setPrefix","since":"3.7.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The prefix to use. Leave empty to reset.","name":"prefix"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"This Loader object."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#setPrefix","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":450,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Sets the Cross Origin Resource Sharing value used when loading files.\n\nFiles can override this value on a per-file basis by specifying an alternative `crossOrigin` value in their file config.\n\nOnce CORs is set it will then affect every file loaded by the Loader from that point on, as long as they don't have\ntheir own CORs setting. To reset it, call this method with no arguments.\n\nFor more details about CORs see https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS","kind":"function","name":"setCORS","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The value to use for the `crossOrigin` property in the load request.","name":"crossOrigin"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"This Loader object."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#setCORS","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":474,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds a file, or array of files, into the load queue.\n\nThe file must be an instance of `Phaser.Loader.File`, or a class that extends it. The Loader will check that the key\nused by the file won't conflict with any other key either in the loader, the inflight queue or the target cache.\nIf allowed it will then add the file into the pending list, read for the load to start. Or, if the load has already\nstarted, ready for the next batch of files to be pulled from the list to the inflight queue.\n\nYou should not normally call this method directly, but rather use one of the Loader methods like `image` or `atlas`,\nhowever you can call this as long as the file given to it is well formed.","kind":"function","name":"addFile","fires":["Phaser.Loader.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File","Array."]},"description":"The file, or array of files, to be added to the load queue.","name":"file"}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#addFile","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":519,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks the key and type of the given file to see if it will conflict with anything already\nin a Cache, the Texture Manager, or the list or inflight queues.","kind":"function","name":"keyExists","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to check the key of.","name":"file"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a cache or queue conflict, otherwise `false`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#keyExists","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":576,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Takes a well formed, fully parsed pack file object and adds its entries into the load queue. Usually you do not call\nthis method directly, but instead use `Loader.pack` and supply a path to a JSON file that holds the\npack data. However, if you've got the data prepared you can pass it to this method.\n\nYou can also provide an optional key. If you do then it will only add the entries from that part of the pack into\nto the load queue. If not specified it will add all entries it finds. For more details about the pack file format\nsee the `LoaderPlugin.pack` method.","kind":"function","name":"addPack","since":"3.7.0","params":[{"type":{"names":["any"]},"description":"The Pack File data to be parsed and each entry of it to added to the load queue.","name":"data"},{"type":{"names":["string"]},"optional":true,"description":"An optional key to use from the pack file data.","name":"packKey"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if any files were added to the queue, otherwise `false`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#addPack","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":648,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Is the Loader actively loading, or processing loaded files?","kind":"function","name":"isLoading","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Loader is busy loading or processing, otherwise `false`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#isLoading","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":661,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Is the Loader ready to start a new load?","kind":"function","name":"isReady","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Loader is ready to start a new load, otherwise `false`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#isReady","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":674,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Starts the Loader running. This will reset the progress and totals and then emit a `start` event.\nIf there is nothing in the queue the Loader will immediately complete, otherwise it will start\nloading the first batch of files.\n\nThe Loader is started automatically if the queue is populated within your Scenes `preload` method.\n\nHowever, outside of this, you need to call this method to start it.\n\nIf the Loader is already running this method will simply return.","kind":"function","name":"start","fires":["Phaser.Loader.Events#event:START"],"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#start","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called automatically during the load process.\nIt updates the `progress` value and then emits a progress event, which you can use to\ndisplay a loading bar in your game.","kind":"function","name":"updateProgress","fires":["Phaser.Loader.Events#event:PROGRESS"],"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#updateProgress","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":739,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called automatically during the load process.","kind":"function","name":"update","since":"3.10.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#update","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":793,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"An internal method called automatically by the XHRLoader belong to a File.\n\nThis method will remove the given file from the inflight Set and update the load progress.\nIf the file was successful its `onProcess` method is called, otherwise it is added to the delete queue.","kind":"function","name":"nextFile","fires":["Phaser.Loader.Events#event:FILE_LOAD","Phaser.Loader.Events#event:FILE_LOAD_ERROR"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that just finished loading, or errored during load.","name":"file"},{"type":{"names":["boolean"]},"description":"`true` if the file loaded successfully, otherwise `false`.","name":"success"}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#nextFile","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":841,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"An internal method that is called automatically by the File when it has finished processing.\n\nIf the process was successful, and the File isn't part of a MultiFile, its `addToCache` method is called.\n\nIt this then removed from the queue. If there are no more files to load `loadComplete` is called.","kind":"function","name":"fileProcessComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file that has finished processing.","name":"file"}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#fileProcessComplete","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":897,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called at the end when the load queue is exhausted and all files have either loaded or errored.\nBy this point every loaded file will now be in its associated cache and ready for use.\n\nAlso clears down the Sets, puts progress to 1 and clears the deletion queue.","kind":"function","name":"loadComplete","fires":["Phaser.Loader.Events#event:COMPLETE","Phaser.Loader.Events#event:POST_PROCESS"],"since":"3.7.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#loadComplete","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":930,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds a File into the pending-deletion queue.","kind":"function","name":"flagForRemoval","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to be queued for deletion when the Loader completes.","name":"file"}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#flagForRemoval","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":943,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Converts the given JSON data into a file that the browser then prompts you to download so you can save it locally.\n\nThe data must be well formed JSON and ready-parsed, not a JavaScript object.","kind":"function","name":"saveJSON","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The JSON data, ready parsed.","name":"data"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"file.json","description":"The name to save the JSON file as.","name":"filename"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"This Loader plugin."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#saveJSON","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":961,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Causes the browser to save the given data as a file to its default Downloads folder.\n\nCreates a DOM level anchor link, assigns it as being a `download` anchor, sets the href\nto be an ObjectURL based on the given data, and then invokes a click event.","kind":"function","name":"save","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The data to be saved. Will be passed through URL.createObjectURL.","name":"data"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"file.json","description":"The filename to save the file as.","name":"filename"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"application/json","description":"The file type to use when saving the file. Defaults to JSON.","name":"filetype"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"This Loader plugin."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#save","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":995,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the Loader.\n\nThis will clear all lists and reset the base URL, path and prefix.\n\nWarning: If the Loader is currently downloading files, or has files in its queue, they will be aborted.","kind":"function","name":"reset","since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#reset","scope":"instance","___s":true},{"meta":{"range":[180,222],"filename":"MergeXHRSettings.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"Extend","longname":"Extend","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MergeXHRSettings.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Takes two XHRSettings Objects and creates a new XHRSettings object from them.\n\nThe new object is seeded by the values given in the global settings, but any setting in\nthe local object overrides the global ones.","kind":"function","name":"MergeXHRSettings","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"description":"The global XHRSettings object.","name":"global"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"description":"The local XHRSettings object.","name":"local"}],"returns":[{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"description":"A newly formed XHRSettings object."}],"memberof":"Phaser.Loader","longname":"Phaser.Loader.MergeXHRSettings","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"MultiFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MultiFile.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"classdesc":"A MultiFile is a special kind of parent that contains two, or more, Files as children and looks after\nthe loading and processing of them all. It is commonly extended and used as a base class for file types such as AtlasJSON or BitmapFont.\n\nYou shouldn't create an instance of a MultiFile directly, but should extend it with your own class, setting a custom type and processing methods.","kind":"class","name":"MultiFile","memberof":"Phaser.Loader","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader that is going to load this File.","name":"loader"},{"type":{"names":["string"]},"description":"The file type string for sorting within the Loader.","name":"type"},{"type":{"names":["string"]},"description":"The key of the file within the loader.","name":"key"},{"type":{"names":["Array."]},"description":"An array of Files that make-up this MultiFile.","name":"files"}],"scope":"static","longname":"Phaser.Loader.MultiFile","___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#loader","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#files","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#complete","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#pending","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#failed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#baseURL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#path","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#prefix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#isReadyToProcess","scope":"instance","___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#addToMultiFile","scope":"instance","___s":true},{"meta":{"filename":"MultiFile.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#onFileComplete","scope":"instance","___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#onFileFailed","scope":"instance","___s":true},{"meta":{"range":[180,228],"filename":"XHRLoader.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"MergeXHRSettings","longname":"MergeXHRSettings","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"XHRLoader.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Creates a new XMLHttpRequest (xhr) object based on the given File and XHRSettings\nand starts the download of it. It uses the Files own XHRSettings and merges them\nwith the global XHRSettings object to set the xhr values before download.","kind":"function","name":"XHRLoader","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to download.","name":"file"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"description":"The global XHRSettings object.","name":"globalXHRSettings"}],"returns":[{"type":{"names":["XMLHttpRequest"]},"description":"The XHR object."}],"memberof":"Phaser.Loader","longname":"Phaser.Loader.XHRLoader","scope":"static","___s":true},{"meta":{"filename":"XHRSettings.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Creates an XHRSettings Object with default values.","kind":"function","name":"XHRSettings","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequestResponseType"]},"optional":true,"defaultvalue":"''","description":"The responseType, such as 'text'.","name":"responseType"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the XHR request use async or not?","name":"async"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"Optional username for the XHR request.","name":"user"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"Optional password for the XHR request.","name":"password"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optional XHR timeout value.","name":"timeout"}],"returns":[{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"description":"The XHRSettings object as used by the Loader."}],"memberof":"Phaser.Loader","longname":"Phaser.Loader.XHRSettings","scope":"static","___s":true},{"meta":{"range":[180,2891],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"FILE_CONST","longname":"FILE_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Loader is idle.","name":"LOADER_IDLE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.LOADER_IDLE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Loader is actively loading.","name":"LOADER_LOADING","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.LOADER_LOADING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Loader is processing files is has loaded.","name":"LOADER_PROCESSING","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.LOADER_PROCESSING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Loader has completed loading and processing.","name":"LOADER_COMPLETE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.LOADER_COMPLETE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Loader is shutting down.","name":"LOADER_SHUTDOWN","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.LOADER_SHUTDOWN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Loader has been destroyed.","name":"LOADER_DESTROYED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.LOADER_DESTROYED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File is in the load queue but not yet started","name":"FILE_PENDING","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_PENDING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File has been started to load by the loader (onLoad called)","name":"FILE_LOADING","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_LOADING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File has loaded successfully, awaiting processing","name":"FILE_LOADED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_LOADED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File failed to load","name":"FILE_FAILED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_FAILED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":99,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File is being processed (onProcess callback)","name":"FILE_PROCESSING","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_PROCESSING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The File has errored somehow during processing.","name":"FILE_ERRORED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_ERRORED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File has finished processing.","name":"FILE_COMPLETE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_COMPLETE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File has been destroyed","name":"FILE_DESTROYED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_DESTROYED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File was populated from local data and doesn't need an HTTP request","name":"FILE_POPULATED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_POPULATED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"ADD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The Loader Plugin Add File Event.\n\nThis event is dispatched when a new file is successfully added to the Loader and placed into the load queue.\n\nListen to it from a Scene using: `this.load.on('addfile', listener)`.\n\nIf you add lots of files to a Loader from a `preload` method, it will dispatch this event for each one of them.","kind":"event","name":"ADD","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique key of the file that was added to the Loader.","name":"key"},{"type":{"names":["string"]},"description":"The [file type]{@link Phaser.Loader.File#type} string of the file that was added to the Loader, i.e. `image`.","name":"type"},{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader Plugin that dispatched this event.","name":"loader"},{"type":{"names":["Phaser.Loader.File"]},"description":"A reference to the File which was added to the Loader.","name":"file"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:ADD","scope":"instance","___s":true},{"meta":{"filename":"COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The Loader Plugin Complete Event.\n\nThis event is dispatched when the Loader has fully processed everything in the load queue.\nBy this point every loaded file will now be in its associated cache and ready for use.\n\nListen to it from a Scene using: `this.load.on('complete', listener)`.","kind":"event","name":"COMPLETE","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader Plugin that dispatched this event.","name":"loader"},{"type":{"names":["integer"]},"description":"The total number of files that successfully loaded.","name":"totalComplete"},{"type":{"names":["integer"]},"description":"The total number of files that failed to load.","name":"totalFailed"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"FILE_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The File Load Complete Event.\n\nThis event is dispatched by the Loader Plugin when any file in the queue finishes loading.\n\nListen to it from a Scene using: `this.load.on('filecomplete', listener)`.\n\nYou can also listen for the completion of a specific file. See the [FILE_KEY_COMPLETE]{@linkcode Phaser.Loader.Events#event:FILE_KEY_COMPLETE} event.","kind":"event","name":"FILE_COMPLETE","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the file that just loaded and finished processing.","name":"key"},{"type":{"names":["string"]},"description":"The [file type]{@link Phaser.Loader.File#type} of the file that just loaded, i.e. `image`.","name":"type"},{"type":{"names":["any"]},"description":"The raw data the file contained.","name":"data"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:FILE_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"FILE_KEY_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The File Load Complete Event.\n\nThis event is dispatched by the Loader Plugin when any file in the queue finishes loading.\n\nIt uses a special dynamic event name constructed from the key and type of the file.\n\nFor example, if you have loaded an `image` with a key of `monster`, you can listen for it\nusing the following:\n\n```javascript\nthis.load.on('filecomplete-image-monster', function (key, type, data) {\n // Your handler code\n});\n```\n\nOr, if you have loaded a texture `atlas` with a key of `Level1`:\n\n```javascript\nthis.load.on('filecomplete-atlas-Level1', function (key, type, data) {\n // Your handler code\n});\n```\n\nOr, if you have loaded a sprite sheet with a key of `Explosion` and a prefix of `GAMEOVER`:\n\n```javascript\nthis.load.on('filecomplete-spritesheet-GAMEOVERExplosion', function (key, type, data) {\n // Your handler code\n});\n```\n\nYou can also listen for the generic completion of files. See the [FILE_COMPLETE]{@linkcode Phaser.Loader.Events#event:FILE_COMPLETE} event.","kind":"event","name":"FILE_KEY_COMPLETE","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the file that just loaded and finished processing.","name":"key"},{"type":{"names":["string"]},"description":"The [file type]{@link Phaser.Loader.File#type} of the file that just loaded, i.e. `image`.","name":"type"},{"type":{"names":["any"]},"description":"The raw data the file contained.","name":"data"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:FILE_KEY_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"FILE_LOAD_ERROR_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The File Load Error Event.\n\nThis event is dispatched by the Loader Plugin when a file fails to load.\n\nListen to it from a Scene using: `this.load.on('loaderror', listener)`.","kind":"event","name":"FILE_LOAD_ERROR","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"A reference to the File which errored during load.","name":"file"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:FILE_LOAD_ERROR","scope":"instance","___s":true},{"meta":{"filename":"FILE_LOAD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The File Load Event.\n\nThis event is dispatched by the Loader Plugin when a file finishes loading,\nbut _before_ it is processed and added to the internal Phaser caches.\n\nListen to it from a Scene using: `this.load.on('load', listener)`.","kind":"event","name":"FILE_LOAD","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"A reference to the File which just finished loading.","name":"file"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:FILE_LOAD","scope":"instance","___s":true},{"meta":{"filename":"FILE_PROGRESS_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The File Load Progress Event.\n\nThis event is dispatched by the Loader Plugin during the load of a file, if the browser receives a DOM ProgressEvent and\nthe `lengthComputable` event property is true. Depending on the size of the file and browser in use, this may, or may not happen.\n\nListen to it from a Scene using: `this.load.on('fileprogress', listener)`.","kind":"event","name":"FILE_PROGRESS","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"A reference to the File which errored during load.","name":"file"},{"type":{"names":["number"]},"description":"A value between 0 and 1 indicating how 'complete' this file is.","name":"percentComplete"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:FILE_PROGRESS","scope":"instance","___s":true},{"meta":{"filename":"POST_PROCESS_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The Loader Plugin Post Process Event.\n\nThis event is dispatched by the Loader Plugin when the Loader has finished loading everything in the load queue.\nIt is dispatched before the internal lists are cleared and each File is destroyed.\n\nUse this hook to perform any last minute processing of files that can only happen once the\nLoader has completed, but prior to it emitting the `complete` event.\n\nListen to it from a Scene using: `this.load.on('postprocess', listener)`.","kind":"event","name":"POST_PROCESS","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader Plugin that dispatched this event.","name":"loader"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:POST_PROCESS","scope":"instance","___s":true},{"meta":{"filename":"PROGRESS_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The Loader Plugin Progress Event.\n\nThis event is dispatched when the Loader updates its load progress, typically as a result of a file having completed loading.\n\nListen to it from a Scene using: `this.load.on('progress', listener)`.","kind":"event","name":"PROGRESS","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current progress of the load. A value between 0 and 1.","name":"progress"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:PROGRESS","scope":"instance","___s":true},{"meta":{"filename":"START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The Loader Plugin Start Event.\n\nThis event is dispatched when the Loader starts running. At this point load progress is zero.\n\nThis event is dispatched even if there aren't any files in the load queue.\n\nListen to it from a Scene using: `this.load.on('start', listener)`.","kind":"event","name":"START","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader Plugin that dispatched this event.","name":"loader"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:START","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Loader","longname":"Phaser.Loader.Events","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"AnimationJSONFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AnimationJSONFile.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Animation JSON File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#animation method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#animation.","kind":"class","name":"AnimationJSONFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.JSONFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"When the JSON file loads only this property will be stored in the Cache.","name":"dataKey"}],"scope":"static","longname":"Phaser.Loader.FileTypes.AnimationJSONFile","___s":true},{"meta":{"filename":"AnimationJSONFile.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"AnimationJSONFile.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called at the end of the load process, after the Loader has finished all files in its queue.","kind":"function","name":"onLoadComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onLoadComplete","scope":"instance","___s":true},{"meta":{"filename":"AnimationJSONFile.js","lineno":79,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an Animation JSON Data file, or array of Animation JSON files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.animation('baddieAnims', 'files/BaddieAnims.json');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nThe key must be a unique String. It is used to add the file to the global JSON Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the JSON Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the JSON Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.animation({\n key: 'baddieAnims',\n url: 'files/BaddieAnims.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.JSONFileConfig` for more details.\n\nOnce the file has finished loading it will automatically be passed to the global Animation Managers `fromJSON` method.\nThis will parse all of the JSON data and create animation data from it. This process happens at the very end\nof the Loader, once every other file in the load queue has finished. The reason for this is to allow you to load\nboth animation data and the images it relies upon in the same load call.\n\nOnce the animation data has been parsed you will be able to play animations using that data.\nPlease see the Animation Manager `fromJSON` method for more details about the format and playback.\n\nYou can also access the raw animation data from its Cache using its key:\n\n```javascript\nthis.load.animation('baddieAnims', 'files/BaddieAnims.json');\n// and later in your game ...\nvar data = this.cache.json.get('baddieAnims');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Waves` the final key will be `LEVEL1.Waves` and\nthis is what you would use to retrieve the text from the JSON Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"data\"\nand no URL is given then the Loader will set the URL to be \"data.json\". It will always add `.json` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nYou can also optionally provide a `dataKey` to use. This allows you to extract only a part of the JSON and store it in the Cache,\nrather than the whole file. For example, if your JSON data had a structure like this:\n\n```json\n{\n \"level1\": {\n \"baddies\": {\n \"aliens\": {},\n \"boss\": {}\n }\n },\n \"level2\": {},\n \"level3\": {}\n}\n```\n\nAnd if you only wanted to create animations from the `boss` data, then you could pass `level1.baddies.boss`as the `dataKey`.\n\nNote: The ability to load this type of file will only be available if the JSON File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"animation","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.JSONFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["string"]},"optional":true,"description":"When the Animation JSON file loads only this property will be stored in the Cache and used to create animation data.","name":"dataKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#animation","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"AtlasJSONFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AtlasJSONFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single JSON based Texture Atlas File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#atlas method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#atlas.\n\nhttps://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?source=photonstorm","kind":"class","name":"AtlasJSONFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the texture image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas json data file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"atlasURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.AtlasJSONFile","___s":true},{"meta":{"filename":"AtlasJSONFile.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"AtlasJSONFile.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a JSON based Texture Atlas, or array of atlases, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.atlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.json');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nPhaser expects the atlas data to be provided in a JSON file, using either the JSON Hash or JSON Array format.\nThese files are created by software such as Texture Packer, Shoebox and Adobe Flash / Animate.\nIf you are using Texture Packer and have enabled multi-atlas support, then please use the Phaser Multi Atlas loader\ninstead of this one.\n\nPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.atlas({\n key: 'mainmenu',\n textureURL: 'images/MainMenu.png',\n atlasURL: 'images/MainMenu.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig` for more details.\n\nInstead of passing a URL for the atlas JSON data you can also pass in a well formed JSON object instead.\n\nOnce the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:\n\n```javascript\nthis.load.atlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.json');\n// and later in your game ...\nthis.add.image(x, y, 'mainmenu', 'background');\n```\n\nTo get a list of all available frames within an atlas please consult your Texture Atlas software.\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\nthen you can specify it by providing an array as the `url` where the second element is the normal map:\n\n```javascript\nthis.load.atlas('mainmenu', [ 'images/MainMenu.png', 'images/MainMenu-n.png' ], 'images/MainMenu.json');\n```\n\nOr, if you are using a config object use the `normalMap` property:\n\n```javascript\nthis.load.atlas({\n key: 'mainmenu',\n textureURL: 'images/MainMenu.png',\n normalMap: 'images/MainMenu-n.png',\n atlasURL: 'images/MainMenu.json'\n});\n```\n\nThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\nNormal maps are a WebGL only feature.\n\nNote: The ability to load this type of file will only be available if the Atlas JSON File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"atlas","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the texture image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas json data file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"atlasURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#atlas","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"AtlasXMLFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AtlasXMLFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single XML based Texture Atlas File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#atlasXML method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#atlasXML.","kind":"class","name":"AtlasXMLFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the texture image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas xml data file from. If undefined or `null` it will be set to `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".","name":"atlasURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas xml file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.AtlasXMLFile","___s":true},{"meta":{"filename":"AtlasXMLFile.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"AtlasXMLFile.js","lineno":109,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an XML based Texture Atlas, or array of atlases, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.atlasXML('mainmenu', 'images/MainMenu.png', 'images/MainMenu.xml');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nPhaser expects the atlas data to be provided in an XML file format.\nThese files are created by software such as Shoebox and Adobe Flash / Animate.\n\nPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.atlasXML({\n key: 'mainmenu',\n textureURL: 'images/MainMenu.png',\n atlasURL: 'images/MainMenu.xml'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig` for more details.\n\nOnce the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:\n\n```javascript\nthis.load.atlasXML('mainmenu', 'images/MainMenu.png', 'images/MainMenu.xml');\n// and later in your game ...\nthis.add.image(x, y, 'mainmenu', 'background');\n```\n\nTo get a list of all available frames within an atlas please consult your Texture Atlas software.\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\nthen you can specify it by providing an array as the `url` where the second element is the normal map:\n\n```javascript\nthis.load.atlasXML('mainmenu', [ 'images/MainMenu.png', 'images/MainMenu-n.png' ], 'images/MainMenu.xml');\n```\n\nOr, if you are using a config object use the `normalMap` property:\n\n```javascript\nthis.load.atlasXML({\n key: 'mainmenu',\n textureURL: 'images/MainMenu.png',\n normalMap: 'images/MainMenu-n.png',\n atlasURL: 'images/MainMenu.xml'\n});\n```\n\nThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\nNormal maps are a WebGL only feature.\n\nNote: The ability to load this type of file will only be available if the Atlas XML File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"atlasXML","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.7.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the texture image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas xml data file from. If undefined or `null` it will be set to `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".","name":"atlasURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas xml file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#atlasXML","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"AudioFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AudioFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Audio File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#audio method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#audio.","kind":"class","name":"AudioFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AudioFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["any"]},"optional":true,"description":"The absolute or relative URL to load this file from in a config object.","name":"urlConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["AudioContext"]},"optional":true,"description":"The AudioContext this file will use to process itself.","name":"audioContext"}],"scope":"static","longname":"Phaser.Loader.FileTypes.AudioFile","___s":true},{"meta":{"filename":"AudioFile.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"AudioFile.js","lineno":167,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an Audio or HTML5Audio file, or array of audio files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.audio('title', [ 'music/Title.ogg', 'music/Title.mp3', 'music/Title.m4a' ]);\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Audio Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Audio Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Audio Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.audio({\n key: 'title',\n url: [ 'music/Title.ogg', 'music/Title.mp3', 'music/Title.m4a' ]\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.AudioFileConfig` for more details.\n\nThe URLs can be relative or absolute. If the URLs are relative the `Loader.baseURL` and `Loader.path` values will be prepended to them.\n\nDue to different browsers supporting different audio file types you should usually provide your audio files in a variety of formats.\nogg, mp3 and m4a are the most common. If you provide an array of URLs then the Loader will determine which _one_ file to load based on\nbrowser support.\n\nIf audio has been disabled in your game, either via the game config, or lack of support from the device, then no audio will be loaded.\n\nNote: The ability to load this type of file will only be available if the Audio File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"audio","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AudioFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the audio files from.","name":"urls"},{"type":{"names":["any"]},"optional":true,"description":"An object containing an `instances` property for HTML5Audio. Defaults to 1.","name":"config"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#audio","scope":"instance","___s":true},{"meta":{"range":[180,217],"filename":"AudioSpriteFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"AudioFile","longname":"AudioFile","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AudioSpriteFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"An Audio Sprite File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#audioSprite method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#audioSprite.","kind":"class","name":"AudioSpriteFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"description":"The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.","name":"jsonURL"},{"type":{"names":["Object"]},"optional":true,"description":"The absolute or relative URL to load the audio file from. If empty it will be obtained by parsing the JSON file.","name":"audioURL"},{"type":{"names":["any"]},"optional":true,"description":"The audio configuration options.","name":"audioConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the audio file. Used in replacement of the Loaders default XHR Settings.","name":"audioXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the json file. Used in replacement of the Loaders default XHR Settings.","name":"jsonXhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.AudioSpriteFile","___s":true},{"meta":{"filename":"AudioSpriteFile.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#onFileComplete","scope":"instance","overrides":"Phaser.Loader.MultiFile#onFileComplete","___s":true},{"meta":{"filename":"AudioSpriteFile.js","lineno":121,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"AudioSpriteFile.js","lineno":143,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a JSON based Audio Sprite, or array of audio sprites, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.audioSprite('kyobi', 'kyobi.json', [\n 'kyobi.ogg',\n 'kyobi.mp3',\n 'kyobi.m4a'\n ]);\n}\n```\n\nAudio Sprites are a combination of audio files and a JSON configuration.\nThe JSON follows the format of that created by https://github.com/tonistiigi/audiosprite\n\nIf the JSON file includes a 'resource' object then you can let Phaser parse it and load the audio\nfiles automatically based on its content. To do this exclude the audio URLs from the load:\n\n```javascript\nfunction preload ()\n{\n this.load.audioSprite('kyobi', 'kyobi.json');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nThe key must be a unique String. It is used to add the file to the global Audio Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Audio Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Audio Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.audioSprite({\n key: 'kyobi',\n jsonURL: 'audio/Kyobi.json',\n audioURL: [\n 'audio/Kyobi.ogg',\n 'audio/Kyobi.mp3',\n 'audio/Kyobi.m4a'\n ]\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig` for more details.\n\nInstead of passing a URL for the audio JSON data you can also pass in a well formed JSON object instead.\n\nOnce the audio has finished loading you can use it create an Audio Sprite by referencing its key:\n\n```javascript\nthis.load.audioSprite('kyobi', 'kyobi.json');\n// and later in your game ...\nvar music = this.sound.addAudioSprite('kyobi');\nmusic.play('title');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nDue to different browsers supporting different audio file types you should usually provide your audio files in a variety of formats.\nogg, mp3 and m4a are the most common. If you provide an array of URLs then the Loader will determine which _one_ file to load based on\nbrowser support.\n\nIf audio has been disabled in your game, either via the game config, or lack of support from the device, then no audio will be loaded.\n\nNote: The ability to load this type of file will only be available if the Audio Sprite File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"audioSprite","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or an array of objects.","name":"key"},{"type":{"names":["string"]},"description":"The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.","name":"jsonURL"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the audio file from. If empty it will be obtained by parsing the JSON file.","name":"audioURL"},{"type":{"names":["any"]},"optional":true,"description":"The audio configuration options.","name":"audioConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the audio file. Used in replacement of the Loaders default XHR Settings.","name":"audioXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the json file. Used in replacement of the Loaders default XHR Settings.","name":"jsonXhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#audioSprite","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"BinaryFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BinaryFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Binary File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#binary method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#binary.","kind":"class","name":"BinaryFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.BinaryFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.bin`, i.e. if `key` was \"alien\" then the URL will be \"alien.bin\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["any"]},"optional":true,"description":"Optional type to cast the binary file to once loaded. For example, `Uint8Array`.","name":"dataType"}],"scope":"static","longname":"Phaser.Loader.FileTypes.BinaryFile","___s":true},{"meta":{"filename":"BinaryFile.js","lineno":69,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"BinaryFile.js","lineno":89,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Binary file, or array of Binary files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.binary('doom', 'files/Doom.wad');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Binary Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Binary Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Binary Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.binary({\n key: 'doom',\n url: 'files/Doom.wad',\n dataType: Uint8Array\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.BinaryFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.binary('doom', 'files/Doom.wad');\n// and later in your game ...\nvar data = this.cache.binary.get('doom');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Data` the final key will be `LEVEL1.Data` and\nthis is what you would use to retrieve the text from the Binary Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"doom\"\nand no URL is given then the Loader will set the URL to be \"doom.bin\". It will always add `.bin` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Binary File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"binary","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.BinaryFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.bin`, i.e. if `key` was \"alien\" then the URL will be \"alien.bin\".","name":"url"},{"type":{"names":["any"]},"optional":true,"description":"Optional type to cast the binary file to once loaded. For example, `Uint8Array`.","name":"dataType"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#binary","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"BitmapFontFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapFontFile.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Bitmap Font based File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#bitmapFont method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#bitmapFont.","kind":"class","name":"BitmapFontFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.BitmapFontFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the font image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the font xml data file from. If undefined or `null` it will be set to `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".","name":"fontDataURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the font image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the font data xml file. Used in replacement of the Loaders default XHR Settings.","name":"fontDataXhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.BitmapFontFile","___s":true},{"meta":{"filename":"BitmapFontFile.js","lineno":86,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"BitmapFontFile.js","lineno":110,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an XML based Bitmap Font, or array of fonts, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n```javascript\nfunction preload ()\n{\n this.load.bitmapFont('goldenFont', 'images/GoldFont.png', 'images/GoldFont.xml');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nPhaser expects the font data to be provided in an XML file format.\nThese files are created by software such as the [Angelcode Bitmap Font Generator](http://www.angelcode.com/products/bmfont/),\n[Littera](http://kvazars.com/littera/) or [Glyph Designer](https://71squared.com/glyphdesigner)\n\nPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.bitmapFont({\n key: 'goldenFont',\n textureURL: 'images/GoldFont.png',\n fontDataURL: 'images/GoldFont.xml'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.BitmapFontFileConfig` for more details.\n\nOnce the atlas has finished loading you can use key of it when creating a Bitmap Text Game Object:\n\n```javascript\nthis.load.bitmapFont('goldenFont', 'images/GoldFont.png', 'images/GoldFont.xml');\n// and later in your game ...\nthis.add.bitmapText(x, y, 'goldenFont', 'Hello World');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use when creating a Bitmap Text object.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\nthen you can specify it by providing an array as the `url` where the second element is the normal map:\n\n```javascript\nthis.load.bitmapFont('goldenFont', [ 'images/GoldFont.png', 'images/GoldFont-n.png' ], 'images/GoldFont.xml');\n```\n\nOr, if you are using a config object use the `normalMap` property:\n\n```javascript\nthis.load.bitmapFont({\n key: 'goldenFont',\n textureURL: 'images/GoldFont.png',\n normalMap: 'images/GoldFont-n.png',\n fontDataURL: 'images/GoldFont.xml'\n});\n```\n\nThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\nNormal maps are a WebGL only feature.\n\nNote: The ability to load this type of file will only be available if the Bitmap Font File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"bitmapFont","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.BitmapFontFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the font image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the font xml data file from. If undefined or `null` it will be set to `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".","name":"fontDataURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the font image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the font data xml file. Used in replacement of the Loaders default XHR Settings.","name":"fontDataXhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#bitmapFont","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"CSSFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CSSFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single CSS File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#css method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#css.","kind":"class","name":"CSSFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.17.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.CSSFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.CSSFile","___s":true},{"meta":{"filename":"CSSFile.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.17.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"CSSFile.js","lineno":88,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a CSS file, or array of CSS files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.css('headers', 'styles/headers.css');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String and not already in-use by another file in the Loader.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.css({\n key: 'headers',\n url: 'styles/headers.css'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.CSSFileConfig` for more details.\n\nOnce the file has finished loading it will automatically be converted into a style DOM element\nvia `document.createElement('style')`. It will have its `defer` property set to false and then the\nresulting element will be appended to `document.head`. The CSS styles are then applied to the current document.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.css\". It will always add `.css` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the CSS File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"css","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.17.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.CSSFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.css`, i.e. if `key` was \"alien\" then the URL will be \"alien.css\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#css","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"GLSLFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GLSLFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single GLSL File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#glsl method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#glsl.","kind":"class","name":"GLSLFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.GLSLFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'fragment'","description":"The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.","name":"shaderType"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.GLSLFile","___s":true},{"meta":{"filename":"GLSLFile.js","lineno":76,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"GLSLFile.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.17.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"GLSLFile.js","lineno":157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Returns the name of the shader from the header block.","kind":"function","name":"getShaderName","since":"3.17.0","params":[{"type":{"names":["Array."]},"description":"The header data.","name":"headerSource"}],"returns":[{"type":{"names":["string"]},"description":"The shader name."}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#getShaderName","scope":"instance","___s":true},{"meta":{"filename":"GLSLFile.js","lineno":182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Returns the type of the shader from the header block.","kind":"function","name":"getShaderType","since":"3.17.0","params":[{"type":{"names":["Array."]},"description":"The header data.","name":"headerSource"}],"returns":[{"type":{"names":["string"]},"description":"The shader type. Either 'fragment' or 'vertex'."}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#getShaderType","scope":"instance","___s":true},{"meta":{"filename":"GLSLFile.js","lineno":207,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Returns the shader uniforms from the header block.","kind":"function","name":"getShaderUniforms","since":"3.17.0","params":[{"type":{"names":["Array."]},"description":"The header data.","name":"headerSource"}],"returns":[{"type":{"names":["any"]},"description":"The shader uniforms object."}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#getShaderUniforms","scope":"instance","___s":true},{"meta":{"filename":"GLSLFile.js","lineno":317,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a GLSL file, or array of GLSL files, to the current load queue.\nIn Phaser 3 GLSL files are just plain Text files at the current moment in time.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.glsl('plasma', 'shaders/Plasma.glsl');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Shader Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Shader Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Shader Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.glsl({\n key: 'plasma',\n shaderType: 'fragment',\n url: 'shaders/Plasma.glsl'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.GLSLFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.glsl('plasma', 'shaders/Plasma.glsl');\n// and later in your game ...\nvar data = this.cache.shader.get('plasma');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `FX.` and the key was `Plasma` the final key will be `FX.Plasma` and\nthis is what you would use to retrieve the text from the Shader Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"plasma\"\nand no URL is given then the Loader will set the URL to be \"plasma.glsl\". It will always add `.glsl` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the GLSL File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"glsl","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.GLSLFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.glsl`, i.e. if `key` was \"alien\" then the URL will be \"alien.glsl\".","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'fragment'","description":"The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.","name":"shaderType"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#glsl","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"HTML5AudioFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HTML5AudioFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Audio File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#audio method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#audio.","kind":"class","name":"HTML5AudioFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AudioFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from.","name":"urlConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.HTML5AudioFile","___s":true},{"meta":{"filename":"HTML5AudioFile.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called when the file finishes loading.","kind":"function","name":"onLoad","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#onLoad","scope":"instance","overrides":"Phaser.Loader.File#onLoad","___s":true},{"meta":{"filename":"HTML5AudioFile.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called if the file errors while loading.","kind":"function","name":"onError","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#onError","scope":"instance","overrides":"Phaser.Loader.File#onError","___s":true},{"meta":{"filename":"HTML5AudioFile.js","lineno":104,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#onProgress","scope":"instance","overrides":"Phaser.Loader.File#onProgress","___s":true},{"meta":{"filename":"HTML5AudioFile.js","lineno":130,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#load","scope":"instance","overrides":"Phaser.Loader.File#load","___s":true},{"meta":{"range":[180,216],"filename":"HTMLFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HTMLFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single HTML File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#html method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#html.","kind":"class","name":"HTMLFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.12.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.HTMLFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.html\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.HTMLFile","___s":true},{"meta":{"filename":"HTMLFile.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"HTMLFile.js","lineno":84,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an HTML file, or array of HTML files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.html('story', 'files/LoginForm.html');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global HTML Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the HTML Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the HTML Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.html({\n key: 'login',\n url: 'files/LoginForm.html'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.HTMLFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.html('login', 'files/LoginForm.html');\n// and later in your game ...\nvar data = this.cache.html.get('login');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Story` the final key will be `LEVEL1.Story` and\nthis is what you would use to retrieve the html from the HTML Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"story\"\nand no URL is given then the Loader will set the URL to be \"story.html\". It will always add `.html` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the HTML File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"html","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.12.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.HTMLFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.html`, i.e. if `key` was \"alien\" then the URL will be \"alien.html\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#html","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"HTMLTextureFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HTMLTextureFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single HTML File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#htmlTexture method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#htmlTexture.","kind":"class","name":"HTMLTextureFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.12.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"url"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the texture the HTML will be rendered to.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the texture the HTML will be rendered to.","name":"height"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.HTMLTextureFile","___s":true},{"meta":{"filename":"HTMLTextureFile.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"HTMLTextureFile.js","lineno":138,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"HTMLTextureFile.js","lineno":153,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an HTML File, or array of HTML Files, to the current load queue. When the files are loaded they\nwill be rendered to textures and stored in the Texture Manager.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.htmlTexture('instructions', 'content/intro.html', 256, 512);\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.htmlTexture({\n key: 'instructions',\n url: 'content/intro.html',\n width: 256,\n height: 512\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig` for more details.\n\nOnce the file has finished loading you can use it as a texture for a Game Object by referencing its key:\n\n```javascript\nthis.load.htmlTexture('instructions', 'content/intro.html', 256, 512);\n// and later in your game ...\nthis.add.image(x, y, 'instructions');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.html\". It will always add `.html` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nThe width and height are the size of the texture to which the HTML will be rendered. It's not possible to determine these\nautomatically, so you will need to provide them, either as arguments or in the file config object.\nWhen the HTML file has loaded a new SVG element is created with a size and viewbox set to the width and height given.\nThe SVG file has a body tag added to it, with the HTML file contents included. It then calls `window.Blob` on the SVG,\nand if successful is added to the Texture Manager, otherwise it fails processing. The overall quality of the rendered\nHTML depends on your browser, and some of them may not even support the svg / blob process used. Be aware that there are\nlimitations on what HTML can be inside an SVG. You can find out more details in this\n[Mozilla MDN entry](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API/Drawing_DOM_objects_into_a_canvas).\n\nNote: The ability to load this type of file will only be available if the HTMLTextureFile File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"htmlTexture","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.12.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.html`, i.e. if `key` was \"alien\" then the URL will be \"alien.html\".","name":"url"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":512,"description":"The width of the texture the HTML will be rendered to.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":512,"description":"The height of the texture the HTML will be rendered to.","name":"height"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#htmlTexture","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"ImageFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImageFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Image File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#image method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#image.","kind":"class","name":"ImageFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.ImageFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["Phaser.Types.Loader.FileTypes.ImageFrameConfig"]},"optional":true,"description":"The frame configuration object. Only provided for, and used by, Sprite Sheets.","name":"frameConfig"}],"scope":"static","longname":"Phaser.Loader.FileTypes.ImageFile","___s":true},{"meta":{"filename":"ImageFile.js","lineno":89,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"ImageFile.js","lineno":123,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"ImageFile.js","lineno":159,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an Image, or array of Images, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.image('logo', 'images/phaserLogo.png');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\nIf you try to load an animated gif only the first frame will be rendered. Browsers do not natively support playback\nof animated gifs to Canvas elements.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.image({\n key: 'logo',\n url: 'images/AtariLogo.png'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.ImageFileConfig` for more details.\n\nOnce the file has finished loading you can use it as a texture for a Game Object by referencing its key:\n\n```javascript\nthis.load.image('logo', 'images/AtariLogo.png');\n// and later in your game ...\nthis.add.image(x, y, 'logo');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\nthen you can specify it by providing an array as the `url` where the second element is the normal map:\n\n```javascript\nthis.load.image('logo', [ 'images/AtariLogo.png', 'images/AtariLogo-n.png' ]);\n```\n\nOr, if you are using a config object use the `normalMap` property:\n\n```javascript\nthis.load.image({\n key: 'logo',\n url: 'images/AtariLogo.png',\n normalMap: 'images/AtariLogo-n.png'\n});\n```\n\nThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\nNormal maps are a WebGL only feature.\n\nNote: The ability to load this type of file will only be available if the Image File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"image","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.ImageFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#image","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"JSONFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"JSONFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single JSON File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#json method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#json.","kind":"class","name":"JSONFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.JSONFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"When the JSON file loads only this property will be stored in the Cache.","name":"dataKey"}],"scope":"static","longname":"Phaser.Loader.FileTypes.JSONFile","___s":true},{"meta":{"filename":"JSONFile.js","lineno":88,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"JSONFile.js","lineno":120,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a JSON file, or array of JSON files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.json('wavedata', 'files/AlienWaveData.json');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global JSON Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the JSON Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the JSON Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.json({\n key: 'wavedata',\n url: 'files/AlienWaveData.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.JSONFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.json('wavedata', 'files/AlienWaveData.json');\n// and later in your game ...\nvar data = this.cache.json.get('wavedata');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Waves` the final key will be `LEVEL1.Waves` and\nthis is what you would use to retrieve the text from the JSON Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"data\"\nand no URL is given then the Loader will set the URL to be \"data.json\". It will always add `.json` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nYou can also optionally provide a `dataKey` to use. This allows you to extract only a part of the JSON and store it in the Cache,\nrather than the whole file. For example, if your JSON data had a structure like this:\n\n```json\n{\n \"level1\": {\n \"baddies\": {\n \"aliens\": {},\n \"boss\": {}\n }\n },\n \"level2\": {},\n \"level3\": {}\n}\n```\n\nAnd you only wanted to store the `boss` data in the Cache, then you could pass `level1.baddies.boss`as the `dataKey`.\n\nNote: The ability to load this type of file will only be available if the JSON File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"json","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.JSONFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["string"]},"optional":true,"description":"When the JSON file loads only this property will be stored in the Cache.","name":"dataKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#json","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"MultiAtlasFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MultiAtlasFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Multi Texture Atlas File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#multiatlas method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#multiatlas.","kind":"class","name":"MultiAtlasFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager. Or a config object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the multi atlas json file from.","name":"atlasURL"},{"type":{"names":["string"]},"optional":true,"description":"Optional path to use when loading the textures defined in the atlas data.","name":"path"},{"type":{"names":["string"]},"optional":true,"description":"Optional Base URL to use when loading the textures defined in the atlas data.","name":"baseURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the atlas json file.","name":"atlasXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the texture files.","name":"textureXhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.MultiAtlasFile","___s":true},{"meta":{"filename":"MultiAtlasFile.js","lineno":75,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#onFileComplete","scope":"instance","overrides":"Phaser.Loader.MultiFile#onFileComplete","___s":true},{"meta":{"filename":"MultiAtlasFile.js","lineno":148,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"MultiAtlasFile.js","lineno":217,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Multi Texture Atlas, or array of multi atlases, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.multiatlas('level1', 'images/Level1.json');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nPhaser expects the atlas data to be provided in a JSON file as exported from the application Texture Packer,\nversion 4.6.3 or above, where you have made sure to use the Phaser 3 Export option.\n\nThe way it works internally is that you provide a URL to the JSON file. Phaser then loads this JSON, parses it and\nextracts which texture files it also needs to load to complete the process. If the JSON also defines normal maps,\nPhaser will load those as well.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.multiatlas({\n key: 'level1',\n atlasURL: 'images/Level1.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig` for more details.\n\nInstead of passing a URL for the atlas JSON data you can also pass in a well formed JSON object instead.\n\nOnce the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:\n\n```javascript\nthis.load.multiatlas('level1', 'images/Level1.json');\n// and later in your game ...\nthis.add.image(x, y, 'level1', 'background');\n```\n\nTo get a list of all available frames within an atlas please consult your Texture Atlas software.\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Multi Atlas File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"multiatlas","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.7.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas json data file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"atlasURL"},{"type":{"names":["string"]},"optional":true,"description":"Optional path to use when loading the textures defined in the atlas data.","name":"path"},{"type":{"names":["string"]},"optional":true,"description":"Optional Base URL to use when loading the textures defined in the atlas data.","name":"baseURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#multiatlas","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"MultiScriptFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MultiScriptFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A Multi Script File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#scripts method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#scripts.","kind":"class","name":"MultiScriptFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.17.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.MultiScriptFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["Array."]},"optional":true,"description":"An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the script files. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.MultiScriptFile","___s":true},{"meta":{"filename":"MultiScriptFile.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.17.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"MultiScriptFile.js","lineno":109,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an array of Script files to the current load queue.\n\nThe difference between this and the `ScriptFile` file type is that you give an array of scripts to this method,\nand the scripts are then processed _exactly_ in that order. This allows you to load a bunch of scripts that\nmay have dependencies on each other without worrying about the async nature of traditional script loading.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.scripts('PostProcess', [\n 'libs/shaders/CopyShader.js',\n 'libs/postprocessing/EffectComposer.js',\n 'libs/postprocessing/RenderPass.js',\n 'libs/postprocessing/MaskPass.js',\n 'libs/postprocessing/ShaderPass.js',\n 'libs/postprocessing/AfterimagePass.js'\n ]);\n}\n```\n\nIn the code above the script files will all be loaded in parallel but only processed (i.e. invoked) in the exact\norder given in the array.\n\nThe files are **not** loaded right away. They are added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the files are queued\nit means you cannot use the files immediately after calling this method, but must wait for the files to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String and not already in-use by another file in the Loader.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.scripts({\n key: 'PostProcess',\n url: [\n 'libs/shaders/CopyShader.js',\n 'libs/postprocessing/EffectComposer.js',\n 'libs/postprocessing/RenderPass.js',\n 'libs/postprocessing/MaskPass.js',\n 'libs/postprocessing/ShaderPass.js',\n 'libs/postprocessing/AfterimagePass.js'\n ]\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.MultiScriptFileConfig` for more details.\n\nOnce all the files have finished loading they will automatically be converted into a script element\nvia `document.createElement('script')`. They will have their language set to JavaScript, `defer` set to\nfalse and then the resulting element will be appended to `document.head`. Any code then in the\nscript will be executed. This is done in the exact order the files are specified in the url array.\n\nThe URLs can be relative or absolute. If the URLs are relative the `Loader.baseURL` and `Loader.path` values will be prepended to them.\n\nNote: The ability to load this type of file will only be available if the MultiScript File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"scripts","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.17.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.MultiScriptFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["Array."]},"optional":true,"description":"An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'js'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for these files.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#scripts","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"PackFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PackFile.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single JSON Pack File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#pack method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#pack.","kind":"class","name":"PackFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.PackFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"When the JSON file loads only this property will be stored in the Cache.","name":"dataKey"}],"scope":"static","longname":"Phaser.Loader.FileTypes.PackFile","___s":true},{"meta":{"filename":"PackFile.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"PackFile.js","lineno":72,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a JSON File Pack, or array of packs, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.pack('level1', 'data/Level1Files.json');\n}\n```\n\nA File Pack is a JSON file (or object) that contains details about other files that should be added into the Loader.\nHere is a small example:\n\n```json\n{ \n \"test1\": {\n \"files\": [\n {\n \"type\": \"image\",\n \"key\": \"taikodrummaster\",\n \"url\": \"assets/pics/taikodrummaster.jpg\"\n },\n {\n \"type\": \"image\",\n \"key\": \"sukasuka-chtholly\",\n \"url\": \"assets/pics/sukasuka-chtholly.png\"\n }\n ]\n },\n \"meta\": {\n \"generated\": \"1401380327373\",\n \"app\": \"Phaser 3 Asset Packer\",\n \"url\": \"https://phaser.io\",\n \"version\": \"1.0\",\n \"copyright\": \"Photon Storm Ltd. 2018\"\n }\n}\n```\n\nThe pack can be split into sections. In the example above you'll see a section called `test1. You can tell\nthe `load.pack` method to parse only a particular section of a pack. The pack is stored in the JSON Cache,\nso you can pass it to the Loader to process additional sections as needed in your game, or you can just load\nthem all at once without specifying anything.\n\nThe pack file can contain an entry for any type of file that Phaser can load. The object structures exactly\nmatch that of the file type configs, and all properties available within the file type configs can be used\nin the pack file too.\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nThe key must be a unique String. It is used to add the file to the global JSON Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the JSON Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the JSON Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.pack({\n key: 'level1',\n url: 'data/Level1Files.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.PackFileConfig` for more details.\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Waves` the final key will be `LEVEL1.Waves` and\nthis is what you would use to retrieve the text from the JSON Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"data\"\nand no URL is given then the Loader will set the URL to be \"data.json\". It will always add `.json` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nYou can also optionally provide a `dataKey` to use. This allows you to extract only a part of the JSON and store it in the Cache,\nrather than the whole file. For example, if your JSON data had a structure like this:\n\n```json\n{\n \"level1\": {\n \"baddies\": {\n \"aliens\": {},\n \"boss\": {}\n }\n },\n \"level2\": {},\n \"level3\": {}\n}\n```\n\nAnd you only wanted to store the `boss` data in the Cache, then you could pass `level1.baddies.boss`as the `dataKey`.\n\nNote: The ability to load this type of file will only be available if the Pack File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"pack","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.7.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.PackFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["string"]},"optional":true,"description":"When the JSON file loads only this property will be stored in the Cache.","name":"dataKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#pack","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"PluginFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PluginFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Plugin Script File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#plugin method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#plugin.","kind":"class","name":"PluginFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.PluginFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Automatically start the plugin after loading?","name":"start"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Scene, this is the property key used.","name":"mapping"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.PluginFile","___s":true},{"meta":{"filename":"PluginFile.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"PluginFile.js","lineno":129,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Plugin Script file, or array of plugin files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.plugin('modplayer', 'plugins/ModPlayer.js');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String and not already in-use by another file in the Loader.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.plugin({\n key: 'modplayer',\n url: 'plugins/ModPlayer.js'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.PluginFileConfig` for more details.\n\nOnce the file has finished loading it will automatically be converted into a script element\nvia `document.createElement('script')`. It will have its language set to JavaScript, `defer` set to\nfalse and then the resulting element will be appended to `document.head`. Any code then in the\nscript will be executed. It will then be passed to the Phaser PluginCache.register method.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.js\". It will always add `.js` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Plugin File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"plugin","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.PluginFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","function"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\". Or, a plugin function.","name":"url"},{"type":{"names":["boolean"]},"optional":true,"description":"Automatically start the plugin after loading?","name":"start"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Scene, this is the property key used.","name":"mapping"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#plugin","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"SVGFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SVGFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single SVG File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#svg method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#svg.","kind":"class","name":"SVGFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.SVGFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.svg`, i.e. if `key` was \"alien\" then the URL will be \"alien.svg\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.FileTypes.SVGSizeConfig"]},"optional":true,"description":"The svg size configuration object.","name":"svgConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.SVGFile","___s":true},{"meta":{"filename":"SVGFile.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"SVGFile.js","lineno":182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"SVGFile.js","lineno":197,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an SVG File, or array of SVG Files, to the current load queue. When the files are loaded they\nwill be rendered to bitmap textures and stored in the Texture Manager.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.svg('morty', 'images/Morty.svg');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.svg({\n key: 'morty',\n url: 'images/Morty.svg'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.SVGFileConfig` for more details.\n\nOnce the file has finished loading you can use it as a texture for a Game Object by referencing its key:\n\n```javascript\nthis.load.svg('morty', 'images/Morty.svg');\n// and later in your game ...\nthis.add.image(x, y, 'morty');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.html\". It will always add `.html` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nYou can optionally pass an SVG Resize Configuration object when you load an SVG file. By default the SVG will be rendered to a texture\nat the same size defined in the SVG file attributes. However, this isn't always desirable. You may wish to resize the SVG (either down\nor up) to improve texture clarity, or reduce texture memory consumption. You can either specify an exact width and height to resize\nthe SVG to:\n\n```javascript\nfunction preload ()\n{\n this.load.svg('morty', 'images/Morty.svg', { width: 300, height: 600 });\n}\n```\n\nOr when using a configuration object:\n\n```javascript\nthis.load.svg({\n key: 'morty',\n url: 'images/Morty.svg',\n svgConfig: {\n width: 300,\n height: 600\n }\n});\n```\n\nAlternatively, you can just provide a scale factor instead:\n\n```javascript\nfunction preload ()\n{\n this.load.svg('morty', 'images/Morty.svg', { scale: 2.5 });\n}\n```\n\nOr when using a configuration object:\n\n```javascript\nthis.load.svg({\n key: 'morty',\n url: 'images/Morty.svg',\n svgConfig: {\n scale: 2.5\n }\n});\n```\n\nIf scale, width and height values are all given, the scale has priority and the width and height values are ignored.\n\nNote: The ability to load this type of file will only be available if the SVG File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"svg","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.SVGFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.svg`, i.e. if `key` was \"alien\" then the URL will be \"alien.svg\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.FileTypes.SVGSizeConfig"]},"optional":true,"description":"The svg size configuration object.","name":"svgConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#svg","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"SceneFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SceneFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"An external Scene JavaScript File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#sceneFile method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#sceneFile.","kind":"class","name":"SceneFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.16.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.SceneFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.SceneFile","___s":true},{"meta":{"filename":"SceneFile.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.16.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"SceneFile.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.16.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"SceneFile.js","lineno":102,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an external Scene file, or array of Scene files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.sceneFile('Level1', 'src/Level1.js');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Scene Manager upon a successful load.\n\nFor a Scene File it's vitally important that the key matches the class name in the JavaScript file.\n\nFor example here is the source file:\n\n```javascript\nclass ExternalScene extends Phaser.Scene {\n\n constructor ()\n {\n super('myScene');\n }\n\n}\n```\n\nBecause the class is called `ExternalScene` that is the exact same key you must use when loading it:\n\n```javascript\nfunction preload ()\n{\n this.load.sceneFile('ExternalScene', 'src/yourScene.js');\n}\n```\n\nThe key that is used within the Scene Manager can either be set to the same, or you can override it in the Scene\nconstructor, as we've done in the example above, where the Scene key was changed to `myScene`.\n\nThe key should be unique both in terms of files being loaded and Scenes already present in the Scene Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Scene Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.sceneFile({\n key: 'Level1',\n url: 'src/Level1.js'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.SceneFileConfig` for more details.\n\nOnce the file has finished loading it will be added to the Scene Manager.\n\n```javascript\nthis.load.sceneFile('Level1', 'src/Level1.js');\n// and later in your game ...\nthis.scene.start('Level1');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `WORLD1.` and the key was `Story` the final key will be `WORLD1.Story` and\nthis is what you would use to retrieve the text from the Scene Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"story\"\nand no URL is given then the Loader will set the URL to be \"story.js\". It will always add `.js` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Scene File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"sceneFile","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.16.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.SceneFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#sceneFile","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"ScenePluginFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScenePluginFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Scene Plugin Script File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#scenePlugin method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#scenePlugin.","kind":"class","name":"ScenePluginFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.8.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.ScenePluginFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be added to Scene.Systems, this is the property key for it.","name":"systemKey"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be added to the Scene, this is the property key for it.","name":"sceneKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.ScenePluginFile","___s":true},{"meta":{"filename":"ScenePluginFile.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.8.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"ScenePluginFile.js","lineno":123,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Scene Plugin Script file, or array of plugin files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.scenePlugin('ModPlayer', 'plugins/ModPlayer.js', 'modPlayer', 'mods');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String and not already in-use by another file in the Loader.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.scenePlugin({\n key: 'modplayer',\n url: 'plugins/ModPlayer.js'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.ScenePluginFileConfig` for more details.\n\nOnce the file has finished loading it will automatically be converted into a script element\nvia `document.createElement('script')`. It will have its language set to JavaScript, `defer` set to\nfalse and then the resulting element will be appended to `document.head`. Any code then in the\nscript will be executed. It will then be passed to the Phaser PluginCache.register method.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.js\". It will always add `.js` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Script File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"scenePlugin","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.8.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.ScenePluginFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","function"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\". Or, set to a plugin function.","name":"url"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be added to Scene.Systems, this is the property key for it.","name":"systemKey"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be added to the Scene, this is the property key for it.","name":"sceneKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#scenePlugin","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"ScriptFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScriptFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Script File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#script method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#script.","kind":"class","name":"ScriptFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.ScriptFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.ScriptFile","___s":true},{"meta":{"filename":"ScriptFile.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"ScriptFile.js","lineno":90,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Script file, or array of Script files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.script('aliens', 'lib/aliens.js');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String and not already in-use by another file in the Loader.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.script({\n key: 'aliens',\n url: 'lib/aliens.js'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.ScriptFileConfig` for more details.\n\nOnce the file has finished loading it will automatically be converted into a script element\nvia `document.createElement('script')`. It will have its language set to JavaScript, `defer` set to\nfalse and then the resulting element will be appended to `document.head`. Any code then in the\nscript will be executed.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.js\". It will always add `.js` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Script File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"script","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.ScriptFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#script","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"SpriteSheetFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SpriteSheetFile.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Sprite Sheet Image File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#spritesheet method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#spritesheet.","kind":"class","name":"SpriteSheetFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.FileTypes.ImageFrameConfig"]},"optional":true,"description":"The frame configuration object.","name":"frameConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.SpriteSheetFile","___s":true},{"meta":{"filename":"SpriteSheetFile.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"SpriteSheetFile.js","lineno":59,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Sprite Sheet Image, or array of Sprite Sheet Images, to the current load queue.\n\nThe term 'Sprite Sheet' in Phaser means a fixed-size sheet. Where every frame in the sheet is the exact same size,\nand you reference those frames using numbers, not frame names. This is not the same thing as a Texture Atlas, where\nthe frames are packed in a way where they take up the least amount of space, and are referenced by their names,\nnot numbers. Some articles and software use the term 'Sprite Sheet' to mean Texture Atlas, so please be aware of\nwhat sort of file you're actually trying to load.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.spritesheet('bot', 'images/robot.png', { frameWidth: 32, frameHeight: 38 });\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\nIf you try to load an animated gif only the first frame will be rendered. Browsers do not natively support playback\nof animated gifs to Canvas elements.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.spritesheet({\n key: 'bot',\n url: 'images/robot.png',\n frameConfig: {\n frameWidth: 32,\n frameHeight: 38,\n startFrame: 0,\n endFrame: 8\n }\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig` for more details.\n\nOnce the file has finished loading you can use it as a texture for a Game Object by referencing its key:\n\n```javascript\nthis.load.spritesheet('bot', 'images/robot.png', { frameWidth: 32, frameHeight: 38 });\n// and later in your game ...\nthis.add.image(x, y, 'bot', 0);\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `PLAYER.` and the key was `Running` the final key will be `PLAYER.Running` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\nthen you can specify it by providing an array as the `url` where the second element is the normal map:\n\n```javascript\nthis.load.spritesheet('logo', [ 'images/AtariLogo.png', 'images/AtariLogo-n.png' ], { frameWidth: 256, frameHeight: 80 });\n```\n\nOr, if you are using a config object use the `normalMap` property:\n\n```javascript\nthis.load.spritesheet({\n key: 'logo',\n url: 'images/AtariLogo.png',\n normalMap: 'images/AtariLogo-n.png',\n frameConfig: {\n frameWidth: 256,\n frameHeight: 80\n }\n});\n```\n\nThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\nNormal maps are a WebGL only feature.\n\nNote: The ability to load this type of file will only be available if the Sprite Sheet File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"spritesheet","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.FileTypes.ImageFrameConfig"]},"optional":true,"description":"The frame configuration object. At a minimum it should have a `frameWidth` property.","name":"frameConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#spritesheet","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"TextFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Text File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#text method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#text.","kind":"class","name":"TextFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TextFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.TextFile","___s":true},{"meta":{"filename":"TextFile.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"TextFile.js","lineno":84,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Text file, or array of Text files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.text('story', 'files/IntroStory.txt');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Text Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Text Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Text Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.text({\n key: 'story',\n url: 'files/IntroStory.txt'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.TextFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.text('story', 'files/IntroStory.txt');\n// and later in your game ...\nvar data = this.cache.text.get('story');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Story` the final key will be `LEVEL1.Story` and\nthis is what you would use to retrieve the text from the Text Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"story\"\nand no URL is given then the Loader will set the URL to be \"story.txt\". It will always add `.txt` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Text File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"text","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TextFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#text","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"TilemapCSVFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TilemapCSVFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Tilemap CSV File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#tilemapCSV method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#tilemapCSV.","kind":"class","name":"TilemapCSVFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.csv`, i.e. if `key` was \"alien\" then the URL will be \"alien.csv\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.TilemapCSVFile","___s":true},{"meta":{"filename":"TilemapCSVFile.js","lineno":69,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"TilemapCSVFile.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"TilemapCSVFile.js","lineno":102,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a CSV Tilemap file, or array of CSV files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.tilemapCSV('level1', 'maps/Level1.csv');\n}\n```\n\nTilemap CSV data can be created in a text editor, or a 3rd party app that exports as CSV.\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Tilemap Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Tilemap Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Text Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.tilemapCSV({\n key: 'level1',\n url: 'maps/Level1.csv'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.tilemapCSV('level1', 'maps/Level1.csv');\n// and later in your game ...\nvar map = this.make.tilemap({ key: 'level1' });\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Story` the final key will be `LEVEL1.Story` and\nthis is what you would use to retrieve the text from the Tilemap Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"level\"\nand no URL is given then the Loader will set the URL to be \"level.csv\". It will always add `.csv` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Tilemap CSV File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"tilemapCSV","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.csv`, i.e. if `key` was \"alien\" then the URL will be \"alien.csv\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#tilemapCSV","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"TilemapImpactFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TilemapImpactFile.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Impact.js Tilemap JSON File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#tilemapImpact method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#tilemapImpact.","kind":"class","name":"TilemapImpactFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.TilemapImpactFile","___s":true},{"meta":{"filename":"TilemapImpactFile.js","lineno":46,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"TilemapImpactFile.js","lineno":63,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an Impact.js Tilemap file, or array of map files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.tilemapImpact('level1', 'maps/Level1.json');\n}\n```\n\nImpact Tilemap data is created the Impact.js Map Editor called Weltmeister.\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Tilemap Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Tilemap Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Text Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.tilemapImpact({\n key: 'level1',\n url: 'maps/Level1.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.tilemapImpact('level1', 'maps/Level1.json');\n// and later in your game ...\nvar map = this.make.tilemap({ key: 'level1' });\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Story` the final key will be `LEVEL1.Story` and\nthis is what you would use to retrieve the text from the Tilemap Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"level\"\nand no URL is given then the Loader will set the URL to be \"level.json\". It will always add `.json` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Tilemap Impact File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"tilemapImpact","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.7.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#tilemapImpact","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"TilemapJSONFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TilemapJSONFile.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Tiled Tilemap JSON File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#tilemapTiledJSON method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#tilemapTiledJSON.","kind":"class","name":"TilemapJSONFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.TilemapJSONFile","___s":true},{"meta":{"filename":"TilemapJSONFile.js","lineno":46,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"TilemapJSONFile.js","lineno":63,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Tiled JSON Tilemap file, or array of map files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.tilemapTiledJSON('level1', 'maps/Level1.json');\n}\n```\n\nThe Tilemap data is created using the Tiled Map Editor and selecting JSON as the export format.\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Tilemap Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Tilemap Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Text Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.tilemapTiledJSON({\n key: 'level1',\n url: 'maps/Level1.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.tilemapTiledJSON('level1', 'maps/Level1.json');\n// and later in your game ...\nvar map = this.make.tilemap({ key: 'level1' });\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Story` the final key will be `LEVEL1.Story` and\nthis is what you would use to retrieve the text from the Tilemap Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"level\"\nand no URL is given then the Loader will set the URL to be \"level.json\". It will always add `.json` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Tilemap JSON File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"tilemapTiledJSON","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#tilemapTiledJSON","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"UnityAtlasFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"UnityAtlasFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single text file based Unity Texture Atlas File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#unityAtlas method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#unityAtlas.","kind":"class","name":"UnityAtlasFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the texture image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas data file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".","name":"atlasURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas data file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.UnityAtlasFile","___s":true},{"meta":{"filename":"UnityAtlasFile.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"UnityAtlasFile.js","lineno":109,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Unity YAML based Texture Atlas, or array of atlases, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.unityAtlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.txt');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nPhaser expects the atlas data to be provided in a YAML formatted text file as exported from Unity.\n\nPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.unityAtlas({\n key: 'mainmenu',\n textureURL: 'images/MainMenu.png',\n atlasURL: 'images/MainMenu.txt'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig` for more details.\n\nOnce the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:\n\n```javascript\nthis.load.unityAtlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.json');\n// and later in your game ...\nthis.add.image(x, y, 'mainmenu', 'background');\n```\n\nTo get a list of all available frames within an atlas please consult your Texture Atlas software.\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\nthen you can specify it by providing an array as the `url` where the second element is the normal map:\n\n```javascript\nthis.load.unityAtlas('mainmenu', [ 'images/MainMenu.png', 'images/MainMenu-n.png' ], 'images/MainMenu.txt');\n```\n\nOr, if you are using a config object use the `normalMap` property:\n\n```javascript\nthis.load.unityAtlas({\n key: 'mainmenu',\n textureURL: 'images/MainMenu.png',\n normalMap: 'images/MainMenu-n.png',\n atlasURL: 'images/MainMenu.txt'\n});\n```\n\nThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\nNormal maps are a WebGL only feature.\n\nNote: The ability to load this type of file will only be available if the Unity Atlas File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"unityAtlas","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the texture image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas data file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".","name":"atlasURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas data file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#unityAtlas","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"VideoFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"VideoFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Video File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#video method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#video.","kind":"class","name":"VideoFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.20.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.VideoFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["any"]},"optional":true,"description":"The absolute or relative URL to load this file from in a config object.","name":"urlConfig"},{"type":{"names":["string"]},"optional":true,"description":"The load event to listen for when _not_ loading as a blob. Either 'loadeddata', 'canplay' or 'canplaythrough'.","name":"loadEvent"},{"type":{"names":["boolean"]},"optional":true,"description":"Load the video as a data blob, or via the Video element?","name":"asBlob"},{"type":{"names":["boolean"]},"optional":true,"description":"Does the video have an audio track? If not you can enable auto-playing on it.","name":"noAudio"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.VideoFile","___s":true},{"meta":{"filename":"VideoFile.js","lineno":76,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.20.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"VideoFile.js","lineno":196,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.20.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#load","scope":"instance","overrides":"Phaser.Loader.File#load","___s":true},{"meta":{"filename":"VideoFile.js","lineno":292,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Video file, or array of video files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.video('intro', [ 'video/level1.mp4', 'video/level1.webm', 'video/level1.mov' ]);\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Video Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Video Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Video Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.video({\n key: 'intro',\n url: [ 'video/level1.mp4', 'video/level1.webm', 'video/level1.mov' ],\n asBlob: false,\n noAudio: true\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.VideoFileConfig` for more details.\n\nThe URLs can be relative or absolute. If the URLs are relative the `Loader.baseURL` and `Loader.path` values will be prepended to them.\n\nDue to different browsers supporting different video file types you should usually provide your video files in a variety of formats.\nmp4, mov and webm are the most common. If you provide an array of URLs then the Loader will determine which _one_ file to load based on\nbrowser support, starting with the first in the array and progressing to the end.\n\nUnlike most asset-types, videos do not _need_ to be preloaded. You can create a Video Game Object and then call its `loadURL` method,\nto load a video at run-time, rather than in advance.\n\nNote: The ability to load this type of file will only be available if the Video File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"video","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.20.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.VideoFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the video files from.","name":"urls"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'loadeddata'","description":"The load event to listen for when _not_ loading as a blob. Either `loadeddata`, `canplay` or `canplaythrough`.","name":"loadEvent"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Load the video as a data blob, or stream it via the Video element?","name":"asBlob"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Does the video have an audio track? If not you can enable auto-playing on it.","name":"noAudio"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#video","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"XMLFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"XMLFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single XML File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#xml method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#xml.","kind":"class","name":"XMLFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.XMLFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.XMLFile","___s":true},{"meta":{"filename":"XMLFile.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"XMLFile.js","lineno":94,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an XML file, or array of XML files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.xml('wavedata', 'files/AlienWaveData.xml');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global XML Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the XML Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the XML Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.xml({\n key: 'wavedata',\n url: 'files/AlienWaveData.xml'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.XMLFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.xml('wavedata', 'files/AlienWaveData.xml');\n// and later in your game ...\nvar data = this.cache.xml.get('wavedata');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Waves` the final key will be `LEVEL1.Waves` and\nthis is what you would use to retrieve the text from the XML Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"data\"\nand no URL is given then the Loader will set the URL to be \"data.xml\". It will always add `.xml` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the XML File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"xml","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.XMLFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#xml","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"kind":"namespace","name":"FileTypes","memberof":"Phaser.Loader","longname":"Phaser.Loader.FileTypes","scope":"static","___s":true},{"meta":{"filename":"AtlasJSONFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"AtlasJSONFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture image file from.","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'png'","description":"The default file extension to use for the image texture if no url is provided.","name":"textureExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the texture image file.","name":"textureXhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"The filename of an associated normal map. It uses the same path and url to load as the texture image.","name":"normalMap"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the atlas json file from. Or a well formed JSON object to use instead.","name":"atlasURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'json'","description":"The default file extension to use for the atlas json if no url is provided.","name":"atlasExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the atlas json file.","name":"atlasXhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig","scope":"static","___s":true},{"meta":{"filename":"AtlasXMLFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"AtlasXMLFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture image file from.","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'png'","description":"The default file extension to use for the image texture if no url is provided.","name":"textureExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the texture image file.","name":"textureXhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"The filename of an associated normal map. It uses the same path and url to load as the texture image.","name":"normalMap"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the atlas xml file from.","name":"atlasURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'xml'","description":"The default file extension to use for the atlas xml if no url is provided.","name":"atlasExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the atlas xml file.","name":"atlasXhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig","scope":"static","___s":true},{"meta":{"filename":"AudioFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"AudioFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within the Loader and Audio Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"urlConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["AudioContext"]},"optional":true,"description":"The AudioContext this file will use to process itself.","name":"audioContext"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.AudioFileConfig","scope":"static","___s":true},{"meta":{"filename":"AudioSpriteFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"AudioSpriteFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Audio Cache.","name":"key"},{"type":{"names":["string"]},"description":"The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.","name":"jsonURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the json file.","name":"jsonXhrSettings"},{"type":{"names":["Object"]},"optional":true,"description":"The absolute or relative URL to load the audio file from.","name":"audioURL"},{"type":{"names":["any"]},"optional":true,"description":"The audio configuration options.","name":"audioConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the audio file.","name":"audioXhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig","scope":"static","___s":true},{"meta":{"filename":"BinaryFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"BinaryFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Binary Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'bin'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["any"]},"optional":true,"description":"Optional type to cast the binary file to once loaded. For example, `Uint8Array`.","name":"dataType"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.BinaryFileConfig","scope":"static","___s":true},{"meta":{"filename":"BitmapFontFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"BitmapFontFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture image file from.","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'png'","description":"The default file extension to use for the image texture if no url is provided.","name":"textureExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the texture image file.","name":"textureXhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"The filename of an associated normal map. It uses the same path and url to load as the texture image.","name":"normalMap"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the font data xml file from.","name":"fontDataURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'xml'","description":"The default file extension to use for the font data xml if no url is provided.","name":"fontDataExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the font data xml file.","name":"fontDataXhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.BitmapFontFileConfig","scope":"static","___s":true},{"meta":{"filename":"CSSFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"CSSFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within the Loader.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'js'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.CSSFileConfig","scope":"static","___s":true},{"meta":{"filename":"GLSLFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"GLSLFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Text Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'fragment'","description":"The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.","name":"shaderType"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'glsl'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.GLSLFileConfig","scope":"static","___s":true},{"meta":{"filename":"HTMLFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"HTMLFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Text Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'html'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.HTMLFileConfig","scope":"static","___s":true},{"meta":{"filename":"HTMLTextureFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"HTMLTextureFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'html'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":512,"description":"The width of the texture the HTML will be rendered to.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":512,"description":"The height of the texture the HTML will be rendered to.","name":"height"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig","scope":"static","___s":true},{"meta":{"filename":"ImageFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"ImageFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'png'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["string"]},"optional":true,"description":"The filename of an associated normal map. It uses the same path and url to load as the image.","name":"normalMap"},{"type":{"names":["Phaser.Types.Loader.FileTypes.ImageFrameConfig"]},"optional":true,"description":"The frame configuration object. Only provided for, and used by, Sprite Sheets.","name":"frameConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.ImageFileConfig","scope":"static","___s":true},{"meta":{"filename":"ImageFrameConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"ImageFrameConfig","type":{"names":["object"]},"properties":[{"type":{"names":["integer"]},"description":"The width of the frame in pixels.","name":"frameWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the frame in pixels. Uses the `frameWidth` value if not provided.","name":"frameHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The first frame to start parsing from.","name":"startFrame"},{"type":{"names":["integer"]},"optional":true,"description":"The frame to stop parsing at. If not provided it will calculate the value based on the image and frame dimensions.","name":"endFrame"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The margin in the image. This is the space around the edge of the frames.","name":"margin"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The spacing between each frame in the image.","name":"spacing"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.ImageFrameConfig","scope":"static","___s":true},{"meta":{"filename":"JSONFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"JSONFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the JSON Cache.","name":"key"},{"type":{"names":["string","any"]},"optional":true,"description":"The absolute or relative URL to load the file from. Or can be a ready formed JSON object, in which case it will be directly added to the Cache.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'json'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["string"]},"optional":true,"description":"If specified instead of the whole JSON file being parsed and added to the Cache, only the section corresponding to this property key will be added. If the property you want to extract is nested, use periods to divide it.","name":"dataKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.JSONFileConfig","scope":"static","___s":true},{"meta":{"filename":"MultiAtlasFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"MultiAtlasFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the multi atlas json file from. Or, a well formed JSON object.","name":"atlasURL"},{"type":{"names":["string"]},"optional":true,"description":"An alias for 'atlasURL'. If given, it overrides anything set in 'atlasURL'.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'json'","description":"The default file extension to use for the atlas json if no url is provided.","name":"atlasExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the atlas json file.","name":"atlasXhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"Optional path to use when loading the textures defined in the atlas data.","name":"path"},{"type":{"names":["string"]},"optional":true,"description":"Optional Base URL to use when loading the textures defined in the atlas data.","name":"baseURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the texture files.","name":"textureXhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig","scope":"static","___s":true},{"meta":{"filename":"MultiScriptFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"MultiScriptFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within the Loader.","name":"key"},{"type":{"names":["Array."]},"optional":true,"description":"An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'js'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for these files.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.MultiScriptFileConfig","scope":"static","___s":true},{"meta":{"filename":"PackFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"PackFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the JSON Cache.","name":"key"},{"type":{"names":["string","any"]},"optional":true,"description":"The absolute or relative URL to load the file from. Or can be a ready formed JSON object, in which case it will be directly processed.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'json'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["string"]},"optional":true,"description":"If specified instead of the whole JSON file being parsed, only the section corresponding to this property key will be added. If the property you want to extract is nested, use periods to divide it.","name":"dataKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.PackFileConfig","scope":"static","___s":true},{"meta":{"filename":"PluginFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"PluginFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within the Loader.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'js'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Automatically start the plugin after loading?","name":"start"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Scene, this is the property key used.","name":"mapping"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.PluginFileConfig","scope":"static","___s":true},{"meta":{"filename":"SVGFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"SVGFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'svg'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["Phaser.Types.Loader.FileTypes.SVGSizeConfig"]},"optional":true,"description":"The svg size configuration object.","name":"svgConfig"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.SVGFileConfig","scope":"static","___s":true},{"meta":{"filename":"SVGSizeConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"SVGSizeConfig","type":{"names":["object"]},"properties":[{"type":{"names":["integer"]},"optional":true,"description":"An optional width. The SVG will be resized to this size before being rendered to a texture.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"An optional height. The SVG will be resized to this size before being rendered to a texture.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"An optional scale. If given it overrides the width / height properties. The SVG is scaled by the scale factor before being rendered to a texture.","name":"scale"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.SVGSizeConfig","scope":"static","___s":true},{"meta":{"filename":"SceneFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"SceneFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Text Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'txt'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.SceneFileConfig","scope":"static","___s":true},{"meta":{"filename":"ScenePluginFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"ScenePluginFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within the Loader.","name":"key"},{"type":{"names":["string","function"]},"optional":true,"description":"The absolute or relative URL to load the file from. Or, a Scene Plugin.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'js'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be added to Scene.Systems, this is the property key for it.","name":"systemKey"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be added to the Scene, this is the property key for it.","name":"sceneKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.ScenePluginFileConfig","scope":"static","___s":true},{"meta":{"filename":"ScriptFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"ScriptFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within the Loader.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'js'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.ScriptFileConfig","scope":"static","___s":true},{"meta":{"filename":"SpriteSheetFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"SpriteSheetFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'png'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["string"]},"optional":true,"description":"The filename of an associated normal map. It uses the same path and url to load as the image.","name":"normalMap"},{"type":{"names":["Phaser.Types.Loader.FileTypes.ImageFrameConfig"]},"optional":true,"description":"The frame configuration object.","name":"frameConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig","scope":"static","___s":true},{"meta":{"filename":"TextFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"TextFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Text Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'txt'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.TextFileConfig","scope":"static","___s":true},{"meta":{"filename":"TilemapCSVFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"TilemapCSVFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Tilemap Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'csv'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig","scope":"static","___s":true},{"meta":{"filename":"TilemapImpactFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"TilemapImpactFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Tilemap Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'json'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig","scope":"static","___s":true},{"meta":{"filename":"TilemapJSONFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"TilemapJSONFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Tilemap Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'json'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig","scope":"static","___s":true},{"meta":{"filename":"UnityAtlasFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"UnityAtlasFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture image file from.","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'png'","description":"The default file extension to use for the image texture if no url is provided.","name":"textureExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the texture image file.","name":"textureXhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"The filename of an associated normal map. It uses the same path and url to load as the texture image.","name":"normalMap"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the atlas data file from.","name":"atlasURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'txt'","description":"The default file extension to use for the atlas data if no url is provided.","name":"atlasExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the atlas data file.","name":"atlasXhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig","scope":"static","___s":true},{"meta":{"filename":"VideoFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"VideoFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.VideoFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["any"]},"optional":true,"description":"The absolute or relative URL to load this file from in a config object.","name":"urlConfig"},{"type":{"names":["string"]},"optional":true,"description":"The load event to listen for when _not_ loading as a blob. Either 'loadeddata', 'canplay' or 'canplaythrough'.","name":"loadEvent"},{"type":{"names":["boolean"]},"optional":true,"description":"Load the video as a data blob, or via the Video element?","name":"asBlob"},{"type":{"names":["boolean"]},"optional":true,"description":"Does the video have an audio track? If not you can enable auto-playing on it.","name":"noAudio"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.VideoFileConfig","scope":"static","___s":true},{"meta":{"filename":"XMLFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"XMLFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Text Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'xml'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.XMLFileConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"namespace","name":"FileTypes","memberof":"Phaser.Types.Loader","longname":"Phaser.Types.Loader.FileTypes","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"kind":"namespace","name":"Loader","memberof":"Phaser","longname":"Phaser.Loader","scope":"static","___s":true},{"meta":{"filename":"FileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/typedefs"},"kind":"typedef","name":"FileConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type"},{"type":{"names":["string"]},"description":"Unique cache key (unique within its file type)","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The URL of the file, not including baseURL.","name":"url"},{"type":{"names":["string"]},"optional":true,"description":"The path of the file, not including the baseURL.","name":"path"},{"type":{"names":["string"]},"optional":true,"description":"The default extension this file uses.","name":"extension"},{"type":{"names":["XMLHttpRequestResponseType"]},"optional":true,"description":"The responseType to be used by the XHR request.","name":"responseType"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject","false"]},"optional":true,"defaultvalue":false,"description":"Custom XHR Settings specific to this file and merged with the Loader defaults.","name":"xhrSettings"},{"type":{"names":["any"]},"optional":true,"description":"A config object that can be used by file types to store transitional data.","name":"config"}],"memberof":"Phaser.Types.Loader","longname":"Phaser.Types.Loader.FileConfig","scope":"static","___s":true},{"meta":{"filename":"XHRSettingsObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/typedefs"},"kind":"typedef","name":"XHRSettingsObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["XMLHttpRequestResponseType"]},"description":"The response type of the XHR request, i.e. `blob`, `text`, etc.","name":"responseType"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the XHR request use async or not?","name":"async"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"Optional username for the XHR request.","name":"user"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"Optional password for the XHR request.","name":"password"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optional XHR timeout value.","name":"timeout"},{"type":{"names":["string","undefined"]},"optional":true,"description":"This value is used to populate the XHR `setRequestHeader` and is undefined by default.","name":"header"},{"type":{"names":["string","undefined"]},"optional":true,"description":"This value is used to populate the XHR `setRequestHeader` and is undefined by default.","name":"headerValue"},{"type":{"names":["string","undefined"]},"optional":true,"description":"This value is used to populate the XHR `setRequestHeader` and is undefined by default.","name":"requestedWith"},{"type":{"names":["string","undefined"]},"optional":true,"description":"Provide a custom mime-type to use instead of the default.","name":"overrideMimeType"}],"memberof":"Phaser.Types.Loader","longname":"Phaser.Types.Loader.XHRSettingsObject","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/typedefs"},"kind":"namespace","name":"Loader","memberof":"Phaser.Types","longname":"Phaser.Types.Loader","scope":"static","___s":true},{"meta":{"filename":"Average.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the mean average of the given values.","kind":"function","name":"Average","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The values to average.","name":"values"}],"returns":[{"type":{"names":["number"]},"description":"The average value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Average","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Bernstein.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"Factorial","longname":"Factorial","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Bernstein.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"[description]","kind":"function","name":"Bernstein","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"n"},{"type":{"names":["number"]},"description":"[description]","name":"i"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Math","longname":"Phaser.Math.Bernstein","scope":"static","___s":true},{"meta":{"filename":"Between.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Compute a random integer between the `min` and `max` values, inclusive.","kind":"function","name":"Between","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The minimum value.","name":"min"},{"type":{"names":["integer"]},"description":"The maximum value.","name":"max"}],"returns":[{"type":{"names":["integer"]},"description":"The random integer."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Between","scope":"static","___s":true},{"meta":{"filename":"CatmullRom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculates a Catmull-Rom value.","kind":"function","name":"CatmullRom","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"t"},{"type":{"names":["number"]},"description":"[description]","name":"p0"},{"type":{"names":["number"]},"description":"[description]","name":"p1"},{"type":{"names":["number"]},"description":"[description]","name":"p2"},{"type":{"names":["number"]},"description":"[description]","name":"p3"}],"returns":[{"type":{"names":["number"]},"description":"The Catmull-Rom value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.CatmullRom","scope":"static","___s":true},{"meta":{"filename":"CeilTo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Ceils to some place comparative to a `base`, default is 10 for decimal place.\n\nThe `place` is represented by the power applied to `base` to get that place.","kind":"function","name":"CeilTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to round.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The place to round to.","name":"place"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The base to round in. Default is 10 for decimal.","name":"base"}],"returns":[{"type":{"names":["number"]},"description":"The rounded value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.CeilTo","scope":"static","___s":true},{"meta":{"filename":"Clamp.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Force a value within the boundaries by clamping it to the range `min`, `max`.","kind":"function","name":"Clamp","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be clamped.","name":"value"},{"type":{"names":["number"]},"description":"The minimum bounds.","name":"min"},{"type":{"names":["number"]},"description":"The maximum bounds.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The clamped value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Clamp","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"DegToRad.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DegToRad.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Convert the given angle from degrees, to the equivalent angle in radians.","kind":"function","name":"DegToRad","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The angle (in degrees) to convert to radians.","name":"degrees"}],"returns":[{"type":{"names":["number"]},"description":"The given angle converted to radians."}],"memberof":"Phaser.Math","longname":"Phaser.Math.DegToRad","scope":"static","___s":true},{"meta":{"filename":"Difference.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculates the positive difference of two given numbers.","kind":"function","name":"Difference","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first number in the calculation.","name":"a"},{"type":{"names":["number"]},"description":"The second number in the calculation.","name":"b"}],"returns":[{"type":{"names":["number"]},"description":"The positive difference of the two given numbers."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Difference","scope":"static","___s":true},{"meta":{"filename":"Factorial.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculates the factorial of a given number for integer values greater than 0.","kind":"function","name":"Factorial","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A positive integer to calculate the factorial of.","name":"value"}],"returns":[{"type":{"names":["number"]},"description":"The factorial of the given number."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Factorial","scope":"static","___s":true},{"meta":{"filename":"FloatBetween.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a random floating point number between the two given bounds, minimum inclusive, maximum exclusive.","kind":"function","name":"FloatBetween","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The lower bound for the float, inclusive.","name":"min"},{"type":{"names":["number"]},"description":"The upper bound for the float exclusive.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"A random float within the given range."}],"memberof":"Phaser.Math","longname":"Phaser.Math.FloatBetween","scope":"static","___s":true},{"meta":{"filename":"FloorTo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Floors to some place comparative to a `base`, default is 10 for decimal place.\n\nThe `place` is represented by the power applied to `base` to get that place.","kind":"function","name":"FloorTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to round.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The place to round to.","name":"place"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The base to round in. Default is 10 for decimal.","name":"base"}],"returns":[{"type":{"names":["number"]},"description":"The rounded value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.FloorTo","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"FromPercent.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FromPercent.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Return a value based on the range between `min` and `max` and the percentage given.","kind":"function","name":"FromPercent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1 representing the percentage.","name":"percent"},{"type":{"names":["number"]},"description":"The minimum value.","name":"min"},{"type":{"names":["number"]},"optional":true,"description":"The maximum value.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The value that is `percent` percent between `min` and `max`."}],"memberof":"Phaser.Math","longname":"Phaser.Math.FromPercent","scope":"static","___s":true},{"meta":{"filename":"GetSpeed.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate a per-ms speed from a distance and time (given in seconds).","kind":"function","name":"GetSpeed","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The distance.","name":"distance"},{"type":{"names":["integer"]},"description":"The time, in seconds.","name":"time"}],"returns":[{"type":{"names":["number"]},"description":"The speed, in distance per ms."}],"examples":["// 400px over 1 second is 0.4 px/ms\nPhaser.Math.GetSpeed(400, 1) // -> 0.4"],"memberof":"Phaser.Math","longname":"Phaser.Math.GetSpeed","scope":"static","___s":true},{"meta":{"filename":"IsEven.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Check if a given value is an even number.","kind":"function","name":"IsEven","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number to perform the check with.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the number is even or not."}],"memberof":"Phaser.Math","longname":"Phaser.Math.IsEven","scope":"static","___s":true},{"meta":{"filename":"IsEvenStrict.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Check if a given value is an even number using a strict type check.","kind":"function","name":"IsEvenStrict","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number to perform the check with.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the number is even or not."}],"memberof":"Phaser.Math","longname":"Phaser.Math.IsEvenStrict","scope":"static","___s":true},{"meta":{"filename":"Linear.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculates a linear (interpolation) value over t.","kind":"function","name":"Linear","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first point.","name":"p0"},{"type":{"names":["number"]},"description":"The second point.","name":"p1"},{"type":{"names":["number"]},"description":"The percentage between p0 and p1 to return, represented as a number between 0 and 1.","name":"t"}],"returns":[{"type":{"names":["number"]},"description":"The step t% of the way between p0 and p1."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Linear","scope":"static","___s":true},{"meta":{"filename":"Matrix3.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"classdesc":"A three-dimensional matrix.\n\nDefaults to the identity matrix when instantiated.","kind":"class","name":"Matrix3","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"optional":true,"description":"Optional Matrix3 to copy values from.","name":"m"}],"scope":"static","longname":"Phaser.Math.Matrix3","___s":true},{"meta":{"filename":"Matrix3.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The matrix values.","name":"val","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#val","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Matrix3.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make a clone of this Matrix3.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"A clone of this Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#clone","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":65,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"This method is an alias for `Matrix3.copy`.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"The Matrix to set the values of this Matrix's from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#set","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the values of a given Matrix into this Matrix.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"The Matrix to copy the values from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#copy","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the values of a given Matrix4 into this Matrix3.","kind":"function","name":"fromMat4","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix4 to copy the values from.","name":"m"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#fromMat4","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the values of this Matrix from the given array.","kind":"function","name":"fromArray","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to copy the values from.","name":"a"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#fromArray","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":163,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Reset this Matrix to an identity (default) matrix.","kind":"function","name":"identity","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#identity","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transpose this Matrix.","kind":"function","name":"transpose","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#transpose","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Invert this Matrix.","kind":"function","name":"invert","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#invert","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":262,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the adjoint, or adjugate, of this Matrix.","kind":"function","name":"adjoint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#adjoint","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the determinant of this Matrix.","kind":"function","name":"determinant","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The determinant of this Matrix."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#determinant","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":322,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Multiply this Matrix by the given Matrix.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"The Matrix to multiply this Matrix by.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#multiply","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Translate this Matrix using the given Vector.","kind":"function","name":"translate","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to translate this Matrix with.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#translate","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":396,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Apply a rotation transformation to this Matrix.","kind":"function","name":"rotate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle in radians to rotate by.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#rotate","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Apply a scale transformation to this Matrix.\n\nUses the `x` and `y` components of the given Vector to scale the Matrix.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to scale this Matrix with.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#scale","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the values of this Matrix from the given Quaternion.","kind":"function","name":"fromQuat","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"The Quaternion to set the values of this Matrix from.","name":"q"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#fromQuat","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":510,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"[description]","kind":"function","name":"normalFromMat4","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"[description]","name":"m"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#normalFromMat4","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"classdesc":"A four-dimensional matrix.","kind":"class","name":"Matrix4","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"optional":true,"description":"Optional Matrix4 to copy values from.","name":"m"}],"scope":"static","longname":"Phaser.Math.Matrix4","___s":true},{"meta":{"filename":"Matrix4.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The matrix values.","name":"val","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#val","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Matrix4.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make a clone of this Matrix4.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"A clone of this Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#clone","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"This method is an alias for `Matrix4.copy`.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix to set the values of this Matrix's from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#set","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the values of a given Matrix into this Matrix.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix to copy the values from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#copy","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the values of this Matrix from the given array.","kind":"function","name":"fromArray","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to copy the values from.","name":"a"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#fromArray","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":151,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Reset this Matrix.\n\nSets all values to `0`.","kind":"function","name":"zero","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#zero","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the `x`, `y` and `z` values of this Matrix.","kind":"function","name":"xyz","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x value.","name":"x"},{"type":{"names":["number"]},"description":"The y value.","name":"y"},{"type":{"names":["number"]},"description":"The z value.","name":"z"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#xyz","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":210,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the scaling values of this Matrix.","kind":"function","name":"scaling","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x scaling value.","name":"x"},{"type":{"names":["number"]},"description":"The y scaling value.","name":"y"},{"type":{"names":["number"]},"description":"The z scaling value.","name":"z"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#scaling","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":236,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Reset this Matrix to an identity (default) matrix.","kind":"function","name":"identity","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#identity","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transpose this Matrix.","kind":"function","name":"transpose","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#transpose","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":303,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Invert this Matrix.","kind":"function","name":"invert","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#invert","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":380,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the adjoint, or adjugate, of this Matrix.","kind":"function","name":"adjoint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#adjoint","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the determinant of this Matrix.","kind":"function","name":"determinant","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The determinant of this Matrix."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#determinant","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":481,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Multiply this Matrix by the given Matrix.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix to multiply this Matrix by.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#multiply","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":561,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"[description]","kind":"function","name":"multiplyLocal","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"[description]","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#multiplyLocal","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":600,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Translate this Matrix using the given Vector.","kind":"function","name":"translate","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to translate this Matrix with.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#translate","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Translate this Matrix using the given values.","kind":"function","name":"translateXYZ","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The x component.","name":"x"},{"type":{"names":["number"]},"description":"The y component.","name":"y"},{"type":{"names":["number"]},"description":"The z component.","name":"z"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#translateXYZ","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":649,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Apply a scale transformation to this Matrix.\n\nUses the `x`, `y` and `z` components of the given Vector to scale the Matrix.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to scale this Matrix with.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#scale","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":686,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Apply a scale transformation to this Matrix.","kind":"function","name":"scaleXYZ","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The x component.","name":"x"},{"type":{"names":["number"]},"description":"The y component.","name":"y"},{"type":{"names":["number"]},"description":"The z component.","name":"z"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#scaleXYZ","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":720,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Derive a rotation matrix around the given axis.","kind":"function","name":"makeRotationAxis","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The rotation axis.","name":"axis"},{"type":{"names":["number"]},"description":"The rotation angle in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#makeRotationAxis","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":754,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Apply a rotation transformation to this Matrix.","kind":"function","name":"rotate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle in radians to rotate by.","name":"rad"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The axis to rotate upon.","name":"axis"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#rotate","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":832,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate this matrix on its X axis.","kind":"function","name":"rotateX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle in radians to rotate by.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#rotateX","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":871,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate this matrix on its Y axis.","kind":"function","name":"rotateY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#rotateY","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":910,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate this matrix on its Z axis.","kind":"function","name":"rotateZ","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#rotateZ","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":949,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the values of this Matrix from the given rotation Quaternion and translation Vector.","kind":"function","name":"fromRotationTranslation","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"The Quaternion to set rotation from.","name":"q"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The Vector to set translation from.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#fromRotationTranslation","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1009,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the values of this Matrix from the given Quaternion.","kind":"function","name":"fromQuat","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"The Quaternion to set the values of this Matrix from.","name":"q"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#fromQuat","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1067,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a frustum matrix with the given bounds.","kind":"function","name":"frustum","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The left bound of the frustum.","name":"left"},{"type":{"names":["number"]},"description":"The right bound of the frustum.","name":"right"},{"type":{"names":["number"]},"description":"The bottom bound of the frustum.","name":"bottom"},{"type":{"names":["number"]},"description":"The top bound of the frustum.","name":"top"},{"type":{"names":["number"]},"description":"The near bound of the frustum.","name":"near"},{"type":{"names":["number"]},"description":"The far bound of the frustum.","name":"far"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#frustum","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1113,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a perspective projection matrix with the given bounds.","kind":"function","name":"perspective","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Vertical field of view in radians","name":"fovy"},{"type":{"names":["number"]},"description":"Aspect ratio. Typically viewport width /height.","name":"aspect"},{"type":{"names":["number"]},"description":"Near bound of the frustum.","name":"near"},{"type":{"names":["number"]},"description":"Far bound of the frustum.","name":"far"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#perspective","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a perspective projection matrix with the given bounds.","kind":"function","name":"perspectiveLH","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the frustum.","name":"width"},{"type":{"names":["number"]},"description":"The height of the frustum.","name":"height"},{"type":{"names":["number"]},"description":"Near bound of the frustum.","name":"near"},{"type":{"names":["number"]},"description":"Far bound of the frustum.","name":"far"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#perspectiveLH","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate an orthogonal projection matrix with the given bounds.","kind":"function","name":"ortho","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The left bound of the frustum.","name":"left"},{"type":{"names":["number"]},"description":"The right bound of the frustum.","name":"right"},{"type":{"names":["number"]},"description":"The bottom bound of the frustum.","name":"bottom"},{"type":{"names":["number"]},"description":"The top bound of the frustum.","name":"top"},{"type":{"names":["number"]},"description":"The near bound of the frustum.","name":"near"},{"type":{"names":["number"]},"description":"The far bound of the frustum.","name":"far"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#ortho","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a look-at matrix with the given eye position, focal point, and up axis.","kind":"function","name":"lookAt","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"Position of the viewer","name":"eye"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"Point the viewer is looking at","name":"center"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"vec3 pointing up.","name":"up"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#lookAt","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1353,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the values of this matrix from the given `yaw`, `pitch` and `roll` values.","kind":"function","name":"yawPitchRoll","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"yaw"},{"type":{"names":["number"]},"description":"[description]","name":"pitch"},{"type":{"names":["number"]},"description":"[description]","name":"roll"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#yawPitchRoll","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1414,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a world matrix from the given rotation, position, scale, view matrix and projection matrix.","kind":"function","name":"setWorldMatrix","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The rotation of the world matrix.","name":"rotation"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The position of the world matrix.","name":"position"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The scale of the world matrix.","name":"scale"},{"type":{"names":["Phaser.Math.Matrix4"]},"optional":true,"description":"The view matrix.","name":"viewMatrix"},{"type":{"names":["Phaser.Math.Matrix4"]},"optional":true,"description":"The projection matrix.","name":"projectionMatrix"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#setWorldMatrix","scope":"instance","___s":true},{"meta":{"filename":"MaxAdd.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Add an `amount` to a `value`, limiting the maximum result to `max`.","kind":"function","name":"MaxAdd","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to add to.","name":"value"},{"type":{"names":["number"]},"description":"The amount to add.","name":"amount"},{"type":{"names":["number"]},"description":"The maximum value to return.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The resulting value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.MaxAdd","scope":"static","___s":true},{"meta":{"filename":"MinSub.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Subtract an `amount` from `value`, limiting the minimum result to `min`.","kind":"function","name":"MinSub","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to subtract from.","name":"value"},{"type":{"names":["number"]},"description":"The amount to subtract.","name":"amount"},{"type":{"names":["number"]},"description":"The minimum value to return.","name":"min"}],"returns":[{"type":{"names":["number"]},"description":"The resulting value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.MinSub","scope":"static","___s":true},{"meta":{"filename":"Percent.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Work out what percentage `value` is of the range between `min` and `max`.\nIf `max` isn't given then it will return the percentage of `value` to `min`.\n\nYou can optionally specify an `upperMax` value, which is a mid-way point in the range that represents 100%, after which the % starts to go down to zero again.","kind":"function","name":"Percent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to determine the percentage of.","name":"value"},{"type":{"names":["number"]},"description":"The minimum value.","name":"min"},{"type":{"names":["number"]},"optional":true,"description":"The maximum value.","name":"max"},{"type":{"names":["number"]},"optional":true,"description":"The mid-way point in the range that represents 100%.","name":"upperMax"}],"returns":[{"type":{"names":["number"]},"description":"A value between 0 and 1 representing the percentage."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Percent","scope":"static","___s":true},{"meta":{"filename":"Quaternion.js","lineno":26,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"classdesc":"A quaternion.","kind":"class","name":"Quaternion","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x component.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y component.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The z component.","name":"z"},{"type":{"names":["number"]},"optional":true,"description":"The w component.","name":"w"}],"scope":"static","longname":"Phaser.Math.Quaternion","___s":true},{"meta":{"filename":"Quaternion.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The x component of this Quaternion.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quaternion.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The y component of this Quaternion.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quaternion.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The z component of this Quaternion.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#z","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quaternion.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The w component of this Quaternion.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#w","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quaternion.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the components of a given Quaternion or Vector into this Quaternion.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to copy the components from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#copy","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":118,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the components of this Quaternion.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["number","object"]},"optional":true,"defaultvalue":0,"description":"The x component, or an object containing x, y, z, and w components.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y component.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z component.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w component.","name":"w"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#set","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":151,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Add a given Quaternion or Vector to this Quaternion. Addition is component-wise.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to add to this Quaternion.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#add","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":171,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Subtract a given Quaternion or Vector from this Quaternion. Subtraction is component-wise.","kind":"function","name":"subtract","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to subtract from this Quaternion.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#subtract","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Scale this Quaternion by the given value.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to scale this Quaternion by.","name":"scale"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#scale","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":211,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length of this Quaternion.","kind":"function","name":"length","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#length","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length of this Quaternion squared.","kind":"function","name":"lengthSq","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Quaternion, squared."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#lengthSq","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":247,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Normalize this Quaternion.","kind":"function","name":"normalize","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#normalize","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":276,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the dot product of this Quaternion and the given Quaternion or Vector.","kind":"function","name":"dot","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to dot product with this Quaternion.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The dot product of this Quaternion and the given Quaternion or Vector."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#dot","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Linearly interpolate this Quaternion towards the given Quaternion or Vector.","kind":"function","name":"lerp","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to interpolate towards.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The percentage of interpolation.","name":"t"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#lerp","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"[description]","kind":"function","name":"rotationTo","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"[description]","name":"a"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"[description]","name":"b"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#rotationTo","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":368,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the axes of this Quaternion.","kind":"function","name":"setAxes","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The view axis.","name":"view"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The right axis.","name":"right"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The upwards axis.","name":"up"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#setAxes","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":399,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Reset this Matrix to an identity (default) Quaternion.","kind":"function","name":"identity","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#identity","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":417,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the axis angle of this Quaternion.","kind":"function","name":"setAxisAngle","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The axis.","name":"axis"},{"type":{"names":["number"]},"description":"The angle in radians.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#setAxisAngle","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":442,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Multiply this Quaternion by the given Quaternion or Vector.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to multiply this Quaternion by.","name":"b"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#multiply","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Smoothly linearly interpolate this Quaternion towards the given Quaternion or Vector.","kind":"function","name":"slerp","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to interpolate towards.","name":"b"},{"type":{"names":["number"]},"description":"The percentage of interpolation.","name":"t"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#slerp","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":535,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Invert this Quaternion.","kind":"function","name":"invert","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#invert","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":563,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Convert this Quaternion into its conjugate.\n\nSets the x, y and z components.","kind":"function","name":"conjugate","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#conjugate","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":582,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate this Quaternion on the X axis.","kind":"function","name":"rotateX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The rotation angle in radians.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#rotateX","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":612,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate this Quaternion on the Y axis.","kind":"function","name":"rotateY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The rotation angle in radians.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#rotateY","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":642,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate this Quaternion on the Z axis.","kind":"function","name":"rotateZ","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The rotation angle in radians.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#rotateZ","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":672,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Create a unit (or rotation) Quaternion from its x, y, and z components.\n\nSets the w component.","kind":"function","name":"calculateW","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#calculateW","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":693,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Convert the given Matrix into this Quaternion.","kind":"function","name":"fromMat3","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"The Matrix to convert from.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#fromMat3","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"RadToDeg.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RadToDeg.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Convert the given angle in radians, to the equivalent angle in degrees.","kind":"function","name":"RadToDeg","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle in radians to convert ot degrees.","name":"radians"}],"returns":[{"type":{"names":["integer"]},"description":"The given angle converted to degrees."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RadToDeg","scope":"static","___s":true},{"meta":{"filename":"RandomXY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Compute a random unit vector.\n\nComputes random values for the given vector between -1 and 1 that can be used to represent a direction.\n\nOptionally accepts a scale value to scale the resulting vector by.","kind":"function","name":"RandomXY","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to compute random values for.","name":"vector"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The scale of the random values.","name":"scale"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The given Vector."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RandomXY","scope":"static","___s":true},{"meta":{"filename":"RandomXYZ.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Compute a random position vector in a spherical area, optionally defined by the given radius.","kind":"function","name":"RandomXYZ","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The Vector to compute random values for.","name":"vec3"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The radius.","name":"radius"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The given Vector."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RandomXYZ","scope":"static","___s":true},{"meta":{"filename":"RandomXYZW.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Compute a random four-dimensional vector.","kind":"function","name":"RandomXYZW","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"The Vector to compute random values for.","name":"vec4"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The scale of the random values.","name":"scale"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"The given Vector."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RandomXYZW","scope":"static","___s":true},{"meta":{"filename":"Rotate.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate a given point by a given angle around the origin (0, 0), in an anti-clockwise direction.","kind":"function","name":"Rotate","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point to be rotated.","name":"point"},{"type":{"names":["number"]},"description":"The angle to be rotated by in an anticlockwise direction.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The given point, rotated by the given angle in an anticlockwise direction."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Rotate","scope":"static","___s":true},{"meta":{"filename":"RotateAround.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate a `point` around `x` and `y` by the given `angle`.","kind":"function","name":"RotateAround","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point to be rotated.","name":"point"},{"type":{"names":["number"]},"description":"The horizontal coordinate to rotate around.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to rotate around.","name":"y"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The given point, rotated by the given angle around the given coordinates."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RotateAround","scope":"static","___s":true},{"meta":{"filename":"RotateAroundDistance.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate a `point` around `x` and `y` by the given `angle` and `distance`.","kind":"function","name":"RotateAroundDistance","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point to be rotated.","name":"point"},{"type":{"names":["number"]},"description":"The horizontal coordinate to rotate around.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to rotate around.","name":"y"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"angle"},{"type":{"names":["number"]},"description":"The distance from (x, y) to place the point at.","name":"distance"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The given point."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RotateAroundDistance","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"RotateVec3.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"Vector3","longname":"Vector3","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateVec3.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotates a vector in place by axis angle.\n\nThis is the same as transforming a point by an\naxis-angle quaternion, but it has higher precision.","kind":"function","name":"RotateVec3","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The vector to be rotated.","name":"vec"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The axis to rotate around.","name":"axis"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The given vector."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RotateVec3","scope":"static","___s":true},{"meta":{"filename":"RoundAwayFromZero.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Round a given number so it is further away from zero. That is, positive numbers are rounded up, and negative numbers are rounded down.","kind":"function","name":"RoundAwayFromZero","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number to round.","name":"value"}],"returns":[{"type":{"names":["number"]},"description":"The rounded number, rounded away from zero."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RoundAwayFromZero","scope":"static","___s":true},{"meta":{"filename":"RoundTo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Round a value to the given precision.\n\nFor example:\n\n```javascript\nRoundTo(123.456, 0) = 123\nRoundTo(123.456, 1) = 120\nRoundTo(123.456, 2) = 100\n```\n\nTo round the decimal, i.e. to round to precision, pass in a negative `place`:\n\n```javascript\nRoundTo(123.456789, 0) = 123\nRoundTo(123.456789, -1) = 123.5\nRoundTo(123.456789, -2) = 123.46\nRoundTo(123.456789, -3) = 123.457\n```","kind":"function","name":"RoundTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to round.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The place to round to. Positive to round the units, negative to round the decimal.","name":"place"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The base to round in. Default is 10 for decimal.","name":"base"}],"returns":[{"type":{"names":["number"]},"description":"The rounded value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RoundTo","scope":"static","___s":true},{"meta":{"filename":"SinCosTableGenerator.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a series of sine and cosine values.","kind":"function","name":"SinCosTableGenerator","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number of values to generate.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The sine value amplitude.","name":"sinAmp"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The cosine value amplitude.","name":"cosAmp"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The frequency of the values.","name":"frequency"}],"returns":[{"type":{"names":["Phaser.Types.Math.SinCosTable"]},"description":"The generated values."}],"memberof":"Phaser.Math","longname":"Phaser.Math.SinCosTableGenerator","scope":"static","___s":true},{"meta":{"filename":"SmoothStep.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate a smooth interpolation percentage of `x` between `min` and `max`.\n\nThe function receives the number `x` as an argument and returns 0 if `x` is less than or equal to the left edge,\n1 if `x` is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial,\nbetween 0 and 1 otherwise.","kind":"function","name":"SmoothStep","since":"3.0.0","see":["{@link https://en.wikipedia.org/wiki/Smoothstep}"],"params":[{"type":{"names":["number"]},"description":"The input value.","name":"x"},{"type":{"names":["number"]},"description":"The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1."}],"memberof":"Phaser.Math","longname":"Phaser.Math.SmoothStep","scope":"static","___s":true},{"meta":{"filename":"SmootherStep.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate a smoother interpolation percentage of `x` between `min` and `max`.\n\nThe function receives the number `x` as an argument and returns 0 if `x` is less than or equal to the left edge,\n1 if `x` is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial,\nbetween 0 and 1 otherwise.\n\nProduces an even smoother interpolation than {@link Phaser.Math.SmoothStep}.","kind":"function","name":"SmootherStep","since":"3.0.0","see":["{@link https://en.wikipedia.org/wiki/Smoothstep#Variations}"],"params":[{"type":{"names":["number"]},"description":"The input value.","name":"x"},{"type":{"names":["number"]},"description":"The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1."}],"memberof":"Phaser.Math","longname":"Phaser.Math.SmootherStep","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"ToXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"Vector2","longname":"Vector2","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ToXY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Returns a Vector2 containing the x and y position of the given index in a `width` x `height` sized grid.\n\nFor example, in a 6 x 4 grid, index 16 would equal x: 4 y: 2.\n\nIf the given index is out of range an empty Vector2 is returned.","kind":"function","name":"ToXY","since":"3.19.0","params":[{"type":{"names":["integer"]},"description":"The position within the grid to get the x/y value for.","name":"index"},{"type":{"names":["integer"]},"description":"The width of the grid.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the grid.","name":"height"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"An optional Vector2 to store the result in. If not given, a new Vector2 instance will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector2 where the x and y properties contain the given grid index."}],"memberof":"Phaser.Math","longname":"Phaser.Math.ToXY","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"TransformXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"Vector2","longname":"Vector2","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TransformXY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Takes the `x` and `y` coordinates and transforms them into the same space as\ndefined by the position, rotation and scale values.","kind":"function","name":"TransformXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to be transformed.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to be transformed.","name":"y"},{"type":{"names":["number"]},"description":"Horizontal position of the transform point.","name":"positionX"},{"type":{"names":["number"]},"description":"Vertical position of the transform point.","name":"positionY"},{"type":{"names":["number"]},"description":"Rotation of the transform point, in radians.","name":"rotation"},{"type":{"names":["number"]},"description":"Horizontal scale of the transform point.","name":"scaleX"},{"type":{"names":["number"]},"description":"Vertical scale of the transform point.","name":"scaleY"},{"type":{"names":["Phaser.Math.Vector2","Phaser.Geom.Point","object"]},"optional":true,"description":"The output vector, point or object for the translated coordinates.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Geom.Point","object"]},"description":"The translated point."}],"memberof":"Phaser.Math","longname":"Phaser.Math.TransformXY","scope":"static","___s":true},{"meta":{"filename":"Vector2.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"classdesc":"A representation of a vector in 2D space.\n\nA two-component vector.","kind":"class","name":"Vector2","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"The x component, or an object with `x` and `y` properties.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y component.","name":"y"}],"scope":"static","longname":"Phaser.Math.Vector2","___s":true},{"meta":{"filename":"Vector2.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The x component of this Vector.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector2.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The y component of this Vector.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector2.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make a clone of this Vector2.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A clone of this Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#clone","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the components of a given Vector into this Vector.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to copy the components from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#copy","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the component values of this Vector from a given Vector2Like object.","kind":"function","name":"setFromObject","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The object containing the component values to set for this Vector.","name":"obj"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#setFromObject","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":115,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the `x` and `y` components of the this Vector to the given `x` and `y` values.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x value to set for this Vector.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y value to set for this Vector.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#set","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"This method is an alias for `Vector2.set`.","kind":"function","name":"setTo","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The x value to set for this Vector.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y value to set for this Vector.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#setTo","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Sets the `x` and `y` values of this object from a given polar coordinate.","kind":"function","name":"setToPolar","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angular coordinate, in radians.","name":"azimuth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The radial coordinate (length).","name":"radius"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#setToPolar","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Check whether this Vector is equal to a given Vector.\n\nPerforms a strict equality check against each Vector's components.","kind":"function","name":"equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The vector to compare with this Vector.","name":"v"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the given Vector is equal to this Vector."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#equals","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the angle between this Vector and the positive x-axis, in radians.","kind":"function","name":"angle","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The angle between this Vector, and the positive x-axis, given in radians."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#angle","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":212,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Add a given Vector to this Vector. Addition is component-wise.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to add to this Vector.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#add","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":230,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Subtract the given Vector from this Vector. Subtraction is component-wise.","kind":"function","name":"subtract","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to subtract from this Vector.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#subtract","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":248,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Perform a component-wise multiplication between this Vector and the given Vector.\n\nMultiplies this Vector by the given Vector.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to multiply this Vector by.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#multiply","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Scale this Vector by the given value.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to scale this Vector by.","name":"value"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#scale","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":294,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Perform a component-wise division between this Vector and the given Vector.\n\nDivides this Vector by the given Vector.","kind":"function","name":"divide","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to divide this Vector by.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#divide","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Negate the `x` and `y` components of this Vector.","kind":"function","name":"negate","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#negate","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the distance between this Vector and the given Vector.","kind":"function","name":"distance","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to calculate the distance to.","name":"src"}],"returns":[{"type":{"names":["number"]},"description":"The distance from this Vector to the given Vector."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#distance","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":348,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the distance between this Vector and the given Vector, squared.","kind":"function","name":"distanceSq","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to calculate the distance to.","name":"src"}],"returns":[{"type":{"names":["number"]},"description":"The distance from this Vector to the given Vector, squared."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#distanceSq","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":366,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length (or magnitude) of this Vector.","kind":"function","name":"length","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Vector."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#length","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":382,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length of this Vector squared.","kind":"function","name":"lengthSq","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Vector, squared."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#lengthSq","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":398,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Normalize this Vector.\n\nMakes the vector a unit length vector (magnitude of 1) in the same direction.","kind":"function","name":"normalize","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#normalize","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Right-hand normalize (make unit length) this Vector.","kind":"function","name":"normalizeRightHand","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#normalizeRightHand","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the dot product of this Vector and the given Vector.","kind":"function","name":"dot","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector2 to dot product with this Vector2.","name":"src"}],"returns":[{"type":{"names":["number"]},"description":"The dot product of this Vector and the given Vector."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#dot","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":458,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the cross product of this Vector and the given Vector.","kind":"function","name":"cross","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector2 to cross with this Vector2.","name":"src"}],"returns":[{"type":{"names":["number"]},"description":"The cross product of this Vector and the given Vector."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#cross","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":473,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Linearly interpolate between this Vector and the given Vector.\n\nInterpolates this Vector towards the given Vector.","kind":"function","name":"lerp","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector2 to interpolate towards.","name":"src"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The interpolation percentage, between 0 and 1.","name":"t"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#lerp","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":499,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Matrix.","kind":"function","name":"transformMat3","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"The Matrix3 to transform this Vector2 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#transformMat3","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":521,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Matrix.","kind":"function","name":"transformMat4","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix4 to transform this Vector2 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#transformMat4","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":543,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make this Vector the zero vector (0, 0).","kind":"function","name":"reset","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#reset","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":561,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static zero Vector2 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"ZERO","type":{"names":["Phaser.Math.Vector2"]},"since":"3.1.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2.ZERO","scope":"static","___s":true},{"meta":{"filename":"Vector2.js","lineno":573,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static right Vector2 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"RIGHT","type":{"names":["Phaser.Math.Vector2"]},"since":"3.16.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2.RIGHT","scope":"static","___s":true},{"meta":{"filename":"Vector2.js","lineno":585,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static left Vector2 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"LEFT","type":{"names":["Phaser.Math.Vector2"]},"since":"3.16.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2.LEFT","scope":"static","___s":true},{"meta":{"filename":"Vector2.js","lineno":597,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static up Vector2 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"UP","type":{"names":["Phaser.Math.Vector2"]},"since":"3.16.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2.UP","scope":"static","___s":true},{"meta":{"filename":"Vector2.js","lineno":609,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static down Vector2 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"DOWN","type":{"names":["Phaser.Math.Vector2"]},"since":"3.16.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2.DOWN","scope":"static","___s":true},{"meta":{"filename":"Vector2.js","lineno":621,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static one Vector2 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"ONE","type":{"names":["Phaser.Math.Vector2"]},"since":"3.16.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2.ONE","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"classdesc":"A representation of a vector in 3D space.\n\nA three-component vector.","kind":"class","name":"Vector3","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x component.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y component.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The z component.","name":"z"}],"scope":"static","longname":"Phaser.Math.Vector3","___s":true},{"meta":{"filename":"Vector3.js","lineno":33,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The x component of this Vector.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector3.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The y component of this Vector.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector3.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The z component of this Vector.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#z","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector3.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set this Vector to point up.\n\nSets the y component of the vector to 1, and the others to 0.","kind":"function","name":"up","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#up","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make a clone of this Vector3.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"A new Vector3 object containing this Vectors values."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#clone","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the cross (vector) product of two given Vectors.","kind":"function","name":"crossVectors","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The first Vector to multiply.","name":"a"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The second Vector to multiply.","name":"b"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#crossVectors","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Check whether this Vector is equal to a given Vector.\n\nPerforms a strict equality check against each Vector's components.","kind":"function","name":"equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The Vector3 to compare against.","name":"v"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the two vectors strictly match, otherwise false."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#equals","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":153,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the components of a given Vector into this Vector.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to copy the components from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#copy","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":172,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the `x`, `y`, and `z` components of this Vector to the given `x`, `y`, and `z` values.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["number","object"]},"description":"The x value to set for this Vector, or an object containing x, y and z components.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y value to set for this Vector.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The z value to set for this Vector.","name":"z"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#set","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Add a given Vector to this Vector. Addition is component-wise.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to add to this Vector.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#add","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Subtract the given Vector from this Vector. Subtraction is component-wise.","kind":"function","name":"subtract","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to subtract from this Vector.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#subtract","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":240,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Perform a component-wise multiplication between this Vector and the given Vector.\n\nMultiplies this Vector by the given Vector.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to multiply this Vector by.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#multiply","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":261,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Scale this Vector by the given value.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to scale this Vector by.","name":"scale"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#scale","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":289,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Perform a component-wise division between this Vector and the given Vector.\n\nDivides this Vector by the given Vector.","kind":"function","name":"divide","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to divide this Vector by.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#divide","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Negate the `x`, `y` and `z` components of this Vector.","kind":"function","name":"negate","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#negate","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":327,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the distance between this Vector and the given Vector.","kind":"function","name":"distance","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to calculate the distance to.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The distance from this Vector to the given Vector."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#distance","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":346,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the distance between this Vector and the given Vector, squared.","kind":"function","name":"distanceSq","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to calculate the distance to.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The distance from this Vector to the given Vector, squared."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#distanceSq","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":365,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length (or magnitude) of this Vector.","kind":"function","name":"length","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Vector."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#length","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":382,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length of this Vector squared.","kind":"function","name":"lengthSq","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Vector, squared."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#lengthSq","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":399,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Normalize this Vector.\n\nMakes the vector a unit length vector (magnitude of 1) in the same direction.","kind":"function","name":"normalize","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#normalize","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":428,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the dot product of this Vector and the given Vector.","kind":"function","name":"dot","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The Vector3 to dot product with this Vector3.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The dot product of this Vector and `v`."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#dot","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the cross (vector) product of this Vector (which will be modified) and the given Vector.","kind":"function","name":"cross","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The Vector to cross product with.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#cross","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":469,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Linearly interpolate between this Vector and the given Vector.\n\nInterpolates this Vector towards the given Vector.","kind":"function","name":"lerp","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The Vector3 to interpolate towards.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The interpolation percentage, between 0 and 1.","name":"t"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#lerp","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":497,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Matrix.","kind":"function","name":"transformMat3","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"The Matrix3 to transform this Vector3 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#transformMat3","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":521,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Matrix.","kind":"function","name":"transformMat4","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix4 to transform this Vector3 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#transformMat4","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transforms the coordinates of this Vector3 with the given Matrix4.","kind":"function","name":"transformCoordinates","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix4 to transform this Vector3 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#transformCoordinates","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":574,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Quaternion.","kind":"function","name":"transformQuat","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"The Quaternion to transform this Vector with.","name":"q"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#transformQuat","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":609,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Multiplies this Vector3 by the specified matrix, applying a W divide. This is useful for projection,\ne.g. unprojecting a 2D point into 3D space.","kind":"function","name":"project","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix4 to multiply this Vector3 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#project","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":653,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Unproject this point from 2D space to 3D space.\nThe point should have its x and y properties set to\n2D screen space, and the z either at 0 (near plane)\nor 1 (far plane). The provided matrix is assumed to already\nbe combined, i.e. projection * view * model.\n\nAfter this operation, this vector's (x, y, z) components will\nrepresent the unprojected 3D coordinate.","kind":"function","name":"unproject","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"Screen x, y, width and height in pixels.","name":"viewport"},{"type":{"names":["Phaser.Math.Matrix4"]},"description":"Combined projection and view matrix.","name":"invProjectionView"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#unproject","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":689,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make this Vector the zero vector (0, 0, 0).","kind":"function","name":"reset","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#reset","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":708,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static zero Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"ZERO","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.ZERO","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":720,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static right Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"RIGHT","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.RIGHT","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":732,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static left Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"LEFT","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.LEFT","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":744,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static up Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"UP","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.UP","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":756,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static down Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"DOWN","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.DOWN","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":768,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static forward Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"FORWARD","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.FORWARD","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":780,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static back Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"BACK","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.BACK","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":792,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static one Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"ONE","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.ONE","scope":"static","___s":true},{"meta":{"filename":"Vector4.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"classdesc":"A representation of a vector in 4D space.\n\nA four-component vector.","kind":"class","name":"Vector4","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x component.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y component.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The z component.","name":"z"},{"type":{"names":["number"]},"optional":true,"description":"The w component.","name":"w"}],"scope":"static","longname":"Phaser.Math.Vector4","___s":true},{"meta":{"filename":"Vector4.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The x component of this Vector.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector4.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The y component of this Vector.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector4.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The z component of this Vector.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#z","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector4.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The w component of this Vector.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#w","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector4.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make a clone of this Vector4.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"A clone of this Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#clone","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the components of a given Vector into this Vector.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"The Vector to copy the components from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#copy","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":123,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Check whether this Vector is equal to a given Vector.\n\nPerforms a strict quality check against each Vector's components.","kind":"function","name":"equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"The vector to check equality with.","name":"v"}],"returns":[{"type":{"names":["boolean"]},"description":"A boolean indicating whether the two Vectors are equal or not."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#equals","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the `x`, `y`, `z` and `w` components of the this Vector to the given `x`, `y`, `z` and `w` values.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["number","object"]},"description":"The x value to set for this Vector, or an object containing x, y, z and w components.","name":"x"},{"type":{"names":["number"]},"description":"The y value to set for this Vector.","name":"y"},{"type":{"names":["number"]},"description":"The z value to set for this Vector.","name":"z"},{"type":{"names":["number"]},"description":"The z value to set for this Vector.","name":"w"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#set","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Add a given Vector to this Vector. Addition is component-wise.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to add to this Vector.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#add","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":193,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Subtract the given Vector from this Vector. Subtraction is component-wise.","kind":"function","name":"subtract","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to subtract from this Vector.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#subtract","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Scale this Vector by the given value.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to scale this Vector by.","name":"scale"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#scale","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":233,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length (or magnitude) of this Vector.","kind":"function","name":"length","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Vector."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#length","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":251,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length of this Vector squared.","kind":"function","name":"lengthSq","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Vector, squared."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#lengthSq","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Normalize this Vector.\n\nMakes the vector a unit length vector (magnitude of 1) in the same direction.","kind":"function","name":"normalize","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#normalize","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the dot product of this Vector and the given Vector.","kind":"function","name":"dot","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"The Vector4 to dot product with this Vector4.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The dot product of this Vector and the given Vector."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#dot","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":315,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Linearly interpolate between this Vector and the given Vector.\n\nInterpolates this Vector towards the given Vector.","kind":"function","name":"lerp","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"The Vector4 to interpolate towards.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The interpolation percentage, between 0 and 1.","name":"t"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#lerp","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":345,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Perform a component-wise multiplication between this Vector and the given Vector.\n\nMultiplies this Vector by the given Vector.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to multiply this Vector by.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#multiply","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Perform a component-wise division between this Vector and the given Vector.\n\nDivides this Vector by the given Vector.","kind":"function","name":"divide","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to divide this Vector by.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#divide","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":389,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the distance between this Vector and the given Vector.","kind":"function","name":"distance","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to calculate the distance to.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The distance from this Vector to the given Vector."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#distance","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":409,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the distance between this Vector and the given Vector, squared.","kind":"function","name":"distanceSq","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to calculate the distance to.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The distance from this Vector to the given Vector, squared."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#distanceSq","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":429,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Negate the `x`, `y`, `z` and `w` components of this Vector.","kind":"function","name":"negate","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#negate","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":447,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Matrix.","kind":"function","name":"transformMat4","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix4 to transform this Vector4 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#transformMat4","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":473,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Quaternion.","kind":"function","name":"transformQuat","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"The Quaternion to transform this Vector with.","name":"q"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#transformQuat","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":510,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make this Vector the zero vector (0, 0, 0, 0).","kind":"function","name":"reset","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#reset","scope":"instance","___s":true},{"meta":{"filename":"Within.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Checks if the two values are within the given `tolerance` of each other.","kind":"function","name":"Within","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first value to use in the calculation.","name":"a"},{"type":{"names":["number"]},"description":"The second value to use in the calculation.","name":"b"},{"type":{"names":["number"]},"description":"The tolerance. Anything equal to or less than this value is considered as being within range.","name":"tolerance"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if `a` is less than or equal to the tolerance of `b`."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Within","scope":"static","___s":true},{"meta":{"filename":"Wrap.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Wrap the given `value` between `min` and `max.","kind":"function","name":"Wrap","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to wrap.","name":"value"},{"type":{"names":["number"]},"description":"The minimum value.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The wrapped value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Wrap","scope":"static","___s":true},{"meta":{"filename":"Between.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Find the angle of a segment from (x1, y1) -> (x2, y2).","kind":"function","name":"Between","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"}],"returns":[{"type":{"names":["number"]},"description":"The angle in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.Between","scope":"static","___s":true},{"meta":{"filename":"BetweenPoints.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).\n\nCalculates the angle of the vector from the first point to the second point.","kind":"function","name":"BetweenPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The first point.","name":"point1"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The second point.","name":"point2"}],"returns":[{"type":{"names":["number"]},"description":"The angle in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.BetweenPoints","scope":"static","___s":true},{"meta":{"filename":"BetweenPointsY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).\n\nThe difference between this method and {@link Phaser.Math.Angle.BetweenPoints} is that this assumes the y coordinate\ntravels down the screen.","kind":"function","name":"BetweenPointsY","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The first point.","name":"point1"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The second point.","name":"point2"}],"returns":[{"type":{"names":["number"]},"description":"The angle in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.BetweenPointsY","scope":"static","___s":true},{"meta":{"filename":"BetweenY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Find the angle of a segment from (x1, y1) -> (x2, y2).\n\nThe difference between this method and {@link Phaser.Math.Angle.Between} is that this assumes the y coordinate\ntravels down the screen.","kind":"function","name":"BetweenY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"}],"returns":[{"type":{"names":["number"]},"description":"The angle in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.BetweenY","scope":"static","___s":true},{"meta":{"range":[180,207],"filename":"CounterClockwise.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CounterClockwise.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Takes an angle in Phasers default clockwise format and converts it so that\n0 is North, 90 is West, 180 is South and 270 is East,\ntherefore running counter-clockwise instead of clockwise.\n\nYou can pass in the angle from a Game Object using:\n\n```javascript\nvar converted = CounterClockwise(gameobject.rotation);\n```\n\nAll values for this function are in radians.","kind":"function","name":"CounterClockwise","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The angle to convert, in radians.","name":"angle"}],"returns":[{"type":{"names":["number"]},"description":"The converted angle, in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.CounterClockwise","scope":"static","___s":true},{"meta":{"filename":"Normalize.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Normalize an angle to the [0, 2pi] range.","kind":"function","name":"Normalize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle to normalize, in radians.","name":"angle"}],"returns":[{"type":{"names":["number"]},"description":"The normalized angle, in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.Normalize","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Reverse.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"name":"Normalize","longname":"Normalize","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Reverse.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Reverse the given angle.","kind":"function","name":"Reverse","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle to reverse, in radians.","name":"angle"}],"returns":[{"type":{"names":["number"]},"description":"The reversed angle, in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.Reverse","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"RotateTo.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateTo.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Rotates `currentAngle` towards `targetAngle`, taking the shortest rotation distance. The `lerp` argument is the amount to rotate by in this call.","kind":"function","name":"RotateTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current angle, in radians.","name":"currentAngle"},{"type":{"names":["number"]},"description":"The target angle to rotate to, in radians.","name":"targetAngle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.05,"description":"The lerp value to add to the current angle.","name":"lerp"}],"returns":[{"type":{"names":["number"]},"description":"The adjusted angle."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.RotateTo","scope":"static","___s":true},{"meta":{"filename":"ShortestBetween.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Gets the shortest angle between `angle1` and `angle2`.\n\nBoth angles must be in the range -180 to 180, which is the same clamped\nrange that `sprite.angle` uses, so you can pass in two sprite angles to\nthis method and get the shortest angle back between the two of them.\n\nThe angle returned will be in the same range. If the returned angle is\ngreater than 0 then it's a counter-clockwise rotation, if < 0 then it's\na clockwise rotation.\n\nTODO: Wrap the angles in this function?","kind":"function","name":"ShortestBetween","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first angle in the range -180 to 180.","name":"angle1"},{"type":{"names":["number"]},"description":"The second angle in the range -180 to 180.","name":"angle2"}],"returns":[{"type":{"names":["number"]},"description":"The shortest angle, in degrees. If greater than zero it's a counter-clockwise rotation."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.ShortestBetween","scope":"static","___s":true},{"meta":{"range":[180,209],"filename":"Wrap.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"name":"MathWrap","longname":"MathWrap","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Wrap.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Wrap an angle.\n\nWraps the angle to a value in the range of -PI to PI.","kind":"function","name":"Wrap","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle to wrap, in radians.","name":"angle"}],"returns":[{"type":{"names":["number"]},"description":"The wrapped angle, in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.Wrap","scope":"static","___s":true},{"meta":{"range":[180,205],"filename":"WrapDegrees.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"name":"Wrap","longname":"Wrap","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WrapDegrees.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Wrap an angle in degrees.\n\nWraps the angle to a value in the range of -180 to 180.","kind":"function","name":"WrapDegrees","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle to wrap, in degrees.","name":"angle"}],"returns":[{"type":{"names":["number"]},"description":"The wrapped angle, in degrees."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.WrapDegrees","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"kind":"namespace","name":"Angle","memberof":"Phaser.Math","longname":"Phaser.Math.Angle","scope":"static","___s":true},{"meta":{"range":[180,1861],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The value of PI * 2.","name":"PI2","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Math","longname":"Phaser.Math.PI2","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The value of PI * 0.5.","name":"TAU","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Math","longname":"Phaser.Math.TAU","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"An epsilon value (1.0e-6)","name":"EPSILON","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Math","longname":"Phaser.Math.EPSILON","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"For converting degrees to radians (PI / 180)","name":"DEG_TO_RAD","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Math","longname":"Phaser.Math.DEG_TO_RAD","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"For converting radians to degrees (180 / PI)","name":"RAD_TO_DEG","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Math","longname":"Phaser.Math.RAD_TO_DEG","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"An instance of the Random Number Generator.\nThis is not set until the Game boots.","name":"RND","type":{"names":["Phaser.Math.RandomDataGenerator"]},"since":"3.0.0","memberof":"Phaser.Math","longname":"Phaser.Math.RND","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The minimum safe integer this browser supports.\nWe use a const for backward compatibility with Internet Explorer.","name":"MIN_SAFE_INTEGER","type":{"names":["number"]},"since":"3.21.0","memberof":"Phaser.Math","longname":"Phaser.Math.MIN_SAFE_INTEGER","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":74,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The maximum safe integer this browser supports.\nWe use a const for backward compatibility with Internet Explorer.","name":"MAX_SAFE_INTEGER","type":{"names":["number"]},"since":"3.21.0","memberof":"Phaser.Math","longname":"Phaser.Math.MAX_SAFE_INTEGER","scope":"static","kind":"member","___s":true},{"meta":{"filename":"DistanceBetween.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the distance between two sets of coordinates (points).","kind":"function","name":"Between","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"}],"returns":[{"type":{"names":["number"]},"description":"The distance between each point."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.Between","scope":"static","___s":true},{"meta":{"filename":"DistanceBetweenPoints.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the distance between two points.","kind":"function","name":"BetweenPoints","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The first point.","name":"a"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The second point.","name":"b"}],"returns":[{"type":{"names":["number"]},"description":"The distance between the points."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.BetweenPoints","scope":"static","___s":true},{"meta":{"filename":"DistanceBetweenPointsSquared.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the squared distance between two points.","kind":"function","name":"BetweenPointsSquared","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The first point.","name":"a"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The second point.","name":"b"}],"returns":[{"type":{"names":["number"]},"description":"The squared distance between the points."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.BetweenPointsSquared","scope":"static","___s":true},{"meta":{"filename":"DistanceChebyshev.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the Chebyshev distance between two sets of coordinates (points).\n\nChebyshev distance (or chessboard distance) is the maximum of the horizontal and vertical distances.\nIt's the effective distance when movement can be horizontal, vertical, or diagonal.","kind":"function","name":"Chebyshev","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"}],"returns":[{"type":{"names":["number"]},"description":"The distance between each point."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.Chebyshev","scope":"static","___s":true},{"meta":{"filename":"DistancePower.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the distance between two sets of coordinates (points) to the power of `pow`.","kind":"function","name":"Power","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"},{"type":{"names":["number"]},"description":"The exponent.","name":"pow"}],"returns":[{"type":{"names":["number"]},"description":"The distance between each point."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.Power","scope":"static","___s":true},{"meta":{"filename":"DistanceSnake.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the snake distance between two sets of coordinates (points).\n\nSnake distance (rectilinear distance, Manhattan distance) is the sum of the horizontal and vertical distances.\nIt's the effective distance when movement is allowed only horizontally or vertically (but not both).","kind":"function","name":"Snake","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"}],"returns":[{"type":{"names":["number"]},"description":"The distance between each point."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.Snake","scope":"static","___s":true},{"meta":{"filename":"DistanceSquared.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the distance between two sets of coordinates (points), squared.","kind":"function","name":"Squared","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"}],"returns":[{"type":{"names":["number"]},"description":"The distance between each point, squared."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.Squared","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"kind":"namespace","name":"Distance","memberof":"Phaser.Math","longname":"Phaser.Math.Distance","scope":"static","___s":true},{"meta":{"range":[180,204],"filename":"EaseMap.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing"},"name":"Back","longname":"Back","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/back"},"description":"Back ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1.70158,"description":"The overshoot amount.","name":"overshoot"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Back","longname":"Phaser.Math.Easing.Back.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/back"},"description":"Back ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1.70158,"description":"The overshoot amount.","name":"overshoot"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Back","longname":"Phaser.Math.Easing.Back.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/back"},"description":"Back ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1.70158,"description":"The overshoot amount.","name":"overshoot"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Back","longname":"Phaser.Math.Easing.Back.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/back"},"kind":"namespace","name":"Back","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Back","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/bounce"},"description":"Bounce ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Bounce","longname":"Phaser.Math.Easing.Bounce.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/bounce"},"description":"Bounce ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Bounce","longname":"Phaser.Math.Easing.Bounce.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/bounce"},"description":"Bounce ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Bounce","longname":"Phaser.Math.Easing.Bounce.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/bounce"},"kind":"namespace","name":"Bounce","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Bounce","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/circular"},"description":"Circular ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Circular","longname":"Phaser.Math.Easing.Circular.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/circular"},"description":"Circular ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Circular","longname":"Phaser.Math.Easing.Circular.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/circular"},"description":"Circular ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Circular","longname":"Phaser.Math.Easing.Circular.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/circular"},"kind":"namespace","name":"Circular","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Circular","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/cubic"},"description":"Cubic ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Cubic","longname":"Phaser.Math.Easing.Cubic.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/cubic"},"description":"Cubic ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Cubic","longname":"Phaser.Math.Easing.Cubic.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/cubic"},"description":"Cubic ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Cubic","longname":"Phaser.Math.Easing.Cubic.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/cubic"},"kind":"namespace","name":"Cubic","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Cubic","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/elastic"},"description":"Elastic ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"The amplitude of the elastic ease.","name":"amplitude"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"Sets how tight the sine-wave is, where smaller values are tighter waves, which result in more cycles.","name":"period"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Elastic","longname":"Phaser.Math.Easing.Elastic.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/elastic"},"description":"Elastic ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"The amplitude of the elastic ease.","name":"amplitude"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"Sets how tight the sine-wave is, where smaller values are tighter waves, which result in more cycles.","name":"period"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Elastic","longname":"Phaser.Math.Easing.Elastic.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/elastic"},"description":"Elastic ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"The amplitude of the elastic ease.","name":"amplitude"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"Sets how tight the sine-wave is, where smaller values are tighter waves, which result in more cycles.","name":"period"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Elastic","longname":"Phaser.Math.Easing.Elastic.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/elastic"},"kind":"namespace","name":"Elastic","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Elastic","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/expo"},"description":"Exponential ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Expo","longname":"Phaser.Math.Easing.Expo.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/expo"},"description":"Exponential ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Expo","longname":"Phaser.Math.Easing.Expo.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/expo"},"description":"Exponential ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Expo","longname":"Phaser.Math.Easing.Expo.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/expo"},"kind":"namespace","name":"Expo","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Expo","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing"},"kind":"namespace","name":"Easing","memberof":"Phaser.Math","longname":"Phaser.Math.Easing","scope":"static","___s":true},{"meta":{"filename":"Linear.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/linear"},"description":"Linear easing (no variation).","kind":"function","name":"Linear","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Linear","longname":"Phaser.Math.Easing.Linear.Linear","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/linear"},"kind":"namespace","name":"Linear","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Linear","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic"},"description":"Quadratic ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quadratic","longname":"Phaser.Math.Easing.Quadratic.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic"},"description":"Quadratic ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quadratic","longname":"Phaser.Math.Easing.Quadratic.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic"},"description":"Quadratic ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quadratic","longname":"Phaser.Math.Easing.Quadratic.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic"},"kind":"namespace","name":"Quadratic","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Quadratic","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quartic"},"description":"Quartic ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quartic","longname":"Phaser.Math.Easing.Quartic.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quartic"},"description":"Quartic ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quartic","longname":"Phaser.Math.Easing.Quartic.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quartic"},"description":"Quartic ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quartic","longname":"Phaser.Math.Easing.Quartic.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quartic"},"kind":"namespace","name":"Quartic","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Quartic","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quintic"},"description":"Quintic ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quintic","longname":"Phaser.Math.Easing.Quintic.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quintic"},"description":"Quintic ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quintic","longname":"Phaser.Math.Easing.Quintic.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quintic"},"description":"Quintic ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quintic","longname":"Phaser.Math.Easing.Quintic.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quintic"},"kind":"namespace","name":"Quintic","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Quintic","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/sine"},"description":"Sinusoidal ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Sine","longname":"Phaser.Math.Easing.Sine.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/sine"},"description":"Sinusoidal ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Sine","longname":"Phaser.Math.Easing.Sine.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/sine"},"description":"Sinusoidal ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Sine","longname":"Phaser.Math.Easing.Sine.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/sine"},"kind":"namespace","name":"Sine","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Sine","scope":"static","___s":true},{"meta":{"filename":"Stepped.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/stepped"},"description":"Stepped easing.","kind":"function","name":"Stepped","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The number of steps in the ease.","name":"steps"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Stepped","longname":"Phaser.Math.Easing.Stepped.Stepped","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/stepped"},"kind":"namespace","name":"Stepped","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Stepped","scope":"static","___s":true},{"meta":{"filename":"Ceil.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/fuzzy"},"description":"Calculate the fuzzy ceiling of the given value.","kind":"function","name":"Ceil","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.0001,"description":"The epsilon.","name":"epsilon"}],"returns":[{"type":{"names":["number"]},"description":"The fuzzy ceiling of the value."}],"memberof":"Phaser.Math.Fuzzy","longname":"Phaser.Math.Fuzzy.Ceil","scope":"static","___s":true},{"meta":{"filename":"Equal.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/fuzzy"},"description":"Check whether the given values are fuzzily equal.\n\nTwo numbers are fuzzily equal if their difference is less than `epsilon`.","kind":"function","name":"Equal","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first value.","name":"a"},{"type":{"names":["number"]},"description":"The second value.","name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.0001,"description":"The epsilon.","name":"epsilon"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the values are fuzzily equal, otherwise `false`."}],"memberof":"Phaser.Math.Fuzzy","longname":"Phaser.Math.Fuzzy.Equal","scope":"static","___s":true},{"meta":{"filename":"Floor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/fuzzy"},"description":"Calculate the fuzzy floor of the given value.","kind":"function","name":"Floor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.0001,"description":"The epsilon.","name":"epsilon"}],"returns":[{"type":{"names":["number"]},"description":"The floor of the value."}],"memberof":"Phaser.Math.Fuzzy","longname":"Phaser.Math.Fuzzy.Floor","scope":"static","___s":true},{"meta":{"filename":"GreaterThan.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/fuzzy"},"description":"Check whether `a` is fuzzily greater than `b`.\n\n`a` is fuzzily greater than `b` if it is more than `b - epsilon`.","kind":"function","name":"GreaterThan","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first value.","name":"a"},{"type":{"names":["number"]},"description":"The second value.","name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.0001,"description":"The epsilon.","name":"epsilon"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if `a` is fuzzily greater than than `b`, otherwise `false`."}],"memberof":"Phaser.Math.Fuzzy","longname":"Phaser.Math.Fuzzy.GreaterThan","scope":"static","___s":true},{"meta":{"filename":"LessThan.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/fuzzy"},"description":"Check whether `a` is fuzzily less than `b`.\n\n`a` is fuzzily less than `b` if it is less than `b + epsilon`.","kind":"function","name":"LessThan","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first value.","name":"a"},{"type":{"names":["number"]},"description":"The second value.","name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.0001,"description":"The epsilon.","name":"epsilon"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if `a` is fuzzily less than `b`, otherwise `false`."}],"memberof":"Phaser.Math.Fuzzy","longname":"Phaser.Math.Fuzzy.LessThan","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/fuzzy"},"kind":"namespace","name":"Fuzzy","memberof":"Phaser.Math","longname":"Phaser.Math.Fuzzy","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"kind":"namespace","name":"Math","memberof":"Phaser","longname":"Phaser.Math","scope":"static","___s":true},{"meta":{"range":[180,215],"filename":"BezierInterpolation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"name":"Bernstein","longname":"Bernstein","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BezierInterpolation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A bezier interpolation method.","kind":"function","name":"Bezier","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The input array of values to interpolate between.","name":"v"},{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1.","name":"k"}],"returns":[{"type":{"names":["number"]},"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.Bezier","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"CatmullRomInterpolation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"name":"CatmullRom","longname":"CatmullRom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CatmullRomInterpolation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A Catmull-Rom interpolation method.","kind":"function","name":"CatmullRom","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The input array of values to interpolate between.","name":"v"},{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1.","name":"k"}],"returns":[{"type":{"names":["number"]},"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.CatmullRom","scope":"static","___s":true},{"meta":{"range":[195,263],"filename":"CubicBezierInterpolation.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P0","longname":"P0","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[284,356],"filename":"CubicBezierInterpolation.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P1","longname":"P1","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[377,435],"filename":"CubicBezierInterpolation.js","lineno":30,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P2","longname":"P2","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[456,504],"filename":"CubicBezierInterpolation.js","lineno":38,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P3","longname":"P3","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"filename":"CubicBezierInterpolation.js","lineno":43,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A cubic bezier interpolation method.\n\nhttps://medium.com/@adrian_cooney/bezier-interpolation-13b68563313a","kind":"function","name":"CubicBezier","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1.","name":"t"},{"type":{"names":["number"]},"description":"The start point.","name":"p0"},{"type":{"names":["number"]},"description":"The first control point.","name":"p1"},{"type":{"names":["number"]},"description":"The second control point.","name":"p2"},{"type":{"names":["number"]},"description":"The end point.","name":"p3"}],"returns":[{"type":{"names":["number"]},"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.CubicBezier","scope":"static","___s":true},{"meta":{"range":[180,209],"filename":"LinearInterpolation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"name":"Linear","longname":"Linear","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LinearInterpolation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A linear interpolation method.","kind":"function","name":"Linear","since":"3.0.0","see":["{@link https://en.wikipedia.org/wiki/Linear_interpolation}"],"params":[{"type":{"names":["Array."]},"description":"The input array of values to interpolate between.","name":"v"},{"type":{"names":["number"]},"nullable":false,"description":"The percentage of interpolation, between 0 and 1.","name":"k"}],"returns":[{"type":{"names":["number"]},"nullable":false,"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.Linear","scope":"static","___s":true},{"meta":{"range":[195,259],"filename":"QuadraticBezierInterpolation.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P0","longname":"P0","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[280,334],"filename":"QuadraticBezierInterpolation.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P1","longname":"P1","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[355,399],"filename":"QuadraticBezierInterpolation.js","lineno":28,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P2","longname":"P2","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuadraticBezierInterpolation.js","lineno":35,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A quadratic bezier interpolation method.","kind":"function","name":"QuadraticBezier","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1.","name":"t"},{"type":{"names":["number"]},"description":"The start point.","name":"p0"},{"type":{"names":["number"]},"description":"The control point.","name":"p1"},{"type":{"names":["number"]},"description":"The end point.","name":"p2"}],"returns":[{"type":{"names":["number"]},"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.QuadraticBezier","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"SmoothStepInterpolation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"name":"SmoothStep","longname":"SmoothStep","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SmoothStepInterpolation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A Smooth Step interpolation method.","kind":"function","name":"SmoothStep","since":"3.9.0","see":["{@link https://en.wikipedia.org/wiki/Smoothstep}"],"params":[{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1.","name":"t"},{"type":{"names":["number"]},"description":"The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.SmoothStep","scope":"static","___s":true},{"meta":{"range":[180,221],"filename":"SmootherStepInterpolation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"name":"SmootherStep","longname":"SmootherStep","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SmootherStepInterpolation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A Smoother Step interpolation method.","kind":"function","name":"SmootherStep","since":"3.9.0","see":["{@link https://en.wikipedia.org/wiki/Smoothstep#Variations}"],"params":[{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1.","name":"t"},{"type":{"names":["number"]},"description":"The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.SmootherStep","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"kind":"namespace","name":"Interpolation","memberof":"Phaser.Math","longname":"Phaser.Math.Interpolation","scope":"static","___s":true},{"meta":{"filename":"GetPowerOfTwo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/pow2"},"description":"Returns the nearest power of 2 to the given `value`.","kind":"function","name":"GetNext","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value.","name":"value"}],"returns":[{"type":{"names":["integer"]},"description":"The nearest power of 2 to `value`."}],"memberof":"Phaser.Math.Pow2","longname":"Phaser.Math.Pow2.GetNext","scope":"static","___s":true},{"meta":{"filename":"IsSizePowerOfTwo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/pow2"},"description":"Checks if the given `width` and `height` are a power of two.\nUseful for checking texture dimensions.","kind":"function","name":"IsSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width.","name":"width"},{"type":{"names":["number"]},"description":"The height.","name":"height"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if `width` and `height` are a power of two, otherwise `false`."}],"memberof":"Phaser.Math.Pow2","longname":"Phaser.Math.Pow2.IsSize","scope":"static","___s":true},{"meta":{"filename":"IsValuePowerOfTwo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/pow2"},"description":"Tests the value and returns `true` if it is a power of two.","kind":"function","name":"IsValue","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to check if it's a power of two.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if `value` is a power of two, otherwise `false`."}],"memberof":"Phaser.Math.Pow2","longname":"Phaser.Math.Pow2.IsValue","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/pow2"},"kind":"namespace","name":"Pow2","memberof":"Phaser.Math","longname":"Phaser.Math.Pow2","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"RandomDataGenerator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"classdesc":"A seeded Random Data Generator.\n\nAccess via `Phaser.Math.RND` which is an instance of this class pre-defined\nby Phaser. Or, create your own instance to use as you require.\n\nThe `Math.RND` generator is seeded by the Game Config property value `seed`.\nIf no such config property exists, a random number is used.\n\nIf you create your own instance of this class you should provide a seed for it.\nIf no seed is given it will use a 'random' one based on Date.now.","kind":"class","name":"RandomDataGenerator","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"optional":true,"description":"The seeds to use for the random number generator.","name":"seeds"}],"scope":"static","longname":"Phaser.Math.RandomDataGenerator","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Signs to choose from.","name":"signs","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#signs","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":163,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Initialize the state of the random data generator.","kind":"function","name":"init","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The seeds to initialize the random data generator with.","name":"seeds"}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#init","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Reset the seed of the random data generator.\n\n_Note_: the seed array is only processed up to the first `undefined` (or `null`) value, should such be present.","kind":"function","name":"sow","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The array of seeds: the `toString()` of each value is used.","name":"seeds"}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#sow","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random integer between 0 and 2^32.","kind":"function","name":"integer","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A random integer between 0 and 2^32."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#integer","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":235,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random real number between 0 and 1.","kind":"function","name":"frac","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A random real number between 0 and 1."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#frac","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random real number between 0 and 2^32.","kind":"function","name":"real","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A random real number between 0 and 2^32."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#real","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":262,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random integer between and including min and max.","kind":"function","name":"integerInRange","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum value in the range.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value in the range.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"A random number between min and max."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#integerInRange","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random integer between and including min and max.\nThis method is an alias for RandomDataGenerator.integerInRange.","kind":"function","name":"between","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum value in the range.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value in the range.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"A random number between min and max."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#between","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random real number between min and max.","kind":"function","name":"realInRange","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum value in the range.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value in the range.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"A random number between min and max."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#realInRange","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":311,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random real number between -1 and 1.","kind":"function","name":"normal","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A random real number between -1 and 1."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#normal","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":324,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a valid RFC4122 version4 ID hex string from https://gist.github.com/1308368","kind":"function","name":"uuid","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"A valid RFC4122 version4 ID hex string"}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#uuid","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":345,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random element from within the given array.","kind":"function","name":"pick","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The array to pick a random element from.","name":"array"}],"returns":[{"type":{"names":["T"]},"description":"A random member of the array."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#pick","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":364,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a sign to be used with multiplication operator.","kind":"function","name":"sign","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"-1 or +1."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#sign","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":377,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random element from within the given array, favoring the earlier entries.","kind":"function","name":"weightedPick","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The array to pick a random element from.","name":"array"}],"returns":[{"type":{"names":["T"]},"description":"A random member of the array."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#weightedPick","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":396,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random timestamp between min and max, or between the beginning of 2000 and the end of 2020 if min and max aren't specified.","kind":"function","name":"timestamp","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum value in the range.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value in the range.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"A random timestamp between min and max."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#timestamp","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":412,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random angle between -180 and 180.","kind":"function","name":"angle","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A random number between -180 and 180."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#angle","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random rotation in radians, between -3.141 and 3.141","kind":"function","name":"rotation","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A random number between -3.141 and 3.141"}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#rotation","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":438,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Gets or Sets the state of the generator. This allows you to retain the values\nthat the generator is using between games, i.e. in a game save file.\n\nTo seed this generator with a previously saved state you can pass it as the\n`seed` value in your game config, or call this method directly after Phaser has booted.\n\nCall this method with no parameters to return the current state.\n\nIf providing a state it should match the same format that this method\nreturns, which is a string with a header `!rnd` followed by the `c`,\n`s0`, `s1` and `s2` values respectively, each comma-delimited.","kind":"function","name":"state","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"Generator state to be set.","name":"state"}],"returns":[{"type":{"names":["string"]},"description":"The current state of the generator."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#state","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":473,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Shuffles the given array, using the current seed.","kind":"function","name":"shuffle","since":"3.7.0","params":[{"type":{"names":["Array."]},"optional":true,"description":"The array to be shuffled.","name":"array"}],"returns":[{"type":{"names":["Array."]},"description":"The shuffled array."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#shuffle","scope":"instance","___s":true},{"meta":{"filename":"SnapCeil.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/snap"},"description":"Snap a value to nearest grid slice, using ceil.\n\nExample: if you have an interval gap of `5` and a position of `12`... you will snap to `15`.\nAs will `14` snap to `15`... but `16` will snap to `20`.","kind":"function","name":"Ceil","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to snap.","name":"value"},{"type":{"names":["number"]},"description":"The interval gap of the grid.","name":"gap"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional starting offset for gap.","name":"start"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` it will divide the snapped value by the gap before returning.","name":"divide"}],"returns":[{"type":{"names":["number"]},"description":"The snapped value."}],"memberof":"Phaser.Math.Snap","longname":"Phaser.Math.Snap.Ceil","scope":"static","___s":true},{"meta":{"filename":"SnapFloor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/snap"},"description":"Snap a value to nearest grid slice, using floor.\n\nExample: if you have an interval gap of `5` and a position of `12`... you will snap to `10`.\nAs will `14` snap to `10`... but `16` will snap to `15`.","kind":"function","name":"Floor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to snap.","name":"value"},{"type":{"names":["number"]},"description":"The interval gap of the grid.","name":"gap"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional starting offset for gap.","name":"start"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` it will divide the snapped value by the gap before returning.","name":"divide"}],"returns":[{"type":{"names":["number"]},"description":"The snapped value."}],"memberof":"Phaser.Math.Snap","longname":"Phaser.Math.Snap.Floor","scope":"static","___s":true},{"meta":{"filename":"SnapTo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/snap"},"description":"Snap a value to nearest grid slice, using rounding.\n\nExample: if you have an interval gap of `5` and a position of `12`... you will snap to `10` whereas `14` will snap to `15`.","kind":"function","name":"To","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to snap.","name":"value"},{"type":{"names":["number"]},"description":"The interval gap of the grid.","name":"gap"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional starting offset for gap.","name":"start"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` it will divide the snapped value by the gap before returning.","name":"divide"}],"returns":[{"type":{"names":["number"]},"description":"The snapped value."}],"memberof":"Phaser.Math.Snap","longname":"Phaser.Math.Snap.To","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/snap"},"kind":"namespace","name":"Snap","memberof":"Phaser.Math","longname":"Phaser.Math.Snap","scope":"static","___s":true},{"meta":{"filename":"SinCosTable.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/typedefs"},"kind":"typedef","name":"SinCosTable","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The sine value.","name":"sin"},{"type":{"names":["number"]},"description":"The cosine value.","name":"cos"},{"type":{"names":["number"]},"description":"The length.","name":"length"}],"memberof":"Phaser.Types.Math","longname":"Phaser.Types.Math.SinCosTable","scope":"static","___s":true},{"meta":{"filename":"Vector2Like.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/typedefs"},"kind":"typedef","name":"Vector2Like","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"The x component.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y component.","name":"y"}],"memberof":"Phaser.Types.Math","longname":"Phaser.Types.Math.Vector2Like","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/typedefs"},"kind":"namespace","name":"Math","memberof":"Phaser.Types","longname":"Phaser.Types.Math","scope":"static","___s":true},{"meta":{"filename":"phaser.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src"},"kind":"namespace","name":"Phaser","longname":"Phaser","scope":"global","___s":true},{"meta":{"filename":"phaser.js","lineno":77,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"The root types namespace.","kind":"namespace","name":"Types","since":"3.17.0","memberof":"Phaser","longname":"Phaser.Types","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"ArcadeImage.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ArcadeImage.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"An Arcade Physics Image is an Image with an Arcade Physics body and related components.\nThe body can be dynamic or static.\n\nThe main difference between an Arcade Image and an Arcade Sprite is that you cannot animate an Arcade Image.","kind":"class","name":"Image","augments":["Phaser.GameObjects.Image","Phaser.Physics.Arcade.Components.Acceleration","Phaser.Physics.Arcade.Components.Angular","Phaser.Physics.Arcade.Components.Bounce","Phaser.Physics.Arcade.Components.Debug","Phaser.Physics.Arcade.Components.Drag","Phaser.Physics.Arcade.Components.Enable","Phaser.Physics.Arcade.Components.Friction","Phaser.Physics.Arcade.Components.Gravity","Phaser.Physics.Arcade.Components.Immovable","Phaser.Physics.Arcade.Components.Mass","Phaser.Physics.Arcade.Components.Size","Phaser.Physics.Arcade.Components.Velocity","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.Physics.Arcade.Image","___s":true},{"meta":{"filename":"ArcadeImage.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This Game Object's Physics Body.","name":"body","type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#body","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Image#body","___s":true},{"meta":{"range":[180,216],"filename":"ArcadePhysics.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":21,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"The Arcade Physics Plugin belongs to a Scene and sets up and manages the Scene's physics simulation.\nIt also holds some useful methods for moving and rotating Arcade Physics Bodies.\n\nYou can access it from within a Scene using `this.physics`.\n\nArcade Physics uses the Projection Method of collision resolution and separation. While it's fast and suitable\nfor 'arcade' style games it lacks stability when multiple objects are in close proximity or resting upon each other.\nThe separation that stops two objects penetrating may create a new penetration against a different object. If you\nrequire a high level of stability please consider using an alternative physics system, such as Matter.js.","kind":"class","name":"ArcadePhysics","memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that this Plugin belongs to.","name":"scene"}],"scope":"static","longname":"Phaser.Physics.Arcade.ArcadePhysics","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Scene that this Plugin belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Scene's Systems.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A configuration object. Union of the `physics.arcade.*` properties of the GameConfig and SceneConfig objects.","name":"config","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The physics simulation.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"An object holding the Arcade Physics factory methods.","name":"add","type":{"names":["Phaser.Physics.Arcade.Factory"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#add","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates the physics configuration for the current Scene.","kind":"function","name":"getConfig","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"The physics configuration."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#getConfig","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":156,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Tests if Game Objects overlap. See {@link Phaser.Physics.Arcade.World#overlap}","kind":"function","name":"overlap","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object or array of objects to check.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"optional":true,"description":"The second object or array of objects to check, or `undefined`.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they overlap. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if at least one Game Object overlaps another."}],"see":["Phaser.Physics.Arcade.World#overlap"],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#overlap","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Performs a collision check and separation between the two physics enabled objects given, which can be single\nGame Objects, arrays of Game Objects, Physics Groups, arrays of Physics Groups or normal Groups.\n\nIf you don't require separation then use {@link #overlap} instead.\n\nIf two Groups or arrays are passed, each member of one will be tested against each member of the other.\n\nIf **only** one Group is passed (as `object1`), each member of the Group will be collided against the other members.\n\nIf **only** one Array is passed, the array is iterated and every element in it is tested against the others.\n\nTwo callbacks can be provided. The `collideCallback` is invoked if a collision occurs and the two colliding\nobjects are passed to it.\n\nArcade Physics uses the Projection Method of collision resolution and separation. While it's fast and suitable\nfor 'arcade' style games it lacks stability when multiple objects are in close proximity or resting upon each other.\nThe separation that stops two objects penetrating may create a new penetration against a different object. If you\nrequire a high level of stability please consider using an alternative physics system, such as Matter.js.","kind":"function","name":"collide","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object or array of objects to check.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"optional":true,"description":"The second object or array of objects to check, or `undefined`.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if any overlapping Game Objects were separated, otherwise false."}],"see":["Phaser.Physics.Arcade.World#collide"],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#collide","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This advanced method is specifically for testing for collision between a single Sprite and an array of Tile objects.\n\nYou should generally use the `collide` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\ntile filtering and culling for you, as well as handle the interesting face collision automatically.\n\nThis method is offered for those who would like to check for collision with specific Tiles in a layer, without\nhaving to set any collision attributes on the tiles in question. This allows you to perform quick dynamic collisions\non small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\nyou should filter them before passing them to this method.\n\nImportant: Use of this method skips the `interesting faces` system that Tilemap Layers use. This means if you have\nsay a row or column of tiles, and you jump into, or walk over them, it's possible to get stuck on the edges of the\ntiles as the interesting face calculations are skipped. However, for quick-fire small collision set tests on\ndynamic maps, this method can prove very useful.","kind":"function","name":"collideTiles","fires":["Phaser.Physics.Arcade.Events#event:TILE_COLLIDE"],"since":"3.17.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first object to check for collision.","name":"sprite"},{"type":{"names":["Array."]},"description":"An array of Tiles to check for collision against.","name":"tiles"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#collideTiles","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This advanced method is specifically for testing for overlaps between a single Sprite and an array of Tile objects.\n\nYou should generally use the `overlap` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\ntile filtering and culling for you, as well as handle the interesting face collision automatically.\n\nThis method is offered for those who would like to check for overlaps with specific Tiles in a layer, without\nhaving to set any collision attributes on the tiles in question. This allows you to perform quick dynamic overlap\ntests on small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\nyou should filter them before passing them to this method.","kind":"function","name":"overlapTiles","fires":["Phaser.Physics.Arcade.Events#event:TILE_OVERLAP"],"since":"3.17.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first object to check for collision.","name":"sprite"},{"type":{"names":["Array."]},"description":"An array of Tiles to check for collision against.","name":"tiles"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects overlap.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#overlapTiles","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":284,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Pauses the simulation.","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The simulation."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#pause","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Resumes the simulation (if paused).","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The simulation."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#resume","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the acceleration.x/y property on the game object so it will move towards the x/y coordinates at the given rate (in pixels per second squared)\n\nYou must give a maximum speed value, beyond which the game object won't go any faster.\n\nNote: The game object does not continuously track the target. If the target changes location during transit the game object will not modify its course.\nNote: The game object doesn't stop moving once it reaches the destination coordinates.","kind":"function","name":"accelerateTo","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"Any Game Object with an Arcade Physics body.","name":"gameObject"},{"type":{"names":["number"]},"description":"The x coordinate to accelerate towards.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to accelerate towards.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The acceleration (change in speed) in pixels per second squared.","name":"speed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":500,"description":"The maximum x velocity the game object can reach.","name":"xSpeedMax"},{"type":{"names":["number"]},"optional":true,"defaultvalue":500,"description":"The maximum y velocity the game object can reach.","name":"ySpeedMax"}],"returns":[{"type":{"names":["number"]},"description":"The angle (in radians) that the object should be visually set to in order to match its new velocity."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#accelerateTo","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":346,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the acceleration.x/y property on the game object so it will move towards the x/y coordinates at the given rate (in pixels per second squared)\n\nYou must give a maximum speed value, beyond which the game object won't go any faster.\n\nNote: The game object does not continuously track the target. If the target changes location during transit the game object will not modify its course.\nNote: The game object doesn't stop moving once it reaches the destination coordinates.","kind":"function","name":"accelerateToObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"Any Game Object with an Arcade Physics body.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to move towards. Can be any object but must have visible x/y properties.","name":"destination"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The acceleration (change in speed) in pixels per second squared.","name":"speed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":500,"description":"The maximum x velocity the game object can reach.","name":"xSpeedMax"},{"type":{"names":["number"]},"optional":true,"defaultvalue":500,"description":"The maximum y velocity the game object can reach.","name":"ySpeedMax"}],"returns":[{"type":{"names":["number"]},"description":"The angle (in radians) that the object should be visually set to in order to match its new velocity."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#accelerateToObject","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Finds the Body or Game Object closest to a source point or object.\n\nIf a `targets` argument is passed, this method finds the closest of those.\nThe targets can be Arcade Physics Game Objects, Dynamic Bodies, or Static Bodies.\n\nIf no `targets` argument is passed, this method finds the closest Dynamic Body.\n\nIf two or more targets are the exact same distance from the source point, only the first target\nis returned.","kind":"function","name":"closest","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"Any object with public `x` and `y` properties, such as a Game Object or Geometry object.","name":"source"},{"type":{"names":["Array.","Array.","Array."]},"optional":true,"description":"The targets.","name":"targets"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody","Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The target closest to the given source point."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#closest","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":424,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Finds the Body or Game Object farthest from a source point or object.\n\nIf a `targets` argument is passed, this method finds the farthest of those.\nThe targets can be Arcade Physics Game Objects, Dynamic Bodies, or Static Bodies.\n\nIf no `targets` argument is passed, this method finds the farthest Dynamic Body.\n\nIf two or more targets are the exact same distance from the source point, only the first target\nis returned.","kind":"function","name":"furthest","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"Any object with public `x` and `y` properties, such as a Game Object or Geometry object.","name":"source"},{"type":{"names":["Array.","Array.","Array."]},"optional":true,"description":"The targets.","name":"targets"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody","Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The target farthest from the given source point."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#furthest","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":479,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Move the given display object towards the x/y coordinates at a steady velocity.\nIf you specify a maxTime then it will adjust the speed (over-writing what you set) so it arrives at the destination in that number of seconds.\nTimings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.\nNote: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\nNote: The display object doesn't stop moving once it reaches the destination coordinates.\nNote: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)","kind":"function","name":"moveTo","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"Any Game Object with an Arcade Physics body.","name":"gameObject"},{"type":{"names":["number"]},"description":"The x coordinate to move towards.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to move towards.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The speed it will move, in pixels per second (default is 60 pixels/sec)","name":"speed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms.","name":"maxTime"}],"returns":[{"type":{"names":["number"]},"description":"The angle (in radians) that the object should be visually set to in order to match its new velocity."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#moveTo","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Move the given display object towards the destination object at a steady velocity.\nIf you specify a maxTime then it will adjust the speed (overwriting what you set) so it arrives at the destination in that number of seconds.\nTimings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.\nNote: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\nNote: The display object doesn't stop moving once it reaches the destination coordinates.\nNote: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)","kind":"function","name":"moveToObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"Any Game Object with an Arcade Physics body.","name":"gameObject"},{"type":{"names":["object"]},"description":"Any object with public `x` and `y` properties, such as a Game Object or Geometry object.","name":"destination"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The speed it will move, in pixels per second (default is 60 pixels/sec)","name":"speed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms.","name":"maxTime"}],"returns":[{"type":{"names":["number"]},"description":"The angle (in radians) that the object should be visually set to in order to match its new velocity."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#moveToObject","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":539,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Given the angle (in degrees) and speed calculate the velocity and return it as a vector, or set it to the given vector object.\nOne way to use this is: velocityFromAngle(angle, 200, sprite.body.velocity) which will set the values directly to the sprite's velocity and not create a new vector object.","kind":"function","name":"velocityFromAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle in degrees calculated in clockwise positive direction (down = 90 degrees positive, right = 0 degrees positive, up = 90 degrees negative)","name":"angle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The speed it will move, in pixels per second squared.","name":"speed"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"The Vector2 in which the x and y properties will be set to the calculated velocity.","name":"vec2"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector2 that stores the velocity."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#velocityFromAngle","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":560,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Given the rotation (in radians) and speed calculate the velocity and return it as a vector, or set it to the given vector object.\nOne way to use this is: velocityFromRotation(rotation, 200, sprite.body.velocity) which will set the values directly to the sprite's velocity and not create a new vector object.","kind":"function","name":"velocityFromRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle in radians.","name":"rotation"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The speed it will move, in pixels per second squared","name":"speed"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"The Vector2 in which the x and y properties will be set to the calculated velocity.","name":"vec2"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector2 that stores the velocity."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#velocityFromRotation","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":581,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This method will search the given rectangular area and return an array of all physics bodies that\noverlap with it. It can return either Dynamic, Static bodies or a mixture of both.\n\nA body only has to intersect with the search area to be considered, it doesn't have to be fully\ncontained within it.\n\nIf Arcade Physics is set to use the RTree (which it is by default) then the search for is extremely fast,\notherwise the search is O(N) for Dynamic Bodies.","kind":"function","name":"overlapRect","since":"3.17.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the area to search within.","name":"x"},{"type":{"names":["number"]},"description":"The top-left y coordinate of the area to search within.","name":"y"},{"type":{"names":["number"]},"description":"The width of the area to search within.","name":"width"},{"type":{"names":["number"]},"description":"The height of the area to search within.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the search include Dynamic Bodies?","name":"includeDynamic"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the search include Static Bodies?","name":"includeStatic"}],"returns":[{"type":{"names":["Array.","Array."]},"description":"An array of bodies that overlap with the given area."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#overlapRect","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This method will search the given circular area and return an array of all physics bodies that\noverlap with it. It can return either Dynamic, Static bodies or a mixture of both.\n\nA body only has to intersect with the search area to be considered, it doesn't have to be fully\ncontained within it.\n\nIf Arcade Physics is set to use the RTree (which it is by default) then the search is rather fast,\notherwise the search is O(N) for Dynamic Bodies.","kind":"function","name":"overlapCirc","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the area to search within.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the area to search within.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the area to search within.","name":"radius"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the search include Dynamic Bodies?","name":"includeDynamic"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the search include Static Bodies?","name":"includeStatic"}],"returns":[{"type":{"names":["Array.","Array."]},"description":"An array of bodies that overlap with the given area."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#overlapCirc","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":634,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Scene that owns this plugin is shutting down.\nWe need to kill and reset all internal properties as well as stop listening to Scene events.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#shutdown","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":662,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Scene that owns this plugin is being destroyed.\nWe need to shutdown and then kill off all external references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"ArcadeSprite.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ArcadeSprite.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"An Arcade Physics Sprite is a Sprite with an Arcade Physics body and related components.\nThe body can be dynamic or static.\n\nThe main difference between an Arcade Sprite and an Arcade Image is that you cannot animate an Arcade Image.\nIf you do not require animation then you can safely use Arcade Images instead of Arcade Sprites.","kind":"class","name":"Sprite","augments":["Phaser.GameObjects.Sprite","Phaser.Physics.Arcade.Components.Acceleration","Phaser.Physics.Arcade.Components.Angular","Phaser.Physics.Arcade.Components.Bounce","Phaser.Physics.Arcade.Components.Debug","Phaser.Physics.Arcade.Components.Drag","Phaser.Physics.Arcade.Components.Enable","Phaser.Physics.Arcade.Components.Friction","Phaser.Physics.Arcade.Components.Gravity","Phaser.Physics.Arcade.Components.Immovable","Phaser.Physics.Arcade.Components.Mass","Phaser.Physics.Arcade.Components.Size","Phaser.Physics.Arcade.Components.Velocity","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.Physics.Arcade.Sprite","___s":true},{"meta":{"filename":"ArcadeSprite.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This Game Object's Physics Body.","name":"body","type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#body","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Sprite#body","___s":true},{"meta":{"range":[248,284],"filename":"Body.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Body.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"A Dynamic Arcade Body.\n\nIts static counterpart is {@link Phaser.Physics.Arcade.StaticBody}.","kind":"class","name":"Body","memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The Arcade Physics simulation this Body belongs to.","name":"world"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object this Body belongs to.","name":"gameObject"}],"scope":"static","longname":"Phaser.Physics.Arcade.Body","___s":true},{"meta":{"filename":"Body.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Arcade Physics simulation this Body belongs to.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Game Object this Body belongs to.","name":"gameObject","type":{"names":["Phaser.GameObjects.GameObject"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#gameObject","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Transformations applied to this Body.","name":"transform","type":{"names":["object"]},"since":"3.4.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#transform","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the Body's boundary is drawn to the debug display.","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#debugShowBody","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the Body's velocity is drawn to the debug display.","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#debugShowVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The color of this Body on the debug display.","name":"debugBodyColor","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#debugBodyColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is updated by the physics simulation.","name":"enable","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#enable","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body's boundary is circular (true) or rectangular (false).","name":"isCircle","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.Physics.Arcade.Body#setCircle"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#isCircle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"If this Body is circular, this is the unscaled radius of the Body's boundary, as set by setCircle(), in source pixels.\nThe true radius is equal to `halfWidth`.","name":"radius","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.Physics.Arcade.Body#setCircle"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#radius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The offset of this Body's position from its Game Object's position, in source pixels.","name":"offset","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#setOffset"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The position of this Body within the simulation.","name":"position","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#position","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":153,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The position of this Body during the previous step.","name":"prev","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#prev","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":162,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The position of this Body during the previous frame.","name":"prevFrame","type":{"names":["Phaser.Math.Vector2"]},"since":"3.20.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#prevFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":171,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body's `rotation` is affected by its angular acceleration and angular velocity.","name":"allowRotation","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#allowRotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":181,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This body's rotation, in degrees, based on its angular acceleration and angular velocity.\nThe Body's rotation controls the `angle` of its Game Object.\nIt doesn't rotate the Body's boundary, which is always an axis-aligned rectangle or a circle.","name":"rotation","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body rotation, in degrees, during the previous step.","name":"preRotation","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#preRotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":201,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The width of the Body boundary, in pixels.\nIf the Body is circular, this is also the diameter.\nIf you wish to change the width use the `Body.setSize` method.","name":"width","type":{"names":["number"]},"readonly":true,"defaultvalue":"64","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":214,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The height of the Body boundary, in pixels.\nIf the Body is circular, this is also the diameter.\nIf you wish to change the height use the `Body.setSize` method.","name":"height","type":{"names":["number"]},"readonly":true,"defaultvalue":"64","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":227,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The unscaled width of the Body, in source pixels, as set by setSize().\nThe default is the width of the Body's Game Object's texture frame.","name":"sourceWidth","type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#setSize"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#sourceWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":238,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The unscaled height of the Body, in source pixels, as set by setSize().\nThe default is the height of the Body's Game Object's texture frame.","name":"sourceHeight","type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#setSize"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#sourceHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":255,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Half the Body's width, in pixels.","name":"halfWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#halfWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":264,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Half the Body's height, in pixels.","name":"halfHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#halfHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The center of the Body's boundary.\nThe midpoint of its `position` (top-left corner) and its bottom-right corner.","name":"center","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#center","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":283,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's velocity, in pixels per second.","name":"velocity","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#velocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":292,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's change in position (due to velocity) at the last step, in pixels.\n\nThe size of this value depends on the simulation's step rate.","name":"newVelocity","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#newVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":304,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's absolute maximum change in position, in pixels per step.","name":"deltaMax","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaMax","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":313,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's change in velocity, in pixels per second squared.","name":"acceleration","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#acceleration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":322,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body's velocity is affected by its `drag`.","name":"allowDrag","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#allowDrag","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":332,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","name":"drag","type":{"names":["Phaser.Math.Vector2","number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#drag","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":349,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body's position is affected by gravity (local or world).","name":"allowGravity","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","see":["Phaser.Physics.Arcade.Body#gravity","Phaser.Physics.Arcade.World#gravity"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#allowGravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":361,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Acceleration due to gravity (specific to this Body), in pixels per second squared.\nTotal gravity is the sum of this vector and the simulation's `gravity`.","name":"gravity","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.World#gravity"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#gravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":372,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Rebound following a collision, relative to 1.","name":"bounce","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#bounce","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":381,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Rebound following a collision with the world boundary, relative to 1.\nIf null, `bounce` is used instead.","name":"worldBounce","type":{"names":["Phaser.Math.Vector2"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#worldBounce","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":392,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The rectangle used for world boundary collisions.\n\nBy default it is set to the world boundary rectangle. Or, if this Body was\ncreated by a Physics Group, then whatever rectangle that Group defined.\n\nYou can also change it by using the `Body.setBoundsRectangle` method.","name":"customBoundsRectangle","type":{"names":["Phaser.Geom.Rectangle"]},"nullable":true,"since":"3.20","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#customBoundsRectangle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":408,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation emits a `worldbounds` event when this Body collides with the world boundary (and `collideWorldBounds` is also true).","name":"onWorldBounds","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.Physics.Arcade.World#worldboundsEvent"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#onWorldBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":419,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation emits a `collide` event when this Body collides with another.","name":"onCollide","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.Physics.Arcade.World#collideEvent"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#onCollide","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":430,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation emits an `overlap` event when this Body overlaps with another.","name":"onOverlap","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.Physics.Arcade.World#overlapEvent"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#onOverlap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":441,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's absolute maximum velocity, in pixels per second.\nThe horizontal and vertical components are applied separately.","name":"maxVelocity","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#maxVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":451,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The maximum speed this Body is allowed to reach, in pixels per second.\n\nIf not negative it limits the scalar value of speed.\n\nAny negative value means no maximum is being applied (the default).","name":"maxSpeed","type":{"names":["number"]},"defaultvalue":"-1","since":"3.16.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#maxSpeed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":465,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"If this Body is `immovable` and in motion, `friction` is the proportion of this Body's motion received by the riding Body on each axis, relative to 1.\nThe horizontal component (x) is applied only when two colliding Bodies are separated vertically.\nThe vertical component (y) is applied only when two colliding Bodies are separated horizontally.\nThe default value (1, 0) moves the riding Body horizontally in equal proportion to this Body and vertically not at all.","name":"friction","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#friction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":477,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"If this Body is using `drag` for deceleration this property controls how the drag is applied.\nIf set to `true` drag will use a damping effect rather than a linear approach. If you are\ncreating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\nthe game Asteroids) then you will get a far smoother and more visually correct deceleration\nby using damping, avoiding the axis-drift that is prone with linear deceleration.\n\nIf you enable this property then you should use far smaller `drag` values than with linear, as\nthey are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\ndeceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.","name":"useDamping","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.10.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#useDamping","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":495,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The rate of change of this Body's `rotation`, in degrees per second.","name":"angularVelocity","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#angularVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":505,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's angular acceleration (change in angular velocity), in degrees per second squared.","name":"angularAcceleration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#angularAcceleration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":515,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Loss of angular velocity due to angular movement, in degrees per second.\n\nAngular drag is applied only when angular acceleration is zero.","name":"angularDrag","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#angularDrag","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":527,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's maximum angular velocity, in degrees per second.","name":"maxAngular","type":{"names":["number"]},"defaultvalue":"1000","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#maxAngular","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":537,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's inertia, relative to a default unit (1).\nWith `bounce`, this affects the exchange of momentum (velocities) during collisions.","name":"mass","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#mass","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":548,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The calculated angle of this Body's velocity vector, in radians, during the last step.","name":"angle","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":558,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The calculated magnitude of the Body's velocity, in pixels per second, during the last step.","name":"speed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#speed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":568,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The direction of the Body's velocity, as calculated during the last step.\nIf the Body is moving on both axes (diagonally), this describes motion on the vertical axis only.","name":"facing","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#facing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":578,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body can be moved by collisions with another Body.","name":"immovable","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#immovable","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":588,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the Body's position and rotation are affected by its velocity, acceleration, drag, and gravity.","name":"moves","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#moves","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":598,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A flag disabling the default horizontal separation of colliding bodies.\nPass your own `collideCallback` to the collider.","name":"customSeparateX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#customSeparateX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":609,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A flag disabling the default vertical separation of colliding bodies.\nPass your own `collideCallback` to the collider.","name":"customSeparateY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#customSeparateY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":620,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The amount of horizontal overlap (before separation), if this Body is colliding with another.","name":"overlapX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#overlapX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":630,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The amount of vertical overlap (before separation), if this Body is colliding with another.","name":"overlapY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#overlapY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":640,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The amount of overlap (before separation), if this Body is circular and colliding with another circular body.","name":"overlapR","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#overlapR","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":650,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is overlapped with another and both are not moving, on at least one axis.","name":"embedded","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#embedded","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":660,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body interacts with the world boundary.","name":"collideWorldBounds","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#collideWorldBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":670,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is checked for collisions and for which directions.\nYou can set `checkCollision.none = true` to disable collision checks.","name":"checkCollision","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#checkCollision","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":680,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is colliding with a Body or Static Body and in which direction.\nIn a collision where both bodies have zero velocity, `embedded` will be set instead.","name":"touching","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#blocked","Phaser.Physics.Arcade.Body#embedded"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#touching","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":693,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This Body's `touching` value during the previous step.","name":"wasTouching","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#touching"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#wasTouching","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":704,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is colliding with a Static Body, a tile, or the world boundary.\nIn a collision with a Static Body, if this Body has zero velocity then `embedded` will be set instead.","name":"blocked","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#embedded","Phaser.Physics.Arcade.Body#touching"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#blocked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":717,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether to automatically synchronize this Body's dimensions to the dimensions of its Game Object's visual bounds.","name":"syncBounds","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.GameObjects.Components.GetBounds#getBounds"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#syncBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":728,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's physics type (dynamic or static).","name":"physicsType","type":{"names":["integer"]},"readonly":true,"defaultvalue":"Phaser.Physics.Arcade.DYNAMIC_BODY","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#physicsType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":814,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Updates the Body's `transform`, `width`, `height`, and `center` from its Game Object.\nThe Body's `position` isn't changed.","kind":"function","name":"updateBounds","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#updateBounds","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":885,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Updates the Body's `center` from its `position`, `width`, and `height`.","kind":"function","name":"updateCenter","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#updateCenter","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":896,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Prepares the Body for a physics step by resetting the `wasTouching`, `touching` and `blocked` states.\n\nThis method is only called if the physics world is going to run a step this frame.","kind":"function","name":"resetFlags","since":"3.18.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#resetFlags","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":932,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Syncs the position body position with the parent Game Object.\n\nThis method is called every game frame, regardless if the world steps or not.","kind":"function","name":"preUpdate","since":"3.17.0","params":[{"type":{"names":["boolean"]},"description":"Will this Body run an update as well?","name":"willStep"},{"type":{"names":["number"]},"description":"The delta time, in seconds, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#preUpdate","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":977,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Performs a single physics step and updates the body velocity, angle, speed and other properties.\n\nThis method can be called multiple times per game frame, depending on the physics step rate.\n\nThe results are synced back to the Game Object in `postUpdate`.","kind":"function","name":"update","fires":["Phaser.Physics.Arcade.Events#event:WORLD_BOUNDS"],"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delta time, in seconds, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#update","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1024,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Feeds the Body results back into the parent Game Object.\n\nThis method is called every game frame, regardless if the world steps or not.","kind":"function","name":"postUpdate","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#postUpdate","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1097,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets a custom collision boundary rectangle. Use if you want to have a custom\nboundary instead of the world boundaries.","kind":"function","name":"setBoundsRectangle","since":"3.20","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"nullable":true,"description":"The new boundary rectangle. Pass `null` to use the World bounds.","name":"bounds"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setBoundsRectangle","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1115,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Checks for collisions between this Body and the world boundary and separates them.","kind":"function","name":"checkWorldBounds","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if this Body is colliding with the world boundary."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#checkWorldBounds","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1172,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the offset of the Body's position from its Game Object's position.","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal offset, in source pixels.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical offset, in source pixels.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setOffset","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1193,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sizes and positions this Body's boundary, as a rectangle.\nModifies the Body `offset` if `center` is true (the default).\nResets the width and height to match current frame, if no width and height provided and a frame is found.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The width of the Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame width.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame height.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Modify the Body's `offset`, placing the Body's center on its Game Object's center. Only works if the Game Object has the `getCenter` method.","name":"center"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setSize","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1248,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sizes and positions this Body's boundary, as a circle.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the Body, in source pixels.","name":"radius"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal offset of the Body from its Game Object, in source pixels.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"description":"The vertical offset of the Body from its Game Object, in source pixels.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setCircle","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Resets this Body to the given coordinates. Also positions its parent Game Object to the same coordinates.\nIf the Body had any velocity or acceleration it is lost as a result of calling this.","kind":"function","name":"reset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position to place the Game Object and Body.","name":"y"}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#reset","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1328,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets acceleration, velocity, and speed to zero.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#stop","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1347,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Copies the coordinates of this Body's edges into an object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyBounds"]},"description":"An object to copy the values into.","name":"obj"}],"returns":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyBounds"]},"description":"- An object with {x, y, right, bottom}."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#getBounds","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Tests if the coordinates are within this Body's boundary.","kind":"function","name":"hitTest","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"True if (x, y) is within this Body."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#hitTest","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1397,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is touching a tile or the world boundary while moving down.","kind":"function","name":"onFloor","since":"3.0.0","see":["Phaser.Physics.Arcade.Body#blocked"],"returns":[{"type":{"names":["boolean"]},"description":"True if touching."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#onFloor","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is touching a tile or the world boundary while moving up.","kind":"function","name":"onCeiling","since":"3.0.0","see":["Phaser.Physics.Arcade.Body#blocked"],"returns":[{"type":{"names":["boolean"]},"description":"True if touching."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#onCeiling","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is touching a tile or the world boundary while moving left or right.","kind":"function","name":"onWall","since":"3.0.0","see":["Phaser.Physics.Arcade.Body#blocked"],"returns":[{"type":{"names":["boolean"]},"description":"True if touching."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#onWall","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1439,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The absolute (non-negative) change in this Body's horizontal position from the previous step.","kind":"function","name":"deltaAbsX","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The delta value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaAbsX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1452,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The absolute (non-negative) change in this Body's vertical position from the previous step.","kind":"function","name":"deltaAbsY","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The delta value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaAbsY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this Body's horizontal position from the previous step.\nThis value is set during the Body's update phase.\n\nAs a Body can update multiple times per step this may not hold the final\ndelta value for the Body. In this case, please see the `deltaXFinal` method.","kind":"function","name":"deltaX","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The delta value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1482,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this Body's vertical position from the previous step.\nThis value is set during the Body's update phase.\n\nAs a Body can update multiple times per step this may not hold the final\ndelta value for the Body. In this case, please see the `deltaYFinal` method.","kind":"function","name":"deltaY","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The delta value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1499,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this Body's horizontal position from the previous game update.\n\nThis value is set during the `postUpdate` phase and takes into account the\n`deltaMax` and final position of the Body.\n\nBecause this value is not calculated until `postUpdate`, you must listen for it\nduring a Scene `POST_UPDATE` or `RENDER` event, and not in `update`, as it will\nnot be calculated by that point. If you _do_ use these values in `update` they\nwill represent the delta from the _previous_ game frame.","kind":"function","name":"deltaXFinal","since":"3.22.0","returns":[{"type":{"names":["number"]},"description":"The final delta x value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaXFinal","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1520,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this Body's vertical position from the previous game update.\n\nThis value is set during the `postUpdate` phase and takes into account the\n`deltaMax` and final position of the Body.\n\nBecause this value is not calculated until `postUpdate`, you must listen for it\nduring a Scene `POST_UPDATE` or `RENDER` event, and not in `update`, as it will\nnot be calculated by that point. If you _do_ use these values in `update` they\nwill represent the delta from the _previous_ game frame.","kind":"function","name":"deltaYFinal","since":"3.22.0","returns":[{"type":{"names":["number"]},"description":"The final delta y value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaYFinal","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this Body's rotation from the previous step, in degrees.","kind":"function","name":"deltaZ","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The delta value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaZ","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Disables this Body and marks it for deletion by the simulation.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#destroy","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1570,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Draws this Body's boundary and velocity, if enabled.","kind":"function","name":"drawDebug","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to draw on.","name":"graphic"}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#drawDebug","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body will be drawn to the debug display.","kind":"function","name":"willDrawDebug","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if either `debugShowBody` or `debugShowVelocity` are enabled."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#willDrawDebug","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1638,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets whether this Body collides with the world boundary.\n\nOptionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.","kind":"function","name":"setCollideWorldBounds","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if this body should collide with the world bounds, otherwise `false`.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.x` value.","name":"bounceX"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.y` value.","name":"bounceY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setCollideWorldBounds","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1682,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's velocity.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity, in pixels per second.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity, in pixels per second.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setVelocity","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1705,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's horizontal velocity.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The velocity, in pixels per second.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setVelocityX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1727,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's vertical velocity.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The velocity, in pixels per second.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setVelocityY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1749,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's maximum velocity.","kind":"function","name":"setMaxVelocity","since":"3.10.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity, in pixels per second.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity, in pixels per second.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setMaxVelocity","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1767,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the maximum speed the Body can move.","kind":"function","name":"setMaxSpeed","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The maximum speed value, in pixels per second. Set to a negative value to disable.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setMaxSpeed","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1784,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's bounce.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal bounce, relative to 1.","name":"x"},{"type":{"names":["number"]},"description":"The vertical bounce, relative to 1.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setBounce","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1802,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's horizontal bounce.","kind":"function","name":"setBounceX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The bounce, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setBounceX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1819,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's vertical bounce.","kind":"function","name":"setBounceY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The bounce, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setBounceY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1836,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's acceleration.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal component, in pixels per second squared.","name":"x"},{"type":{"names":["number"]},"description":"The vertical component, in pixels per second squared.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAcceleration","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1854,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's horizontal acceleration.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The acceleration, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAccelerationX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1871,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's vertical acceleration.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The acceleration, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAccelerationY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1888,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Enables or disables drag.","kind":"function","name":"setAllowDrag","since":"3.9.0","see":["Phaser.Physics.Arcade.Body#allowDrag"],"params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` to allow drag on this body, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAllowDrag","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1908,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Enables or disables gravity's effect on this Body.","kind":"function","name":"setAllowGravity","since":"3.9.0","see":["Phaser.Physics.Arcade.Body#allowGravity"],"params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` to allow gravity on this body, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAllowGravity","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1928,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Enables or disables rotation.","kind":"function","name":"setAllowRotation","since":"3.9.0","see":["Phaser.Physics.Arcade.Body#allowRotation"],"params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` to allow rotation on this body, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAllowRotation","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1948,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's drag.","kind":"function","name":"setDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal component, in pixels per second squared.","name":"x"},{"type":{"names":["number"]},"description":"The vertical component, in pixels per second squared.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setDrag","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1966,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's horizontal drag.","kind":"function","name":"setDragX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The drag, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setDragX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1983,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's vertical drag.","kind":"function","name":"setDragY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The drag, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setDragY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2000,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's gravity.","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal component, in pixels per second squared.","name":"x"},{"type":{"names":["number"]},"description":"The vertical component, in pixels per second squared.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setGravity","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2018,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's horizontal gravity.","kind":"function","name":"setGravityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravity, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setGravityX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2035,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's vertical gravity.","kind":"function","name":"setGravityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravity, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setGravityY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2052,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's friction.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal component, relative to 1.","name":"x"},{"type":{"names":["number"]},"description":"The vertical component, relative to 1.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setFriction","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2070,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's horizontal friction.","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The friction value, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setFrictionX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2087,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's vertical friction.","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The friction value, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setFrictionY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2104,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's angular velocity.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The velocity, in degrees per second.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAngularVelocity","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2121,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's angular acceleration.","kind":"function","name":"setAngularAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The acceleration, in degrees per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAngularAcceleration","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2138,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's angular drag.","kind":"function","name":"setAngularDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The drag, in degrees per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAngularDrag","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's mass.","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The mass value, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setMass","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2172,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's `immovable` property.","kind":"function","name":"setImmovable","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The value to assign to `immovable`.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setImmovable","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's `enable` property.","kind":"function","name":"setEnable","since":"3.15.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The value to assign to `enable`.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setEnable","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2210,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's horizontal position (left edge).","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":2231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's vertical position (top edge).","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":2252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The left edge of the Body's boundary. Identical to x.","name":"left","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":2269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The right edge of the Body's boundary.","name":"right","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":2286,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The top edge of the Body's boundary. Identical to y.","name":"top","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":2303,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The bottom edge of this Body's boundary.","name":"bottom","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"Collider.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Collider.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"An Arcade Physics Collider will automatically check for collision, or overlaps, between two objects\nevery step. If a collision, or overlap, occurs it will invoke the given callbacks.","kind":"class","name":"Collider","memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The Arcade physics World that will manage the collisions.","name":"world"},{"type":{"names":["boolean"]},"description":"Whether to check for collisions or overlap.","name":"overlapOnly"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object to check for collision.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The second object to check for collision.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"description":"The callback to invoke when the two objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"description":"The callback to invoke when the two objects collide. Must return a boolean.","name":"processCallback"},{"type":{"names":["any"]},"description":"The scope in which to call the callbacks.","name":"callbackContext"}],"scope":"static","longname":"Phaser.Physics.Arcade.Collider","___s":true},{"meta":{"filename":"Collider.js","lineno":33,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The world in which the bodies will collide.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The name of the collider (unused by Phaser).","name":"name","type":{"names":["string"]},"since":"3.1.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the collider is active.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether to check for collisions or overlaps.","name":"overlapOnly","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#overlapOnly","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The first object to check for collision.","name":"object1","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#object1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The second object to check for collision.","name":"object2","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#object2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The callback to invoke when the two objects collide.","name":"collideCallback","type":{"names":["ArcadePhysicsCallback"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#collideCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"If a processCallback exists it must return true or collision checking will be skipped.","name":"processCallback","type":{"names":["ArcadePhysicsCallback"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#processCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The context the collideCallback and processCallback will run in.","name":"callbackContext","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#callbackContext","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":116,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A name for the Collider.\n\nPhaser does not use this value, it's for your own reference.","kind":"function","name":"setName","since":"3.1.0","params":[{"type":{"names":["string"]},"description":"The name to assign to the Collider.","name":"name"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Collider"]},"description":"This Collider instance."}],"memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#setName","scope":"instance","___s":true},{"meta":{"filename":"Collider.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Called by World as part of its step processing, initial operation of collision checking.","kind":"function","name":"update","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#update","scope":"instance","___s":true},{"meta":{"filename":"Collider.js","lineno":153,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Removes Collider from World and disposes of its resources.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#destroy","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"Factory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"ArcadeImage","longname":"ArcadeImage","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Factory.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"The Arcade Physics Factory allows you to easily create Arcade Physics enabled Game Objects.\nObjects that are created by this Factory are automatically added to the physics world.","kind":"class","name":"Factory","memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The Arcade Physics World instance.","name":"world"}],"scope":"static","longname":"Phaser.Physics.Arcade.Factory","___s":true},{"meta":{"filename":"Factory.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A reference to the Arcade Physics World.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A reference to the Scene this Arcade Physics instance belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A reference to the Scene.Systems this Arcade Physics instance belongs to.","name":"sys","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#sys","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Arcade Physics Collider object.","kind":"function","name":"collider","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group","Array."]},"description":"The first object to check for collision.","name":"object1"},{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group","Array."]},"description":"The second object to check for collision.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects collide. Must return a boolean.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The scope in which to call the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Collider"]},"description":"The Collider that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#collider","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Arcade Physics Collider Overlap object.","kind":"function","name":"overlap","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group","Array."]},"description":"The first object to check for overlap.","name":"object1"},{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group","Array."]},"description":"The second object to check for overlap.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects collide. Must return a boolean.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The scope in which to call the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Collider"]},"description":"The Collider that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#overlap","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Adds an Arcade Physics Body to the given Game Object.","kind":"function","name":"existing","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A Game Object.","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a Static body (true) or Dynamic body (false).","name":"isStatic"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#existing","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":118,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Arcade Image object with a Static body.","kind":"function","name":"staticImage","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"The Image object that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#staticImage","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":142,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Arcade Image object with a Dynamic body.","kind":"function","name":"image","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"The Image object that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#image","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Arcade Sprite object with a Static body.","kind":"function","name":"staticSprite","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"The Sprite object that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#staticSprite","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Arcade Sprite object with a Dynamic body.","kind":"function","name":"sprite","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"The Sprite object that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#sprite","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":216,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a Static Physics Group object.\nAll Game Objects created by this Group will automatically be static Arcade Physics objects.","kind":"function","name":"staticGroup","since":"3.0.0","params":[{"type":{"names":["Array.","Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Game Objects to add to this group; or the `config` argument.","name":"children"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Settings for this group.","name":"config"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticGroup"]},"description":"The Static Group object that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#staticGroup","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":233,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a Physics Group object.\nAll Game Objects created by this Group will automatically be dynamic Arcade Physics objects.","kind":"function","name":"group","since":"3.0.0","params":[{"type":{"names":["Array.","Phaser.Types.Physics.Arcade.PhysicsGroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Game Objects to add to this group; or the `config` argument.","name":"children"},{"type":{"names":["Phaser.Types.Physics.Arcade.PhysicsGroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Settings for this group.","name":"config"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Group"]},"description":"The Group object that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#group","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":250,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Destroys this Factory.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#destroy","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"GetOverlapX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetOverlapX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Calculates and returns the horizontal overlap between two arcade physics bodies and sets their properties\naccordingly, including: `touching.left`, `touching.right`, `touching.none` and `overlapX'.","kind":"function","name":"GetOverlapX","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first Body to separate.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second Body to separate.","name":"body2"},{"type":{"names":["boolean"]},"description":"Is this an overlap only check, or part of separation?","name":"overlapOnly"},{"type":{"names":["number"]},"description":"A value added to the delta values during collision checks. Increase it to prevent sprite tunneling(sprites passing through another instead of colliding).","name":"bias"}],"returns":[{"type":{"names":["number"]},"description":"The amount of overlap."}],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.GetOverlapX","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"GetOverlapY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetOverlapY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Calculates and returns the vertical overlap between two arcade physics bodies and sets their properties\naccordingly, including: `touching.up`, `touching.down`, `touching.none` and `overlapY'.","kind":"function","name":"GetOverlapY","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first Body to separate.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second Body to separate.","name":"body2"},{"type":{"names":["boolean"]},"description":"Is this an overlap only check, or part of separation?","name":"overlapOnly"},{"type":{"names":["number"]},"description":"A value added to the delta values during collision checks. Increase it to prevent sprite tunneling(sprites passing through another instead of colliding).","name":"bias"}],"returns":[{"type":{"names":["number"]},"description":"The amount of overlap."}],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.GetOverlapY","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"PhysicsGroup.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"ArcadeSprite","longname":"ArcadeSprite","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"An Arcade Physics Group object.\n\nAll Game Objects created by this Group will automatically be given dynamic Arcade Physics bodies.\n\nIts static counterpart is {@link Phaser.Physics.Arcade.StaticGroup}.","kind":"class","name":"Group","augments":["Phaser.GameObjects.Group"],"memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The physics simulation.","name":"world"},{"type":{"names":["Phaser.Scene"]},"description":"The scene this group belongs to.","name":"scene"},{"type":{"names":["Array.","Phaser.Types.Physics.Arcade.PhysicsGroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Game Objects to add to this group; or the `config` argument.","name":"children"},{"type":{"names":["Phaser.Types.Physics.Arcade.PhysicsGroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Settings for this group.","name":"config"}],"scope":"static","longname":"Phaser.Physics.Arcade.Group","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The physics simulation.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The class to create new Group members from.\n\nThis should be either `Phaser.Physics.Arcade.Image`, `Phaser.Physics.Arcade.Sprite`, or a class extending one of those.","name":"classType","type":{"names":["function"]},"defaultvalue":"ArcadeSprite","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#classType","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Group#classType","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":100,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The physics type of the Group's members.","name":"physicsType","type":{"names":["integer"]},"defaultvalue":"Phaser.Physics.Arcade.DYNAMIC_BODY","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#physicsType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Default physics properties applied to Game Objects added to the Group or created by the Group. Derived from the `config` argument.","name":"defaults","type":{"names":["Phaser.Types.Physics.Arcade.PhysicsGroupDefaults"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#defaults","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":150,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A textual representation of this Game Object.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"defaultvalue":"'PhysicsGroup'","since":"3.21.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#type","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Group#type","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":162,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Enables a Game Object's Body and assigns `defaults`. Called when a Group member is added or created.","kind":"function","name":"createCallbackHandler","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object being added.","name":"child"}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#createCallbackHandler","scope":"instance","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Disables a Game Object's Body. Called when a Group member is removed.","kind":"function","name":"removeCallbackHandler","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object being removed.","name":"child"}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#removeCallbackHandler","scope":"instance","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the velocity of each Group member.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity.","name":"x"},{"type":{"names":["number"]},"description":"The vertical velocity.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The velocity increment. When set, the first member receives velocity (x, y), the second (x + step, y + step), and so on.","name":"step"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Group"]},"description":"This Physics Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setVelocity","scope":"instance","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the horizontal velocity of each Group member.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The velocity value.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The velocity increment. When set, the first member receives velocity (x), the second (x + step), and so on.","name":"step"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Group"]},"description":"This Physics Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setVelocityX","scope":"instance","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the vertical velocity of each Group member.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The velocity value.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The velocity increment. When set, the first member receives velocity (y), the second (y + step), and so on.","name":"step"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Group"]},"description":"This Physics Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setVelocityY","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"SeparateX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"GetOverlapX","longname":"GetOverlapX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SeparateX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Separates two overlapping bodies on the X-axis (horizontally).\n\nSeparation involves moving two overlapping bodies so they don't overlap anymore and adjusting their velocities based on their mass. This is a core part of collision detection.\n\nThe bodies won't be separated if there is no horizontal overlap between them, if they are static, or if either one uses custom logic for its separation.","kind":"function","name":"SeparateX","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first Body to separate.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second Body to separate.","name":"body2"},{"type":{"names":["boolean"]},"description":"If `true`, the bodies will only have their overlap data set and no separation will take place.","name":"overlapOnly"},{"type":{"names":["number"]},"description":"A value to add to the delta value during overlap checking. Used to prevent sprite tunneling.","name":"bias"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two bodies overlap horizontally, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.SeparateX","scope":"static","___s":true},{"meta":{"range":[180,218],"filename":"SeparateY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"GetOverlapY","longname":"GetOverlapY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SeparateY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Separates two overlapping bodies on the Y-axis (vertically).\n\nSeparation involves moving two overlapping bodies so they don't overlap anymore and adjusting their velocities based on their mass. This is a core part of collision detection.\n\nThe bodies won't be separated if there is no vertical overlap between them, if they are static, or if either one uses custom logic for its separation.","kind":"function","name":"SeparateY","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first Body to separate.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second Body to separate.","name":"body2"},{"type":{"names":["boolean"]},"description":"If `true`, the bodies will only have their overlap data set and no separation will take place.","name":"overlapOnly"},{"type":{"names":["number"]},"description":"A value to add to the delta value during overlap checking. Used to prevent sprite tunneling.","name":"bias"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two bodies overlap vertically, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.SeparateY","scope":"static","___s":true},{"meta":{"range":[180,234],"filename":"StaticBody.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"CircleContains","longname":"CircleContains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"StaticBody.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"A Static Arcade Physics Body.\n\nA Static Body never moves, and isn't automatically synchronized with its parent Game Object.\nThat means if you make any change to the parent's origin, position, or scale after creating or adding the body, you'll need to update the Body manually.\n\nA Static Body can collide with other Bodies, but is never moved by collisions.\n\nIts dynamic counterpart is {@link Phaser.Physics.Arcade.Body}.","kind":"class","name":"StaticBody","memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The Arcade Physics simulation this Static Body belongs to.","name":"world"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object this Static Body belongs to.","name":"gameObject"}],"scope":"static","longname":"Phaser.Physics.Arcade.StaticBody","___s":true},{"meta":{"filename":"StaticBody.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Arcade Physics simulation this Static Body belongs to.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Game Object this Static Body belongs to.","name":"gameObject","type":{"names":["Phaser.GameObjects.GameObject"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#gameObject","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the Static Body's boundary is drawn to the debug display.","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#debugShowBody","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The color of this Static Body on the debug display.","name":"debugBodyColor","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#debugBodyColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Static Body is updated by the physics simulation.","name":"enable","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#enable","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Static Body's boundary is circular (`true`) or rectangular (`false`).","name":"isCircle","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#isCircle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"If this Static Body is circular, this is the unscaled radius of the Static Body's boundary, as set by {@link #setCircle}, in source pixels.\nThe true radius is equal to `halfWidth`.","name":"radius","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#radius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The offset of this Static Body's actual position from any updated position.\n\nUnlike a dynamic Body, a Static Body does not follow its Game Object. As such, this offset is only applied when resizing the Static Body.","name":"offset","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The position of this Static Body within the simulation.","name":"position","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#position","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The width of the Static Body's boundary, in pixels.\nIf the Static Body is circular, this is also the Static Body's diameter.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The height of the Static Body's boundary, in pixels.\nIf the Static Body is circular, this is also the Static Body's diameter.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Half the Static Body's width, in pixels.\nIf the Static Body is circular, this is also the Static Body's radius.","name":"halfWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#halfWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Half the Static Body's height, in pixels.\nIf the Static Body is circular, this is also the Static Body's radius.","name":"halfHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#halfHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The center of the Static Body's boundary.\nThis is the midpoint of its `position` (top-left corner) and its bottom-right corner.","name":"center","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#center","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A constant zero velocity used by the Arcade Physics simulation for calculations.","name":"velocity","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#velocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":188,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A constant `false` value expected by the Arcade Physics simulation.","name":"allowGravity","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#allowGravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":199,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Gravitational force applied specifically to this Body. Values are in pixels per second squared. Always zero for a Static Body.","name":"gravity","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#gravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":209,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Rebound, or restitution, following a collision, relative to 1. Always zero for a Static Body.","name":"bounce","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#bounce","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":221,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation emits a `worldbounds` event when this StaticBody collides with the world boundary.\nAlways false for a Static Body. (Static Bodies never collide with the world boundary and never trigger a `worldbounds` event.)","name":"onWorldBounds","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#onWorldBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":233,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation emits a `collide` event when this StaticBody collides with another.","name":"onCollide","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#onCollide","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":243,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation emits an `overlap` event when this StaticBody overlaps with another.","name":"onOverlap","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#onOverlap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":253,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The StaticBody's inertia, relative to a default unit (1). With `bounce`, this affects the exchange of momentum (velocities) during collisions.","name":"mass","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#mass","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":263,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this object can be moved by collisions with another body.","name":"immovable","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#immovable","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A flag disabling the default horizontal separation of colliding bodies. Pass your own `collideHandler` to the collider.","name":"customSeparateX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#customSeparateX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":283,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A flag disabling the default vertical separation of colliding bodies. Pass your own `collideHandler` to the collider.","name":"customSeparateY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#customSeparateY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":293,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The amount of horizontal overlap (before separation), if this Body is colliding with another.","name":"overlapX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#overlapX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":303,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The amount of vertical overlap (before separation), if this Body is colliding with another.","name":"overlapY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#overlapY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":313,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The amount of overlap (before separation), if this StaticBody is circular and colliding with another circular body.","name":"overlapR","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#overlapR","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":323,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this StaticBody has ever overlapped with another while both were not moving.","name":"embedded","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#embedded","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":333,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this StaticBody interacts with the world boundary.\nAlways false for a Static Body. (Static Bodies never collide with the world boundary.)","name":"collideWorldBounds","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#collideWorldBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":345,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this StaticBody is checked for collisions and for which directions. You can set `checkCollision.none = false` to disable collision checks.","name":"checkCollision","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#checkCollision","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":354,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this StaticBody has ever collided with another body and in which direction.","name":"touching","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#touching","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":363,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this StaticBody was colliding with another body during the last step or any previous step, and in which direction.","name":"wasTouching","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#wasTouching","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":372,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this StaticBody has ever collided with a tile or the world boundary.","name":"blocked","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#blocked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":381,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The StaticBody's physics type (static by default).","name":"physicsType","type":{"names":["integer"]},"defaultvalue":"Phaser.Physics.Arcade.STATIC_BODY","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#physicsType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":416,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Changes the Game Object this Body is bound to.\nFirst it removes its reference from the old Game Object, then sets the new one.\nYou can optionally update the position and dimensions of this Body to reflect that of the new Game Object.","kind":"function","name":"setGameObject","since":"3.1.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The new Game Object that will own this Body.","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Reposition and resize this Body to match the new Game Object?","name":"update"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"see":["Phaser.Physics.Arcade.StaticBody#updateFromGameObject"],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#setGameObject","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":452,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Syncs the Body's position and size with its parent Game Object.","kind":"function","name":"updateFromGameObject","since":"3.1.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#updateFromGameObject","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":481,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the offset of the body.","kind":"function","name":"setOffset","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The horizontal offset of the Body from the Game Object's center.","name":"x"},{"type":{"names":["number"]},"description":"The vertical offset of the Body from the Game Object's center.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#setOffset","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the size of the body.\nResets the width and height to match current frame, if no width and height provided and a frame is found.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The width of the Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame width.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame height.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Modify the Body's `offset`, placing the Body's center on its Game Object's center. Only works if the Game Object has the `getCenter` method.","name":"center"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#setSize","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":574,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets this Static Body to have a circular body and sets its sizes and position.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the StaticBody, in pixels.","name":"radius"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal offset of the StaticBody from its Game Object, in pixels.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"description":"The vertical offset of the StaticBody from its Game Object, in pixels.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#setCircle","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":619,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Updates the StaticBody's `center` from its `position` and dimensions.","kind":"function","name":"updateCenter","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#updateCenter","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":630,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Resets this Body to the given coordinates. Also positions its parent Game Object to the same coordinates.","kind":"function","name":"reset","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x coordinate to reset the body to. If not given will use the parent Game Object's coordinate.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to reset the body to. If not given will use the parent Game Object's coordinate.","name":"y"}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#reset","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":657,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"NOOP function. A Static Body cannot be stopped.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#stop","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":670,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Returns the x and y coordinates of the top left and bottom right points of the StaticBody.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyBounds"]},"description":"The object which will hold the coordinates of the bounds.","name":"obj"}],"returns":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyBounds"]},"description":"The same object that was passed with `x`, `y`, `right` and `bottom` values matching the respective values of the StaticBody."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#getBounds","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":690,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Checks to see if a given x,y coordinate is colliding with this Static Body.","kind":"function","name":"hitTest","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to check against this body.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to check against this body.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the given coordinate lies within this body, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#hitTest","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":706,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"NOOP","kind":"function","name":"postUpdate","since":"3.12.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#postUpdate","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":716,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The absolute (non-negative) change in this StaticBody's horizontal position from the previous step. Always zero.","kind":"function","name":"deltaAbsX","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"Always zero for a Static Body."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#deltaAbsX","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":729,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The absolute (non-negative) change in this StaticBody's vertical position from the previous step. Always zero.","kind":"function","name":"deltaAbsY","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"Always zero for a Static Body."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#deltaAbsY","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this StaticBody's horizontal position from the previous step. Always zero.","kind":"function","name":"deltaX","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The change in this StaticBody's velocity from the previous step. Always zero."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#deltaX","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":755,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this StaticBody's vertical position from the previous step. Always zero.","kind":"function","name":"deltaY","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The change in this StaticBody's velocity from the previous step. Always zero."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#deltaY","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":768,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this StaticBody's rotation from the previous step. Always zero.","kind":"function","name":"deltaZ","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The change in this StaticBody's rotation from the previous step. Always zero."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#deltaZ","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":781,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Disables this Body and marks it for destruction during the next step.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#destroy","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":794,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Draws a graphical representation of the StaticBody for visual debugging purposes.","kind":"function","name":"drawDebug","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to use for the debug drawing of the StaticBody.","name":"graphic"}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#drawDebug","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":825,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Indicates whether the StaticBody is going to be showing a debug visualization during postUpdate.","kind":"function","name":"willDrawDebug","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether or not the StaticBody is going to show the debug visualization during postUpdate."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#willDrawDebug","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":838,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Mass of the StaticBody. Will set the Mass to 0.1 if the value passed is less than or equal to zero.","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to set the Mass to. Values of zero or less are changed to 0.1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#setMass","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":861,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The x coordinate of the StaticBody.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":886,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The y coordinate of the StaticBody.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":911,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Returns the left-most x coordinate of the area of the StaticBody.","name":"left","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":928,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The right-most x coordinate of the area of the StaticBody.","name":"right","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":945,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The highest y coordinate of the area of the StaticBody.","name":"top","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":962,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The lowest y coordinate of the area of the StaticBody. (y + height)","name":"bottom","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,220],"filename":"StaticPhysicsGroup.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"ArcadeSprite","longname":"ArcadeSprite","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"An Arcade Physics Static Group object.\n\nAll Game Objects created by this Group will automatically be given static Arcade Physics bodies.\n\nIts dynamic counterpart is {@link Phaser.Physics.Arcade.Group}.","kind":"class","name":"StaticGroup","augments":["Phaser.GameObjects.Group"],"memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The physics simulation.","name":"world"},{"type":{"names":["Phaser.Scene"]},"description":"The scene this group belongs to.","name":"scene"},{"type":{"names":["Array.","Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Game Objects to add to this group; or the `config` argument.","name":"children"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Settings for this group.","name":"config"}],"scope":"static","longname":"Phaser.Physics.Arcade.StaticGroup","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The physics simulation.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":85,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The scene this group belongs to.","name":"physicsType","type":{"names":["integer"]},"defaultvalue":"Phaser.Physics.Arcade.STATIC_BODY","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#physicsType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A textual representation of this Game Object.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"defaultvalue":"'StaticPhysicsGroup'","since":"3.21.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#type","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Group#type","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Adds a static physics body to the new group member (if it lacks one) and adds it to the simulation.","kind":"function","name":"createCallbackHandler","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The new group member.","name":"child"}],"see":["Phaser.Physics.Arcade.World#enableBody"],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#createCallbackHandler","scope":"instance","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Disables the group member's physics body, removing it from the simulation.","kind":"function","name":"removeCallbackHandler","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The group member being removed.","name":"child"}],"see":["Phaser.Physics.Arcade.World#disableBody"],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#removeCallbackHandler","scope":"instance","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Refreshes the group.","kind":"function","name":"createMultipleCallbackHandler","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The newly created group members.","name":"entries"}],"see":["Phaser.Physics.Arcade.StaticGroup#refresh"],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#createMultipleCallbackHandler","scope":"instance","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":160,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Resets each Body to the position of its parent Game Object.\nBody sizes aren't changed (use {@link Phaser.Physics.Arcade.Components.Enable#refreshBody} for that).","kind":"function","name":"refresh","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticGroup"]},"description":"This group."}],"see":["Phaser.Physics.Arcade.StaticBody#reset"],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#refresh","scope":"instance","___s":true},{"meta":{"range":[180,204],"filename":"World.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"World.js","lineno":35,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"The Arcade Physics World.\n\nThe World is responsible for creating, managing, colliding and updating all of the bodies within it.\n\nAn instance of the World belongs to a Phaser.Scene and is accessed via the property `physics.world`.","kind":"class","name":"World","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this World instance belongs.","name":"scene"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeWorldConfig"]},"description":"An Arcade Physics Configuration object.","name":"config"}],"scope":"static","longname":"Phaser.Physics.Arcade.World","___s":true},{"meta":{"filename":"World.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Scene this simulation belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Dynamic Bodies in this simulation.","name":"bodies","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#bodies","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Static Bodies in this simulation.","name":"staticBodies","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#staticBodies","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Static Bodies marked for deletion.","name":"pendingDestroy","type":{"names":["Phaser.Structs.Set.<(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody)>"]},"since":"3.1.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#pendingDestroy","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This simulation's collision processors.","name":"colliders","type":{"names":["Phaser.Structs.ProcessQueue."]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#colliders","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Acceleration of Bodies due to gravity, in pixels per second.","name":"gravity","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#gravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A boundary constraining Bodies.","name":"bounds","type":{"names":["Phaser.Geom.Rectangle"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#bounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The boundary edges that Bodies can collide with.","name":"checkCollision","type":{"names":["Phaser.Types.Physics.Arcade.CheckCollisionObject"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#checkCollision","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The number of physics steps to be taken per second.\n\nThis property is read-only. Use the `setFPS` method to modify it at run-time.","name":"fps","readonly":true,"type":{"names":["number"]},"defaultvalue":"60","since":"3.10.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#fps","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The number of steps that took place in the last frame.","name":"stepsLastFrame","readonly":true,"type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#stepsLastFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":197,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Scaling factor applied to the frame rate.\n\n- 1.0 = normal speed\n- 2.0 = half speed\n- 0.5 = double speed","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.10.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The maximum absolute difference of a Body's per-step velocity and its overlap with another Body that will result in separation on *each axis*.\nLarger values favor separation.\nSmaller values favor no separation.","name":"OVERLAP_BIAS","type":{"names":["number"]},"defaultvalue":"4","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#OVERLAP_BIAS","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":223,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The maximum absolute value of a Body's overlap with a tile that will result in separation on *each axis*.\nLarger values favor separation.\nSmaller values favor no separation.\nThe optimum value may be similar to the tile size.","name":"TILE_BIAS","type":{"names":["number"]},"defaultvalue":"16","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#TILE_BIAS","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":236,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Always separate overlapping Bodies horizontally before vertically.\nFalse (the default) means Bodies are first separated on the axis of greater gravity, or the vertical axis if neither is greater.","name":"forceX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#forceX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":247,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation advances with the game loop.","name":"isPaused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#isPaused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":268,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Enables the debug display.","name":"drawDebug","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#drawDebug","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":278,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The graphics object drawing the debug display.","name":"debugGraphic","type":{"names":["Phaser.GameObjects.Graphics"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#debugGraphic","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":287,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Default debug display settings for new Bodies.","name":"defaults","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeWorldDefaults"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#defaults","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":303,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The maximum number of items per node on the RTree.\n\nThis is ignored if `useTree` is `false`. If you have a large number of bodies in\nyour world then you may find search performance improves by increasing this value,\nto allow more items per node and less node division.","name":"maxEntries","type":{"names":["integer"]},"defaultvalue":"16","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#maxEntries","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":317,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Should this Arcade Physics World use an RTree for Dynamic and Static Physics bodies?\n\nAn RTree is a fast way of spatially sorting of all the bodies in the world.\nHowever, at certain limits, the cost of clearing and inserting the bodies into the\ntree every frame becomes more expensive than the search speed gains it provides.\n\nIf you have a large number of dynamic bodies in your world then it may be best to\ndisable the use of the RTree by setting this property to `false` in the physics config.\n\nThe number it can cope with depends on browser and device, but a conservative estimate\nof around 5,000 bodies should be considered the max before disabling it.\n\nThis only applies to dynamic bodies. Static bodies are always kept in an RTree,\nbecause they don't have to be cleared every frame, so you benefit from the\nmassive search speeds all the time.","name":"useTree","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.10.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#useTree","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":341,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The spatial index of Dynamic Bodies.","name":"tree","type":{"names":["Phaser.Structs.RTree"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#tree","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":350,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The spatial index of Static Bodies.","name":"staticTree","type":{"names":["Phaser.Structs.RTree"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#staticTree","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":359,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Recycled input for tree searches.","name":"treeMinMax","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeWorldTreeMinMax"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#treeMinMax","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":394,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Adds an Arcade Physics Body to a Game Object, an array of Game Objects, or the children of a Group.\n\nThe difference between this and the `enableBody` method is that you can pass arrays or Groups\nto this method.\n\nYou can specify if the bodies are to be Dynamic or Static. A dynamic body can move via velocity and\nacceleration. A static body remains fixed in place and as such is able to use an optimized search\ntree, making it ideal for static elements such as level objects. You can still collide and overlap\nwith static bodies.\n\nNormally, rather than calling this method directly, you'd use the helper methods available in the\nArcade Physics Factory, such as:\n\n```javascript\nthis.physics.add.image(x, y, textureKey);\nthis.physics.add.sprite(x, y, textureKey);\n```\n\nCalling factory methods encapsulates the creation of a Game Object and the creation of its\nbody at the same time. If you are creating custom classes then you can pass them to this\nmethod to have their bodies created.","kind":"function","name":"enable","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group","Array."]},"description":"The object, or objects, on which to create the bodies.","name":"object"},{"type":{"names":["integer"]},"optional":true,"description":"The type of Body to create. Either `DYNAMIC_BODY` or `STATIC_BODY`.","name":"bodyType"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#enable","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":462,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates an Arcade Physics Body on a single Game Object.\n\nIf the Game Object already has a body, this method will simply add it back into the simulation.\n\nYou can specify if the body is Dynamic or Static. A dynamic body can move via velocity and\nacceleration. A static body remains fixed in place and as such is able to use an optimized search\ntree, making it ideal for static elements such as level objects. You can still collide and overlap\nwith static bodies.\n\nNormally, rather than calling this method directly, you'd use the helper methods available in the\nArcade Physics Factory, such as:\n\n```javascript\nthis.physics.add.image(x, y, textureKey);\nthis.physics.add.sprite(x, y, textureKey);\n```\n\nCalling factory methods encapsulates the creation of a Game Object and the creation of its\nbody at the same time. If you are creating custom classes then you can pass them to this\nmethod to have their bodies created.","kind":"function","name":"enableBody","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object on which to create the body.","name":"object"},{"type":{"names":["integer"]},"optional":true,"description":"The type of Body to create. Either `DYNAMIC_BODY` or `STATIC_BODY`.","name":"bodyType"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object on which the body was created."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#enableBody","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Adds an existing Arcade Physics Body or StaticBody to the simulation.\n\nThe body is enabled and added to the local search trees.","kind":"function","name":"add","since":"3.10.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The Body to be added to the simulation.","name":"body"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The Body that was added to the simulation."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#add","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":543,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Disables the Arcade Physics Body of a Game Object, an array of Game Objects, or the children of a Group.\n\nThe difference between this and the `disableBody` method is that you can pass arrays or Groups\nto this method.\n\nThe body itself is not deleted, it just has its `enable` property set to false, which\nmeans you can re-enable it again at any point by passing it to enable `World.enable` or `World.add`.","kind":"function","name":"disable","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group","Array."]},"description":"The object, or objects, on which to disable the bodies.","name":"object"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#disable","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":594,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Disables an existing Arcade Physics Body or StaticBody and removes it from the simulation.\n\nThe body is disabled and removed from the local search trees.\n\nThe body itself is not deleted, it just has its `enable` property set to false, which\nmeans you can re-enable it again at any point by passing it to enable `World.enable` or `World.add`.","kind":"function","name":"disableBody","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The Body to be disabled.","name":"body"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#disableBody","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":614,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Removes an existing Arcade Physics Body or StaticBody from the simulation.\n\nThe body is disabled and removed from the local search trees.\n\nThe body itself is not deleted, it just has its `enabled` property set to false, which\nmeans you can re-enable it again at any point by passing it to enable `enable` or `add`.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The body to be removed from the simulation.","name":"body"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#remove","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":641,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a Graphics Game Object that the world will use to render the debug display to.\n\nThis is called automatically when the World is instantiated if the `debug` config property\nwas set to `true`. However, you can call it at any point should you need to display the\ndebug Graphic from a fixed point.\n\nYou can control which objects are drawn to the Graphics object, and the colors they use,\nby setting the debug properties in the physics config.\n\nYou should not typically use this in a production game. Use it to aid during debugging.","kind":"function","name":"createDebugGraphic","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object that was created for use by the World."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#createDebugGraphic","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":671,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the position, size and properties of the World boundary.\n\nThe World boundary is an invisible rectangle that defines the edges of the World.\nIf a Body is set to collide with the world bounds then it will automatically stop\nwhen it reaches any of the edges. You can optionally set which edges of the boundary\nshould be checked against.","kind":"function","name":"setBounds","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the boundary.","name":"x"},{"type":{"names":["number"]},"description":"The top-left y coordinate of the boundary.","name":"y"},{"type":{"names":["number"]},"description":"The width of the boundary.","name":"width"},{"type":{"names":["number"]},"description":"The height of the boundary.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"description":"Should bodies check against the left edge of the boundary?","name":"checkLeft"},{"type":{"names":["boolean"]},"optional":true,"description":"Should bodies check against the right edge of the boundary?","name":"checkRight"},{"type":{"names":["boolean"]},"optional":true,"description":"Should bodies check against the top edge of the boundary?","name":"checkUp"},{"type":{"names":["boolean"]},"optional":true,"description":"Should bodies check against the bottom edge of the boundary?","name":"checkDown"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#setBounds","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":705,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Enables or disables collisions on each edge of the World boundary.","kind":"function","name":"setBoundsCollision","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should bodies check against the left edge of the boundary?","name":"left"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should bodies check against the right edge of the boundary?","name":"right"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should bodies check against the top edge of the boundary?","name":"up"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should bodies check against the bottom edge of the boundary?","name":"down"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#setBoundsCollision","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":733,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Pauses the simulation.\n\nA paused simulation does not update any existing bodies, or run any Colliders.\n\nHowever, you can still enable and disable bodies within it, or manually run collide or overlap\nchecks.","kind":"function","name":"pause","fires":["Phaser.Physics.Arcade.Events#event:PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#pause","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":756,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Resumes the simulation, if paused.","kind":"function","name":"resume","fires":["Phaser.Physics.Arcade.Events#event:RESUME"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#resume","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":774,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Collider object and adds it to the simulation.\n\nA Collider is a way to automatically perform collision checks between two objects,\ncalling the collide and process callbacks if they occur.\n\nColliders are run as part of the World update, after all of the Bodies have updated.\n\nBy creating a Collider you don't need then call `World.collide` in your `update` loop,\nas it will be handled for you automatically.","kind":"function","name":"addCollider","since":"3.0.0","see":["Phaser.Physics.Arcade.World#collide"],"params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object to check for collision.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The second object to check for collision.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects collide. Must return a boolean.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The scope in which to call the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Collider"]},"description":"The Collider that was created."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#addCollider","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":810,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Overlap Collider object and adds it to the simulation.\n\nA Collider is a way to automatically perform overlap checks between two objects,\ncalling the collide and process callbacks if they occur.\n\nColliders are run as part of the World update, after all of the Bodies have updated.\n\nBy creating a Collider you don't need then call `World.overlap` in your `update` loop,\nas it will be handled for you automatically.","kind":"function","name":"addOverlap","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object to check for overlap.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The second object to check for overlap.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects overlap.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects overlap. Must return a boolean.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The scope in which to call the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Collider"]},"description":"The Collider that was created."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#addOverlap","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":845,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Removes a Collider from the simulation so it is no longer processed.\n\nThis method does not destroy the Collider. If you wish to add it back at a later stage you can call\n`World.colliders.add(Collider)`.\n\nIf you no longer need the Collider you can call the `Collider.destroy` method instead, which will\nautomatically clear all of its references and then remove it from the World. If you call destroy on\na Collider you _don't_ need to pass it to this method too.","kind":"function","name":"removeCollider","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Collider"]},"description":"The Collider to remove from the simulation.","name":"collider"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#removeCollider","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":869,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the frame rate to run the simulation at.\n\nThe frame rate value is used to simulate a fixed update time step. This fixed\ntime step allows for a straightforward implementation of a deterministic game state.\n\nThis frame rate is independent of the frequency at which the game is rendering. The\nhigher you set the fps, the more physics simulation steps will occur per game step.\nConversely, the lower you set it, the less will take place.\n\nYou can optionally advance the simulation directly yourself by calling the `step` method.","kind":"function","name":"setFPS","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The frame rate to advance the simulation at.","name":"framerate"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#setFPS","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":978,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Advances the simulation by a time increment.","kind":"function","name":"step","fires":["Phaser.Physics.Arcade.Events#event:WORLD_STEP"],"since":"3.10.0","params":[{"type":{"names":["number"]},"description":"The delta time amount, in seconds, by which to advance the simulation.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#step","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1030,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Updates bodies, draws the debug display, and handles pending queue operations.","kind":"function","name":"postUpdate","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#postUpdate","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Calculates a Body's velocity and updates its position.","kind":"function","name":"updateMotion","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body to be updated.","name":"body"},{"type":{"names":["number"]},"description":"The delta value to be used in the motion calculations, in seconds.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#updateMotion","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1144,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Calculates a Body's angular velocity.","kind":"function","name":"computeAngularVelocity","since":"3.10.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body to compute the velocity for.","name":"body"},{"type":{"names":["number"]},"description":"The delta value to be used in the calculation, in seconds.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#computeAngularVelocity","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Calculates a Body's per-axis velocity.","kind":"function","name":"computeVelocity","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body to compute the velocity for.","name":"body"},{"type":{"names":["number"]},"description":"The delta value to be used in the calculation, in seconds.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#computeVelocity","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1313,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Separates two Bodies.","kind":"function","name":"separate","fires":["Phaser.Physics.Arcade.Events#event:COLLIDE","Phaser.Physics.Arcade.Events#event:OVERLAP"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first Body to be separated.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second Body to be separated.","name":"body2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The process callback.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The context in which to invoke the callback.","name":"callbackContext"},{"type":{"names":["boolean"]},"optional":true,"description":"If this a collide or overlap check?","name":"overlapOnly"}],"returns":[{"type":{"names":["boolean"]},"description":"True if separation occurred, otherwise false."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#separate","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Separates two Bodies, when both are circular.","kind":"function","name":"separateCircle","fires":["Phaser.Physics.Arcade.Events#event:COLLIDE","Phaser.Physics.Arcade.Events#event:OVERLAP"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first Body to be separated.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second Body to be separated.","name":"body2"},{"type":{"names":["boolean"]},"optional":true,"description":"If this a collide or overlap check?","name":"overlapOnly"},{"type":{"names":["number"]},"optional":true,"description":"A small value added to the calculations.","name":"bias"}],"returns":[{"type":{"names":["boolean"]},"description":"True if separation occurred, otherwise false."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#separateCircle","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1560,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Checks to see if two Bodies intersect at all.","kind":"function","name":"intersects","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first body to check.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second body to check.","name":"body2"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the two bodies intersect, otherwise false."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#intersects","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Tests if a circular Body intersects with another Body.","kind":"function","name":"circleBodyIntersects","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The circular body to test.","name":"circle"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The rectangular body to test.","name":"body"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the two bodies intersect, otherwise false."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#circleBodyIntersects","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1630,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Tests if Game Objects overlap.","kind":"function","name":"overlap","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object or array of objects to check.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"optional":true,"description":"The second object or array of objects to check, or `undefined`.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects overlap.","name":"overlapCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they overlap. If this is set then `overlapCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if at least one Game Object overlaps another."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#overlap","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1653,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Performs a collision check and separation between the two physics enabled objects given, which can be single\nGame Objects, arrays of Game Objects, Physics Groups, arrays of Physics Groups or normal Groups.\n\nIf you don't require separation then use {@link #overlap} instead.\n\nIf two Groups or arrays are passed, each member of one will be tested against each member of the other.\n\nIf **only** one Group is passed (as `object1`), each member of the Group will be collided against the other members.\n\nIf **only** one Array is passed, the array is iterated and every element in it is tested against the others.\n\nTwo callbacks can be provided. The `collideCallback` is invoked if a collision occurs and the two colliding\nobjects are passed to it.\n\nArcade Physics uses the Projection Method of collision resolution and separation. While it's fast and suitable\nfor 'arcade' style games it lacks stability when multiple objects are in close proximity or resting upon each other.\nThe separation that stops two objects penetrating may create a new penetration against a different object. If you\nrequire a high level of stability please consider using an alternative physics system, such as Matter.js.","kind":"function","name":"collide","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object or array of objects to check.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"optional":true,"description":"The second object or array of objects to check, or `undefined`.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if any overlapping Game Objects were separated, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#collide","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2039,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This advanced method is specifically for testing for collision between a single Sprite and an array of Tile objects.\n\nYou should generally use the `collide` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\ntile filtering and culling for you, as well as handle the interesting face collision automatically.\n\nThis method is offered for those who would like to check for collision with specific Tiles in a layer, without\nhaving to set any collision attributes on the tiles in question. This allows you to perform quick dynamic collisions\non small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\nyou should filter them before passing them to this method.\n\nImportant: Use of this method skips the `interesting faces` system that Tilemap Layers use. This means if you have\nsay a row or column of tiles, and you jump into, or walk over them, it's possible to get stuck on the edges of the\ntiles as the interesting face calculations are skipped. However, for quick-fire small collision set tests on\ndynamic maps, this method can prove very useful.","kind":"function","name":"collideTiles","fires":["Phaser.Physics.Arcade.Events#event:TILE_COLLIDE"],"since":"3.17.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first object to check for collision.","name":"sprite"},{"type":{"names":["Array."]},"description":"An array of Tiles to check for collision against.","name":"tiles"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#collideTiles","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2079,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This advanced method is specifically for testing for overlaps between a single Sprite and an array of Tile objects.\n\nYou should generally use the `overlap` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\ntile filtering and culling for you, as well as handle the interesting face collision automatically.\n\nThis method is offered for those who would like to check for overlaps with specific Tiles in a layer, without\nhaving to set any collision attributes on the tiles in question. This allows you to perform quick dynamic overlap\ntests on small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\nyou should filter them before passing them to this method.","kind":"function","name":"overlapTiles","fires":["Phaser.Physics.Arcade.Events#event:TILE_OVERLAP"],"since":"3.17.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first object to check for collision.","name":"sprite"},{"type":{"names":["Array."]},"description":"An array of Tiles to check for collision against.","name":"tiles"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects overlap.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#overlapTiles","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Internal handler for Sprite vs. Tilemap collisions.\nPlease use Phaser.Physics.Arcade.World#collide instead.","kind":"function","name":"collideSpriteVsTilemapLayer","fires":["Phaser.Physics.Arcade.Events#event:TILE_COLLIDE","Phaser.Physics.Arcade.Events#event:TILE_OVERLAP"],"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first object to check for collision.","name":"sprite"},{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"description":"The second object to check for collision.","name":"tilemapLayer"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"},{"type":{"names":["boolean"]},"optional":true,"description":"Whether this is a collision or overlap check.","name":"overlapOnly"}],"returns":[{"type":{"names":["boolean"]},"description":"True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#collideSpriteVsTilemapLayer","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2286,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Wrap an object's coordinates (or several objects' coordinates) within {@link Phaser.Physics.Arcade.World#bounds}.\n\nIf the object is outside any boundary edge (left, top, right, bottom), it will be moved to the same offset from the opposite edge (the interior).","kind":"function","name":"wrap","since":"3.3.0","params":[{"type":{"names":["*"]},"description":"A Game Object, a Group, an object with `x` and `y` coordinates, or an array of such objects.","name":"object"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"An amount added to each boundary edge during the operation.","name":"padding"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#wrap","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2317,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Wrap each object's coordinates within {@link Phaser.Physics.Arcade.World#bounds}.","kind":"function","name":"wrapArray","since":"3.3.0","params":[{"type":{"names":["Array.<*>"]},"description":"An array of objects to be wrapped.","name":"objects"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"An amount added to the boundary.","name":"padding"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#wrapArray","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2334,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Wrap an object's coordinates within {@link Phaser.Physics.Arcade.World#bounds}.","kind":"function","name":"wrapObject","since":"3.3.0","params":[{"type":{"names":["*"]},"description":"A Game Object, a Physics Body, or any object with `x` and `y` coordinates","name":"object"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"An amount added to the boundary.","name":"padding"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#wrapObject","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Shuts down the simulation, clearing physics data and removing listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#shutdown","scope":"instance","overrides":"Phaser.Events.EventEmitter#shutdown","___s":true},{"meta":{"filename":"World.js","lineno":2368,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Shuts down the simulation and disconnects it from the current scene.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"Acceleration.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the acceleration properties of an Arcade Physics Body.","kind":"namespace","name":"Acceleration","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Acceleration","scope":"static","___s":true},{"meta":{"filename":"Acceleration.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal and vertical acceleration. If the vertical acceleration value is not provided, the vertical acceleration is set to the same value as the horizontal acceleration.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal acceleration","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical acceleration","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Acceleration"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Acceleration","longname":"Phaser.Physics.Arcade.Components.Acceleration#setAcceleration","scope":"instance","___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal acceleration.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal acceleration","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Acceleration"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Acceleration","longname":"Phaser.Physics.Arcade.Components.Acceleration#setAccelerationX","scope":"instance","___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's vertical acceleration.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical acceleration","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Acceleration"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Acceleration","longname":"Phaser.Physics.Arcade.Components.Acceleration#setAccelerationY","scope":"instance","___s":true},{"meta":{"filename":"Angular.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the angular acceleration properties of an Arcade Physics Body.","kind":"namespace","name":"Angular","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Angular","scope":"static","___s":true},{"meta":{"filename":"Angular.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular velocity of the body.\n\nIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\nHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\ncausing them to visually rotate, even though the body remains axis-aligned.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Angular"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Angular","longname":"Phaser.Physics.Arcade.Components.Angular#setAngularVelocity","scope":"instance","___s":true},{"meta":{"filename":"Angular.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular acceleration of the body.\n\nIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\nHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\ncausing them to visually rotate, even though the body remains axis-aligned.","kind":"function","name":"setAngularAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of angular acceleration.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Angular"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Angular","longname":"Phaser.Physics.Arcade.Components.Angular#setAngularAcceleration","scope":"instance","___s":true},{"meta":{"filename":"Angular.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular drag of the body. Drag is applied to the current velocity, providing a form of deceleration.","kind":"function","name":"setAngularDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of drag.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Angular"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Angular","longname":"Phaser.Physics.Arcade.Components.Angular#setAngularDrag","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the bounce properties of an Arcade Physics Body.","kind":"namespace","name":"Bounce","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Bounce","scope":"static","___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the bounce values of this body.\n\nBounce is the amount of restitution, or elasticity, the body has when it collides with another object.\nA value of 1 means that it will retain its full velocity after the rebound. A value of 0 means it will not rebound at all.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Bounce"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Bounce","longname":"Phaser.Physics.Arcade.Components.Bounce#setBounce","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the horizontal bounce value for this body.","kind":"function","name":"setBounceX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Bounce"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Bounce","longname":"Phaser.Physics.Arcade.Components.Bounce#setBounceX","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the vertical bounce value for this body.","kind":"function","name":"setBounceY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Bounce"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Bounce","longname":"Phaser.Physics.Arcade.Components.Bounce#setBounceY","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets whether this Body collides with the world boundary.\n\nOptionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.","kind":"function","name":"setCollideWorldBounds","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if this body should collide with the world bounds, otherwise `false`.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.x` value.","name":"bounceX"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.y` value.","name":"bounceY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Bounce"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Bounce","longname":"Phaser.Physics.Arcade.Components.Bounce#setCollideWorldBounds","scope":"instance","___s":true},{"meta":{"filename":"Debug.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the debug properties of an Arcade Physics Body.","kind":"namespace","name":"Debug","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Debug","scope":"static","___s":true},{"meta":{"filename":"Debug.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the debug values of this body.\n\nBodies will only draw their debug if debug has been enabled for Arcade Physics as a whole.\nNote that there is a performance cost in drawing debug displays. It should never be used in production.","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` to have this body render its outline to the debug display.","name":"showBody"},{"type":{"names":["boolean"]},"description":"Set to `true` to have this body render a velocity marker to the debug display.","name":"showVelocity"},{"type":{"names":["number"]},"description":"The color of the body outline when rendered to the debug display.","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Debug"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Debug","longname":"Phaser.Physics.Arcade.Components.Debug#setDebug","scope":"instance","___s":true},{"meta":{"filename":"Debug.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the color of the body outline when it renders to the debug display.","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The color of the body outline when rendered to the debug display.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Debug"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Debug","longname":"Phaser.Physics.Arcade.Components.Debug#setDebugBodyColor","scope":"instance","___s":true},{"meta":{"filename":"Debug.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set to `true` to have this body render its outline to the debug display.","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components.Debug","longname":"Phaser.Physics.Arcade.Components.Debug#debugShowBody","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Debug.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set to `true` to have this body render a velocity marker to the debug display.","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components.Debug","longname":"Phaser.Physics.Arcade.Components.Debug#debugShowVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Debug.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"The color of the body outline when it renders to the debug display.","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components.Debug","longname":"Phaser.Physics.Arcade.Components.Debug#debugBodyColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Drag.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the drag properties of an Arcade Physics Body.","kind":"namespace","name":"Drag","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Drag","scope":"static","___s":true},{"meta":{"filename":"Drag.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal and vertical drag. If the vertical drag value is not provided, the vertical drag is set to the same value as the horizontal drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal drag to apply.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical drag to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Drag"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Drag","longname":"Phaser.Physics.Arcade.Components.Drag#setDrag","scope":"instance","___s":true},{"meta":{"filename":"Drag.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDragX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal drag to apply.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Drag"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Drag","longname":"Phaser.Physics.Arcade.Components.Drag#setDragX","scope":"instance","___s":true},{"meta":{"filename":"Drag.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's vertical drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDragY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of vertical drag to apply.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Drag"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Drag","longname":"Phaser.Physics.Arcade.Components.Drag#setDragY","scope":"instance","___s":true},{"meta":{"filename":"Drag.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"If this Body is using `drag` for deceleration this function controls how the drag is applied.\nIf set to `true` drag will use a damping effect rather than a linear approach. If you are\ncreating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\nthe game Asteroids) then you will get a far smoother and more visually correct deceleration\nby using damping, avoiding the axis-drift that is prone with linear deceleration.\n\nIf you enable this property then you should use far smaller `drag` values than with linear, as\nthey are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\ndeceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.","kind":"function","name":"setDamping","since":"3.10.0","params":[{"type":{"names":["boolean"]},"description":"`true` to use damping for deceleration, or `false` to use linear deceleration.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Drag"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Drag","longname":"Phaser.Physics.Arcade.Components.Drag#setDamping","scope":"instance","___s":true},{"meta":{"filename":"Enable.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the enable properties of an Arcade Physics Body.","kind":"namespace","name":"Enable","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Enable","scope":"static","___s":true},{"meta":{"filename":"Enable.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Enables this Game Object's Body.","kind":"function","name":"enableBody","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Also reset the Body and place it at (x, y).","name":"reset"},{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"x"},{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"y"},{"type":{"names":["boolean"]},"description":"Also activate this Game Object.","name":"enableGameObject"},{"type":{"names":["boolean"]},"description":"Also show this Game Object.","name":"showGameObject"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Enable"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.Body#enable","Phaser.Physics.Arcade.StaticBody#enable","Phaser.Physics.Arcade.Body#reset","Phaser.Physics.Arcade.StaticBody#reset","Phaser.GameObjects.GameObject#active","Phaser.GameObjects.GameObject#visible"],"memberof":"Phaser.Physics.Arcade.Components.Enable","longname":"Phaser.Physics.Arcade.Components.Enable#enableBody","scope":"instance","___s":true},{"meta":{"filename":"Enable.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Stops and disables this Game Object's Body.","kind":"function","name":"disableBody","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also deactivate this Game Object.","name":"disableGameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also hide this Game Object.","name":"hideGameObject"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Enable"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.Body#enable","Phaser.Physics.Arcade.StaticBody#enable","Phaser.GameObjects.GameObject#active","Phaser.GameObjects.GameObject#visible"],"memberof":"Phaser.Physics.Arcade.Components.Enable","longname":"Phaser.Physics.Arcade.Components.Enable#disableBody","scope":"instance","___s":true},{"meta":{"filename":"Enable.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Syncs the Body's position and size with its parent Game Object.\nYou don't need to call this for Dynamic Bodies, as it happens automatically.\nBut for Static bodies it's a useful way of modifying the position of a Static Body\nin the Physics World, based on its Game Object.","kind":"function","name":"refreshBody","since":"3.1.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Enable"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.StaticBody#updateFromGameObject"],"memberof":"Phaser.Physics.Arcade.Components.Enable","longname":"Phaser.Physics.Arcade.Components.Enable#refreshBody","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving horizontally in the X axis. The higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"namespace","name":"Friction","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Friction","scope":"static","___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal friction to apply.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical friction to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Friction"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Friction","longname":"Phaser.Physics.Arcade.Components.Friction#setFriction","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving horizontally in the X axis.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of friction to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Friction"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Friction","longname":"Phaser.Physics.Arcade.Components.Friction#setFrictionX","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving vertically in the Y axis.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of friction to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Friction"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Friction","longname":"Phaser.Physics.Arcade.Components.Friction#setFrictionY","scope":"instance","___s":true},{"meta":{"filename":"Gravity.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods for setting the gravity properties of an Arcade Physics Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Gravity","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Gravity","scope":"static","___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the X and Y values of the gravitational pull to act upon this Arcade Physics Game Object. Values can be positive or negative. Larger values result in a stronger effect.\n\nIf only one value is provided, this value will be used for both the X and Y axis.","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the X-axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The gravitational force to be applied to the Y-axis. If this is not specified, the X value will be used.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Gravity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Gravity","longname":"Phaser.Physics.Arcade.Components.Gravity#setGravity","scope":"instance","___s":true},{"meta":{"filename":"Gravity.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the gravitational force to be applied to the X axis. Value can be positive or negative. Larger values result in a stronger effect.","kind":"function","name":"setGravityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the X-axis.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Gravity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Gravity","longname":"Phaser.Physics.Arcade.Components.Gravity#setGravityX","scope":"instance","___s":true},{"meta":{"filename":"Gravity.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the gravitational force to be applied to the Y axis. Value can be positive or negative. Larger values result in a stronger effect.","kind":"function","name":"setGravityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the Y-axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Gravity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Gravity","longname":"Phaser.Physics.Arcade.Components.Gravity#setGravityY","scope":"instance","___s":true},{"meta":{"filename":"Immovable.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the immovable properties of an Arcade Physics Body.","kind":"namespace","name":"Immovable","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Immovable","scope":"static","___s":true},{"meta":{"filename":"Immovable.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets Whether this Body can be moved by collisions with another Body.","kind":"function","name":"setImmovable","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets if this body can be moved by collisions with another Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Immovable"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Immovable","longname":"Phaser.Physics.Arcade.Components.Immovable#setImmovable","scope":"instance","___s":true},{"meta":{"filename":"Mass.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the mass properties of an Arcade Physics Body.","kind":"namespace","name":"Mass","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Mass","scope":"static","___s":true},{"meta":{"filename":"Mass.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the mass of the physics body","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"New value for the mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Mass"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Mass","longname":"Phaser.Physics.Arcade.Components.Mass#setMass","scope":"instance","___s":true},{"meta":{"filename":"OverlapCirc.js","lineno":6,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"This method will search the given circular area and return an array of all physics bodies that\noverlap with it. It can return either Dynamic, Static bodies or a mixture of both.\n\nA body only has to intersect with the search area to be considered, it doesn't have to be fully\ncontained within it.\n\nIf Arcade Physics is set to use the RTree (which it is by default) then the search is rather fast,\notherwise the search is O(N) for Dynamic Bodies.","kind":"function","name":"OverlapCirc","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the area to search within.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the area to search within.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the area to search within.","name":"radius"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the search include Dynamic Bodies?","name":"includeDynamic"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the search include Static Bodies?","name":"includeStatic"}],"returns":[{"type":{"names":["Array.","Array."]},"description":"An array of bodies that overlap with the given area."}],"memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.OverlapCirc","scope":"static","___s":true},{"meta":{"filename":"OverlapRect.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"This method will search the given rectangular area and return an array of all physics bodies that\noverlap with it. It can return either Dynamic, Static bodies or a mixture of both.\n\nA body only has to intersect with the search area to be considered, it doesn't have to be fully\ncontained within it.\n\nIf Arcade Physics is set to use the RTree (which it is by default) then the search for is extremely fast,\notherwise the search is O(N) for Dynamic Bodies.","kind":"function","name":"OverlapRect","since":"3.17.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the area to search within.","name":"x"},{"type":{"names":["number"]},"description":"The top-left y coordinate of the area to search within.","name":"y"},{"type":{"names":["number"]},"description":"The width of the area to search within.","name":"width"},{"type":{"names":["number"]},"description":"The height of the area to search within.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the search include Dynamic Bodies?","name":"includeDynamic"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the search include Static Bodies?","name":"includeStatic"}],"returns":[{"type":{"names":["Array.","Array."]},"description":"An array of bodies that overlap with the given area."}],"memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.OverlapRect","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods for setting the size of an Arcade Physics Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Size","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Size","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body offset. This allows you to adjust the difference between the center of the body\nand the x and y coordinates of the parent Game Object.","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to offset the body from the parent Game Object along the x-axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Size"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Size","longname":"Phaser.Physics.Arcade.Components.Size#setOffset","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the size of this physics body. Setting the size does not adjust the dimensions\nof the parent Game Object.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new width of the physics body, in pixels.","name":"width"},{"type":{"names":["number"]},"description":"The new height of the physics body, in pixels.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the body be re-positioned so its center aligns with the parent Game Object?","name":"center"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Size"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Size","longname":"Phaser.Physics.Arcade.Components.Size#setSize","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":55,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets this physics body to use a circle for collision instead of a rectangle.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the physics body, in pixels.","name":"radius"},{"type":{"names":["number"]},"optional":true,"description":"The amount to offset the body from the parent Game Object along the x-axis.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to offset the body from the parent Game Object along the y-axis.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Size"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Size","longname":"Phaser.Physics.Arcade.Components.Size#setCircle","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods for modifying the velocity of an Arcade Physics body.\n\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Velocity","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Velocity","scope":"static","___s":true},{"meta":{"filename":"Velocity.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the velocity of the Body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity of the body. Positive values move the body to the right, while negative values move it to the left.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity of the body. Positive values move the body down, while negative values move it up.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Velocity","longname":"Phaser.Physics.Arcade.Components.Velocity#setVelocity","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the horizontal component of the body's velocity.\n\nPositive values move the body to the right, while negative values move it to the left.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new horizontal velocity.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Velocity","longname":"Phaser.Physics.Arcade.Components.Velocity#setVelocityX","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the vertical component of the body's velocity.\n\nPositive values move the body down, while negative values move it up.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new vertical velocity of the body.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Velocity","longname":"Phaser.Physics.Arcade.Components.Velocity#setVelocityY","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the maximum velocity of the body.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new maximum horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The new maximum vertical velocity.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Velocity","longname":"Phaser.Physics.Arcade.Components.Velocity#setMaxVelocity","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"kind":"namespace","name":"Components","memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.Components","scope":"static","___s":true},{"meta":{"range":[229,2318],"filename":"const.js","lineno":13,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Arcade Physics consts.","ignore":true,"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Dynamic Body.","name":"DYNAMIC_BODY","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#physicsType","Phaser.Physics.Arcade.Group#physicsType"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.DYNAMIC_BODY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Static Body.","name":"STATIC_BODY","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#physicsType","Phaser.Physics.Arcade.StaticBody#physicsType"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.STATIC_BODY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":41,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Arcade Physics Group containing Dynamic Bodies.","name":"GROUP","readonly":true,"type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.GROUP","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":51,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A Tilemap Layer.","name":"TILEMAPLAYER","readonly":true,"type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.TILEMAPLAYER","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Facing no direction (initial value).","name":"FACING_NONE","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#facing"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.FACING_NONE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Facing up.","name":"FACING_UP","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#facing"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.FACING_UP","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Facing down.","name":"FACING_DOWN","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#facing"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.FACING_DOWN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Facing left.","name":"FACING_LEFT","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#facing"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.FACING_LEFT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Facing right.","name":"FACING_RIGHT","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#facing"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.FACING_RIGHT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"COLLIDE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics World Collide Event.\n\nThis event is dispatched by an Arcade Physics World instance if two bodies collide _and_ at least\none of them has their [onCollide]{@link Phaser.Physics.Arcade.Body#onCollide} property set to `true`.\n\nIt provides an alternative means to handling collide events rather than using the callback approach.\n\nListen to it from a Scene using: `this.physics.world.on('collide', listener)`.\n\nPlease note that 'collide' and 'overlap' are two different things in Arcade Physics.","kind":"event","name":"COLLIDE","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first Game Object involved in the collision. This is the parent of `body1`.","name":"gameObject1"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The second Game Object involved in the collision. This is the parent of `body2`.","name":"gameObject2"},{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The first Physics Body involved in the collision.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The second Physics Body involved in the collision.","name":"body2"}],"memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:COLLIDE","scope":"instance","___s":true},{"meta":{"filename":"OVERLAP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics World Overlap Event.\n\nThis event is dispatched by an Arcade Physics World instance if two bodies overlap _and_ at least\none of them has their [onOverlap]{@link Phaser.Physics.Arcade.Body#onOverlap} property set to `true`.\n\nIt provides an alternative means to handling overlap events rather than using the callback approach.\n\nListen to it from a Scene using: `this.physics.world.on('overlap', listener)`.\n\nPlease note that 'collide' and 'overlap' are two different things in Arcade Physics.","kind":"event","name":"OVERLAP","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first Game Object involved in the overlap. This is the parent of `body1`.","name":"gameObject1"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The second Game Object involved in the overlap. This is the parent of `body2`.","name":"gameObject2"},{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The first Physics Body involved in the overlap.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The second Physics Body involved in the overlap.","name":"body2"}],"memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:OVERLAP","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics World Pause Event.\n\nThis event is dispatched by an Arcade Physics World instance when it is paused.\n\nListen to it from a Scene using: `this.physics.world.on('pause', listener)`.","kind":"event","name":"PAUSE","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:PAUSE","scope":"instance","___s":true},{"meta":{"filename":"RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics World Resume Event.\n\nThis event is dispatched by an Arcade Physics World instance when it resumes from a paused state.\n\nListen to it from a Scene using: `this.physics.world.on('resume', listener)`.","kind":"event","name":"RESUME","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:RESUME","scope":"instance","___s":true},{"meta":{"filename":"TILE_COLLIDE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics Tile Collide Event.\n\nThis event is dispatched by an Arcade Physics World instance if a body collides with a Tile _and_\nhas its [onCollide]{@link Phaser.Physics.Arcade.Body#onCollide} property set to `true`.\n\nIt provides an alternative means to handling collide events rather than using the callback approach.\n\nListen to it from a Scene using: `this.physics.world.on('tilecollide', listener)`.\n\nPlease note that 'collide' and 'overlap' are two different things in Arcade Physics.","kind":"event","name":"TILE_COLLIDE","since":"3.16.1","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object involved in the collision. This is the parent of `body`.","name":"gameObject"},{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile the body collided with.","name":"tile"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Arcade Physics Body of the Game Object involved in the collision.","name":"body"}],"memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:TILE_COLLIDE","scope":"instance","___s":true},{"meta":{"filename":"TILE_OVERLAP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics Tile Overlap Event.\n\nThis event is dispatched by an Arcade Physics World instance if a body overlaps with a Tile _and_\nhas its [onOverlap]{@link Phaser.Physics.Arcade.Body#onOverlap} property set to `true`.\n\nIt provides an alternative means to handling overlap events rather than using the callback approach.\n\nListen to it from a Scene using: `this.physics.world.on('tileoverlap', listener)`.\n\nPlease note that 'collide' and 'overlap' are two different things in Arcade Physics.","kind":"event","name":"TILE_OVERLAP","since":"3.16.1","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object involved in the overlap. This is the parent of `body`.","name":"gameObject"},{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile the body overlapped.","name":"tile"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Arcade Physics Body of the Game Object involved in the overlap.","name":"body"}],"memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:TILE_OVERLAP","scope":"instance","___s":true},{"meta":{"filename":"WORLD_BOUNDS_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics World Bounds Event.\n\nThis event is dispatched by an Arcade Physics World instance if a body makes contact with the world bounds _and_\nit has its [onWorldBounds]{@link Phaser.Physics.Arcade.Body#onWorldBounds} property set to `true`.\n\nIt provides an alternative means to handling collide events rather than using the callback approach.\n\nListen to it from a Scene using: `this.physics.world.on('worldbounds', listener)`.","kind":"event","name":"WORLD_BOUNDS","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Arcade Physics Body that hit the world bounds.","name":"body"},{"type":{"names":["boolean"]},"description":"Is the Body blocked up? I.e. collided with the top of the world bounds.","name":"up"},{"type":{"names":["boolean"]},"description":"Is the Body blocked down? I.e. collided with the bottom of the world bounds.","name":"down"},{"type":{"names":["boolean"]},"description":"Is the Body blocked left? I.e. collided with the left of the world bounds.","name":"left"},{"type":{"names":["boolean"]},"description":"Is the Body blocked right? I.e. collided with the right of the world bounds.","name":"right"}],"memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:WORLD_BOUNDS","scope":"instance","___s":true},{"meta":{"filename":"WORLD_STEP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics World Step Event.\n\nThis event is dispatched by an Arcade Physics World instance whenever a physics step is run.\nIt is emitted _after_ the bodies and colliders have been updated.\n\nIn high framerate settings this can be multiple times per game frame.\n\nListen to it from a Scene using: `this.physics.world.on('worldstep', listener)`.","kind":"event","name":"WORLD_STEP","since":"3.18.0","memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:WORLD_STEP","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.Events","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"kind":"typedef","name":"ArcadePhysicsCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first Body to separate.","name":"object1"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The second Body to separate.","name":"object2"}],"longname":"ArcadePhysicsCallback","scope":"global","___s":true},{"meta":{"filename":"index.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"kind":"namespace","name":"Arcade","memberof":"Phaser.Physics","longname":"Phaser.Physics.Arcade","scope":"static","___s":true},{"meta":{"filename":"ProcessTileCallbacks.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"A function to process the collision callbacks between a single tile and an Arcade Physics enabled Game Object.","kind":"function","name":"ProcessTileCallbacks","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The Tile to process.","name":"tile"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"The Game Object to process with the Tile.","name":"sprite"}],"returns":[{"type":{"names":["boolean"]},"description":"The result of the callback, `true` for further processing, or `false` to skip this pair."}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.ProcessTileCallbacks","scope":"static","___s":true},{"meta":{"filename":"ProcessTileSeparationX.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"Internal function to process the separation of a physics body from a tile.","kind":"function","name":"ProcessTileSeparationX","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body object to separate.","name":"body"},{"type":{"names":["number"]},"description":"The x separation amount.","name":"x"}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.ProcessTileSeparationX","scope":"static","___s":true},{"meta":{"filename":"ProcessTileSeparationY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"Internal function to process the separation of a physics body from a tile.","kind":"function","name":"ProcessTileSeparationY","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body object to separate.","name":"body"},{"type":{"names":["number"]},"description":"The y separation amount.","name":"y"}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.ProcessTileSeparationY","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"SeparateTile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"name":"TileCheckX","longname":"TileCheckX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SeparateTile.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"The core separation function to separate a physics body and a tile.","kind":"function","name":"SeparateTile","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The index of the tile within the map data.","name":"i"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body object to separate.","name":"body"},{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile to collide against.","name":"tile"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A rectangle-like object defining the dimensions of the tile.","name":"tileWorldRect"},{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"description":"The tilemapLayer to collide against.","name":"tilemapLayer"},{"type":{"names":["number"]},"description":"The tile bias value. Populated by the `World.TILE_BIAS` constant.","name":"tileBias"},{"type":{"names":["boolean"]},"description":"Is this check coming from a TilemapLayer or an array of tiles?","name":"isLayer"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the body was separated, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.SeparateTile","scope":"static","___s":true},{"meta":{"range":[180,240],"filename":"TileCheckX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"name":"ProcessTileSeparationX","longname":"ProcessTileSeparationX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TileCheckX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"Check the body against the given tile on the X axis.\nUsed internally by the SeparateTile function.","kind":"function","name":"TileCheckX","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body object to separate.","name":"body"},{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile to check.","name":"tile"},{"type":{"names":["number"]},"description":"The left position of the tile within the tile world.","name":"tileLeft"},{"type":{"names":["number"]},"description":"The right position of the tile within the tile world.","name":"tileRight"},{"type":{"names":["number"]},"description":"The tile bias value. Populated by the `World.TILE_BIAS` constant.","name":"tileBias"},{"type":{"names":["boolean"]},"description":"Is this check coming from a TilemapLayer or an array of tiles?","name":"isLayer"}],"returns":[{"type":{"names":["number"]},"description":"The amount of separation that occurred."}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.TileCheckX","scope":"static","___s":true},{"meta":{"range":[180,240],"filename":"TileCheckY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"name":"ProcessTileSeparationY","longname":"ProcessTileSeparationY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TileCheckY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"Check the body against the given tile on the Y axis.\nUsed internally by the SeparateTile function.","kind":"function","name":"TileCheckY","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body object to separate.","name":"body"},{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile to check.","name":"tile"},{"type":{"names":["number"]},"description":"The top position of the tile within the tile world.","name":"tileTop"},{"type":{"names":["number"]},"description":"The bottom position of the tile within the tile world.","name":"tileBottom"},{"type":{"names":["number"]},"description":"The tile bias value. Populated by the `World.TILE_BIAS` constant.","name":"tileBias"},{"type":{"names":["boolean"]},"description":"Is this check coming from a TilemapLayer or an array of tiles?","name":"isLayer"}],"returns":[{"type":{"names":["number"]},"description":"The amount of separation that occurred."}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.TileCheckY","scope":"static","___s":true},{"meta":{"filename":"TileIntersectsBody.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"Checks for intersection between the given tile rectangle-like object and an Arcade Physics body.","kind":"function","name":"TileIntersectsBody","since":"3.0.0","params":[{"type":{"names":["Object"]},"description":"A rectangle object that defines the tile placement in the world.","name":"tileWorldRect"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The body to check for intersection against.","name":"body"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` of the tile intersects with the body, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.TileIntersectsBody","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"kind":"namespace","name":"Tilemap","memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.Tilemap","scope":"static","___s":true},{"meta":{"filename":"ArcadeBodyBounds.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"ArcadeBodyBounds","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The left edge.","name":"x"},{"type":{"names":["number"]},"description":"The upper edge.","name":"y"},{"type":{"names":["number"]},"description":"The right edge.","name":"right"},{"type":{"names":["number"]},"description":"The lower edge.","name":"bottom"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.ArcadeBodyBounds","scope":"static","___s":true},{"meta":{"filename":"ArcadeBodyCollision.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"ArcadeBodyCollision","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"True if the Body is not colliding.","name":"none"},{"type":{"names":["boolean"]},"description":"True if the Body is colliding on its upper edge.","name":"up"},{"type":{"names":["boolean"]},"description":"True if the Body is colliding on its lower edge.","name":"down"},{"type":{"names":["boolean"]},"description":"True if the Body is colliding on its left edge.","name":"left"},{"type":{"names":["boolean"]},"description":"True if the Body is colliding on its right edge.","name":"right"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.ArcadeBodyCollision","scope":"static","___s":true},{"meta":{"filename":"ArcadeColliderType.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"description":"An Arcade Physics Collider Type.","kind":"typedef","name":"ArcadeColliderType","type":{"names":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Group","Phaser.Physics.Arcade.Sprite","Phaser.Physics.Arcade.Image","Phaser.Physics.Arcade.StaticGroup","Phaser.Physics.Arcade.Group","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer","Array.","Array.","Array.","Array.","Array.","Array.","Array."]},"since":"3.0.0","memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.ArcadeColliderType","scope":"static","___s":true},{"meta":{"filename":"ArcadeWorldConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"ArcadeWorldConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"Sets {@link Phaser.Physics.Arcade.World#fps}.","name":"fps"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Sets {@link Phaser.Physics.Arcade.World#timeScale}.","name":"timeScale"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"Sets {@link Phaser.Physics.Arcade.World#gravity}.","name":"gravity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.World#bounds bounds.x}.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.World#bounds bounds.y}.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.World#bounds bounds.width}.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.World#bounds bounds.height}.","name":"height"},{"type":{"names":["Phaser.Types.Physics.Arcade.CheckCollisionObject"]},"optional":true,"description":"Sets {@link Phaser.Physics.Arcade.World#checkCollision}.","name":"checkCollision"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"Sets {@link Phaser.Physics.Arcade.World#OVERLAP_BIAS}.","name":"overlapBias"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16,"description":"Sets {@link Phaser.Physics.Arcade.World#TILE_BIAS}.","name":"tileBias"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets {@link Phaser.Physics.Arcade.World#forceX}.","name":"forceX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets {@link Phaser.Physics.Arcade.World#isPaused}.","name":"isPaused"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets {@link Phaser.Physics.Arcade.World#debug}.","name":"debug"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.World#defaults debugShowBody}.","name":"debugShowBody"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.World#defaults debugShowStaticBody}.","name":"debugShowStaticBody"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.World#defaults debugShowStaticBody}.","name":"debugShowVelocity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xff00ff","description":"Sets {@link Phaser.Physics.Arcade.World#defaults debugBodyColor}.","name":"debugBodyColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x0000ff","description":"Sets {@link Phaser.Physics.Arcade.World#defaults debugStaticBodyColor}.","name":"debugStaticBodyColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x00ff00","description":"Sets {@link Phaser.Physics.Arcade.World#defaults debugVelocityColor}.","name":"debugVelocityColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16,"description":"Sets {@link Phaser.Physics.Arcade.World#maxEntries}.","name":"maxEntries"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.World#useTree}.","name":"useTree"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.ArcadeWorldConfig","scope":"static","___s":true},{"meta":{"filename":"ArcadeWorldDefaults.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"ArcadeWorldDefaults","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Set to `true` to render dynamic body outlines to the debug display.","name":"debugShowBody"},{"type":{"names":["boolean"]},"description":"Set to `true` to render static body outlines to the debug display.","name":"debugShowStaticBody"},{"type":{"names":["boolean"]},"description":"Set to `true` to render body velocity markers to the debug display.","name":"debugShowVelocity"},{"type":{"names":["number"]},"description":"The color of dynamic body outlines when rendered to the debug display.","name":"bodyDebugColor"},{"type":{"names":["number"]},"description":"The color of static body outlines when rendered to the debug display.","name":"staticBodyDebugColor"},{"type":{"names":["number"]},"description":"The color of the velocity markers when rendered to the debug display.","name":"velocityDebugColor"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.ArcadeWorldDefaults","scope":"static","___s":true},{"meta":{"filename":"ArcadeWorldTreeMinMax.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"ArcadeWorldTreeMinMax","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The minimum x value used in RTree searches.","name":"minX"},{"type":{"names":["number"]},"description":"The minimum y value used in RTree searches.","name":"minY"},{"type":{"names":["number"]},"description":"The maximum x value used in RTree searches.","name":"maxX"},{"type":{"names":["number"]},"description":"The maximum y value used in RTree searches.","name":"maxY"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.ArcadeWorldTreeMinMax","scope":"static","___s":true},{"meta":{"filename":"CheckCollisionObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"CheckCollisionObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Will bodies collide with the top side of the world bounds?","name":"up"},{"type":{"names":["boolean"]},"description":"Will bodies collide with the bottom side of the world bounds?","name":"down"},{"type":{"names":["boolean"]},"description":"Will bodies collide with the left side of the world bounds?","name":"left"},{"type":{"names":["boolean"]},"description":"Will bodies collide with the right side of the world bounds?","name":"right"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.CheckCollisionObject","scope":"static","___s":true},{"meta":{"filename":"PhysicsGroupConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"PhysicsGroupConfig","type":{"names":["object"]},"augments":["Phaser.Types.GameObjects.Group.GroupConfig"],"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets {@link Phaser.Physics.Arcade.Body#collideWorldBounds}.","name":"collideWorldBounds"},{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"defaultvalue":null,"description":"Sets {@link Phaser.Physics.Arcade.Body#setBoundsRectangle setBoundsRectangle}.","name":"customBoundsRectangle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#acceleration acceleration.x}.","name":"accelerationX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#acceleration acceleration.y}.","name":"accelerationY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.Body#allowDrag}.","name":"allowDrag"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.Body#allowGravity}.","name":"allowGravity"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.Body#allowRotation}.","name":"allowRotation"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#bounce bounce.x}.","name":"bounceX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#bounce bounce.y}.","name":"bounceY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#drag drag.x}.","name":"dragX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#drag drag.y}.","name":"dragY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.Body#enable enable}.","name":"enable"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#gravity gravity.x}.","name":"gravityX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#gravity gravity.y}.","name":"gravityY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#friction friction.x}.","name":"frictionX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#friction friction.y}.","name":"frictionY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#velocity velocity.x}.","name":"velocityX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#velocity velocity.y}.","name":"velocityY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#angularVelocity}.","name":"angularVelocity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#angularAcceleration}.","name":"angularAcceleration"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#angularDrag}.","name":"angularDrag"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#mass}.","name":"mass"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets {@link Phaser.Physics.Arcade.Body#immovable}.","name":"immovable"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.PhysicsGroupConfig","scope":"static","___s":true},{"meta":{"filename":"PhysicsGroupDefaults.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"PhysicsGroupDefaults","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"As {@link Phaser.Physics.Arcade.Body#setCollideWorldBounds}.","name":"setCollideWorldBounds"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"As {@link Phaser.Physics.Arcade.Body#setBoundsRectangle}.","name":"setBoundsRectangle"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAccelerationX}.","name":"setAccelerationX"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAccelerationY}.","name":"setAccelerationY"},{"type":{"names":["boolean"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAllowDrag}.","name":"setAllowDrag"},{"type":{"names":["boolean"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAllowGravity}.","name":"setAllowGravity"},{"type":{"names":["boolean"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAllowRotation}.","name":"setAllowRotation"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setBounceX}.","name":"setBounceX"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setBounceY}.","name":"setBounceY"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setDragX}.","name":"setDragX"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setDragY}.","name":"setDragY"},{"type":{"names":["boolean"]},"description":"As {@link Phaser.Physics.Arcade.Body#setEnable}.","name":"setEnable"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setGravityX}.","name":"setGravityX"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setGravityY}.","name":"setGravityY"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setFrictionX}.","name":"setFrictionX"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setFrictionY}.","name":"setFrictionY"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setVelocityX}.","name":"setVelocityX"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setVelocityY}.","name":"setVelocityY"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAngularVelocity}.","name":"setAngularVelocity"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAngularAcceleration}.","name":"setAngularAcceleration"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAngularDrag}.","name":"setAngularDrag"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setMass}.","name":"setMass"},{"type":{"names":["boolean"]},"description":"As {@link Phaser.Physics.Arcade.Body#setImmovable}.","name":"setImmovable"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.PhysicsGroupDefaults","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"namespace","name":"Arcade","memberof":"Phaser.Types.Physics","longname":"Phaser.Types.Physics.Arcade","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Body.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Body.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"kind":"typedef","name":"BodyUpdateCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"body"}],"memberof":"Phaser.Types.Physics.Impact","longname":"Phaser.Types.Physics.Impact.BodyUpdateCallback","scope":"static","___s":true},{"meta":{"filename":"Body.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"An Impact.js compatible physics body.\nThis re-creates the properties you'd get on an Entity and the math needed to update them.","kind":"class","name":"Body","memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"[description]","name":"world"},{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16,"description":"[description]","name":"sx"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16,"description":"[description]","name":"sy"}],"scope":"static","longname":"Phaser.Physics.Impact.Body","___s":true},{"meta":{"filename":"Body.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"world","type":{"names":["Phaser.Physics.Impact.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"gameObject","type":{"names":["Phaser.GameObjects.GameObject"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#gameObject","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The ImpactBody, ImpactSprite or ImpactImage object that owns this Body, if any.","name":"parent","type":{"names":["Phaser.Physics.Impact.ImpactBody","Phaser.Physics.Impact.ImpactImage","Phaser.Physics.Impact.ImpactSprite"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"id","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#id","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"size","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#size","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"offset","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"pos","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#pos","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"last","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#last","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"vel","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#vel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"accel","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#accel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"friction","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#friction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"maxVel","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#maxVel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"standing","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#standing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":184,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"gravityFactor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#gravityFactor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":193,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"bounciness","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#bounciness","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":202,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"minBounceVelocity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#minBounceVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"accelGround","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#accelGround","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":221,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"accelAir","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#accelAir","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":231,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"jumpSpeed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#jumpSpeed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":241,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"type","type":{"names":["Phaser.Physics.Impact.TYPE"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":250,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"checkAgainst","type":{"names":["Phaser.Physics.Impact.TYPE"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#checkAgainst","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":259,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"collides","type":{"names":["Phaser.Physics.Impact.COLLIDES"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#collides","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":268,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#debugShowBody","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":277,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#debugShowVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":286,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"debugBodyColor","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#debugBodyColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":295,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"updateCallback","type":{"names":["Phaser.Types.Physics.Impact.BodyUpdateCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#updateCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":304,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"min 44 deg, max 136 deg","name":"slopeStanding","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#slopeStanding","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"reset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#reset","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":347,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#update","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"drawDebug","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"[description]","name":"graphic"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#drawDebug","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":419,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"willDrawDebug","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#willDrawDebug","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"skipHash","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#skipHash","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":445,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Determines whether the body collides with the `other` one or not.","kind":"function","name":"touches","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"other"}],"returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#touches","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Reset the size and position of the physics body.","kind":"function","name":"resetSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to position the body.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to position the body.","name":"y"},{"type":{"names":["number"]},"description":"The width of the body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the body.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#resetSize","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":488,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Export this body object to JSON.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Physics.Impact.JSONImpactBody"]},"description":"JSON representation of this body object."}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#toJSON","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":517,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"fromJSON","todo":["Code it!"],"since":"3.0.0","params":[{"type":{"names":["object"]},"description":"[description]","name":"config"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#fromJSON","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":530,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Can be overridden by user code","kind":"function","name":"check","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"other"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#check","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":542,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Can be overridden by user code","kind":"function","name":"collideWith","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"other"},{"type":{"names":["string"]},"description":"[description]","name":"axis"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#collideWith","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":559,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Can be overridden by user code but must return a boolean.","kind":"function","name":"handleMovementTrace","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"res"}],"returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#handleMovementTrace","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":574,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#destroy","scope":"instance","___s":true},{"meta":{"filename":"COLLIDES.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Collision Types - Determine if and how entities collide with each other.\n\nIn ACTIVE vs. LITE or FIXED vs. ANY collisions, only the \"weak\" entity moves,\nwhile the other one stays fixed. In ACTIVE vs. ACTIVE and ACTIVE vs. PASSIVE\ncollisions, both entities are moved. LITE or PASSIVE entities don't collide\nwith other LITE or PASSIVE entities at all. The behavior for FIXED vs.\nFIXED collisions is undefined.","kind":"namespace","name":"COLLIDES","memberof":"Phaser.Physics.Impact","since":"3.0.0","longname":"Phaser.Physics.Impact.COLLIDES","scope":"static","___s":true},{"meta":{"filename":"COLLIDES.js","lineno":23,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Never collides.","name":"NEVER","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.COLLIDES","longname":"Phaser.Physics.Impact.COLLIDES.NEVER","scope":"static","___s":true},{"meta":{"filename":"COLLIDES.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Lite collision.","name":"LITE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.COLLIDES","longname":"Phaser.Physics.Impact.COLLIDES.LITE","scope":"static","___s":true},{"meta":{"filename":"COLLIDES.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Passive collision.","name":"PASSIVE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.COLLIDES","longname":"Phaser.Physics.Impact.COLLIDES.PASSIVE","scope":"static","___s":true},{"meta":{"filename":"COLLIDES.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Active collision.","name":"ACTIVE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.COLLIDES","longname":"Phaser.Physics.Impact.COLLIDES.ACTIVE","scope":"static","___s":true},{"meta":{"filename":"COLLIDES.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Fixed collision.","name":"FIXED","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.COLLIDES","longname":"Phaser.Physics.Impact.COLLIDES.FIXED","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"CollisionMap.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CollisionMap.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"[description]","kind":"class","name":"CollisionMap","memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"[description]","name":"tilesize"},{"type":{"names":["array"]},"optional":true,"description":"[description]","name":"data"}],"scope":"static","longname":"Phaser.Physics.Impact.CollisionMap","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":30,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"tilesize","type":{"names":["integer"]},"defaultvalue":"32","since":"3.0.0","memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#tilesize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"data","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"lastSlope","type":{"names":["integer"]},"defaultvalue":"55","since":"3.0.0","memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#lastSlope","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"tiledef","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#tiledef","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"trace","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"description":"[description]","name":"vx"},{"type":{"names":["number"]},"description":"[description]","name":"vy"},{"type":{"names":["number"]},"description":"[description]","name":"objectWidth"},{"type":{"names":["number"]},"description":"[description]","name":"objectHeight"}],"returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#trace","scope":"instance","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":156,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"step","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"[description]","name":"res"},{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"description":"[description]","name":"vx"},{"type":{"names":["number"]},"description":"[description]","name":"vy"},{"type":{"names":["number"]},"description":"[description]","name":"width"},{"type":{"names":["number"]},"description":"[description]","name":"height"},{"type":{"names":["number"]},"description":"[description]","name":"rvx"},{"type":{"names":["number"]},"description":"[description]","name":"rvy"},{"type":{"names":["number"]},"description":"[description]","name":"step"}],"memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#step","scope":"instance","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"checkDef","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"[description]","name":"res"},{"type":{"names":["number"]},"description":"[description]","name":"t"},{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"description":"[description]","name":"vx"},{"type":{"names":["number"]},"description":"[description]","name":"vy"},{"type":{"names":["number"]},"description":"[description]","name":"width"},{"type":{"names":["number"]},"description":"[description]","name":"height"},{"type":{"names":["number"]},"description":"[description]","name":"tileX"},{"type":{"names":["number"]},"description":"[description]","name":"tileY"}],"returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#checkDef","scope":"instance","___s":true},{"meta":{"range":[180,187],"filename":"DefaultDefs.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"H","longname":"H","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"Factory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Factory.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"The Impact Physics Factory allows you to easily create Impact Physics enabled Game Objects.\nObjects that are created by this Factory are automatically added to the physics world.","kind":"class","name":"Factory","memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"A reference to the Impact Physics world.","name":"world"}],"scope":"static","longname":"Phaser.Physics.Impact.Factory","___s":true},{"meta":{"filename":"Factory.js","lineno":30,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"A reference to the Impact Physics world.","name":"world","type":{"names":["Phaser.Physics.Impact.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"A reference to the Scene.Systems this Impact Physics instance belongs to.","name":"sys","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#sys","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":49,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Creates a new ImpactBody object and adds it to the physics simulation.","kind":"function","name":"body","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the body in the physics world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the body in the physics world.","name":"y"},{"type":{"names":["number"]},"description":"The width of the body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the body.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"The ImpactBody object that was created."}],"memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#body","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Adds an Impact Physics Body to the given Game Object.","kind":"function","name":"existing","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to receive the physics body.","name":"gameObject"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object."}],"memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#existing","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Creates a new ImpactImage object and adds it to the physics world.","kind":"function","name":"image","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"The ImpactImage object that was created."}],"memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#image","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Creates a new ImpactSprite object and adds it to the physics world.","kind":"function","name":"sprite","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"The ImpactSprite object that was created."}],"memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#sprite","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":137,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Destroys this Factory.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#destroy","scope":"instance","___s":true},{"meta":{"range":[180,215],"filename":"GetVelocity.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetVelocity.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"GetVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"},{"type":{"names":["number"]},"description":"[description]","name":"vel"},{"type":{"names":["number"]},"description":"[description]","name":"accel"},{"type":{"names":["number"]},"description":"[description]","name":"friction"},{"type":{"names":["number"]},"description":"[description]","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.GetVelocity","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"ImpactBody.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImpactBody.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"[description]","kind":"class","name":"ImpactBody","memberof":"Phaser.Physics.Impact","since":"3.0.0","augments":["Phaser.Physics.Impact.Components.Acceleration","Phaser.Physics.Impact.Components.BodyScale","Phaser.Physics.Impact.Components.BodyType","Phaser.Physics.Impact.Components.Bounce","Phaser.Physics.Impact.Components.CheckAgainst","Phaser.Physics.Impact.Components.Collides","Phaser.Physics.Impact.Components.Debug","Phaser.Physics.Impact.Components.Friction","Phaser.Physics.Impact.Components.Gravity","Phaser.Physics.Impact.Components.Offset","Phaser.Physics.Impact.Components.SetGameObject","Phaser.Physics.Impact.Components.Velocity"],"params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"[description]","name":"world"},{"type":{"names":["number"]},"description":"x - The horizontal position of this physics body in the world.","name":"x"},{"type":{"names":["number"]},"description":"y - The vertical position of this physics body in the world.","name":"y"},{"type":{"names":["number"]},"description":"The width of the physics body in the world.","name":"width"},{"type":{"names":["number"]},"description":"[description]","name":"height"}],"scope":"static","longname":"Phaser.Physics.Impact.ImpactBody","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"body","type":{"names":["Phaser.Physics.Impact.Body"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#body","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"size","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#size","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"offset","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"vel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#vel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"accel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#accel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"friction","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#friction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"maxVel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#maxVel","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"ImpactImage.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImpactImage.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"An Impact Physics Image Game Object.\n\nAn Image is a light-weight Game Object useful for the display of static images in your game,\nsuch as logos, backgrounds, scenery or other non-animated elements. Images can have input\nevents and physics bodies, or be tweened, tinted or scrolled. The main difference between an\nImage and a Sprite is that you cannot animate an Image as they do not have the Animation component.","kind":"class","name":"ImpactImage","augments":["Phaser.GameObjects.Image","Phaser.Physics.Impact.Components.Acceleration","Phaser.Physics.Impact.Components.BodyScale","Phaser.Physics.Impact.Components.BodyType","Phaser.Physics.Impact.Components.Bounce","Phaser.Physics.Impact.Components.CheckAgainst","Phaser.Physics.Impact.Components.Collides","Phaser.Physics.Impact.Components.Debug","Phaser.Physics.Impact.Components.Friction","Phaser.Physics.Impact.Components.Gravity","Phaser.Physics.Impact.Components.Offset","Phaser.Physics.Impact.Components.SetGameObject","Phaser.Physics.Impact.Components.Velocity","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"The physics world of the Impact physics system.","name":"world"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.Physics.Impact.ImpactImage","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The Physics Body linked to an ImpactImage.","name":"body","type":{"names":["Phaser.Physics.Impact.Body"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#body","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Image#body","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The size of the physics Body.","name":"size","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#size","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The X and Y offset of the Body from the left and top of the Image.","name":"offset","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":113,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The velocity, or rate of change the Body's position. Measured in pixels per second.","name":"vel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#vel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The acceleration is the rate of change of the velocity. Measured in pixels per second squared.","name":"accel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#accel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Friction between colliding bodies.","name":"friction","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#friction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":140,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The maximum velocity of the body.","name":"maxVel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#maxVel","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"ImpactPhysics.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"[description]","kind":"class","name":"ImpactPhysics","memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"[description]","name":"scene"}],"scope":"static","longname":"Phaser.Physics.Impact.ImpactPhysics","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"config","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"world","type":{"names":["Phaser.Physics.Impact.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"add","type":{"names":["Phaser.Physics.Impact.Factory"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#add","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"getConfig","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#getConfig","scope":"instance","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":141,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"The Impact World object."}],"memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#pause","scope":"instance","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"The Impact World object."}],"memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#resume","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"ImpactSprite.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"An Impact Physics Sprite Game Object.\n\nA Sprite Game Object is used for the display of both static and animated images in your game.\nSprites can have input events and physics bodies. They can also be tweened, tinted, scrolled\nand animated.\n\nThe main difference between a Sprite and an Image Game Object is that you cannot animate Images.\nAs such, Sprites take a fraction longer to process and have a larger API footprint due to the Animation\nComponent. If you do not require animation then you can safely use Images to replace Sprites in all cases.","kind":"class","name":"ImpactSprite","augments":["Phaser.GameObjects.Sprite","Phaser.Physics.Impact.Components.Acceleration","Phaser.Physics.Impact.Components.BodyScale","Phaser.Physics.Impact.Components.BodyType","Phaser.Physics.Impact.Components.Bounce","Phaser.Physics.Impact.Components.CheckAgainst","Phaser.Physics.Impact.Components.Collides","Phaser.Physics.Impact.Components.Debug","Phaser.Physics.Impact.Components.Friction","Phaser.Physics.Impact.Components.Gravity","Phaser.Physics.Impact.Components.Offset","Phaser.Physics.Impact.Components.SetGameObject","Phaser.Physics.Impact.Components.Velocity","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"[description]","name":"world"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.Physics.Impact.ImpactSprite","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"body","type":{"names":["Phaser.Physics.Impact.Body"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#body","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Sprite#body","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"size","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#size","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"offset","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"vel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#vel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":125,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"accel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#accel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"friction","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#friction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":143,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"maxVel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#maxVel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SeparateX.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"SeparateX","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"[description]","name":"world"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"left"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"right"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"optional":true,"description":"[description]","name":"weak"}],"memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.SeparateX","scope":"static","___s":true},{"meta":{"filename":"SeparateY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"SeparateY","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"[description]","name":"world"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"top"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"bottom"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"optional":true,"description":"[description]","name":"weak"}],"memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.SeparateY","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"Solver.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"COLLIDES","longname":"COLLIDES","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Solver.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Impact Physics Solver","kind":"function","name":"Solver","fires":["Phaser.Physics.Impact.Events#event:COLLIDE"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"The Impact simulation to run the solver in.","name":"world"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"The first body in the collision.","name":"bodyA"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"The second body in the collision.","name":"bodyB"}],"memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.Solver","scope":"static","___s":true},{"meta":{"filename":"TYPE.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Collision Types - Determine if and how entities collide with each other.\n\nIn ACTIVE vs. LITE or FIXED vs. ANY collisions, only the \"weak\" entity moves,\nwhile the other one stays fixed. In ACTIVE vs. ACTIVE and ACTIVE vs. PASSIVE\ncollisions, both entities are moved. LITE or PASSIVE entities don't collide\nwith other LITE or PASSIVE entities at all. The behavior for FIXED vs.\nFIXED collisions is undefined.","kind":"namespace","name":"TYPE","memberof":"Phaser.Physics.Impact","since":"3.0.0","longname":"Phaser.Physics.Impact.TYPE","scope":"static","___s":true},{"meta":{"filename":"TYPE.js","lineno":22,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Collides with nothing.","name":"NONE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.TYPE","longname":"Phaser.Physics.Impact.TYPE.NONE","scope":"static","___s":true},{"meta":{"filename":"TYPE.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Type A. Collides with Type B.","name":"A","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.TYPE","longname":"Phaser.Physics.Impact.TYPE.A","scope":"static","___s":true},{"meta":{"filename":"TYPE.js","lineno":42,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Type B. Collides with Type A.","name":"B","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.TYPE","longname":"Phaser.Physics.Impact.TYPE.B","scope":"static","___s":true},{"meta":{"filename":"TYPE.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Collides with both types A and B.","name":"BOTH","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.TYPE","longname":"Phaser.Physics.Impact.TYPE.BOTH","scope":"static","___s":true},{"meta":{"filename":"UpdateMotion.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Set up the trace-result\nvar res = {\n collision: {x: false, y: false, slope: false},\n pos: {x: x, y: y},\n tile: {x: 0, y: 0}\n};","kind":"function","name":"UpdateMotion","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"body"},{"type":{"names":["object"]},"description":"[description]","name":"res"}],"memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.UpdateMotion","scope":"static","___s":true},{"meta":{"range":[180,204],"filename":"World.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"World.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"[description]","kind":"class","name":"World","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Impact World instance belongs.","name":"scene"},{"type":{"names":["Phaser.Types.Physics.Impact.WorldConfig"]},"description":"[description]","name":"config"}],"scope":"static","longname":"Phaser.Physics.Impact.World","___s":true},{"meta":{"filename":"World.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"bodies","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#bodies","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"gravity","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#gravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Spatial hash cell dimensions","name":"cellSize","type":{"names":["integer"]},"defaultvalue":"64","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#cellSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"collisionMap","type":{"names":["Phaser.Physics.Impact.CollisionMap"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#collisionMap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":90,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":100,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Impacts maximum time step is 20 fps.","name":"maxStep","type":{"names":["number"]},"defaultvalue":"0.05","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#maxStep","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"drawDebug","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#drawDebug","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"debugGraphic","type":{"names":["Phaser.GameObjects.Graphics"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#debugGraphic","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":140,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"defaults","type":{"names":["Phaser.Types.Physics.Impact.WorldDefaults"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#defaults","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"An object containing the 4 wall bodies that bound the physics world.","name":"walls","type":{"names":["Phaser.Types.Physics.Impact.WorldWalls"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#walls","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"delta","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#delta","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":219,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Sets the collision map for the world either from a Weltmeister JSON level in the cache or from\na 2D array. If loading from a Weltmeister level, the map must have a layer called \"collision\".","kind":"function","name":"setCollisionMap","since":"3.0.0","params":[{"type":{"names":["string","Array.>"]},"description":"Either a string key that corresponds to a Weltmeister level\nin the cache, or a 2D array of collision IDs.","name":"key"},{"type":{"names":["integer"]},"description":"The size of a tile. This is optional if loading from a Weltmeister\nlevel in the cache.","name":"tileSize"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.CollisionMap"]},"nullable":true,"description":"The newly created CollisionMap, or null if the method failed to\ncreate the CollisionMap."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setCollisionMap","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Sets the collision map for the world from a tilemap layer. Only tiles that are marked as\ncolliding will be used. You can specify the mapping from tiles to slope IDs in a couple of\nways. The easiest is to use Tiled and the slopeTileProperty option. Alternatively, you can\nmanually create a slopeMap that stores the mapping between tile indices and slope IDs.","kind":"function","name":"setCollisionMapFromTilemapLayer","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"description":"The tilemap layer to use.","name":"tilemapLayer"},{"type":{"names":["Phaser.Types.Physics.Impact.CollisionOptions"]},"optional":true,"description":"Options for controlling the mapping from tiles to slope IDs.","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.CollisionMap"]},"description":"The newly created CollisionMap."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setCollisionMapFromTilemapLayer","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":338,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Sets the bounds of the Physics world to match the given world pixel dimensions.\nYou can optionally set which 'walls' to create: left, right, top or bottom.\nIf none of the walls are given it will default to use the walls settings it had previously.\nI.e. if you previously told it to not have the left or right walls, and you then adjust the world size\nthe newly created bounds will also not have the left and right walls.\nExplicitly state them in the parameters to override this.","kind":"function","name":"setBounds","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x coordinate of the top-left corner of the bounds.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate of the top-left corner of the bounds.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the bounds.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the bounds.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"[description]","name":"thickness"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the left bounds wall.","name":"left"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the right bounds wall.","name":"right"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the top bounds wall.","name":"top"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the bottom bounds wall.","name":"bottom"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setBounds","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":381,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"position = 'left', 'right', 'top' or 'bottom'","kind":"function","name":"updateWall","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"[description]","name":"add"},{"type":{"names":["string"]},"description":"[description]","name":"position"},{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"description":"[description]","name":"width"},{"type":{"names":["number"]},"description":"[description]","name":"height"}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#updateWall","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":423,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Creates a Graphics Game Object used for debug display and enables the world for debug drawing.","kind":"function","name":"createDebugGraphic","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object created that will have the debug visuals drawn to it."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#createDebugGraphic","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":444,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"getNextID","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#getNextID","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":457,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"description":"[description]","name":"sizeX"},{"type":{"names":["number"]},"description":"[description]","name":"sizeY"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"The Body that was added to this World."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#create","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":479,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"The Body to remove from this World.","name":"object"}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#remove","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":492,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"pause","fires":["Phaser.Physics.Impact.Events#event:PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#pause","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":510,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"resume","fires":["Phaser.Physics.Impact.Events#event:RESUME"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#resume","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":528,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#update","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":599,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Check the body against the spatial hash.","kind":"function","name":"checkHash","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"body"},{"type":{"names":["object"]},"description":"[description]","name":"hash"},{"type":{"names":["number"]},"description":"[description]","name":"size"}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#checkHash","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":651,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"checkBodies","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"bodyA"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"bodyB"}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#checkBodies","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":685,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setCollidesNever","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the collides value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setCollidesNever","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":705,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setLite","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the collides value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setLite","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":725,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setPassive","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the collides value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setPassive","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":745,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the collides value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setActive","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":765,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setFixed","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the collides value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setFixed","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":785,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setTypeNone","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setTypeNone","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":805,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setTypeA","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setTypeA","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":825,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setTypeB","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setTypeB","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":845,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setAvsB","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setAvsB","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":866,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setBvsA","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setBvsA","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":887,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setCheckAgainstNone","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setCheckAgainstNone","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":907,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setCheckAgainstA","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setCheckAgainstA","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":927,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setCheckAgainstB","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setCheckAgainstB","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":947,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#shutdown","scope":"instance","overrides":"Phaser.Events.EventEmitter#shutdown","___s":true},{"meta":{"filename":"World.js","lineno":958,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"Acceleration.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Acceleration component.\nShould be applied as a mixin.","kind":"namespace","name":"Acceleration","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Acceleration","scope":"static","___s":true},{"meta":{"filename":"Acceleration.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal acceleration of this body.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Acceleration"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Acceleration","longname":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationX","scope":"instance","___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical acceleration of this body.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Acceleration"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Acceleration","longname":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationY","scope":"instance","___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical acceleration of this body.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal acceleration to apply.","name":"x"},{"type":{"names":["number"]},"description":"The amount of vertical acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Acceleration"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Acceleration","longname":"Phaser.Physics.Impact.Components.Acceleration#setAcceleration","scope":"instance","___s":true},{"meta":{"filename":"BodyScale.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Body Scale component.\nShould be applied as a mixin.","kind":"namespace","name":"BodyScale","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.BodyScale","scope":"static","___s":true},{"meta":{"filename":"BodyScale.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the size of the physics body.","kind":"function","name":"setBodySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the body in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height of the body in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.BodyScale"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.BodyScale","longname":"Phaser.Physics.Impact.Components.BodyScale#setBodySize","scope":"instance","___s":true},{"meta":{"filename":"BodyScale.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the scale of the physics body.","kind":"function","name":"setBodyScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of the body.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The vertical scale of the body. If not given, will use the horizontal scale value.","name":"scaleY"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.BodyScale"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.BodyScale","longname":"Phaser.Physics.Impact.Components.BodyScale#setBodyScale","scope":"instance","___s":true},{"meta":{"range":[180,205],"filename":"BodyType.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"name":"TYPE","longname":"TYPE","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BodyType.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Body Type component.\nShould be applied as a mixin.","kind":"namespace","name":"BodyType","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.BodyType","scope":"static","___s":true},{"meta":{"filename":"BodyType.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"getBodyType","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.Components.BodyType","longname":"Phaser.Physics.Impact.Components.BodyType#getBodyType","scope":"instance","___s":true},{"meta":{"filename":"BodyType.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.BodyType","longname":"Phaser.Physics.Impact.Components.BodyType#setTypeNone","scope":"instance","___s":true},{"meta":{"filename":"BodyType.js","lineno":46,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.BodyType","longname":"Phaser.Physics.Impact.Components.BodyType#setTypeA","scope":"instance","___s":true},{"meta":{"filename":"BodyType.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.BodyType","longname":"Phaser.Physics.Impact.Components.BodyType#setTypeB","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Bounce component.\nShould be applied as a mixin.","kind":"namespace","name":"Bounce","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Bounce","scope":"static","___s":true},{"meta":{"filename":"Bounce.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the impact physics bounce, or restitution, value.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 (no rebound) and 1 (full rebound)","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Bounce","longname":"Phaser.Physics.Impact.Components.Bounce#setBounce","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the minimum velocity the body is allowed to be moving to be considered for rebound.","kind":"function","name":"setMinBounceVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum allowed velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Bounce","longname":"Phaser.Physics.Impact.Components.Bounce#setMinBounceVelocity","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The bounce, or restitution, value of this body.\nA value between 0 (no rebound) and 1 (full rebound)","name":"bounce","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.Bounce","longname":"Phaser.Physics.Impact.Components.Bounce#bounce","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,205],"filename":"CheckAgainst.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"name":"TYPE","longname":"TYPE","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Check Against component.\nShould be applied as a mixin.","kind":"namespace","name":"CheckAgainst","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.CheckAgainst","scope":"static","___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setAvsB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.CheckAgainst","longname":"Phaser.Physics.Impact.Components.CheckAgainst#setAvsB","scope":"instance","___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setBvsA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.CheckAgainst","longname":"Phaser.Physics.Impact.Components.CheckAgainst#setBvsA","scope":"instance","___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.CheckAgainst","longname":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstNone","scope":"instance","___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.CheckAgainst","longname":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstA","scope":"instance","___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.CheckAgainst","longname":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstB","scope":"instance","___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"checkAgainst","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.CheckAgainst","longname":"Phaser.Physics.Impact.Components.CheckAgainst#checkAgainst","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,213],"filename":"Collides.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"name":"COLLIDES","longname":"COLLIDES","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Collides.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"kind":"typedef","name":"CollideCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"body"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"other"},{"type":{"names":["string"]},"description":"[description]","name":"axis"}],"longname":"CollideCallback","scope":"global","___s":true},{"meta":{"filename":"Collides.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Collides component.\nShould be applied as a mixin.","kind":"namespace","name":"Collides","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Collides","scope":"static","___s":true},{"meta":{"filename":"Collides.js","lineno":29,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollideCallback","since":"3.0.0","params":[{"type":{"names":["CollideCallback"]},"description":"[description]","name":"callback"},{"type":{"names":["*"]},"description":"[description]","name":"scope"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#setCollideCallback","scope":"instance","___s":true},{"meta":{"filename":"Collides.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollidesNever","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#setCollidesNever","scope":"instance","___s":true},{"meta":{"filename":"Collides.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setLiteCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#setLiteCollision","scope":"instance","___s":true},{"meta":{"filename":"Collides.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setPassiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#setPassiveCollision","scope":"instance","___s":true},{"meta":{"filename":"Collides.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setActiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#setActiveCollision","scope":"instance","___s":true},{"meta":{"filename":"Collides.js","lineno":112,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFixedCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#setFixedCollision","scope":"instance","___s":true},{"meta":{"filename":"Collides.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"collides","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#collides","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Debug.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Debug component.\nShould be applied as a mixin.","kind":"namespace","name":"Debug","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Debug","scope":"static","___s":true},{"meta":{"filename":"Debug.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"[description]","name":"showBody"},{"type":{"names":["boolean"]},"description":"[description]","name":"showVelocity"},{"type":{"names":["number"]},"description":"[description]","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Debug","longname":"Phaser.Physics.Impact.Components.Debug#setDebug","scope":"instance","___s":true},{"meta":{"filename":"Debug.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Debug","longname":"Phaser.Physics.Impact.Components.Debug#setDebugBodyColor","scope":"instance","___s":true},{"meta":{"filename":"Debug.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.Debug","longname":"Phaser.Physics.Impact.Components.Debug#debugShowBody","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Debug.js","lineno":75,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.Debug","longname":"Phaser.Physics.Impact.Components.Debug#debugShowVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Debug.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.Debug","longname":"Phaser.Physics.Impact.Components.Debug#debugBodyColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Friction.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Friction component.\nShould be applied as a mixin.","kind":"namespace","name":"Friction","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Friction","scope":"static","___s":true},{"meta":{"filename":"Friction.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Friction","longname":"Phaser.Physics.Impact.Components.Friction#setFrictionX","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Friction","longname":"Phaser.Physics.Impact.Components.Friction#setFrictionY","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Friction","longname":"Phaser.Physics.Impact.Components.Friction#setFriction","scope":"instance","___s":true},{"meta":{"filename":"Gravity.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Gravity component.\nShould be applied as a mixin.","kind":"namespace","name":"Gravity","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Gravity","scope":"static","___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Gravity","longname":"Phaser.Physics.Impact.Components.Gravity#setGravity","scope":"instance","___s":true},{"meta":{"filename":"Gravity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"gravity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.Gravity","longname":"Phaser.Physics.Impact.Components.Gravity#gravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Offset.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Offset component.\nShould be applied as a mixin.","kind":"namespace","name":"Offset","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Offset","scope":"static","___s":true},{"meta":{"filename":"Offset.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Offset","longname":"Phaser.Physics.Impact.Components.Offset#setOffset","scope":"instance","___s":true},{"meta":{"filename":"SetGameObject.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Set Game Object component.\nShould be applied as a mixin.","kind":"namespace","name":"SetGameObject","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.SetGameObject","scope":"static","___s":true},{"meta":{"filename":"SetGameObject.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGameObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"[description]","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"[description]","name":"sync"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.SetGameObject","longname":"Phaser.Physics.Impact.Components.SetGameObject#setGameObject","scope":"instance","___s":true},{"meta":{"filename":"SetGameObject.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"syncGameObject","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.SetGameObject","longname":"Phaser.Physics.Impact.Components.SetGameObject#syncGameObject","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Velocity component.\nShould be applied as a mixin.","kind":"namespace","name":"Velocity","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Velocity","scope":"static","___s":true},{"meta":{"filename":"Velocity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Velocity","longname":"Phaser.Physics.Impact.Components.Velocity#setVelocityX","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Velocity","longname":"Phaser.Physics.Impact.Components.Velocity#setVelocityY","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical velocities of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Velocity","longname":"Phaser.Physics.Impact.Components.Velocity#setVelocity","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the maximum velocity this body can travel at.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The maximum allowed horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The maximum allowed vertical velocity. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Velocity","longname":"Phaser.Physics.Impact.Components.Velocity#setMaxVelocity","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"kind":"namespace","name":"Components","memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.Components","scope":"static","___s":true},{"meta":{"filename":"COLLIDE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/events"},"description":"The Impact Physics World Collide Event.\n\nThis event is dispatched by an Impact Physics World instance if two bodies collide.\n\nListen to it from a Scene using: `this.impact.world.on('collide', listener)`.","kind":"event","name":"COLLIDE","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"The first body involved in the collision.","name":"bodyA"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"The second body involved in the collision.","name":"bodyB"},{"type":{"names":["string"]},"description":"The collision axis. Either `x` or `y`.","name":"axis"}],"memberof":"Phaser.Physics.Impact.Events","longname":"Phaser.Physics.Impact.Events#event:COLLIDE","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/events"},"description":"The Impact Physics World Pause Event.\n\nThis event is dispatched by an Impact Physics World instance when it is paused.\n\nListen to it from a Scene using: `this.impact.world.on('pause', listener)`.","kind":"event","name":"PAUSE","since":"3.0.0","memberof":"Phaser.Physics.Impact.Events","longname":"Phaser.Physics.Impact.Events#event:PAUSE","scope":"instance","___s":true},{"meta":{"filename":"RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/events"},"description":"The Impact Physics World Resume Event.\n\nThis event is dispatched by an Impact Physics World instance when it resumes from a paused state.\n\nListen to it from a Scene using: `this.impact.world.on('resume', listener)`.","kind":"event","name":"RESUME","since":"3.0.0","memberof":"Phaser.Physics.Impact.Events","longname":"Phaser.Physics.Impact.Events#event:RESUME","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"An Impact.js compatible physics world, body and solver, for those who are used\nto the Impact way of defining and controlling physics bodies. Also works with\nthe new Loader support for Weltmeister map data.\n\nWorld updated to run off the Phaser main loop.\nBody extended to support additional setter functions.\n\nTo create the map data you'll need Weltmeister, which comes with Impact\nand can be purchased from http://impactjs.com\n\nMy thanks to Dominic Szablewski for his permission to support Impact in Phaser.","kind":"namespace","name":"Impact","memberof":"Phaser.Physics","longname":"Phaser.Physics.Impact","scope":"static","___s":true},{"meta":{"filename":"CollisionOptions.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs"},"kind":"typedef","name":"CollisionOptions","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":null,"description":"Slope IDs can be stored on tiles directly\nusing Impacts tileset editor. If a tile has a property with the given slopeTileProperty string\nname, the value of that property for the tile will be used for its slope mapping. E.g. a 45\ndegree slope upward could be given a \"slope\" property with a value of 2.","name":"slopeTileProperty"},{"type":{"names":["object"]},"optional":true,"defaultvalue":null,"description":"A tile index to slope definition map.","name":"slopeMap"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":null,"description":"If specified, the default slope ID to\nassign to a colliding tile. If not specified, the tile's index is used.","name":"defaultCollidingSlope"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The default slope ID to assign to a\nnon-colliding tile.","name":"defaultNonCollidingSlope"}],"memberof":"Phaser.Types.Physics.Impact","longname":"Phaser.Types.Physics.Impact.CollisionOptions","scope":"static","___s":true},{"meta":{"filename":"JSONImpactBody.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs"},"kind":"typedef","name":"JSONImpactBody","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"[description]","name":"name"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"[description]","name":"size"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The entity's position in the game world.","name":"pos"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Current velocity in pixels per second.","name":"vel"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Current acceleration to be added to the entity's velocity per second. E.g. an entity with a `vel.x` of 0 and `accel.x` of 10 will have a `vel.x` of 100 ten seconds later.","name":"accel"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Deceleration to be subtracted from the entity's velocity per second. Only applies if `accel` is 0.","name":"friction"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The maximum velocity a body can move.","name":"maxVel"},{"type":{"names":["number"]},"description":"[description]","name":"gravityFactor"},{"type":{"names":["number"]},"description":"[description]","name":"bounciness"},{"type":{"names":["number"]},"description":"[description]","name":"minBounceVelocity"},{"type":{"names":["Phaser.Physics.Impact.TYPE"]},"description":"[description]","name":"type"},{"type":{"names":["Phaser.Physics.Impact.TYPE"]},"description":"[description]","name":"checkAgainst"},{"type":{"names":["Phaser.Physics.Impact.COLLIDES"]},"description":"[description]","name":"collides"}],"memberof":"Phaser.Types.Physics.Impact","longname":"Phaser.Types.Physics.Impact.JSONImpactBody","scope":"static","___s":true},{"meta":{"filename":"WorldConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs"},"kind":"typedef","name":"WorldConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Impact.World#gravity}","name":"gravity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The size of the cells used for the broadphase pass. Increase this value if you have lots of large objects in the world.","name":"cellSize"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A number that allows per-body time scaling, e.g. a force-field where bodies inside are in slow-motion, while others are at full speed.","name":"timeScale"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.05,"description":"[description]","name":"maxStep"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets {@link Phaser.Physics.Impact.World#debug}.","name":"debug"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"The maximum velocity a body can move.","name":"maxVelocity"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether the Body's boundary is drawn to the debug display.","name":"debugShowBody"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether the Body's velocity is drawn to the debug display.","name":"debugShowVelocity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xff00ff","description":"The color of this Body on the debug display.","name":"debugBodyColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x00ff00","description":"The color of the Body's velocity on the debug display.","name":"debugVelocityColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"maxVelocity","description":"Maximum X velocity objects can move.","name":"maxVelocityX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"maxVelocity","description":"Maximum Y velocity objects can move.","name":"maxVelocityY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":40,"description":"The minimum velocity an object can be moving at to be considered for bounce.","name":"minBounceVelocity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Gravity multiplier. Set to 0 for no gravity.","name":"gravityFactor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The default bounce, or restitution, of bodies in the world.","name":"bounciness"},{"type":{"names":["object","boolean"]},"optional":true,"description":"Should the world have bounds enabled by default?","name":"setBounds"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the world bounds.","name":"setBounds.x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the world bounds.","name":"setBounds.y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the world bounds.","name":"setBounds.width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the world bounds.","name":"setBounds.height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The thickness of the walls of the world bounds.","name":"setBounds.thickness"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the left-side world bounds wall be created?","name":"setBounds.left"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the right-side world bounds wall be created?","name":"setBounds.right"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the top world bounds wall be created?","name":"setBounds.top"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the bottom world bounds wall be created?","name":"setBounds.bottom"}],"memberof":"Phaser.Types.Physics.Impact","longname":"Phaser.Types.Physics.Impact.WorldConfig","scope":"static","___s":true},{"meta":{"filename":"WorldDefaults.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs"},"description":"An object containing the 4 wall bodies that bound the physics world.","kind":"typedef","name":"WorldDefaults","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Whether the Body's boundary is drawn to the debug display.","name":"debugShowBody"},{"type":{"names":["boolean"]},"description":"Whether the Body's velocity is drawn to the debug display.","name":"debugShowVelocity"},{"type":{"names":["number"]},"description":"The color of this Body on the debug display.","name":"bodyDebugColor"},{"type":{"names":["number"]},"description":"The color of the Body's velocity on the debug display.","name":"velocityDebugColor"},{"type":{"names":["number"]},"description":"Maximum X velocity objects can move.","name":"maxVelocityX"},{"type":{"names":["number"]},"description":"Maximum Y velocity objects can move.","name":"maxVelocityY"},{"type":{"names":["number"]},"description":"The minimum velocity an object can be moving at to be considered for bounce.","name":"minBounceVelocity"},{"type":{"names":["number"]},"description":"Gravity multiplier. Set to 0 for no gravity.","name":"gravityFactor"},{"type":{"names":["number"]},"description":"The default bounce, or restitution, of bodies in the world.","name":"bounciness"}],"memberof":"Phaser.Types.Physics.Impact","longname":"Phaser.Types.Physics.Impact.WorldDefaults","scope":"static","___s":true},{"meta":{"filename":"WorldWalls.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs"},"kind":"typedef","name":"WorldWalls","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"nullable":true,"description":"The left-side wall of the world bounds.","name":"left"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"nullable":true,"description":"The right-side wall of the world bounds.","name":"right"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"nullable":true,"description":"The top wall of the world bounds.","name":"top"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"nullable":true,"description":"The bottom wall of the world bounds.","name":"bottom"}],"memberof":"Phaser.Types.Physics.Impact","longname":"Phaser.Types.Physics.Impact.WorldWalls","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs"},"kind":"namespace","name":"Impact","memberof":"Phaser.Types.Physics","longname":"Phaser.Types.Physics.Impact","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics"},"kind":"namespace","name":"Physics","memberof":"Phaser","longname":"Phaser.Physics","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics"},"kind":"namespace","name":"Physics","memberof":"Phaser.Types","longname":"Phaser.Types.Physics","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"BodyBounds.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BodyBounds.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"The Body Bounds class contains methods to help you extract the world coordinates from various points around\nthe bounds of a Matter Body. Because Matter bodies are positioned based on their center of mass, and not a\ndimension based center, you often need to get the bounds coordinates in order to properly align them in the world.\n\nYou can access this class via the MatterPhysics class from a Scene, i.e.:\n\n```javascript\nthis.matter.bodyBounds.getTopLeft(body);\n```\n\nSee also the `MatterPhysics.alignBody` method.","kind":"class","name":"BodyBounds","memberof":"Phaser.Physics.Matter","since":"3.22.0","scope":"static","longname":"Phaser.Physics.Matter.BodyBounds","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A Vector2 that stores the temporary bounds center value during calculations by methods in this class.","name":"boundsCenter","type":{"names":["Phaser.Math.Vector2"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#boundsCenter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A Vector2 that stores the temporary center diff values during calculations by methods in this class.","name":"centerDiff","type":{"names":["Phaser.Math.Vector2"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#centerDiff","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":55,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Parses the given body to get the bounds diff values from it.\n\nThey're stored in this class in the temporary properties `boundsCenter` and `centerDiff`.\n\nThis method is called automatically by all other methods in this class.","kind":"function","name":"parseBody","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the bounds position from.","name":"body"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if it was able to get the bounds, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#parseBody","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the top-left of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getTopLeft","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getTopLeft","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the top-center of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getTopCenter","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getTopCenter","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":161,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the top-right of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getTopRight","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getTopRight","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the left-center of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getLeftCenter","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getLeftCenter","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the center of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getCenter","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getCenter","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":262,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the right-center of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getRightCenter","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getRightCenter","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":296,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the bottom-left of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getBottomLeft","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getBottomLeft","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the bottom-center of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getBottomCenter","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getBottomCenter","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":364,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the bottom-right of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getBottomRight","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getBottomRight","scope":"instance","___s":true},{"meta":{"filename":"CustomMain.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"kind":"namespace","name":"Matter","memberof":"Phaser.Physics.Matter","longname":"Phaser.Physics.Matter.Matter","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"Factory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Bodies","longname":"Bodies","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Factory.js","lineno":21,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"The Matter Factory is responsible for quickly creating a variety of different types of\nbodies, constraints and Game Objects and adding them into the physics world.\n\nYou access the factory from within a Scene using `add`:\n\n```javascript\nthis.matter.add.rectangle(x, y, width, height);\n```\n\nUse of the Factory is optional. All of the objects it creates can also be created\ndirectly via your own code or constructors. It is provided as a means to keep your\ncode concise.","kind":"class","name":"Factory","memberof":"Phaser.Physics.Matter","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"The Matter World which this Factory adds to.","name":"world"}],"scope":"static","longname":"Phaser.Physics.Matter.Factory","___s":true},{"meta":{"filename":"Factory.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Matter World which this Factory adds to.","name":"world","type":{"names":["Phaser.Physics.Matter.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Scene which this Factory's Matter World belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Scene.Systems this Matter Physics instance belongs to.","name":"sys","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#sys","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a new rigid rectangular Body and adds it to the World.","kind":"function","name":"rectangle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the center of the Body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the center of the Body.","name":"y"},{"type":{"names":["number"]},"description":"The width of the Body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the Body.","name":"height"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#rectangle","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a new rigid trapezoidal Body and adds it to the World.","kind":"function","name":"trapezoid","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the center of the Body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the center of the Body.","name":"y"},{"type":{"names":["number"]},"description":"The width of the trapezoid Body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the trapezoid Body.","name":"height"},{"type":{"names":["number"]},"description":"The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.","name":"slope"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#trapezoid","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":124,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a new rigid circular Body and adds it to the World.","kind":"function","name":"circle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the center of the Body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the center of the Body.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"},{"type":{"names":["number"]},"optional":true,"description":"The maximum amount of sides to use for the polygon which will approximate this circle.","name":"maxSides"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#circle","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a new rigid polygonal Body and adds it to the World.","kind":"function","name":"polygon","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the center of the Body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the center of the Body.","name":"y"},{"type":{"names":["number"]},"description":"The number of sides the polygon will have.","name":"sides"},{"type":{"names":["number"]},"description":"The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#polygon","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a body using the supplied vertices (or an array containing multiple sets of vertices) and adds it to the World.\nIf the vertices are convex, they will pass through as supplied. Otherwise, if the vertices are concave, they will be decomposed. Note that this process is not guaranteed to support complex sets of vertices, e.g. ones with holes.","kind":"function","name":"fromVertices","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the center of the Body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the center of the Body.","name":"y"},{"type":{"names":["string","array"]},"description":"The vertices data. Either a path string or an array of vertices.","name":"vertexSets"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Flag internal edges (coincident part edges)","name":"flagInternal"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.01,"description":"Whether Matter.js will discard collinear edges (to improve performance).","name":"removeCollinear"},{"type":{"names":["number"]},"optional":true,"defaultvalue":10,"description":"During decomposition discard parts that have an area less than this.","name":"minimumArea"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#fromVertices","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a body using data exported from the application PhysicsEditor (https://www.codeandweb.com/physicseditor)\n\nThe PhysicsEditor file should be loaded as JSON:\n\n```javascript\npreload ()\n{\n this.load.json('vehicles', 'assets/vehicles.json);\n}\n\ncreate ()\n{\n const vehicleShapes = this.cache.json.get('vehicles');\n this.matter.add.fromPhysicsEditor(400, 300, vehicleShapes.truck);\n}\n```\n\nDo not pass the entire JSON file to this method, but instead pass one of the shapes contained within it.\n\nIf you pas in an `options` object, any settings in there will override those in the PhysicsEditor config object.","kind":"function","name":"fromPhysicsEditor","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The horizontal world location of the body.","name":"x"},{"type":{"names":["number"]},"description":"The vertical world location of the body.","name":"y"},{"type":{"names":["any"]},"description":"The JSON data exported from PhysicsEditor.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the newly created body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#fromPhysicsEditor","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":248,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a body using the path data from an SVG file.\n\nSVG Parsing requires the pathseg polyfill from https://github.com/progers/pathseg\n\nThe SVG file should be loaded as XML, as this method requires the ability to extract\nthe path data from it. I.e.:\n\n```javascript\npreload ()\n{\n this.load.xml('face', 'assets/face.svg);\n}\n\ncreate ()\n{\n this.matter.add.fromSVG(400, 300, this.cache.xml.get('face'));\n}\n```","kind":"function","name":"fromSVG","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the body.","name":"y"},{"type":{"names":["object"]},"description":"The SVG Path data.","name":"xml"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Scale the vertices by this amount after creation.","name":"scale"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the newly created body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#fromSVG","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":311,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a body using the supplied physics data, as provided by a JSON file.\n\nThe data file should be loaded as JSON:\n\n```javascript\npreload ()\n{\n this.load.json('ninjas', 'assets/ninjas.json);\n}\n\ncreate ()\n{\n const ninjaShapes = this.cache.json.get('ninjas');\n\n this.matter.add.fromJSON(400, 300, ninjaShapes.shinobi);\n}\n```\n\nDo not pass the entire JSON file to this method, but instead pass one of the shapes contained within it.\n\nIf you pas in an `options` object, any settings in there will override those in the config object.\n\nThe structure of the JSON file is as follows:\n\n```text\n{\n 'generator_info': // The name of the application that created the JSON data\n 'shapeName': {\n 'type': // The type of body\n 'label': // Optional body label\n 'vertices': // An array, or an array of arrays, containing the vertex data in x/y object pairs\n }\n}\n```\n\nAt the time of writing, only the Phaser Physics Tracer App exports in this format.","kind":"function","name":"fromJSON","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the body.","name":"y"},{"type":{"names":["any"]},"description":"The JSON physics data.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the newly created body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#fromJSON","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":375,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Create a new composite containing Matter Image objects created in a grid arrangement.\nThis function uses the body bounds to prevent overlaps.","kind":"function","name":"imageStack","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"description":"An optional frame from the Texture this Game Object is rendering with. Set to `null` to skip this value.","name":"frame"},{"type":{"names":["number"]},"description":"The horizontal position of this composite in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this composite in the world.","name":"y"},{"type":{"names":["number"]},"description":"The number of columns in the grid.","name":"columns"},{"type":{"names":["number"]},"description":"The number of rows in the grid.","name":"rows"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The distance between each column.","name":"columnGap"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The distance between each row.","name":"rowGap"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"A Matter JS Composite Stack."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#imageStack","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":419,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Create a new composite containing bodies created in the callback in a grid arrangement.\n\nThis function uses the body bounds to prevent overlaps.","kind":"function","name":"stack","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this composite in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this composite in the world.","name":"y"},{"type":{"names":["number"]},"description":"The number of columns in the grid.","name":"columns"},{"type":{"names":["number"]},"description":"The number of rows in the grid.","name":"rows"},{"type":{"names":["number"]},"description":"The distance between each column.","name":"columnGap"},{"type":{"names":["number"]},"description":"The distance between each row.","name":"rowGap"},{"type":{"names":["function"]},"description":"The callback that creates the stack.","name":"callback"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"A new composite containing objects created in the callback."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#stack","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":446,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Create a new composite containing bodies created in the callback in a pyramid arrangement.\nThis function uses the body bounds to prevent overlaps.","kind":"function","name":"pyramid","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this composite in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this composite in the world.","name":"y"},{"type":{"names":["number"]},"description":"The number of columns in the pyramid.","name":"columns"},{"type":{"names":["number"]},"description":"The number of rows in the pyramid.","name":"rows"},{"type":{"names":["number"]},"description":"The distance between each column.","name":"columnGap"},{"type":{"names":["number"]},"description":"The distance between each row.","name":"rowGap"},{"type":{"names":["function"]},"description":"The callback function to be invoked.","name":"callback"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"A Matter JS Composite pyramid."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#pyramid","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Chains all bodies in the given composite together using constraints.","kind":"function","name":"chain","since":"3.0.0","params":[{"type":{"names":["MatterJS.CompositeType"]},"description":"The composite in which all bodies will be chained together sequentially.","name":"composite"},{"type":{"names":["number"]},"description":"The horizontal offset of the BodyA constraint. This is a percentage based on the body size, not a world position.","name":"xOffsetA"},{"type":{"names":["number"]},"description":"The vertical offset of the BodyA constraint. This is a percentage based on the body size, not a world position.","name":"yOffsetA"},{"type":{"names":["number"]},"description":"The horizontal offset of the BodyB constraint. This is a percentage based on the body size, not a world position.","name":"xOffsetB"},{"type":{"names":["number"]},"description":"The vertical offset of the BodyB constraint. This is a percentage based on the body size, not a world position.","name":"yOffsetB"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"The original composite that was passed to this method."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#chain","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":492,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Connects bodies in the composite with constraints in a grid pattern, with optional cross braces.","kind":"function","name":"mesh","since":"3.0.0","params":[{"type":{"names":["MatterJS.CompositeType"]},"description":"The composite in which all bodies will be chained together.","name":"composite"},{"type":{"names":["number"]},"description":"The number of columns in the mesh.","name":"columns"},{"type":{"names":["number"]},"description":"The number of rows in the mesh.","name":"rows"},{"type":{"names":["boolean"]},"description":"Create cross braces for the mesh as well?","name":"crossBrace"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"The original composite that was passed to this method."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#mesh","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":511,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a composite with a Newton's Cradle setup of bodies and constraints.","kind":"function","name":"newtonsCradle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the start of the cradle.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the start of the cradle.","name":"y"},{"type":{"names":["number"]},"description":"The number of balls in the cradle.","name":"number"},{"type":{"names":["number"]},"description":"The radius of each ball in the cradle.","name":"size"},{"type":{"names":["number"]},"description":"The length of the 'string' the balls hang from.","name":"length"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"A Newton's cradle composite."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#newtonsCradle","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":534,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a composite with simple car setup of bodies and constraints.","kind":"function","name":"car","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the car in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the car in the world.","name":"y"},{"type":{"names":["number"]},"description":"The width of the car chasis.","name":"width"},{"type":{"names":["number"]},"description":"The height of the car chasis.","name":"height"},{"type":{"names":["number"]},"description":"The radius of the car wheels.","name":"wheelSize"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"A new composite car body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#car","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":557,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a simple soft body like object.","kind":"function","name":"softBody","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this composite in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this composite in the world.","name":"y"},{"type":{"names":["number"]},"description":"The number of columns in the Composite.","name":"columns"},{"type":{"names":["number"]},"description":"The number of rows in the Composite.","name":"rows"},{"type":{"names":["number"]},"description":"The distance between each column.","name":"columnGap"},{"type":{"names":["number"]},"description":"The distance between each row.","name":"rowGap"},{"type":{"names":["boolean"]},"description":"`true` to create cross braces between the bodies, or `false` to create just straight braces.","name":"crossBrace"},{"type":{"names":["number"]},"description":"The radius of this circlular composite.","name":"particleRadius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"particleOptions"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"constraintOptions"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"A new composite simple soft body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#softBody","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":585,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"This method is an alias for `Factory.constraint`.\n\nConstraints (or joints) are used for specifying that a fixed distance must be maintained\nbetween two bodies, or a body and a fixed world-space position.\n\nThe stiffness of constraints can be modified to create springs or elastic.\n\nTo simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\nvalue (e.g. `0.7` or above).\n\nIf the constraint is unstable, try lowering the `stiffness` value and / or increasing\n`constraintIterations` within the Matter Config.\n\nFor compound bodies, constraints must be applied to the parent body and not one of its parts.","kind":"function","name":"joint","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The first possible `Body` that this constraint is attached to.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"The second possible `Body` that this constraint is attached to.","name":"bodyB"},{"type":{"names":["number"]},"optional":true,"description":"A Number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.","name":"stiffness"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"A Matter JS Constraint."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#joint","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":617,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"This method is an alias for `Factory.constraint`.\n\nConstraints (or joints) are used for specifying that a fixed distance must be maintained\nbetween two bodies, or a body and a fixed world-space position.\n\nThe stiffness of constraints can be modified to create springs or elastic.\n\nTo simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\nvalue (e.g. `0.7` or above).\n\nIf the constraint is unstable, try lowering the `stiffness` value and / or increasing\n`constraintIterations` within the Matter Config.\n\nFor compound bodies, constraints must be applied to the parent body and not one of its parts.","kind":"function","name":"spring","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The first possible `Body` that this constraint is attached to.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"The second possible `Body` that this constraint is attached to.","name":"bodyB"},{"type":{"names":["number"]},"optional":true,"description":"A Number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.","name":"stiffness"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"A Matter JS Constraint."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#spring","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":649,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Constraints (or joints) are used for specifying that a fixed distance must be maintained\nbetween two bodies, or a body and a fixed world-space position.\n\nThe stiffness of constraints can be modified to create springs or elastic.\n\nTo simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\nvalue (e.g. `0.7` or above).\n\nIf the constraint is unstable, try lowering the `stiffness` value and / or increasing\n`constraintIterations` within the Matter Config.\n\nFor compound bodies, constraints must be applied to the parent body and not one of its parts.","kind":"function","name":"constraint","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The first possible `Body` that this constraint is attached to.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"The second possible `Body` that this constraint is attached to.","name":"bodyB"},{"type":{"names":["number"]},"optional":true,"description":"A Number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.","name":"stiffness"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"A Matter JS Constraint."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#constraint","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":696,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Constraints (or joints) are used for specifying that a fixed distance must be maintained\nbetween two bodies, or a body and a fixed world-space position.\n\nA world constraint has only one body, you should specify a `pointA` position in\nthe constraint options parameter to attach the constraint to the world.\n\nThe stiffness of constraints can be modified to create springs or elastic.\n\nTo simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\nvalue (e.g. `0.7` or above).\n\nIf the constraint is unstable, try lowering the `stiffness` value and / or increasing\n`constraintIterations` within the Matter Config.\n\nFor compound bodies, constraints must be applied to the parent body and not one of its parts.","kind":"function","name":"worldConstraint","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Matter `Body` that this constraint is attached to.","name":"body"},{"type":{"names":["number"]},"optional":true,"description":"A number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.","name":"stiffness"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"A Matter JS Constraint."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#worldConstraint","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":744,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"This method is an alias for `Factory.pointerConstraint`.\n\nA Pointer Constraint is a special type of constraint that allows you to click\nand drag bodies in a Matter World. It monitors the active Pointers in a Scene,\nand when one is pressed down it checks to see if that hit any part of any active\nbody in the world. If it did, and the body has input enabled, it will begin to\ndrag it until either released, or you stop it via the `stopDrag` method.\n\nYou can adjust the stiffness, length and other properties of the constraint via\nthe `options` object on creation.","kind":"function","name":"mouseSpring","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"A Matter JS Constraint."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#mouseSpring","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":768,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A Pointer Constraint is a special type of constraint that allows you to click\nand drag bodies in a Matter World. It monitors the active Pointers in a Scene,\nand when one is pressed down it checks to see if that hit any part of any active\nbody in the world. If it did, and the body has input enabled, it will begin to\ndrag it until either released, or you stop it via the `stopDrag` method.\n\nYou can adjust the stiffness, length and other properties of the constraint via\nthe `options` object on creation.","kind":"function","name":"pointerConstraint","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"A Matter JS Constraint."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#pointerConstraint","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":801,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a Matter Physics Image Game Object.\n\nAn Image is a light-weight Game Object useful for the display of static images in your game,\nsuch as logos, backgrounds, scenery or other non-animated elements. Images can have input\nevents and physics bodies, or be tweened, tinted or scrolled. The main difference between an\nImage and a Sprite is that you cannot animate an Image as they do not have the Animation component.","kind":"function","name":"image","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with. Set to `null` to skip this value.","name":"frame"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"The Matter Image Game Object."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#image","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":829,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a wrapper around a Tile that provides access to a corresponding Matter body. A tile can only\nhave one Matter body associated with it. You can either pass in an existing Matter body for\nthe tile or allow the constructor to create the corresponding body for you. If the Tile has a\ncollision group (defined in Tiled), those shapes will be used to create the body. If not, the\ntile's rectangle bounding box will be used.\n\nThe corresponding body will be accessible on the Tile itself via Tile.physics.matterBody.\n\nNote: not all Tiled collision shapes are supported. See\nPhaser.Physics.Matter.TileBody#setFromTileCollision for more information.","kind":"function","name":"tileBody","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The target tile that should have a Matter body.","name":"tile"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterTileOptions"]},"optional":true,"description":"Options to be used when creating the Matter body.","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"The Matter Tile Body Game Object."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#tileBody","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":854,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a Matter Physics Sprite Game Object.\n\nA Sprite Game Object is used for the display of both static and animated images in your game.\nSprites can have input events and physics bodies. They can also be tweened, tinted, scrolled\nand animated.\n\nThe main difference between a Sprite and an Image Game Object is that you cannot animate Images.\nAs such, Sprites take a fraction longer to process and have a larger API footprint due to the Animation\nComponent. If you do not require animation then you can safely use Images to replace Sprites in all cases.","kind":"function","name":"sprite","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with. Set to `null` to skip this value.","name":"frame"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"The Matter Sprite Game Object."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#sprite","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":886,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes an existing Game Object and injects all of the Matter Components into it.\n\nThis enables you to use component methods such as `setVelocity` or `isSensor` directly from\nthis Game Object.\n\nYou can also pass in either a Matter Body Configuration object, or a Matter Body instance\nto link with this Game Object.","kind":"function","name":"gameObject","since":"3.3.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to inject the Matter Components in to.","name":"gameObject"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig","MatterJS.Body"]},"optional":true,"description":"A Matter Body configuration object, or an instance of a Matter Body.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Add this Matter Body to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that had the Matter Components injected into it."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#gameObject","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":909,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Destroys this Factory.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"MatterGameObject.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Components","longname":"Components","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MatterGameObject.js","lineno":26,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A Matter Game Object is a generic object that allows you to combine any Phaser Game Object,\nincluding those you have extended or created yourself, with all of the Matter Components.\n\nThis enables you to use component methods such as `setVelocity` or `isSensor` directly from\nthis Game Object.","kind":"function","name":"MatterGameObject","since":"3.3.0","params":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"The Matter world to add the body to.","name":"world"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will have the Matter body applied to it.","name":"gameObject"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig","MatterJS.Body"]},"optional":true,"description":"A Matter Body configuration object, or an instance of a Matter Body.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the newly created body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was created with the Matter body."}],"memberof":"Phaser.Physics.Matter","longname":"Phaser.Physics.Matter.MatterGameObject","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"MatterImage.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MatterImage.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"A Matter Physics Image Game Object.\n\nAn Image is a light-weight Game Object useful for the display of static images in your game,\nsuch as logos, backgrounds, scenery or other non-animated elements. Images can have input\nevents and physics bodies, or be tweened, tinted or scrolled. The main difference between an\nImage and a Sprite is that you cannot animate an Image as they do not have the Animation component.","kind":"class","name":"Image","augments":["Phaser.GameObjects.Image","Phaser.Physics.Matter.Components.Bounce","Phaser.Physics.Matter.Components.Collision","Phaser.Physics.Matter.Components.Force","Phaser.Physics.Matter.Components.Friction","Phaser.Physics.Matter.Components.Gravity","Phaser.Physics.Matter.Components.Mass","Phaser.Physics.Matter.Components.Sensor","Phaser.Physics.Matter.Components.SetBody","Phaser.Physics.Matter.Components.Sleep","Phaser.Physics.Matter.Components.Static","Phaser.Physics.Matter.Components.Transform","Phaser.Physics.Matter.Components.Velocity","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Physics.Matter","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"A reference to the Matter.World instance that this body belongs to.","name":"world"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"scope":"static","longname":"Phaser.Physics.Matter.Image","___s":true},{"meta":{"filename":"MatterImage.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Matter.World instance that this body belongs to.","name":"world","type":{"names":["Phaser.Physics.Matter.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#world","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,230],"filename":"MatterPhysics.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"ALIGN_CONST","longname":"ALIGN_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":41,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"The Phaser Matter plugin provides the ability to use the Matter JS Physics Engine within your Phaser games.\n\nUnlike Arcade Physics, the other physics system provided with Phaser, Matter JS is a full-body physics system.\nIt features:\n\n* Rigid bodies\n* Compound bodies\n* Composite bodies\n* Concave and convex hulls\n* Physical properties (mass, area, density etc.)\n* Restitution (elastic and inelastic collisions)\n* Collisions (broad-phase, mid-phase and narrow-phase)\n* Stable stacking and resting\n* Conservation of momentum\n* Friction and resistance\n* Constraints\n* Gravity\n* Sleeping and static bodies\n* Rounded corners (chamfering)\n* Views (translate, zoom)\n* Collision queries (raycasting, region tests)\n* Time scaling (slow-mo, speed-up)\n\nConfiguration of Matter is handled via the Matter World Config object, which can be passed in either the\nPhaser Game Config, or Phaser Scene Config. Here is a basic example:\n\n```js\nphysics: {\n default: 'matter',\n matter: {\n enableSleeping: true,\n gravity: {\n y: 0\n },\n debug: {\n showBody: true,\n showStaticBody: true\n }\n }\n}\n```\n\nThis class acts as an interface between a Phaser Scene and a single instance of the Matter Engine.\n\nUse it to access the most common Matter features and helper functions.\n\nYou can find details, documentation and examples on the Matter JS website: https://brm.io/matter-js/","kind":"class","name":"MatterPhysics","memberof":"Phaser.Physics.Matter","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Phaser Scene that owns this Matter Physics instance.","name":"scene"}],"scope":"static","longname":"Phaser.Physics.Matter.MatterPhysics","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Phaser Scene that owns this Matter Physics instance","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":113,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Scene Systems that belong to the Scene owning this Matter Physics instance.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The parsed Matter Configuration object.","name":"config","type":{"names":["Phaser.Types.Physics.Matter.MatterWorldConfig"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"An instance of the Matter World class. This class is responsible for the updating of the\nMatter Physics world, as well as handling debug drawing functions.","name":"world","type":{"names":["Phaser.Physics.Matter.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"An instance of the Matter Factory. This class provides lots of functions for creating a\nwide variety of physics objects and adds them automatically to the Matter World.\n\nYou can use this class to cut-down on the amount of code required in your game, however,\nuse of the Factory is entirely optional and should be seen as a development aid. It's\nperfectly possible to create and add components to the Matter world without using it.","name":"add","type":{"names":["Phaser.Physics.Matter.Factory"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#add","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"An instance of the Body Bounds class. This class contains functions used for getting the\nworld position from various points around the bounds of a physics body.","name":"bodyBounds","type":{"names":["Phaser.Physics.Matter.BodyBounds"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#bodyBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Body` module.\n\nThe `Matter.Body` module contains methods for creating and manipulating body models.\nA `Matter.Body` is a rigid body that can be simulated by a `Matter.Engine`.\nFactories for commonly used body configurations (such as rectangles, circles and other polygons) can be found in the `Bodies` module.","name":"body","type":{"names":["MatterJS.BodyFactory"]},"since":"3.18.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#body","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":180,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Composite` module.\n\nThe `Matter.Composite` module contains methods for creating and manipulating composite bodies.\nA composite body is a collection of `Matter.Body`, `Matter.Constraint` and other `Matter.Composite`, therefore composites form a tree structure.\nIt is important to use the functions in this module to modify composites, rather than directly modifying their properties.\nNote that the `Matter.World` object is also a type of `Matter.Composite` and as such all composite methods here can also operate on a `Matter.World`.","name":"composite","type":{"names":["MatterJS.CompositeFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#composite","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Detector` module.\n\nThe `Matter.Detector` module contains methods for detecting collisions given a set of pairs.","name":"detector","type":{"names":["MatterJS.DetectorFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#detector","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":207,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Grid` module.\n\nThe `Matter.Grid` module contains methods for creating and manipulating collision broadphase grid structures.","name":"grid","type":{"names":["MatterJS.GridFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#grid","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":218,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Pair` module.\n\nThe `Matter.Pair` module contains methods for creating and manipulating collision pairs.","name":"pair","type":{"names":["MatterJS.PairFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#pair","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":229,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Pairs` module.\n\nThe `Matter.Pairs` module contains methods for creating and manipulating collision pair sets.","name":"pairs","type":{"names":["MatterJS.PairsFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#pairs","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":240,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Query` module.\n\nThe `Matter.Query` module contains methods for performing collision queries.","name":"query","type":{"names":["MatterJS.QueryFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#query","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":251,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Resolver` module.\n\nThe `Matter.Resolver` module contains methods for resolving collision pairs.","name":"resolver","type":{"names":["MatterJS.ResolverFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#resolver","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":262,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.SAT` module.\n\nThe `Matter.SAT` module contains methods for detecting collisions using the Separating Axis Theorem.","name":"sat","type":{"names":["MatterJS.SATFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#sat","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":275,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Constraint` module.\n\nThe `Matter.Constraint` module contains methods for creating and manipulating constraints.\nConstraints are used for specifying that a fixed distance must be maintained between two bodies (or a body and a fixed world-space position).\nThe stiffness of constraints can be modified to create springs or elastic.","name":"constraint","type":{"names":["MatterJS.ConstraintFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#constraint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":290,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Bodies` module.\n\nThe `Matter.Bodies` module contains factory methods for creating rigid bodies\nwith commonly used body configurations (such as rectangles, circles and other polygons).","name":"bodies","type":{"names":["MatterJS.BodiesFactory"]},"since":"3.18.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#bodies","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":302,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Composites` module.\n\nThe `Matter.Composites` module contains factory methods for creating composite bodies\nwith commonly used configurations (such as stacks and chains).","name":"composites","type":{"names":["MatterJS.CompositesFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#composites","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":316,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Axes` module.\n\nThe `Matter.Axes` module contains methods for creating and manipulating sets of axes.","name":"axes","type":{"names":["MatterJS.AxesFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#axes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":327,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Bounds` module.\n\nThe `Matter.Bounds` module contains methods for creating and manipulating axis-aligned bounding boxes (AABB).","name":"bounds","type":{"names":["MatterJS.BoundsFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#bounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":338,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Svg` module.\n\nThe `Matter.Svg` module contains methods for converting SVG images into an array of vector points.\n\nTo use this module you also need the SVGPathSeg polyfill: https://github.com/progers/pathseg","name":"svg","type":{"names":["MatterJS.SvgFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#svg","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":351,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Vector` module.\n\nThe `Matter.Vector` module contains methods for creating and manipulating vectors.\nVectors are the basis of all the geometry related operations in the engine.\nA `Matter.Vector` object is of the form `{ x: 0, y: 0 }`.","name":"vector","type":{"names":["MatterJS.VectorFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#vector","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":364,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Vertices` module.\n\nThe `Matter.Vertices` module contains methods for creating and manipulating sets of vertices.\nA set of vertices is an array of `Matter.Vector` with additional indexing properties inserted by `Vertices.create`.\nA `Matter.Body` maintains a set of vertices to represent the shape of the object (its convex hull).","name":"vertices","type":{"names":["MatterJS.VerticesFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#vertices","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":377,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Vertices` module.\n\nThe `Matter.Vertices` module contains methods for creating and manipulating sets of vertices.\nA set of vertices is an array of `Matter.Vector` with additional indexing properties inserted by `Vertices.create`.\nA `Matter.Body` maintains a set of vertices to represent the shape of the object (its convex hull).","name":"verts","type":{"names":["MatterJS.VerticesFactory"]},"since":"3.14.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#verts","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"This internal method is called when this class starts and retrieves the final Matter World Config.","kind":"function","name":"getConfig","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterWorldConfig"]},"description":"The Matter World Config."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#getConfig","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":489,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Enables the Matter Attractors Plugin.\n\nThe attractors plugin that makes it easy to apply continual forces on bodies.\nIt's possible to simulate effects such as wind, gravity and magnetism.\n\nhttps://github.com/liabru/matter-attractors\n\nThis method is called automatically if `plugins.attractors` is set in the Matter World Config.\nHowever, you can also call it directly from within your game.","kind":"function","name":"enableAttractorPlugin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#enableAttractorPlugin","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Enables the Matter Wrap Plugin.\n\nThe coordinate wrapping plugin that automatically wraps the position of bodies such that they always stay\nwithin the given bounds. Upon crossing a boundary the body will appear on the opposite side of the bounds,\nwhile maintaining its velocity.\n\nhttps://github.com/liabru/matter-wrap\n\nThis method is called automatically if `plugins.wrap` is set in the Matter World Config.\nHowever, you can also call it directly from within your game.","kind":"function","name":"enableWrapPlugin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#enableWrapPlugin","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":538,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Enables the Matter Collision Events Plugin.\n\nNote that this plugin is enabled by default. So you should only ever need to call this\nmethod if you have specifically disabled the plugin in your Matter World Config.\nYou can disable it by setting `plugins.collisionevents: false` in your Matter World Config.\n\nThis plugin triggers three new events on Matter.Body:\n\n1. `onCollide`\n2. `onCollideEnd`\n3. `onCollideActive`\n\nThese events correspond to the Matter.js events `collisionStart`, `collisionActive` and `collisionEnd`, respectively.\nYou can listen to these events via Matter.Events or they will also be emitted from the Matter World.\n\nThis plugin also extends Matter.Body with three convenience functions:\n\n`Matter.Body.setOnCollide(callback)`\n`Matter.Body.setOnCollideEnd(callback)`\n`Matter.Body.setOnCollideActive(callback)`\n\nYou can register event callbacks by providing a function of type (pair: Matter.Pair) => void\n\nhttps://github.com/dxu/matter-collision-events","kind":"function","name":"enableCollisionEventsPlugin","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#enableCollisionEventsPlugin","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":577,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Pauses the Matter World instance and sets `enabled` to `false`.\n\nA paused world will not run any simulations for the duration it is paused.","kind":"function","name":"pause","fires":["Phaser.Physics.Matter.Events#event:PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"The Matter World object."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#pause","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":593,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Resumes this Matter World instance from a paused state and sets `enabled` to `true`.","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"The Matter World object."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#resume","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":606,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the Matter Engine to run at fixed timestep of 60Hz and enables `autoUpdate`.\nIf you have set a custom `getDelta` function then this will override it.","kind":"function","name":"set60Hz","since":"3.4.0","returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#set60Hz","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":623,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the Matter Engine to run at fixed timestep of 30Hz and enables `autoUpdate`.\nIf you have set a custom `getDelta` function then this will override it.","kind":"function","name":"set30Hz","since":"3.4.0","returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#set30Hz","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":640,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Manually advances the physics simulation by one iteration.\n\nYou can optionally pass in the `delta` and `correction` values to be used by Engine.update.\nIf undefined they use the Matter defaults of 60Hz and no correction.\n\nCalling `step` directly bypasses any checks of `enabled` or `autoUpdate`.\n\nIt also ignores any custom `getDelta` functions, as you should be passing the delta\nvalue in to this call.\n\nYou can adjust the number of iterations that Engine.update performs internally.\nUse the Scene Matter Physics config object to set the following properties:\n\npositionIterations (defaults to 6)\nvelocityIterations (defaults to 4)\nconstraintIterations (defaults to 2)\n\nAdjusting these values can help performance in certain situations, depending on the physics requirements\nof your game.","kind":"function","name":"step","since":"3.4.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":16.666,"description":"The delta value.","name":"delta"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Optional delta correction value.","name":"correction"}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#step","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":672,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Checks if the vertices of the given body, or an array of bodies, contains the given point, or not.\n\nYou can pass in either a single body, or an array of bodies to be checked. This method will\nreturn `true` if _any_ of the bodies in the array contain the point. See the `intersectPoint` method if you need\nto get a list of intersecting bodies.\n\nThe point should be transformed into the Matter World coordinate system in advance. This happens by\ndefault with Input Pointers, but if you wish to use points from another system you may need to\ntransform them before passing them.","kind":"function","name":"containsPoint","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"The body, or an array of bodies, to check against the point.","name":"body"},{"type":{"names":["number"]},"description":"The horizontal coordinate of the point.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the point.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the point is within one of the bodies given, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#containsPoint","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":703,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Checks the given coordinates to see if any vertices of the given bodies contain it.\n\nIf no bodies are provided it will search all bodies in the Matter World, including within Composites.\n\nThe coordinates should be transformed into the Matter World coordinate system in advance. This happens by\ndefault with Input Pointers, but if you wish to use coordinates from another system you may need to\ntransform them before passing them.","kind":"function","name":"intersectPoint","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the point.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the point.","name":"y"},{"type":{"names":["Array."]},"optional":true,"description":"An array of bodies to check. If not provided it will search all bodies in the world.","name":"bodies"}],"returns":[{"type":{"names":["Array."]},"description":"An array of bodies which contain the given point."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#intersectPoint","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Checks the given rectangular area to see if any vertices of the given bodies intersect with it.\nOr, if the `outside` parameter is set to `true`, it checks to see which bodies do not\nintersect with it.\n\nIf no bodies are provided it will search all bodies in the Matter World, including within Composites.","kind":"function","name":"intersectRect","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the top-left of the area.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the top-left of the area.","name":"y"},{"type":{"names":["number"]},"description":"The width of the area.","name":"width"},{"type":{"names":["number"]},"description":"The height of the area.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `false` it checks for vertices inside the area, if `true` it checks for vertices outside the area.","name":"outside"},{"type":{"names":["Array."]},"optional":true,"description":"An array of bodies to check. If not provided it will search all bodies in the world.","name":"bodies"}],"returns":[{"type":{"names":["Array."]},"description":"An array of bodies that intersect with the given area."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#intersectRect","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":787,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Checks the given ray segment to see if any vertices of the given bodies intersect with it.\n\nIf no bodies are provided it will search all bodies in the Matter World.\n\nThe width of the ray can be specified via the `rayWidth` parameter.","kind":"function","name":"intersectRay","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the start of the ray segment.","name":"x1"},{"type":{"names":["number"]},"description":"The vertical coordinate of the start of the ray segment.","name":"y1"},{"type":{"names":["number"]},"description":"The horizontal coordinate of the end of the ray segment.","name":"x2"},{"type":{"names":["number"]},"description":"The vertical coordinate of the end of the ray segment.","name":"y2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The width of the ray segment.","name":"rayWidth"},{"type":{"names":["Array."]},"optional":true,"description":"An array of bodies to check. If not provided it will search all bodies in the world.","name":"bodies"}],"returns":[{"type":{"names":["Array."]},"description":"An array of bodies whos vertices intersect with the ray segment."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#intersectRay","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":823,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Checks the given Matter Body to see if it intersects with any of the given bodies.\n\nIf no bodies are provided it will check against all bodies in the Matter World.","kind":"function","name":"intersectBody","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The target body.","name":"body"},{"type":{"names":["Array."]},"optional":true,"description":"An array of bodies to check the target body against. If not provided it will search all bodies in the world.","name":"bodies"}],"returns":[{"type":{"names":["Array."]},"description":"An array of bodies whos vertices intersect with target body."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#intersectBody","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":860,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Checks to see if the target body, or an array of target bodies, intersects with any of the given bodies.\n\nIf intersection occurs this method will return `true` and, if provided, invoke the callbacks.\n\nIf no bodies are provided for the second parameter the target will check again all bodies in the Matter World.\n\nNote that bodies can only overlap if they are in non-colliding collision groups or categories.\n\nIf you provide a `processCallback` then the two bodies that overlap are sent to it. This callback\nmust return a boolean and is used to allow you to perform additional processing tests before a final\noutcome is decided. If it returns `true` then the bodies are finally passed to the `overlapCallback`, if set.\n\nIf you provide an `overlapCallback` then the matching pairs of overlapping bodies will be sent to it.\n\nBoth callbacks have the following signature: `function (bodyA, bodyB, collisionInfo)` where `bodyA` is always\nthe target body. The `collisionInfo` object contains additional data, such as the angle and depth of penetration.","kind":"function","name":"overlap","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"The target body, or array of target bodies, to check.","name":"target"},{"type":{"names":["Array."]},"optional":true,"description":"The second body, or array of bodies, to check. If falsey it will check against all bodies in the world.","name":"bodies"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the bodies overlap.","name":"overlapCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two bodies if they overlap. If this is set then `overlapCallback` will only be invoked if this callback returns `true`.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The context, or scope, in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the target body intersects with _any_ of the bodies given, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#overlap","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":936,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the collision filter category of all given Matter Bodies to the given value.\n\nThis number must be a power of two between 2^0 (= 1) and 2^31.\n\nBodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\ncategories are included in their collision masks (see {@link #setCollidesWith}).","kind":"function","name":"setCollisionCategory","since":"3.22.0","params":[{"type":{"names":["Array."]},"description":"An array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"Unique category bitfield.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setCollisionCategory","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":964,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the collision filter group of all given Matter Bodies to the given value.\n\nIf the group value is zero, or if two Matter Bodies have different group values,\nthey will collide according to the usual collision filter rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\n\nIf two Matter Bodies have the same positive group value, they will always collide;\nif they have the same negative group value they will never collide.","kind":"function","name":"setCollisionGroup","since":"3.22.0","params":[{"type":{"names":["Array."]},"description":"An array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"Unique group index.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":993,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the collision filter mask of all given Matter Bodies to the given value.\n\nTwo Matter Bodies with different collision groups will only collide if each one includes the others\ncategory in its mask based on a bitwise AND operation: `(categoryA & maskB) !== 0` and \n`(categoryB & maskA) !== 0` are both true.","kind":"function","name":"setCollidesWith","since":"3.22.0","params":[{"type":{"names":["Array."]},"description":"An array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number","Array."]},"description":"A unique category bitfield, or an array of them.","name":"categories"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setCollidesWith","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1034,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes an array and returns a new array made from all of the Matter Bodies found in the original array.\n\nFor example, passing in Matter Game Objects, such as a bunch of Matter Sprites, to this method, would\nreturn an array containing all of their native Matter Body objects.\n\nIf the `bodies` argument is falsey, it will return all bodies in the world.","kind":"function","name":"getMatterBodies","since":"3.22.0","params":[{"type":{"names":["array"]},"optional":true,"description":"An array of objects to extract the bodies from. If falsey, it will return all bodies in the world.","name":"bodies"}],"returns":[{"type":{"names":["Array."]},"description":"An array of native Matter Body objects."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#getMatterBodies","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1073,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets both the horizontal and vertical linear velocity of the physics bodies.","kind":"function","name":"setVelocity","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"The horizontal linear velocity value.","name":"x"},{"type":{"names":["number"]},"description":"The vertical linear velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setVelocity","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1102,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets just the horizontal linear velocity of the physics bodies.\nThe vertical velocity of the body is unchanged.","kind":"function","name":"setVelocityX","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"The horizontal linear velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setVelocityX","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets just the vertical linear velocity of the physics bodies.\nThe horizontal velocity of the body is unchanged.","kind":"function","name":"setVelocityY","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"The vertical linear velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setVelocityY","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1160,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the angular velocity of the bodies instantly.\nPosition, angle, force etc. are unchanged.","kind":"function","name":"setAngularVelocity","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"The angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setAngularVelocity","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Applies a force to a body, at the bodies current position, including resulting torque.","kind":"function","name":"applyForce","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#applyForce","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1212,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Applies a force to a body, from the given world position, including resulting torque.\nIf no angle is given, the current body angle is used.\n\nUse very small speed values, such as 0.1, depending on the mass and required velocity.","kind":"function","name":"applyForceFromPosition","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"A Vector that specifies the world-space position to apply the force at.","name":"position"},{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"},{"type":{"names":["number"]},"optional":true,"description":"The angle, in radians, to apply the force from. Leave undefined to use the current body angle.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#applyForceFromPosition","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1250,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Apply a force to a body based on the given angle and speed.\nIf no angle is given, the current body angle is used.\n\nUse very small speed values, such as 0.1, depending on the mass and required velocity.","kind":"function","name":"applyForceFromAngle","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"},{"type":{"names":["number"]},"optional":true,"description":"The angle, in radians, to apply the force from. Leave undefined to use the current body angle.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#applyForceFromAngle","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns the length of the given constraint, which is the distance between the two points.","kind":"function","name":"getConstraintLength","since":"3.22.0","params":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"The constraint to get the length from.","name":"constraint"}],"returns":[{"type":{"names":["number"]},"description":"The length of the constraint."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#getConstraintLength","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Aligns a Body, or Matter Game Object, against the given coordinates.\n\nThe alignment takes place using the body bounds, which take into consideration things\nlike body scale and rotation.\n\nAlthough a Body has a `position` property, it is based on the center of mass for the body,\nnot a dimension based center. This makes aligning bodies difficult, especially if they have\nrotated or scaled. This method will derive the correct position based on the body bounds and\nits center of mass offset, in order to align the body with the given coordinate.\n\nFor example, if you wanted to align a body so it sat in the bottom-center of the\nScene, and the world was 800 x 600 in size:\n\n```javascript\nthis.matter.alignBody(body, 400, 600, Phaser.Display.Align.BOTTOM_CENTER);\n```\n\nYou pass in 400 for the x coordinate, because that is the center of the world, and 600 for\nthe y coordinate, as that is the base of the world.","kind":"function","name":"alignBody","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to align.","name":"body"},{"type":{"names":["number"]},"description":"The horizontal position to align the body to.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position to align the body to.","name":"y"},{"type":{"names":["integer"]},"description":"One of the `Phaser.Display.Align` constants, such as `Phaser.Display.Align.TOP_LEFT`.","name":"align"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#alignBody","scope":"instance","___s":true},{"meta":{"range":[180,250],"filename":"MatterSprite.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"AnimationComponent","longname":"AnimationComponent","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MatterSprite.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"A Matter Physics Sprite Game Object.\n\nA Sprite Game Object is used for the display of both static and animated images in your game.\nSprites can have input events and physics bodies. They can also be tweened, tinted, scrolled\nand animated.\n\nThe main difference between a Sprite and an Image Game Object is that you cannot animate Images.\nAs such, Sprites take a fraction longer to process and have a larger API footprint due to the Animation\nComponent. If you do not require animation then you can safely use Images to replace Sprites in all cases.","kind":"class","name":"Sprite","augments":["Phaser.GameObjects.Sprite","Phaser.Physics.Matter.Components.Bounce","Phaser.Physics.Matter.Components.Collision","Phaser.Physics.Matter.Components.Force","Phaser.Physics.Matter.Components.Friction","Phaser.Physics.Matter.Components.Gravity","Phaser.Physics.Matter.Components.Mass","Phaser.Physics.Matter.Components.Sensor","Phaser.Physics.Matter.Components.SetBody","Phaser.Physics.Matter.Components.Sleep","Phaser.Physics.Matter.Components.Static","Phaser.Physics.Matter.Components.Transform","Phaser.Physics.Matter.Components.Velocity","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Physics.Matter","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"A reference to the Matter.World instance that this body belongs to.","name":"world"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"scope":"static","longname":"Phaser.Physics.Matter.Sprite","___s":true},{"meta":{"filename":"MatterSprite.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Matter.World instance that this body belongs to.","name":"world","type":{"names":["Phaser.Physics.Matter.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#world","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,220],"filename":"MatterTileBody.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Bodies","longname":"Bodies","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"A wrapper around a Tile that provides access to a corresponding Matter body. A tile can only\nhave one Matter body associated with it. You can either pass in an existing Matter body for\nthe tile or allow the constructor to create the corresponding body for you. If the Tile has a\ncollision group (defined in Tiled), those shapes will be used to create the body. If not, the\ntile's rectangle bounding box will be used.\n\nThe corresponding body will be accessible on the Tile itself via Tile.physics.matterBody.\n\nNote: not all Tiled collision shapes are supported. See\nPhaser.Physics.Matter.TileBody#setFromTileCollision for more information.","kind":"class","name":"TileBody","memberof":"Phaser.Physics.Matter","since":"3.0.0","augments":["Phaser.Physics.Matter.Components.Bounce","Phaser.Physics.Matter.Components.Collision","Phaser.Physics.Matter.Components.Friction","Phaser.Physics.Matter.Components.Gravity","Phaser.Physics.Matter.Components.Mass","Phaser.Physics.Matter.Components.Sensor","Phaser.Physics.Matter.Components.Sleep","Phaser.Physics.Matter.Components.Static"],"params":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"The Matter world instance this body belongs to.","name":"world"},{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The target tile that should have a Matter body.","name":"tile"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterTileOptions"]},"optional":true,"description":"Options to be used when creating the Matter body.","name":"options"}],"scope":"static","longname":"Phaser.Physics.Matter.TileBody","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":63,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The tile object the body is associated with.","name":"tile","type":{"names":["Phaser.Tilemaps.Tile"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#tile","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Matter world the body exists within.","name":"world","type":{"names":["Phaser.Physics.Matter.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":116,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the current body to a rectangle that matches the bounds of the tile.","kind":"function","name":"setFromTileRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyTileOptions"]},"optional":true,"description":"Options to be used when creating the Matter body. See MatterJS.Body for a list of what Matter accepts.","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This TileBody object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setFromTileRectangle","scope":"instance","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":142,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the current body from the collision group associated with the Tile. This is typically\nset up in Tiled's collision editor.\n\nNote: Matter doesn't support all shapes from Tiled. Rectangles and polygons are directly\nsupported. Ellipses are converted into circle bodies. Polylines are treated as if they are\nclosed polygons. If a tile has multiple shapes, a multi-part body will be created. Concave\nshapes are supported if poly-decomp library is included. Decomposition is not guaranteed to\nwork for complex shapes (e.g. holes), so it's often best to manually decompose a concave\npolygon into multiple convex polygons yourself.","kind":"function","name":"setFromTileCollision","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyTileOptions"]},"optional":true,"description":"Options to be used when creating the Matter body. See MatterJS.Body for a list of what Matter accepts.","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This TileBody object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setFromTileCollision","scope":"instance","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":239,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the current body to the given body. This will remove the previous body, if one already\nexists.","kind":"function","name":"setBody","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The new Matter body to use.","name":"body"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to add the body to the Matter world.","name":"addToWorld"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This TileBody object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setBody","scope":"instance","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":271,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Removes the current body from the TileBody and from the Matter world","kind":"function","name":"removeBody","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This TileBody object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#removeBody","scope":"instance","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Removes the current body from the tile and the world.","kind":"function","name":"destroy","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This TileBody object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#destroy","scope":"instance","___s":true},{"meta":{"range":[274,314],"filename":"PhysicsEditorParser.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Bodies","longname":"Bodies","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PhysicsEditorParser.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Use PhysicsEditorParser.parseBody() to build a Matter body object, based on a physics data file\ncreated and exported with PhysicsEditor (https://www.codeandweb.com/physicseditor).","kind":"namespace","name":"PhysicsEditorParser","since":"3.10.0","memberof":"Phaser.Physics.Matter","longname":"Phaser.Physics.Matter.PhysicsEditorParser","scope":"static","___s":true},{"meta":{"filename":"PhysicsEditorParser.js","lineno":24,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Parses a body element exported by PhysicsEditor.","kind":"function","name":"parseBody","since":"3.10.0","params":[{"type":{"names":["number"]},"description":"The horizontal world location of the body.","name":"x"},{"type":{"names":["number"]},"description":"The vertical world location of the body.","name":"y"},{"type":{"names":["object"]},"description":"The body configuration and fixture (child body) definitions, as exported by PhysicsEditor.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A compound Matter JS Body."}],"memberof":"Phaser.Physics.Matter.PhysicsEditorParser","longname":"Phaser.Physics.Matter.PhysicsEditorParser.parseBody","scope":"static","___s":true},{"meta":{"filename":"PhysicsEditorParser.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Parses an element of the \"fixtures\" list exported by PhysicsEditor","kind":"function","name":"parseFixture","since":"3.10.0","params":[{"type":{"names":["object"]},"description":"The fixture object to parse.","name":"fixtureConfig"}],"returns":[{"type":{"names":["Array."]},"description":"- An array of Matter JS Bodies."}],"memberof":"Phaser.Physics.Matter.PhysicsEditorParser","longname":"Phaser.Physics.Matter.PhysicsEditorParser.parseFixture","scope":"static","___s":true},{"meta":{"filename":"PhysicsEditorParser.js","lineno":104,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Parses the \"vertices\" lists exported by PhysicsEditor.","kind":"function","name":"parseVertices","since":"3.10.0","params":[{"type":{"names":["array"]},"description":"The vertex lists to parse.","name":"vertexSets"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Array."]},"description":"- An array of Matter JS Bodies."}],"memberof":"Phaser.Physics.Matter.PhysicsEditorParser","longname":"Phaser.Physics.Matter.PhysicsEditorParser.parseVertices","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"PhysicsJSONParser.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Bodies","longname":"Bodies","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PhysicsJSONParser.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a body using the supplied physics data, as provided by a JSON file.\n\nThe data file should be loaded as JSON:\n\n```javascript\npreload ()\n{\n this.load.json('ninjas', 'assets/ninjas.json);\n}\n\ncreate ()\n{\n const ninjaShapes = this.cache.json.get('ninjas');\n\n this.matter.add.fromJSON(400, 300, ninjaShapes.shinobi);\n}\n```\n\nDo not pass the entire JSON file to this method, but instead pass one of the shapes contained within it.\n\nIf you pas in an `options` object, any settings in there will override those in the config object.\n\nThe structure of the JSON file is as follows:\n\n```text\n{\n 'generator_info': // The name of the application that created the JSON data\n 'shapeName': {\n 'type': // The type of body\n 'label': // Optional body label\n 'vertices': // An array, or an array of arrays, containing the vertex data in x/y object pairs\n }\n}\n```\n\nAt the time of writing, only the Phaser Physics Tracer App exports in this format.","kind":"namespace","name":"PhysicsJSONParser","since":"3.22.0","memberof":"Phaser.Physics.Matter","longname":"Phaser.Physics.Matter.PhysicsJSONParser","scope":"static","___s":true},{"meta":{"filename":"PhysicsJSONParser.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Parses a body element from the given JSON data.","kind":"function","name":"parseBody","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The horizontal world location of the body.","name":"x"},{"type":{"names":["number"]},"description":"The vertical world location of the body.","name":"y"},{"type":{"names":["object"]},"description":"The body configuration data.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.PhysicsJSONParser","longname":"Phaser.Physics.Matter.PhysicsJSONParser.parseBody","scope":"static","___s":true},{"meta":{"range":[180,221],"filename":"PointerConstraint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Bounds","longname":"Bounds","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"A Pointer Constraint is a special type of constraint that allows you to click\nand drag bodies in a Matter World. It monitors the active Pointers in a Scene,\nand when one is pressed down it checks to see if that hit any part of any active\nbody in the world. If it did, and the body has input enabled, it will begin to\ndrag it until either released, or you stop it via the `stopDrag` method.\n\nYou can adjust the stiffness, length and other properties of the constraint via\nthe `options` object on creation.","kind":"class","name":"PointerConstraint","memberof":"Phaser.Physics.Matter","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene to which this Pointer Constraint belongs.","name":"scene"},{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"A reference to the Matter World instance to which this Constraint belongs.","name":"world"},{"type":{"names":["object"]},"optional":true,"description":"A Constraint configuration object.","name":"options"}],"scope":"static","longname":"Phaser.Physics.Matter.PointerConstraint","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Scene to which this Pointer Constraint belongs.\nThis is the same Scene as the Matter World instance.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Matter World instance to which this Constraint belongs.","name":"world","type":{"names":["Phaser.Physics.Matter.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Camera the Pointer was interacting with when the input\ndown event was processed.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Input Pointer that activated this Constraint.\nThis is set in the `onDown` handler.","name":"pointer","type":{"names":["Phaser.Input.Pointer"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#pointer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Is this Constraint active or not?\n\nAn active constraint will be processed each update. An inactive one will be skipped.\nUse this to toggle a Pointer Constraint on and off.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The internal transformed position.","name":"position","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#position","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The body that is currently being dragged, if any.","name":"body","type":{"names":["MatterJS.BodyType"]},"nullable":true,"since":"3.16.2","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#body","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The part of the body that was clicked on to start the drag.","name":"part","type":{"names":["MatterJS.BodyType"]},"nullable":true,"since":"3.16.2","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#part","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The native Matter Constraint that is used to attach to bodies.","name":"constraint","type":{"names":["MatterJS.ConstraintType"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#constraint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A Pointer has been pressed down onto the Scene.\n\nIf this Constraint doesn't have an active Pointer then a hit test is set to\nrun against all active bodies in the world during the _next_ call to `update`.\nIf a body is found, it is bound to this constraint and the drag begins.","kind":"function","name":"onDown","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"A reference to the Pointer that was pressed.","name":"pointer"}],"memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#onDown","scope":"instance","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A Pointer has been released from the Scene. If it was the one this constraint was using, it's cleared.","kind":"function","name":"onUp","since":"3.22.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"A reference to the Pointer that was pressed.","name":"pointer"}],"memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#onUp","scope":"instance","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":194,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Scans all active bodies in the current Matter World to see if any of them\nare hit by the Pointer. The _first one_ found to hit is set as the active contraint\nbody.","kind":"function","name":"getBody","fires":["Phaser.Physics.Matter.Events#event:DRAG_START"],"since":"3.16.2","returns":[{"type":{"names":["boolean"]},"description":"`true` if a body was found and set, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#getBody","scope":"instance","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":234,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Scans the current body to determine if a part of it was clicked on.\nIf a part is found the body is set as the `constraint.bodyB` property,\nas well as the `body` property of this class. The part is also set.","kind":"function","name":"hitTestBody","since":"3.16.2","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Matter Body to check.","name":"body"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"A translated hit test position.","name":"position"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if a part of the body was hit, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#hitTestBody","scope":"instance","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Internal update handler. Called in the Matter BEFORE_UPDATE step.","kind":"function","name":"update","fires":["Phaser.Physics.Matter.Events#event:DRAG"],"since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#update","scope":"instance","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Stops the Pointer Constraint from dragging the body any further.\n\nThis is called automatically if the Pointer is released while actively\ndragging a body. Or, you can call it manually to release a body from a\nconstraint without having to first release the pointer.","kind":"function","name":"stopDrag","fires":["Phaser.Physics.Matter.Events#event:DRAG_END"],"since":"3.16.2","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#stopDrag","scope":"instance","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Destroys this Pointer Constraint instance and all of its references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#destroy","scope":"instance","___s":true},{"meta":{"range":[180,220],"filename":"World.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Bodies","longname":"Bodies","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"World.js","lineno":23,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"The Matter World class is responsible for managing one single instance of a Matter Physics World for Phaser.\n\nAccess this via `this.matter.world` from within a Scene.\n\nThis class creates a Matter JS World Composite along with the Matter JS Engine during instantiation. It also\nhandles delta timing, bounds, body and constraint creation and debug drawing.\n\nIf you wish to access the Matter JS World object directly, see the `localWorld` property.\nIf you wish to access the Matter Engine directly, see the `engine` property.\n\nThis class is an Event Emitter and will proxy _all_ Matter JS events, as they are received.","kind":"class","name":"World","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Physics.Matter","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Matter World instance belongs.","name":"scene"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterWorldConfig"]},"description":"The Matter World configuration object.","name":"config"}],"scope":"static","longname":"Phaser.Physics.Matter.World","___s":true},{"meta":{"filename":"World.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Scene to which this Matter World instance belongs.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"An instance of the MatterJS Engine.","name":"engine","type":{"names":["MatterJS.Engine"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#engine","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A `World` composite object that will contain all simulated bodies and constraints.","name":"localWorld","type":{"names":["MatterJS.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#localWorld","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"An object containing the 4 wall bodies that bound the physics world.","name":"walls","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#walls","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A flag that toggles if the world is enabled or not.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":113,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The correction argument is an optional Number that specifies the time correction factor to apply to the update.\nThis can help improve the accuracy of the simulation in cases where delta is changing between updates.\nThe value of correction is defined as delta / lastDelta, i.e. the percentage change of delta over the last step.\nTherefore the value is always 1 (no correction) when delta is constant (or when no correction is desired, which is the default).\nSee the paper on Time Corrected Verlet for more information.","name":"correction","type":{"names":["number"]},"defaultvalue":"1","since":"3.4.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#correction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"This function is called every time the core game loop steps, which is bound to the\nRequest Animation Frame frequency unless otherwise modified.\n\nThe function is passed two values: `time` and `delta`, both of which come from the game step values.\n\nIt must return a number. This number is used as the delta value passed to Matter.Engine.update.\n\nYou can override this function with your own to define your own timestep.\n\nIf you need to update the Engine multiple times in a single game step then call\n`World.update` as many times as required. Each call will trigger the `getDelta` function.\nIf you wish to have full control over when the Engine updates then see the property `autoUpdate`.\n\nYou can also adjust the number of iterations that Engine.update performs.\nUse the Scene Matter Physics config object to set the following properties:\n\npositionIterations (defaults to 6)\nvelocityIterations (defaults to 4)\nconstraintIterations (defaults to 2)\n\nAdjusting these values can help performance in certain situations, depending on the physics requirements\nof your game.","name":"getDelta","type":{"names":["function"]},"since":"3.4.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#getDelta","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":172,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Matter JS Runner Configuration object.\n\nThis object is populated via the Matter Configuration object's `runner` property and is\nupdated constantly during the game step.","name":"runner","type":{"names":["Phaser.Types.Physics.Matter.MatterRunnerConfig"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#runner","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":198,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Automatically call Engine.update every time the game steps.\nIf you disable this then you are responsible for calling `World.step` directly from your game.\nIf you call `set60Hz` or `set30Hz` then `autoUpdate` is reset to `true`.","name":"autoUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.4.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#autoUpdate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":212,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A flag that controls if the debug graphics will be drawn to or not.","name":"drawDebug","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#drawDebug","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":222,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"An instance of the Graphics object the debug bodies are drawn to, if enabled.","name":"debugGraphic","type":{"names":["Phaser.GameObjects.Graphics"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#debugGraphic","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":231,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The debug configuration object.\n\nThe values stored in this object are read from the Matter World Config `debug` property.\n\nWhen a new Body or Constraint is _added to the World_, they are given the values stored in this object,\nunless they have their own `render` object set that will override them.\n\nNote that while you can modify the values of properties in this object at run-time, it will not change\nany of the Matter objects _already added_. It will only impact objects newly added to the world, or one\nthat is removed and then re-added at a later time.","name":"debugConfig","type":{"names":["Phaser.Types.Physics.Matter.MatterDebugConfig"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#debugConfig","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":347,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the debug render style for the children of the given Matter Composite.\n\nComposites themselves do not render, but they can contain bodies, constraints and other composites that may do.\nSo the children of this composite are passed to the `setBodyRenderStyle`, `setCompositeRenderStyle` and\n`setConstraintRenderStyle` methods accordingly.","kind":"function","name":"setCompositeRenderStyle","since":"3.22.0","params":[{"type":{"names":["MatterJS.CompositeType"]},"description":"The Matter Composite to set the render style on.","name":"composite"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#setCompositeRenderStyle","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":397,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the debug render style for the given Matter Body.\n\nIf you are using this on a Phaser Game Object, such as a Matter Sprite, then pass in the body property\nto this method, not the Game Object itself.\n\nIf you wish to skip a parameter, so it retains its current value, pass `false` for it.\n\nIf you wish to reset the Body render colors to the defaults found in the World Debug Config, then call\nthis method with just the `body` parameter provided and no others.","kind":"function","name":"setBodyRenderStyle","since":"3.22.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Matter Body to set the render style on.","name":"body"},{"type":{"names":["number"]},"optional":true,"description":"The line color. If `null` it will use the World Debug Config value.","name":"lineColor"},{"type":{"names":["number"]},"optional":true,"description":"The line opacity, between 0 and 1. If `null` it will use the World Debug Config value.","name":"lineOpacity"},{"type":{"names":["number"]},"optional":true,"description":"The line thickness. If `null` it will use the World Debug Config value.","name":"lineThickness"},{"type":{"names":["number"]},"optional":true,"description":"The fill color. If `null` it will use the World Debug Config value.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The fill opacity, between 0 and 1. If `null` it will use the World Debug Config value.","name":"fillOpacity"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#setBodyRenderStyle","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the debug render style for the given Matter Constraint.\n\nIf you are using this on a Phaser Game Object, then pass in the body property\nto this method, not the Game Object itself.\n\nIf you wish to skip a parameter, so it retains its current value, pass `false` for it.\n\nIf you wish to reset the Constraint render colors to the defaults found in the World Debug Config, then call\nthis method with just the `constraint` parameter provided and no others.","kind":"function","name":"setConstraintRenderStyle","since":"3.22.0","params":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"The Matter Constraint to set the render style on.","name":"constraint"},{"type":{"names":["number"]},"optional":true,"description":"The line color. If `null` it will use the World Debug Config value.","name":"lineColor"},{"type":{"names":["number"]},"optional":true,"description":"The line opacity, between 0 and 1. If `null` it will use the World Debug Config value.","name":"lineOpacity"},{"type":{"names":["number"]},"optional":true,"description":"The line thickness. If `null` it will use the World Debug Config value.","name":"lineThickness"},{"type":{"names":["number"]},"optional":true,"description":"If this constraint is a pin, this sets the size of the pin circle. If `null` it will use the World Debug Config value.","name":"pinSize"},{"type":{"names":["number"]},"optional":true,"description":"The color used when rendering this constraints anchors. If `null` it will use the World Debug Config value.","name":"anchorColor"},{"type":{"names":["number"]},"optional":true,"description":"The size of the anchor circle, if this constraint has anchors. If `null` it will use the World Debug Config value.","name":"anchorSize"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#setConstraintRenderStyle","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":594,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"This internal method acts as a proxy between all of the Matter JS events and then re-emits them\nvia this class.","kind":"function","name":"setEventsProxy","since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#setEventsProxy","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the bounds of the Physics world to match the given world pixel dimensions.\nYou can optionally set which 'walls' to create: left, right, top or bottom.\nIf none of the walls are given it will default to use the walls settings it had previously.\nI.e. if you previously told it to not have the left or right walls, and you then adjust the world size\nthe newly created bounds will also not have the left and right walls.\nExplicitly state them in the parameters to override this.","kind":"function","name":"setBounds","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the top-left corner of the bounds.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the top-left corner of the bounds.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the bounds.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the bounds.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The thickness of each wall, in pixels.","name":"thickness"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the left bounds wall.","name":"left"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the right bounds wall.","name":"right"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the top bounds wall.","name":"top"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the bottom bounds wall.","name":"bottom"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#setBounds","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":760,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Updates the 4 rectangle bodies that were created, if `setBounds` was set in the Matter config, to use\nthe new positions and sizes. This method is usually only called internally via the `setBounds` method.","kind":"function","name":"updateWall","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` if the walls are being added or updated, `false` to remove them from the world.","name":"add"},{"type":{"names":["string"]},"optional":true,"description":"Either `left`, `right`, `top` or `bottom`. Only optional if `add` is `false`.","name":"position"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position to place the walls at. Only optional if `add` is `false`.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position to place the walls at. Only optional if `add` is `false`.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the walls, in pixels. Only optional if `add` is `false`.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the walls, in pixels. Only optional if `add` is `false`.","name":"height"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#updateWall","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":802,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a Phaser.GameObjects.Graphics object that is used to render all of the debug bodies and joints to.\n\nThis method is called automatically by the constructor, if debugging has been enabled.\n\nThe created Graphics object is automatically added to the Scene at 0x0 and given a depth of `Number.MAX_VALUE`,\nso it renders above all else in the Scene.\n\nThe Graphics object is assigned to the `debugGraphic` property of this class and `drawDebug` is enabled.","kind":"function","name":"createDebugGraphic","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The newly created Graphics object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#createDebugGraphic","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":830,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the world gravity and gravity scale to 0.","kind":"function","name":"disableGravity","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#disableGravity","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":847,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the worlds gravity to the values given.\n\nGravity effects all bodies in the world, unless they have the `ignoreGravity` flag set.","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world gravity x component.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The world gravity y component.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.001,"description":"The gravity scale factor.","name":"scale"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#setGravity","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":877,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a rectangle Matter body and adds it to the world.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the body in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the body in the world.","name":"y"},{"type":{"names":["number"]},"description":"The width of the body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the body.","name":"height"},{"type":{"names":["object"]},"description":"Optional Matter configuration object.","name":"options"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Matter.js body that was created."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#create","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":900,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Adds a Matter JS object, or array of objects, to the world.\n\nThe objects should be valid Matter JS entities, such as a Body, Composite or Constraint.\n\nTriggers `beforeAdd` and `afterAdd` events.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["object","Array."]},"description":"Can be single object, or an array, and can be a body, composite or constraint.","name":"object"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#add","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":921,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Removes a Matter JS object, or array of objects, from the world.\n\nThe objects should be valid Matter JS entities, such as a Body, Composite or Constraint.\n\nTriggers `beforeRemove` and `afterRemove` events.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["object","Array."]},"description":"Can be single object, or an array, and can be a body, composite or constraint.","name":"object"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally search the objects children and recursively remove those as well.","name":"deep"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#remove","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":955,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Removes a Matter JS constraint, or array of constraints, from the world.\n\nTriggers `beforeRemove` and `afterRemove` events.","kind":"function","name":"removeConstraint","since":"3.0.0","params":[{"type":{"names":["MatterJS.ConstraintType","Array."]},"description":"A Matter JS Constraint, or an array of constraints, to be removed.","name":"constraint"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally search the objects children and recursively remove those as well.","name":"deep"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#removeConstraint","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":975,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Adds `MatterTileBody` instances for all the colliding tiles within the given tilemap layer.\n\nSet the appropriate tiles in your layer to collide before calling this method!","kind":"function","name":"convertTilemapLayer","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"description":"An array of tiles.","name":"tilemapLayer"},{"type":{"names":["object"]},"optional":true,"description":"Options to be passed to the MatterTileBody constructor. {@see Phaser.Physics.Matter.TileBody}","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#convertTilemapLayer","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":999,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Adds `MatterTileBody` instances for the given tiles. This adds bodies regardless of whether the\ntiles are set to collide or not.","kind":"function","name":"convertTiles","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of tiles.","name":"tiles"},{"type":{"names":["object"]},"optional":true,"description":"Options to be passed to the MatterTileBody constructor. {@see Phaser.Physics.Matter.TileBody}","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#convertTiles","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1026,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns the next unique group index for which bodies will collide.\nIf `isNonColliding` is `true`, returns the next unique group index for which bodies will not collide.","kind":"function","name":"nextGroup","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true`, returns the next unique group index for which bodies will _not_ collide.","name":"isNonColliding"}],"returns":[{"type":{"names":["number"]},"description":"Unique category bitfield"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#nextGroup","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1042,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns the next unique category bitfield (starting after the initial default category 0x0001).\nThere are 32 available.","kind":"function","name":"nextCategory","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"Unique category bitfield"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#nextCategory","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1056,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Pauses this Matter World instance and sets `enabled` to `false`.\n\nA paused world will not run any simulations for the duration it is paused.","kind":"function","name":"pause","fires":["Phaser.Physics.Matter.Events#event:PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#pause","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1076,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Resumes this Matter World instance from a paused state and sets `enabled` to `true`.","kind":"function","name":"resume","fires":["Phaser.Physics.Matter.Events#event:RESUME"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#resume","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1094,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The internal update method. This is called automatically by the parent Scene.\n\nMoves the simulation forward in time by delta ms. Uses `World.correction` value as an optional number that\nspecifies the time correction factor to apply to the update. This can help improve the accuracy of the\nsimulation in cases where delta is changing between updates. The value of correction is defined as `delta / lastDelta`,\ni.e. the percentage change of delta over the last step. Therefore the value is always 1 (no correction) when\ndelta is constant (or when no correction is desired, which is the default).\nSee the paper on Time Corrected Verlet for more information.\n\nTriggers `beforeUpdate` and `afterUpdate` events. Triggers `collisionStart`, `collisionActive` and `collisionEnd` events.\n\nIf the World is paused, `update` is still run, but exits early and does not update the Matter Engine.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#update","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Manually advances the physics simulation by one iteration.\n\nYou can optionally pass in the `delta` and `correction` values to be used by Engine.update.\nIf undefined they use the Matter defaults of 60Hz and no correction.\n\nCalling `step` directly bypasses any checks of `enabled` or `autoUpdate`.\n\nIt also ignores any custom `getDelta` functions, as you should be passing the delta\nvalue in to this call.\n\nYou can adjust the number of iterations that Engine.update performs internally.\nUse the Scene Matter Physics config object to set the following properties:\n\npositionIterations (defaults to 6)\nvelocityIterations (defaults to 4)\nconstraintIterations (defaults to 2)\n\nAdjusting these values can help performance in certain situations, depending on the physics requirements\nof your game.","kind":"function","name":"step","since":"3.4.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":16.666,"description":"The delta value.","name":"delta"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Optional delta correction value.","name":"correction"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#step","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Runs the Matter Engine.update at a fixed timestep of 60Hz.","kind":"function","name":"update60Hz","since":"3.4.0","returns":[{"type":{"names":["number"]},"description":"The delta value to be passed to Engine.update."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#update60Hz","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1226,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Runs the Matter Engine.update at a fixed timestep of 30Hz.","kind":"function","name":"update30Hz","since":"3.4.0","returns":[{"type":{"names":["number"]},"description":"The delta value to be passed to Engine.update."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#update30Hz","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1239,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns `true` if the given body can be found within the World.","kind":"function","name":"has","since":"3.22.0","params":[{"type":{"names":["MatterJS.Body","Phaser.GameObjects.GameObject"]},"description":"The Matter Body, or Game Object, to search for within the world.","name":"body"}],"returns":[{"type":{"names":["Array."]},"description":"An array of all the Matter JS Bodies in this World."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#has","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns all the bodies in the Matter World, including all bodies in children, recursively.","kind":"function","name":"getAllBodies","since":"3.22.0","returns":[{"type":{"names":["Array."]},"description":"An array of all the Matter JS Bodies in this World."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#getAllBodies","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns all the constraints in the Matter World, including all constraints in children, recursively.","kind":"function","name":"getAllConstraints","since":"3.22.0","returns":[{"type":{"names":["Array."]},"description":"An array of all the Matter JS Constraints in this World."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#getAllConstraints","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1282,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns all the composites in the Matter World, including all composites in children, recursively.","kind":"function","name":"getAllComposites","since":"3.22.0","returns":[{"type":{"names":["Array."]},"description":"An array of all the Matter JS Composites in this World."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#getAllComposites","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1360,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders the Engine Broadphase Controller Grid to the given Graphics instance.\n\nThe debug renderer calls this method if the `showBroadphase` config value is set.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render the Grid to your own Graphics instance.","kind":"function","name":"renderGrid","since":"3.22.0","params":[{"type":{"names":["MatterJS.Grid"]},"description":"The Matter Grid to be rendered.","name":"grid"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"},{"type":{"names":["number"]},"description":"The line opacity, between 0 and 1.","name":"lineOpacity"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderGrid","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1406,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders the list of Pair separations to the given Graphics instance.\n\nThe debug renderer calls this method if the `showSeparations` config value is set.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render the Grid to your own Graphics instance.","kind":"function","name":"renderSeparations","since":"3.22.0","params":[{"type":{"names":["Array."]},"description":"An array of Matter Pairs to be rendered.","name":"pairs"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderSeparations","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1475,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders the list of collision points and normals to the given Graphics instance.\n\nThe debug renderer calls this method if the `showCollisions` config value is set.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render the Grid to your own Graphics instance.","kind":"function","name":"renderCollisions","since":"3.22.0","params":[{"type":{"names":["Array."]},"description":"An array of Matter Pairs to be rendered.","name":"pairs"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderCollisions","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1569,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders the bounds of an array of Bodies to the given Graphics instance.\n\nIf the body is a compound body, it will render the bounds for the parent compound.\n\nThe debug renderer calls this method if the `showBounds` config value is set.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render bounds to your own Graphics instance.","kind":"function","name":"renderBodyBounds","since":"3.22.0","params":[{"type":{"names":["array"]},"description":"An array of bodies from the localWorld.","name":"bodies"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"},{"type":{"names":["number"]},"description":"The line opacity, between 0 and 1.","name":"lineOpacity"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderBodyBounds","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1633,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders either all axes, or a single axis indicator, for an array of Bodies, to the given Graphics instance.\n\nThe debug renderer calls this method if the `showAxes` or `showAngleIndicator` config values are set.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render bounds to your own Graphics instance.","kind":"function","name":"renderBodyAxes","since":"3.22.0","params":[{"type":{"names":["array"]},"description":"An array of bodies from the localWorld.","name":"bodies"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["boolean"]},"description":"If `true` it will render all body axes. If `false` it will render a single axis indicator.","name":"showAxes"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"},{"type":{"names":["number"]},"description":"The line opacity, between 0 and 1.","name":"lineOpacity"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderBodyAxes","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1710,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders a velocity indicator for an array of Bodies, to the given Graphics instance.\n\nThe debug renderer calls this method if the `showVelocity` config value is set.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render bounds to your own Graphics instance.","kind":"function","name":"renderBodyVelocity","since":"3.22.0","params":[{"type":{"names":["array"]},"description":"An array of bodies from the localWorld.","name":"bodies"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"},{"type":{"names":["number"]},"description":"The line opacity, between 0 and 1.","name":"lineOpacity"},{"type":{"names":["number"]},"description":"The line thickness.","name":"lineThickness"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderBodyVelocity","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1842,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders a single Matter Body to the given Phaser Graphics Game Object.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render a Body to your own Graphics instance.\n\nIf you don't wish to render a line around the body, set the `lineColor` parameter to `null`.\nEqually, if you don't wish to render a fill, set the `fillColor` parameter to `null`.","kind":"function","name":"renderBody","since":"3.22.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Matter Body to be rendered.","name":"body"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["boolean"]},"description":"Render internal edges of the polygon?","name":"showInternalEdges"},{"type":{"names":["number"]},"optional":true,"description":"The line color.","name":"lineColor"},{"type":{"names":["number"]},"optional":true,"description":"The line opacity, between 0 and 1.","name":"lineOpacity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The line thickness.","name":"lineThickness"},{"type":{"names":["number"]},"optional":true,"description":"The fill color.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The fill opacity, between 0 and 1.","name":"fillOpacity"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderBody","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1982,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders the Convex Hull for a single Matter Body to the given Phaser Graphics Game Object.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render a Body hull to your own Graphics instance.","kind":"function","name":"renderConvexHull","since":"3.22.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Matter Body to be rendered.","name":"body"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The color used to render the hull.","name":"hullColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The hull line thickness.","name":"lineThickness"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderConvexHull","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2060,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders a single Matter Constraint, such as a Pin or a Spring, to the given Phaser Graphics Game Object.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render a Constraint to your own Graphics instance.","kind":"function","name":"renderConstraint","since":"3.22.0","params":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"The Matter Constraint to render.","name":"constraint"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"},{"type":{"names":["number"]},"description":"The line opacity, between 0 and 1.","name":"lineOpacity"},{"type":{"names":["number"]},"description":"The line thickness.","name":"lineThickness"},{"type":{"names":["number"]},"description":"If this constraint is a pin, this sets the size of the pin circle.","name":"pinSize"},{"type":{"names":["number"]},"description":"The color used when rendering this constraints anchors. Set to `null` to not render anchors.","name":"anchorColor"},{"type":{"names":["number"]},"description":"The size of the anchor circle, if this constraint has anchors and is rendering them.","name":"anchorSize"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderConstraint","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2156,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Resets the internal collision IDs that Matter.JS uses for Body collision groups.\n\nYou should call this before destroying your game if you need to restart the game\nagain on the same page, without first reloading the page. Or, if you wish to\nconsistently destroy a Scene that contains Matter.js and then run it again\nlater in the same game.","kind":"function","name":"resetCollisionIDs","since":"3.17.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#resetCollisionIDs","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2176,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Will remove all Matter physics event listeners and clear the matter physics world,\nengine and any debug graphics, if any.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#shutdown","scope":"instance","overrides":"Phaser.Events.EventEmitter#shutdown","___s":true},{"meta":{"filename":"World.js","lineno":2199,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Will remove all Matter physics event listeners and clear the matter physics world,\nengine and any debug graphics, if any.\n\nAfter destroying the world it cannot be re-used again.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"Bounce.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A component to set restitution on objects.","kind":"namespace","name":"Bounce","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Bounce","scope":"static","___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the restitution on the physics object.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Bounce","longname":"Phaser.Physics.Matter.Components.Bounce#setBounce","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Contains methods for changing the collision filter of a Matter Body. Should be used as a mixin and not called directly.","kind":"namespace","name":"Collision","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Collision","scope":"static","___s":true},{"meta":{"filename":"Collision.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\nTwo bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\ncategories are included in their collision masks (see {@link #setCollidesWith}).","kind":"function","name":"setCollisionCategory","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique category bitfield.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setCollisionCategory","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\nthey will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\nIf two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\nthey will never collide.","kind":"function","name":"setCollisionGroup","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique group index.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\ncollide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\nand `(categoryB & maskA) !== 0` are both true.","kind":"function","name":"setCollidesWith","since":"3.0.0","params":[{"type":{"names":["number","Array."]},"description":"A unique category bitfield, or an array of them.","name":"categories"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setCollidesWith","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollide","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body starts colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setOnCollide","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideEnd","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body stops colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setOnCollideEnd","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideActive","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke for the duration of this body colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setOnCollideActive","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideWith","since":"3.22.0","params":[{"type":{"names":["MatterJS.Body","Array."]},"description":"The body, or an array of bodies, to test for collisions with.","name":"body"},{"type":{"names":["function"]},"description":"The callback to invoke when this body collides with the given body or bodies.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setOnCollideWith","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"Force.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Force.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A component to apply force to Matter.js bodies.","kind":"namespace","name":"Force","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Force","scope":"static","___s":true},{"meta":{"filename":"Force.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Applies a force to a body.","kind":"function","name":"applyForce","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Force","longname":"Phaser.Physics.Matter.Components.Force#applyForce","scope":"instance","___s":true},{"meta":{"filename":"Force.js","lineno":38,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Applies a force to a body from a given position.","kind":"function","name":"applyForceFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The position in which the force comes from.","name":"position"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Force","longname":"Phaser.Physics.Matter.Components.Force#applyForceFrom","scope":"instance","___s":true},{"meta":{"filename":"Force.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the forward position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrust","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Force","longname":"Phaser.Physics.Matter.Components.Force#thrust","scope":"instance","___s":true},{"meta":{"filename":"Force.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the left position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustLeft","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Force","longname":"Phaser.Physics.Matter.Components.Force#thrustLeft","scope":"instance","___s":true},{"meta":{"filename":"Force.js","lineno":102,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the right position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustRight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Force","longname":"Phaser.Physics.Matter.Components.Force#thrustRight","scope":"instance","___s":true},{"meta":{"filename":"Force.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the back position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustBack","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Force","longname":"Phaser.Physics.Matter.Components.Force#thrustBack","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Contains methods for changing the friction of a Game Object's Matter Body. Should be used a mixin, not called directly.","kind":"namespace","name":"Friction","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Friction","scope":"static","___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets new friction values for this Game Object's Matter Body.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.","name":"air"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.","name":"fstatic"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Friction","longname":"Phaser.Physics.Matter.Components.Friction#setFriction","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new air resistance for this Game Object's Matter Body.\nA value of 0 means the Body will never slow as it moves through space.\nThe higher the value, the faster a Body slows when moving through space.","kind":"function","name":"setFrictionAir","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new air resistance for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Friction","longname":"Phaser.Physics.Matter.Components.Friction#setFrictionAir","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new static friction for this Game Object's Matter Body.\nA value of 0 means the Body will never \"stick\" when it is nearly stationary.\nThe higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.","kind":"function","name":"setFrictionStatic","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new static friction for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Friction","longname":"Phaser.Physics.Matter.Components.Friction#setFrictionStatic","scope":"instance","___s":true},{"meta":{"filename":"Gravity.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A component to manipulate world gravity for Matter.js bodies.","kind":"namespace","name":"Gravity","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Gravity","scope":"static","___s":true},{"meta":{"filename":"Gravity.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A togglable function for ignoring world gravity in real-time on the current body.","kind":"function","name":"setIgnoreGravity","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to true to ignore the effect of world gravity, or false to not ignore it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Gravity","longname":"Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"Mass.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Mass.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Allows accessing the mass, density, and center of mass of a Matter-enabled Game Object. Should be used as a mixin and not directly.","kind":"namespace","name":"Mass","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Mass","scope":"static","___s":true},{"meta":{"filename":"Mass.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the mass of the Game Object's Matter Body.","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Mass","longname":"Phaser.Physics.Matter.Components.Mass#setMass","scope":"instance","___s":true},{"meta":{"filename":"Mass.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets density of the body.","kind":"function","name":"setDensity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new density of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Mass","longname":"Phaser.Physics.Matter.Components.Mass#setDensity","scope":"instance","___s":true},{"meta":{"filename":"Mass.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The body's center of mass.\n\nCalling this creates a new `Vector2 each time to avoid mutation.\n\nIf you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.","name":"centerOfMass","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.10.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The center of mass."}],"memberof":"Phaser.Physics.Matter.Components.Mass","longname":"Phaser.Physics.Matter.Components.Mass#centerOfMass","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Sensor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables a Matter-enabled Game Object to be a sensor. Should be used as a mixin and not directly.","kind":"namespace","name":"Sensor","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Sensor","scope":"static","___s":true},{"meta":{"filename":"Sensor.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body belonging to this Game Object to be a sensor.\nSensors trigger collision events, but don't react with colliding body physically.","kind":"function","name":"setSensor","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as a sensor, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sensor","longname":"Phaser.Physics.Matter.Components.Sensor#setSensor","scope":"instance","___s":true},{"meta":{"filename":"Sensor.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Is the body belonging to this Game Object a sensor or not?","kind":"function","name":"isSensor","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is a sensor, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Components.Sensor","longname":"Phaser.Physics.Matter.Components.Sensor#isSensor","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"SetBody.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Bodies","longname":"Bodies","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetBody.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables a Matter-enabled Game Object to set its Body. Should be used as a mixin and not directly.","kind":"namespace","name":"SetBody","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.SetBody","scope":"static","___s":true},{"meta":{"filename":"SetBody.js","lineno":23,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on a Game Object to a rectangle.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setRectangle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.SetBody","longname":"Phaser.Physics.Matter.Components.SetBody#setRectangle","scope":"instance","___s":true},{"meta":{"filename":"SetBody.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on a Game Object to a circle.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.SetBody","longname":"Phaser.Physics.Matter.Components.SetBody#setCircle","scope":"instance","___s":true},{"meta":{"filename":"SetBody.js","lineno":62,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on the Game Object to a polygon shape.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setPolygon","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number of sides the polygon will have.","name":"sides"},{"type":{"names":["number"]},"description":"The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.SetBody","longname":"Phaser.Physics.Matter.Components.SetBody#setPolygon","scope":"instance","___s":true},{"meta":{"filename":"SetBody.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on the Game Object to a trapezoid shape.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setTrapezoid","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the trapezoid Body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the trapezoid Body.","name":"height"},{"type":{"names":["number"]},"description":"The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.","name":"slope"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.SetBody","longname":"Phaser.Physics.Matter.Components.SetBody#setTrapezoid","scope":"instance","___s":true},{"meta":{"filename":"SetBody.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set this Game Object to use the given existing Matter Body.\n\nThe body is first removed from the world before being added to this Game Object.","kind":"function","name":"setExistingBody","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Body this Game Object should use.","name":"body"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.SetBody","longname":"Phaser.Physics.Matter.Components.SetBody#setExistingBody","scope":"instance","___s":true},{"meta":{"filename":"SetBody.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set this Game Object to create and use a new Body based on the configuration object given.\n\nCalling this method resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setBody","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Physics.Matter.MatterSetBodyConfig"]},"description":"Either a string, such as `circle`, or a Matter Set Body Configuration object.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.SetBody","longname":"Phaser.Physics.Matter.Components.SetBody#setBody","scope":"instance","___s":true},{"meta":{"range":[180,209],"filename":"Sleep.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Events","longname":"Events","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Sleep.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables a Matter-enabled Game Object to be able to go to sleep. Should be used as a mixin and not directly.","kind":"namespace","name":"Sleep","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Sleep","scope":"static","___s":true},{"meta":{"filename":"Sleep.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets this Body to sleep.","kind":"function","name":"setToSleep","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Sleep"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sleep","longname":"Phaser.Physics.Matter.Components.Sleep#setToSleep","scope":"instance","___s":true},{"meta":{"filename":"Sleep.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Wakes this Body if asleep.","kind":"function","name":"setAwake","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Sleep"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sleep","longname":"Phaser.Physics.Matter.Components.Sleep#setAwake","scope":"instance","___s":true},{"meta":{"filename":"Sleep.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).","kind":"function","name":"setSleepThreshold","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Sleep"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sleep","longname":"Phaser.Physics.Matter.Components.Sleep#setSleepThreshold","scope":"instance","___s":true},{"meta":{"filename":"Sleep.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enable sleep and wake events for this body.\n\nBy default when a body goes to sleep, or wakes up, it will not emit any events.\n\nThe events are emitted by the Matter World instance and can be listened to via\nthe `SLEEP_START` and `SLEEP_END` events.","kind":"function","name":"setSleepEvents","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` if you want the sleep start event to be emitted for this body.","name":"start"},{"type":{"names":["boolean"]},"description":"`true` if you want the sleep end event to be emitted for this body.","name":"end"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Sleep"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sleep","longname":"Phaser.Physics.Matter.Components.Sleep#setSleepEvents","scope":"instance","___s":true},{"meta":{"filename":"Sleep.js","lineno":88,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep Start event for this body.","kind":"function","name":"setSleepStartEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Sleep"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sleep","longname":"Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent","scope":"instance","___s":true},{"meta":{"filename":"Sleep.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep End event for this body.","kind":"function","name":"setSleepEndEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Sleep"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sleep","longname":"Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"Static.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Static.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Provides methods used for getting and setting the static state of a physics body.","kind":"namespace","name":"Static","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Static","scope":"static","___s":true},{"meta":{"filename":"Static.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Changes the physics body to be either static `true` or dynamic `false`.","kind":"function","name":"setStatic","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as being static, or `false` to make it dynamic.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Static","longname":"Phaser.Physics.Matter.Components.Static#setStatic","scope":"instance","___s":true},{"meta":{"filename":"Static.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Returns `true` if the body is static, otherwise `false` for a dynamic body.","kind":"function","name":"isStatic","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is static, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Components.Static","longname":"Phaser.Physics.Matter.Components.Static#isStatic","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"Transform.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Transform.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Provides methods used for getting and setting the position, scale and rotation of a Game Object.","kind":"namespace","name":"Transform","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Transform","scope":"static","___s":true},{"meta":{"filename":"Transform.js","lineno":25,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#scaleX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#scaleY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":146,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Use `angle` to set or get rotation of the physics body associated to this GameObject.\nUnlike rotation, when using set the value can be in degrees, which will be converted to radians internally.","name":"angle","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":168,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Use `rotation` to set or get the rotation of the physics body associated with this GameObject.\nThe value when set must be in radians.","name":"rotation","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":192,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the position of the physics body along x and y axes.\nBoth the parameters to this function are optional and if not passed any they default to 0.\nVelocity, angle, force etc. are unchanged.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the body.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical position of the body.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Transform"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":217,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Immediately sets the angle of the Body.\nAngular velocity, position, force etc. are unchanged.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The angle of the body, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Transform"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#setRotation","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":239,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Setting fixed rotation sets the Body inertia to Infinity, which stops it\nfrom being able to rotate when forces are applied to it.","kind":"function","name":"setFixedRotation","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Transform"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#setFixedRotation","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Immediately sets the angle of the Body.\nAngular velocity, position, force etc. are unchanged.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The angle to set, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Transform"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#setAngle","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":277,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the x value.","name":"y"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"The point (Vector2) from which scaling will occur.","name":"point"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Transform"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#setScale","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"Velocity.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Velocity.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Contains methods for changing the velocity of a Matter Body. Should be used as a mixin and not called directly.","kind":"namespace","name":"Velocity","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Velocity","scope":"static","___s":true},{"meta":{"filename":"Velocity.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the angular velocity of the body instantly.\nPosition, angle, force etc. are unchanged.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Velocity","longname":"Phaser.Physics.Matter.Components.Velocity#setAngularVelocity","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Velocity","longname":"Phaser.Physics.Matter.Components.Velocity#setVelocityX","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Velocity","longname":"Phaser.Physics.Matter.Components.Velocity#setVelocityY","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets both the horizontal and vertical velocity of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value, it can be either positive or negative. If not given, it will be the same as the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Velocity","longname":"Phaser.Physics.Matter.Components.Velocity#setVelocity","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"kind":"namespace","name":"Components","memberof":"Phaser.Physics.Matter","longname":"Phaser.Physics.Matter.Components","scope":"static","___s":true},{"meta":{"filename":"AFTER_ADD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"AfterAddEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"An array of the object(s) that have been added. May be a single body, constraint, composite or a mixture of these.","name":"object"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.AfterAddEvent","scope":"static","___s":true},{"meta":{"filename":"AFTER_ADD_EVENT.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics After Add Event.\n\nThis event is dispatched by a Matter Physics World instance at the end of the process when a new Body\nor Constraint has just been added to the world.\n\nListen to it from a Scene using: `this.matter.world.on('afteradd', listener)`.","kind":"event","name":"AFTER_ADD","since":"3.22.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.AfterAddEvent"]},"description":"The Add Event object.","name":"event"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:AFTER_ADD","scope":"instance","___s":true},{"meta":{"filename":"AFTER_REMOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"AfterRemoveEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"An array of the object(s) that were removed. May be a single body, constraint, composite or a mixture of these.","name":"object"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.AfterRemoveEvent","scope":"static","___s":true},{"meta":{"filename":"AFTER_REMOVE_EVENT.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics After Remove Event.\n\nThis event is dispatched by a Matter Physics World instance at the end of the process when a \nBody or Constraint was removed from the world.\n\nListen to it from a Scene using: `this.matter.world.on('afterremove', listener)`.","kind":"event","name":"AFTER_REMOVE","since":"3.22.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.AfterRemoveEvent"]},"description":"The Remove Event object.","name":"event"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:AFTER_REMOVE","scope":"instance","___s":true},{"meta":{"filename":"AFTER_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"AfterUpdateEvent","type":{"names":["object"]},"properties":[{"type":{"names":["number"]},"description":"The Matter Engine `timing.timestamp` value for the event.","name":"timestamp"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.AfterUpdateEvent","scope":"static","___s":true},{"meta":{"filename":"AFTER_UPDATE_EVENT.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics After Update Event.\n\nThis event is dispatched by a Matter Physics World instance after the engine has updated and all collision events have resolved.\n\nListen to it from a Scene using: `this.matter.world.on('afterupdate', listener)`.","kind":"event","name":"AFTER_UPDATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.AfterUpdateEvent"]},"description":"The Update Event object.","name":"event"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:AFTER_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"BEFORE_ADD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"BeforeAddEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"An array of the object(s) to be added. May be a single body, constraint, composite or a mixture of these.","name":"object"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.BeforeAddEvent","scope":"static","___s":true},{"meta":{"filename":"BEFORE_ADD_EVENT.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Before Add Event.\n\nThis event is dispatched by a Matter Physics World instance at the start of the process when a new Body\nor Constraint is being added to the world.\n\nListen to it from a Scene using: `this.matter.world.on('beforeadd', listener)`.","kind":"event","name":"BEFORE_ADD","since":"3.22.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.BeforeAddEvent"]},"description":"The Add Event object.","name":"event"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:BEFORE_ADD","scope":"instance","___s":true},{"meta":{"filename":"BEFORE_REMOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"BeforeRemoveEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"An array of the object(s) to be removed. May be a single body, constraint, composite or a mixture of these.","name":"object"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.BeforeRemoveEvent","scope":"static","___s":true},{"meta":{"filename":"BEFORE_REMOVE_EVENT.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Before Remove Event.\n\nThis event is dispatched by a Matter Physics World instance at the start of the process when a \nBody or Constraint is being removed from the world.\n\nListen to it from a Scene using: `this.matter.world.on('beforeremove', listener)`.","kind":"event","name":"BEFORE_REMOVE","since":"3.22.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.BeforeRemoveEvent"]},"description":"The Remove Event object.","name":"event"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:BEFORE_REMOVE","scope":"instance","___s":true},{"meta":{"filename":"BEFORE_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"BeforeUpdateEvent","type":{"names":["object"]},"properties":[{"type":{"names":["number"]},"description":"The Matter Engine `timing.timestamp` value for the event.","name":"timestamp"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.BeforeUpdateEvent","scope":"static","___s":true},{"meta":{"filename":"BEFORE_UPDATE_EVENT.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Before Update Event.\n\nThis event is dispatched by a Matter Physics World instance right before all the collision processing takes place.\n\nListen to it from a Scene using: `this.matter.world.on('beforeupdate', listener)`.","kind":"event","name":"BEFORE_UPDATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.BeforeUpdateEvent"]},"description":"The Update Event object.","name":"event"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:BEFORE_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"COLLISION_ACTIVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"CollisionActiveEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"A list of all affected pairs in the collision.","name":"pairs"},{"type":{"names":["number"]},"description":"The Matter Engine `timing.timestamp` value for the event.","name":"timestamp"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.CollisionActiveEvent","scope":"static","___s":true},{"meta":{"filename":"COLLISION_ACTIVE_EVENT.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Collision Active Event.\n\nThis event is dispatched by a Matter Physics World instance after the engine has updated.\nIt provides a list of all pairs that are colliding in the current tick (if any).\n\nListen to it from a Scene using: `this.matter.world.on('collisionactive', listener)`.","kind":"event","name":"COLLISION_ACTIVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.CollisionActiveEvent"]},"description":"The Collision Event object.","name":"event"},{"type":{"names":["MatterJS.BodyType"]},"description":"The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.","name":"bodyB"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:COLLISION_ACTIVE","scope":"instance","___s":true},{"meta":{"filename":"COLLISION_END_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"CollisionEndEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"A list of all affected pairs in the collision.","name":"pairs"},{"type":{"names":["number"]},"description":"The Matter Engine `timing.timestamp` value for the event.","name":"timestamp"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.CollisionEndEvent","scope":"static","___s":true},{"meta":{"filename":"COLLISION_END_EVENT.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Collision End Event.\n\nThis event is dispatched by a Matter Physics World instance after the engine has updated.\nIt provides a list of all pairs that have finished colliding in the current tick (if any).\n\nListen to it from a Scene using: `this.matter.world.on('collisionend', listener)`.","kind":"event","name":"COLLISION_END","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.CollisionEndEvent"]},"description":"The Collision Event object.","name":"event"},{"type":{"names":["MatterJS.BodyType"]},"description":"The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.","name":"bodyB"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:COLLISION_END","scope":"instance","___s":true},{"meta":{"filename":"COLLISION_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"CollisionStartEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"A list of all affected pairs in the collision.","name":"pairs"},{"type":{"names":["number"]},"description":"The Matter Engine `timing.timestamp` value for the event.","name":"timestamp"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.CollisionStartEvent","scope":"static","___s":true},{"meta":{"filename":"COLLISION_START_EVENT.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Collision Start Event.\n\nThis event is dispatched by a Matter Physics World instance after the engine has updated.\nIt provides a list of all pairs that have started to collide in the current tick (if any).\n\nListen to it from a Scene using: `this.matter.world.on('collisionstart', listener)`.","kind":"event","name":"COLLISION_START","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.CollisionStartEvent"]},"description":"The Collision Event object.","name":"event"},{"type":{"names":["MatterJS.BodyType"]},"description":"The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.","name":"bodyB"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:COLLISION_START","scope":"instance","___s":true},{"meta":{"filename":"DRAG_END_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Drag End Event.\n\nThis event is dispatched by a Matter Physics World instance when a Pointer Constraint\nstops dragging a body.\n\nListen to it from a Scene using: `this.matter.world.on('dragend', listener)`.","kind":"event","name":"DRAG_END","since":"3.16.2","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Body that has stopped being dragged. This is a Matter Body, not a Phaser Game Object.","name":"body"},{"type":{"names":["Phaser.Physics.Matter.PointerConstraint"]},"description":"The Pointer Constraint that was dragging the body.","name":"constraint"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:DRAG_END","scope":"instance","___s":true},{"meta":{"filename":"DRAG_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Drag Event.\n\nThis event is dispatched by a Matter Physics World instance when a Pointer Constraint\nis actively dragging a body. It is emitted each time the pointer moves.\n\nListen to it from a Scene using: `this.matter.world.on('drag', listener)`.","kind":"event","name":"DRAG","since":"3.16.2","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Body that is being dragged. This is a Matter Body, not a Phaser Game Object.","name":"body"},{"type":{"names":["Phaser.Physics.Matter.PointerConstraint"]},"description":"The Pointer Constraint that is dragging the body.","name":"constraint"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:DRAG","scope":"instance","___s":true},{"meta":{"filename":"DRAG_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Drag Start Event.\n\nThis event is dispatched by a Matter Physics World instance when a Pointer Constraint\nstarts dragging a body.\n\nListen to it from a Scene using: `this.matter.world.on('dragstart', listener)`.","kind":"event","name":"DRAG_START","since":"3.16.2","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Body that has started being dragged. This is a Matter Body, not a Phaser Game Object.","name":"body"},{"type":{"names":["MatterJS.BodyType"]},"description":"The part of the body that was clicked on.","name":"part"},{"type":{"names":["Phaser.Physics.Matter.PointerConstraint"]},"description":"The Pointer Constraint that is dragging the body.","name":"constraint"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:DRAG_START","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics World Pause Event.\n\nThis event is dispatched by an Matter Physics World instance when it is paused.\n\nListen to it from a Scene using: `this.matter.world.on('pause', listener)`.","kind":"event","name":"PAUSE","since":"3.0.0","memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:PAUSE","scope":"instance","___s":true},{"meta":{"filename":"RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics World Resume Event.\n\nThis event is dispatched by an Matter Physics World instance when it resumes from a paused state.\n\nListen to it from a Scene using: `this.matter.world.on('resume', listener)`.","kind":"event","name":"RESUME","since":"3.0.0","memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:RESUME","scope":"instance","___s":true},{"meta":{"filename":"SLEEP_END_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"SleepEndEvent","type":{"names":["object"]},"properties":[{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.SleepEndEvent","scope":"static","___s":true},{"meta":{"filename":"SLEEP_END_EVENT.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Sleep End Event.\n\nThis event is dispatched by a Matter Physics World instance when a Body stop sleeping.\n\nListen to it from a Scene using: `this.matter.world.on('sleepend', listener)`.","kind":"event","name":"SLEEP_END","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.SleepEndEvent"]},"description":"The Sleep Event object.","name":"event"},{"type":{"names":["MatterJS.BodyType"]},"description":"The body that has stopped sleeping.","name":"body"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:SLEEP_END","scope":"instance","___s":true},{"meta":{"filename":"SLEEP_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"SleepStartEvent","type":{"names":["object"]},"properties":[{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.SleepStartEvent","scope":"static","___s":true},{"meta":{"filename":"SLEEP_START_EVENT.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Sleep Start Event.\n\nThis event is dispatched by a Matter Physics World instance when a Body goes to sleep.\n\nListen to it from a Scene using: `this.matter.world.on('sleepstart', listener)`.","kind":"event","name":"SLEEP_START","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.SleepStartEvent"]},"description":"The Sleep Event object.","name":"event"},{"type":{"names":["MatterJS.BodyType"]},"description":"The body that has gone to sleep.","name":"body"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:SLEEP_START","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Physics.Matter","longname":"Phaser.Physics.Matter.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"kind":"namespace","name":"Matter","memberof":"Phaser.Physics","longname":"Phaser.Physics.Matter","scope":"static","___s":true},{"meta":{"filename":"MatterBody.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterBody","type":{"names":["MatterJS.BodyType","Phaser.GameObjects.GameObject","Phaser.Physics.Matter.Image","Phaser.Physics.Matter.Sprite","Phaser.Physics.Matter.TileBody"]},"since":"3.22.0","memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterBody","scope":"static","___s":true},{"meta":{"filename":"MatterBodyConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterBodyConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'Body'","description":"An arbitrary string-based name to help identify this body.","name":"label"},{"type":{"names":["Array."]},"optional":true,"description":"An array of bodies that make up this body. The first body in the array must always be a self reference to the current body instance. All bodies in the `parts` array together form a single rigid compound body.","name":"parts"},{"type":{"names":["any"]},"optional":true,"description":"An object reserved for storing plugin-specific properties.","name":"plugin"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A number specifying the angle of the body, in radians.","name":"angle"},{"type":{"names":["Array."]},"optional":true,"defaultvalue":null,"description":"An array of `Vector` objects that specify the convex hull of the rigid body. These should be provided about the origin `(0, 0)`.","name":"vertices"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"A `Vector` that specifies the current world-space position of the body.","name":"position"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"A `Vector` that specifies the force to apply in the current step. It is zeroed after every `Body.update`. See also `Body.applyForce`.","name":"force"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that specifies the torque (turning force) to apply in the current step. It is zeroed after every `Body.update`.","name":"torque"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"A flag that indicates whether a body is a sensor. Sensor triggers collision events, but doesn't react with colliding body physically.","name":"isSensor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"A flag that indicates whether a body is considered static. A static body can never change position or angle and is completely fixed.","name":"isStatic"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping by the `Matter.Sleeping` module (if sleeping is enabled by the engine).","name":"sleepThreshold"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.001,"description":"A `Number` that defines the density of the body, that is its mass per unit area. If you pass the density via `Body.create` the `mass` property is automatically calculated for you based on the size (area) of the object. This is generally preferable to simply setting mass and allows for more intuitive definition of materials (e.g. rock has a higher density than wood).","name":"density"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that defines the restitution (elasticity) of the body. The value is always positive and is in the range `(0, 1)`.","name":"restitution"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"A `Number` that defines the friction of the body. The value is always positive and is in the range `(0, 1)`. A value of `0` means that the body may slide indefinitely. A value of `1` means the body may come to a stop almost instantly after a force is applied.","name":"friction"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"A `Number` that defines the static friction of the body (in the Coulomb friction model). A value of `0` means the body will never 'stick' when it is nearly stationary and only dynamic `friction` is used. The higher the value (e.g. `10`), the more force it will take to initially get the body moving when nearly stationary. This value is multiplied with the `friction` property to make it easier to change `friction` and maintain an appropriate amount of static friction.","name":"frictionStatic"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.01,"description":"A `Number` that defines the air friction of the body (air resistance). A value of `0` means the body will never slow as it moves through space. The higher the value, the faster a body slows when moving through space.","name":"frictionAir"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterCollisionFilter"]},"optional":true,"description":"An `Object` that specifies the collision filtering properties of this body.","name":"collisionFilter"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.05,"description":"A `Number` that specifies a tolerance on how far a body is allowed to 'sink' or rotate into other bodies. Avoid changing this value unless you understand the purpose of `slop` in physics engines. The default should generally suffice, although very large bodies may require larger values for stable stacking.","name":"slop"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A `Number` that allows per-body time scaling, e.g. a force-field where bodies inside are in slow-motion, while others are at full speed.","name":"timeScale"},{"type":{"names":["number","Array.","Phaser.Types.Physics.Matter.MatterChamferConfig"]},"optional":true,"defaultvalue":null,"description":"A number, or array of numbers, to chamfer the vertices of the body, or a full Chamfer configuration object.","name":"chamfer"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The radius of this body if a circle.","name":"circleRadius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that defines the mass of the body, although it may be more appropriate to specify the `density` property instead. If you modify this value, you must also modify the `body.inverseMass` property (`1 / mass`).","name":"mass"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that defines the inverse mass of the body (`1 / mass`). If you modify this value, you must also modify the `body.mass` property.","name":"inverseMass"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"A `Vector` that specifies the initial scale of the body.","name":"scale"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"A `Vector` that scales the influence of World gravity when applied to this body.","name":"gravityScale"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"A boolean that toggles if this body should ignore world gravity or not.","name":"ignoreGravity"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"A boolean that toggles if this body should ignore pointer / mouse constraints or not.","name":"ignorePointer"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyRenderConfig"]},"optional":true,"description":"The Debug Render configuration object for this body.","name":"render"},{"type":{"names":["function"]},"optional":true,"description":"A callback that is invoked when this Body starts colliding with any other Body. You can register callbacks by providing a function of type `( pair: Matter.Pair) => void`.","name":"onCollideCallback"},{"type":{"names":["function"]},"optional":true,"description":"A callback that is invoked when this Body stops colliding with any other Body. You can register callbacks by providing a function of type `( pair: Matter.Pair) => void`.","name":"onCollideEndCallback"},{"type":{"names":["function"]},"optional":true,"description":"A callback that is invoked for the duration that this Body is colliding with any other Body. You can register callbacks by providing a function of type `( pair: Matter.Pair) => void`.","name":"onCollideActiveCallback"},{"type":{"names":["any"]},"optional":true,"description":"A collision callback dictionary used by the `Body.setOnCollideWith` function.","name":"onCollideWith"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterBodyConfig","scope":"static","___s":true},{"meta":{"filename":"MatterBodyRenderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterBodyRenderConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this body be rendered by the Debug Renderer?","name":"visible"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The opacity of the body and all parts within it.","name":"opacity"},{"type":{"names":["number"]},"optional":true,"description":"The color value of the fill when rendering this body.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The opacity of the fill when rendering this body, a value between 0 and 1.","name":"fillOpacity"},{"type":{"names":["number"]},"optional":true,"description":"The color value of the line stroke when rendering this body.","name":"lineColor"},{"type":{"names":["number"]},"optional":true,"description":"The opacity of the line when rendering this body, a value between 0 and 1.","name":"lineOpacity"},{"type":{"names":["number"]},"optional":true,"description":"If rendering lines, the thickness of the line.","name":"lineThickness"},{"type":{"names":["object"]},"optional":true,"description":"Controls the offset between the body and the parent Game Object, if it has one.","name":"sprite"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal offset between the body and the parent Game Object texture, if it has one.","name":"sprite.xOffset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical offset between the body and the parent Game Object texture, if it has one.","name":"sprite.yOffset"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterBodyRenderConfig","scope":"static","___s":true},{"meta":{"filename":"MatterBodyTileOptions.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterBodyTileOptions","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not the newly created body should be made static. This defaults to true since typically tiles should not be moved.","name":"isStatic"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to add the newly created body (or existing body if options.body is used) to the Matter world.","name":"addToWorld"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterBodyTileOptions","scope":"static","___s":true},{"meta":{"filename":"MatterChamferConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterChamferConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["number","Array."]},"optional":true,"defaultvalue":8,"description":"A single number, or an array, to specify the radius for each vertex.","name":"radius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":-1,"description":"The quality of the chamfering. -1 means 'auto'.","name":"quality"},{"type":{"names":["number"]},"optional":true,"defaultvalue":2,"description":"The minimum quality of the chamfering. The higher this value, the more vertices are created.","name":"qualityMin"},{"type":{"names":["number"]},"optional":true,"defaultvalue":14,"description":"The maximum quality of the chamfering. The higher this value, the more vertices are created.","name":"qualityMax"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterChamferConfig","scope":"static","___s":true},{"meta":{"filename":"MatterCollisionData.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterCollisionData","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["boolean"]},"description":"Have the pair collided or not?","name":"collided"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the first body involved in the collision.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the second body involved in the collision.","name":"bodyB"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the dominant axis body.","name":"axisBody"},{"type":{"names":["number"]},"description":"The index of the dominant collision axis vector (edge normal)","name":"axisNumber"},{"type":{"names":["number"]},"description":"The depth of the collision on the minimum overlap.","name":"depth"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the parent of Body A, or to Body A itself if it has no parent.","name":"parentA"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the parent of Body B, or to Body B itself if it has no parent.","name":"parentB"},{"type":{"names":["MatterJS.Vector"]},"description":"The collision normal, facing away from Body A.","name":"normal"},{"type":{"names":["MatterJS.Vector"]},"description":"The tangent of the collision normal.","name":"tangent"},{"type":{"names":["MatterJS.Vector"]},"description":"The penetration distances between the two bodies.","name":"penetration"},{"type":{"names":["Array."]},"description":"An array of support points, either exactly one or two points.","name":"supports"},{"type":{"names":["number"]},"description":"The resulting inverse mass from the collision.","name":"inverseMass"},{"type":{"names":["number"]},"description":"The resulting friction from the collision.","name":"friction"},{"type":{"names":["number"]},"description":"The resulting static friction from the collision.","name":"frictionStatic"},{"type":{"names":["number"]},"description":"The resulting restitution from the collision.","name":"restitution"},{"type":{"names":["number"]},"description":"The resulting slop from the collision.","name":"slop"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterCollisionData","scope":"static","___s":true},{"meta":{"filename":"MatterCollisionFilter.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"description":"An `Object` that specifies the collision filtering properties of this body.\n\nCollisions between two bodies will obey the following rules:\n- If the two bodies have the same non-zero value of `collisionFilter.group`,\n they will always collide if the value is positive, and they will never collide\n if the value is negative.\n- If the two bodies have different values of `collisionFilter.group` or if one\n (or both) of the bodies has a value of 0, then the category/mask rules apply as follows:\n\nEach body belongs to a collision category, given by `collisionFilter.category`. This\nvalue is used as a bit field and the category should have only one bit set, meaning that\nthe value of this property is a power of two in the range [1, 2^31]. Thus, there are 32\ndifferent collision categories available.\n\nEach body also defines a collision bitmask, given by `collisionFilter.mask` which specifies\nthe categories it collides with (the value is the bitwise AND value of all these categories).\n\nUsing the category/mask rules, two bodies `A` and `B` collide if each includes the other's\ncategory in its mask, i.e. `(categoryA & maskB) !== 0` and `(categoryB & maskA) !== 0`\nare both true.","kind":"typedef","name":"MatterCollisionFilter","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x0001","description":"A bit field that specifies the collision category this body belongs to. The category value should have only one bit set, for example `0x0001`. This means there are up to 32 unique collision categories available.","name":"category"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xFFFFFFFF","description":"A bit mask that specifies the collision categories this body may collide with.","name":"mask"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"An Integer `Number`, that specifies the collision group this body belongs to.","name":"group"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterCollisionFilter","scope":"static","___s":true},{"meta":{"filename":"MatterCollisionPair.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterCollisionPair","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["string"]},"description":"The unique auto-generated collision pair id. A combination of the body A and B IDs.","name":"id"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the first body involved in the collision.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the second body involved in the collision.","name":"bodyB"},{"type":{"names":["Array."]},"description":"An array containing all of the active contacts between bodies A and B.","name":"activeContacts"},{"type":{"names":["number"]},"description":"The amount of separation that occured between bodies A and B.","name":"separation"},{"type":{"names":["boolean"]},"description":"Is the collision still active or not?","name":"isActive"},{"type":{"names":["boolean"]},"description":"Has Matter determined the collision are being active yet?","name":"confirmedActive"},{"type":{"names":["boolean"]},"description":"Is either body A or B a sensor?","name":"isSensor"},{"type":{"names":["number"]},"description":"The timestamp when the collision pair was created.","name":"timeCreated"},{"type":{"names":["number"]},"description":"The timestamp when the collision pair was most recently updated.","name":"timeUpdated"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterCollisionData"]},"description":"The collision data object.","name":"collision"},{"type":{"names":["number"]},"description":"The resulting inverse mass from the collision.","name":"inverseMass"},{"type":{"names":["number"]},"description":"The resulting friction from the collision.","name":"friction"},{"type":{"names":["number"]},"description":"The resulting static friction from the collision.","name":"frictionStatic"},{"type":{"names":["number"]},"description":"The resulting restitution from the collision.","name":"restitution"},{"type":{"names":["number"]},"description":"The resulting slop from the collision.","name":"slop"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterCollisionPair","scope":"static","___s":true},{"meta":{"filename":"MatterConstraintConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterConstraintConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'Constraint'","description":"An arbitrary string-based name to help identify this constraint.","name":"label"},{"type":{"names":["MatterJS.BodyType"]},"optional":true,"description":"The first possible `Body` that this constraint is attached to.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"optional":true,"description":"The second possible `Body` that this constraint is attached to.","name":"bodyB"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"A `Vector` that specifies the offset of the constraint from center of the `constraint.bodyA` if defined, otherwise a world-space position.","name":"pointA"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"A `Vector` that specifies the offset of the constraint from center of the `constraint.bodyB` if defined, otherwise a world-space position.","name":"pointB"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A `Number` that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts like a soft spring.","name":"stiffness"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that specifies the angular stiffness of the constraint.","name":"angularStiffness"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The angleA of the constraint. If bodyA is set, the angle of bodyA is used instead.","name":"angleA"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The angleB of the constraint. If bodyB is set, the angle of bodyB is used instead.","name":"angleB"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that specifies the damping of the constraint, i.e. the amount of resistance applied to each body based on their velocities to limit the amount of oscillation. Damping will only be apparent when the constraint also has a very low `stiffness`. A value of `0.1` means the constraint will apply heavy damping, resulting in little to no oscillation. A value of `0` means the constraint will apply no damping.","name":"damping"},{"type":{"names":["number"]},"optional":true,"description":"A `Number` that specifies the target resting length of the constraint. It is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.","name":"length"},{"type":{"names":["any"]},"optional":true,"description":"An object reserved for storing plugin-specific properties.","name":"plugin"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintRenderConfig"]},"optional":true,"description":"The Debug Render configuration object for this constraint.","name":"render"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterConstraintConfig","scope":"static","___s":true},{"meta":{"filename":"MatterConstraintRenderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterConstraintRenderConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this constraint be rendered by the Debug Renderer?","name":"visible"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If this constraint has anchors, should they be rendered? Pin constraints never have anchors.","name":"anchors"},{"type":{"names":["number"]},"optional":true,"description":"The color value of the line stroke when rendering this constraint.","name":"lineColor"},{"type":{"names":["number"]},"optional":true,"description":"The opacity of the line when rendering this constraint, a value between 0 and 1.","name":"lineOpacity"},{"type":{"names":["number"]},"optional":true,"description":"If rendering lines, the thickness of the line.","name":"lineThickness"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"The size of the circles drawn when rendering pin constraints.","name":"pinSize"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"The size of the circles drawn as the constraint anchors.","name":"anchorSize"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xefefef","description":"The color value of constraint anchors.","name":"anchorColor"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterConstraintRenderConfig","scope":"static","___s":true},{"meta":{"filename":"MatterDebugConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterDebugConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render all of the body axes?","name":"showAxes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render just a single body axis?","name":"showAngleIndicator"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":"0xe81153","description":"The color of the body angle / axes lines.","name":"angleColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render the broadphase grid?","name":"showBroadphase"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":"0xffb400","description":"The color of the broadphase grid.","name":"broadphaseColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render the bounds of the bodies in the world?","name":"showBounds"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":"0xffffff","description":"The color of the body bounds.","name":"boundsColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render the velocity of the bodies in the world?","name":"showVelocity"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":"0x00aeef","description":"The color of the body velocity line.","name":"velocityColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render the collision points and normals for colliding pairs.","name":"showCollisions"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":"0xf5950c","description":"The color of the collision points.","name":"collisionColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render lines showing the separation between bodies.","name":"showSeparation"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":"0xffa500","description":"The color of the body separation line.","name":"separationColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Render the dynamic bodies in the world to the Graphics object?","name":"showBody"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Render the static bodies in the world to the Graphics object?","name":"showStaticBody"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When rendering bodies, render the internal edges as well?","name":"showInternalEdges"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render the bodies using a fill color.","name":"renderFill"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Render the bodies using a line stroke.","name":"renderLine"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x106909","description":"The color value of the fill when rendering dynamic bodies.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The opacity of the fill when rendering dynamic bodies, a value between 0 and 1.","name":"fillOpacity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x28de19","description":"The color value of the line stroke when rendering dynamic bodies.","name":"lineColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The opacity of the line when rendering dynamic bodies, a value between 0 and 1.","name":"lineOpacity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"If rendering lines, the thickness of the line.","name":"lineThickness"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x0d177b","description":"The color value of the fill when rendering static bodies.","name":"staticFillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x1327e4","description":"The color value of the line stroke when rendering static bodies.","name":"staticLineColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render any sleeping bodies (dynamic or static) in the world to the Graphics object?","name":"showSleeping"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.7,"description":"The amount to multiply the opacity of sleeping static bodies by.","name":"staticBodySleepOpacity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x464646","description":"The color value of the fill when rendering sleeping dynamic bodies.","name":"sleepFillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x999a99","description":"The color value of the line stroke when rendering sleeping dynamic bodies.","name":"sleepLineColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Render bodies or body parts that are flagged as being a sensor?","name":"showSensors"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x0d177b","description":"The fill color when rendering body sensors.","name":"sensorFillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x1327e4","description":"The line color when rendering body sensors.","name":"sensorLineColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Render the position of non-static bodies?","name":"showPositions"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"The size of the rectangle drawn when rendering the body position.","name":"positionSize"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xe042da","description":"The color value of the rectangle drawn when rendering the body position.","name":"positionColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Render all world constraints to the Graphics object?","name":"showJoint"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xe0e042","description":"The color value of joints when `showJoint` is set.","name":"jointColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The line opacity when rendering joints, a value between 0 and 1.","name":"jointLineOpacity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":2,"description":"The line thickness when rendering joints.","name":"jointLineThickness"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"The size of the circles drawn when rendering pin constraints.","name":"pinSize"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x42e0e0","description":"The color value of the circles drawn when rendering pin constraints.","name":"pinColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xe042e0","description":"The color value of spring constraints.","name":"springColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xefefef","description":"The color value of constraint anchors.","name":"anchorColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"The size of the circles drawn as the constraint anchors.","name":"anchorSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When rendering polygon bodies, render the convex hull as well?","name":"showConvexHulls"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xd703d0","description":"The color value of hulls when `showConvexHulls` is set.","name":"hullColor"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterDebugConfig","scope":"static","___s":true},{"meta":{"filename":"MatterRunnerConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterRunnerConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"A boolean that specifies if the runner should use a fixed timestep (otherwise it is variable). If timing is fixed, then the apparent simulation speed will change depending on the frame rate (but behaviour will be deterministic). If the timing is variable, then the apparent simulation speed will be constant (approximately, but at the cost of determininism).","name":"isFixed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"A number that specifies the frame rate in seconds. If you don't specify this, but do specify `delta`, those values set the fps rate.","name":"fps"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A number that specifies the time correction factor to apply to the update. This can help improve the accuracy of the simulation in cases where delta is changing between updates.","name":"correction"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The size of the delta smoothing array when `isFixed` is `false`.","name":"deltaSampleSize"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16.666,"description":"A number that specifies the time step between updates in milliseconds. If you set the `fps` property, this value is set based on that. If `isFixed` is set to `true`, then `delta` is fixed. If it is `false`, then `delta` can dynamically change to maintain the correct apparent simulation speed.","name":"delta"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16.666,"description":"A number that specifies the minimum time step between updates in milliseconds.","name":"deltaMin"},{"type":{"names":["number"]},"optional":true,"defaultvalue":33.333,"description":"A number that specifies the maximum time step between updates in milliseconds.","name":"deltaMax"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterRunnerConfig","scope":"static","___s":true},{"meta":{"filename":"MatterSetBodyConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterSetBodyConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'rectangle'","description":"The shape type. Either `rectangle`, `circle`, `trapezoid`, `polygon`, `fromVertices`, `fromVerts` or `fromPhysicsEditor`.","name":"type"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal world position to place the body at.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical world position to place the body at.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the body.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the body.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The radius of the body. Used by `circle` and `polygon` shapes.","name":"radius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":25,"description":"The max sizes of the body. Used by the `circle` shape.","name":"maxSides"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"Used by the `trapezoid` shape. The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.","name":"slope"},{"type":{"names":["number"]},"optional":true,"defaultvalue":5,"description":"Used by the `polygon` shape. The number of sides the polygon will have.","name":"sides"},{"type":{"names":["string","array"]},"optional":true,"description":"Used by the `fromVerts` shape. The vertices data. Either a path string or an array of vertices.","name":"verts"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Used by the `fromVerts` shape. Flag internal edges (coincident part edges)","name":"flagInternal"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.01,"description":"Used by the `fromVerts` shape. Whether Matter.js will discard collinear edges (to improve performance).","name":"removeCollinear"},{"type":{"names":["number"]},"optional":true,"defaultvalue":10,"description":"Used by the `fromVerts` shape. During decomposition discard parts that have an area less than this.","name":"minimumArea"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the new body be automatically added to the world?","name":"addToWorld"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterSetBodyConfig","scope":"static","___s":true},{"meta":{"filename":"MatterTileOptions.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterTileOptions","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["MatterJS.BodyType"]},"optional":true,"defaultvalue":null,"description":"An existing Matter body to be used instead of creating a new one.","name":"body"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not the newly created body should be made static. This defaults to true since typically tiles should not be moved.","name":"isStatic"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to add the newly created body (or existing body if options.body is used) to the Matter world.","name":"addToWorld"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterTileOptions","scope":"static","___s":true},{"meta":{"filename":"MatterWorldConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterWorldConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.Math.Vector2Like","boolean"]},"optional":true,"description":"Sets {@link Phaser.Physics.Matter.World#gravity}. If `false` Gravity will be set to zero.","name":"gravity"},{"type":{"names":["object","boolean"]},"optional":true,"description":"Should the world have bounds enabled by default?","name":"setBounds"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the world bounds.","name":"setBounds.x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the world bounds.","name":"setBounds.y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the world bounds.","name":"setBounds.width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the world bounds.","name":"setBounds.height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The thickness of the walls of the world bounds.","name":"setBounds.thickness"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the left-side world bounds wall be created?","name":"setBounds.left"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the right-side world bounds wall be created?","name":"setBounds.right"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the top world bounds wall be created?","name":"setBounds.top"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the bottom world bounds wall be created?","name":"setBounds.bottom"},{"type":{"names":["number"]},"optional":true,"defaultvalue":6,"description":"The number of position iterations to perform each update. The higher the value, the higher quality the simulation will be at the expense of performance.","name":"positionIterations"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"The number of velocity iterations to perform each update. The higher the value, the higher quality the simulation will be at the expense of performance.","name":"velocityIterations"},{"type":{"names":["number"]},"optional":true,"defaultvalue":2,"description":"The number of constraint iterations to perform each update. The higher the value, the higher quality the simulation will be at the expense of performance.","name":"constraintIterations"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"A flag that specifies whether the engine should allow sleeping via the `Matter.Sleeping` module. Sleeping can improve stability and performance, but often at the expense of accuracy.","name":"enableSleeping"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that specifies the current simulation-time in milliseconds starting from `0`. It is incremented on every `Engine.update` by the given `delta` argument.","name":"timing.timestamp"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A `Number` that specifies the global scaling factor of time for all bodies. A value of `0` freezes the simulation. A value of `0.1` gives a slow-motion effect. A value of `1.2` gives a speed-up effect.","name":"timing.timeScale"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the Matter Attractor Plugin be enabled? An attractors plugin that makes it easy to apply continual forces on bodies. It's possible to simulate effects such as wind, gravity and magnetism.","name":"plugins.attractors"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the Matter Wrap Plugin be enabled? A coordinate wrapping plugin that automatically wraps the position of bodies such that they always stay within the given bounds. Upon crossing a boundary the body will appear on the opposite side of the bounds, while maintaining its velocity.","name":"plugins.wrap"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the Matter Collision Events Plugin be enabled?","name":"plugins.collisionevents"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Toggles if the world is enabled or not.","name":"enabled"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"An optional Number that specifies the time correction factor to apply to the update.","name":"correction"},{"type":{"names":["function"]},"optional":true,"description":"This function is called every time the core game loop steps, which is bound to the Request Animation Frame frequency unless otherwise modified.","name":"getDelta"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Automatically call Engine.update every time the game steps.","name":"autoUpdate"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"Sets the Resolver resting threshold property.","name":"restingThresh"},{"type":{"names":["number"]},"optional":true,"defaultvalue":6,"description":"Sets the Resolver resting threshold tangent property.","name":"restingThreshTangent"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.9,"description":"Sets the Resolver position dampen property.","name":"positionDampen"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.8,"description":"Sets the Resolver position warming property.","name":"positionWarming"},{"type":{"names":["number"]},"optional":true,"defaultvalue":5,"description":"Sets the Resolver friction normal multiplier property.","name":"frictionNormalMultiplier"},{"type":{"names":["boolean","Phaser.Types.Physics.Matter.MatterDebugConfig"]},"optional":true,"defaultvalue":false,"description":"Controls the Matter Debug Rendering options. If a boolean it will use the default values, otherwise, specify a Debug Config object.","name":"debug"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterRunnerConfig"]},"optional":true,"description":"Sets the Matter Runner options.","name":"runner"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterWorldConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"namespace","name":"Matter","memberof":"Phaser.Types.Physics","longname":"Phaser.Types.Physics.Matter","scope":"static","___s":true},{"meta":{"range":[215,248],"filename":"BasePlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BasePlugin.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"classdesc":"A Global Plugin is installed just once into the Game owned Plugin Manager.\nIt can listen for Game events and respond to them.","kind":"class","name":"BasePlugin","memberof":"Phaser.Plugins","since":"3.8.0","params":[{"type":{"names":["Phaser.Plugins.PluginManager"]},"description":"A reference to the Plugin Manager.","name":"pluginManager"}],"scope":"static","longname":"Phaser.Plugins.BasePlugin","___s":true},{"meta":{"filename":"BasePlugin.js","lineno":49,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The PluginManager calls this method on a Global Plugin when the plugin is first instantiated.\nIt will never be called again on this instance.\nIn here you can set-up whatever you need for this plugin to run.\nIf a plugin is set to automatically start then `BasePlugin.start` will be called immediately after this.\nOn a Scene Plugin, this method is never called. Use {@link Phaser.Plugins.ScenePlugin#boot} instead.","kind":"function","name":"init","since":"3.8.0","params":[{"type":{"names":["any"]},"optional":true,"nullable":true,"description":"A value specified by the user, if any, from the `data` property of the plugin's configuration object (if started at game boot) or passed in the PluginManager's `install` method (if started manually).","name":"data"}],"memberof":"Phaser.Plugins.BasePlugin","longname":"Phaser.Plugins.BasePlugin#init","scope":"instance","___s":true},{"meta":{"filename":"BasePlugin.js","lineno":65,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The PluginManager calls this method on a Global Plugin when the plugin is started.\nIf a plugin is stopped, and then started again, this will get called again.\nTypically called immediately after `BasePlugin.init`.\nOn a Scene Plugin, this method is never called.","kind":"function","name":"start","since":"3.8.0","memberof":"Phaser.Plugins.BasePlugin","longname":"Phaser.Plugins.BasePlugin#start","scope":"instance","___s":true},{"meta":{"filename":"BasePlugin.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The PluginManager calls this method on a Global Plugin when the plugin is stopped.\nThe game code has requested that your plugin stop doing whatever it does.\nIt is now considered as 'inactive' by the PluginManager.\nHandle that process here (i.e. stop listening for events, etc)\nIf the plugin is started again then `BasePlugin.start` will be called again.\nOn a Scene Plugin, this method is never called.","kind":"function","name":"stop","since":"3.8.0","memberof":"Phaser.Plugins.BasePlugin","longname":"Phaser.Plugins.BasePlugin#stop","scope":"instance","___s":true},{"meta":{"filename":"BasePlugin.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Game instance has been destroyed.\nYou must release everything in here, all references, all objects, free it all up.","kind":"function","name":"destroy","since":"3.8.0","memberof":"Phaser.Plugins.BasePlugin","longname":"Phaser.Plugins.BasePlugin#destroy","scope":"instance","___s":true},{"meta":{"filename":"DefaultPlugins.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"kind":"typedef","name":"DefaultPlugins","type":{"names":["object"]},"properties":[{"type":{"names":["array"]},"description":"These are the Global Managers that are created by the Phaser.Game instance.","name":"Global"},{"type":{"names":["array"]},"description":"These are the core plugins that are installed into every Scene.Systems instance, no matter what.","name":"CoreScene"},{"type":{"names":["array"]},"description":"These plugins are created in Scene.Systems in addition to the CoreScenePlugins.","name":"DefaultScene"}],"memberof":"Phaser.Plugins","longname":"Phaser.Plugins.DefaultPlugins","scope":"static","___s":true},{"meta":{"filename":"DefaultPlugins.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"These are the Global Managers that are created by the Phaser.Game instance.\nThey are referenced from Scene.Systems so that plugins can use them.","name":"Global","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Plugins","longname":"Phaser.Plugins.Global","scope":"static","kind":"member","___s":true},{"meta":{"filename":"DefaultPlugins.js","lineno":38,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"These are the core plugins that are installed into every Scene.Systems instance, no matter what.\nThey are optionally exposed in the Scene as well (see the InjectionMap for details)\n\nThey are created in the order in which they appear in this array and EventEmitter is always first.","name":"CoreScene","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Plugins","longname":"Phaser.Plugins.CoreScene","scope":"static","kind":"member","___s":true},{"meta":{"filename":"DefaultPlugins.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"These plugins are created in Scene.Systems in addition to the CoreScenePlugins.\n\nYou can elect not to have these plugins by either creating a DefaultPlugins object as part\nof the Game Config, by creating a Plugins object as part of a Scene Config, or by modifying this array\nand building your own bundle.\n\nThey are optionally exposed in the Scene as well (see the InjectionMap for details)\n\nThey are always created in the order in which they appear in the array.","name":"DefaultScene","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Plugins","longname":"Phaser.Plugins.DefaultScene","scope":"static","kind":"member","___s":true},{"meta":{"filename":"PluginCache.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"kind":"namespace","name":"PluginCache","memberof":"Phaser.Plugins","longname":"Phaser.Plugins.PluginCache","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":21,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Static method called directly by the Core internal Plugins.\nKey is a reference used to get the plugin from the plugins object (i.e. InputPlugin)\nPlugin is the object to instantiate to create the plugin\nMapping is what the plugin is injected into the Scene.Systems as (i.e. input)","kind":"function","name":"register","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"A reference used to get this plugin from the plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"The plugin to be stored. Should be the core object, not instantiated.","name":"plugin"},{"type":{"names":["string"]},"description":"If this plugin is to be injected into the Scene Systems, this is the property key map used.","name":"mapping"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Core Scene plugin or a Custom Scene plugin?","name":"custom"}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.register","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":42,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Stores a custom plugin in the global plugin cache.\nThe key must be unique, within the scope of the cache.","kind":"function","name":"registerCustom","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"A reference used to get this plugin from the plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"The plugin to be stored. Should be the core object, not instantiated.","name":"plugin"},{"type":{"names":["string"]},"description":"If this plugin is to be injected into the Scene Systems, this is the property key map used.","name":"mapping"},{"type":{"names":["any"]},"nullable":true,"description":"A value to be passed to the plugin's `init` method.","name":"data"}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.registerCustom","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":59,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Checks if the given key is already being used in the core plugin cache.","kind":"function","name":"hasCore","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key to check for.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the key is already in use in the core cache, otherwise `false`."}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.hasCore","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":74,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Checks if the given key is already being used in the custom plugin cache.","kind":"function","name":"hasCustom","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key to check for.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the key is already in use in the custom cache, otherwise `false`."}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.hasCustom","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":89,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Returns the core plugin object from the cache based on the given key.","kind":"function","name":"getCore","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the core plugin to get.","name":"key"}],"returns":[{"type":{"names":["Phaser.Types.Plugins.CorePluginContainer"]},"description":"The core plugin object."}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.getCore","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":104,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Returns the custom plugin object from the cache based on the given key.","kind":"function","name":"getCustom","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the custom plugin to get.","name":"key"}],"returns":[{"type":{"names":["Phaser.Types.Plugins.CustomPluginContainer"]},"description":"The custom plugin object."}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.getCustom","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":119,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Returns an object from the custom cache based on the given key that can be instantiated.","kind":"function","name":"getCustomClass","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the custom plugin to get.","name":"key"}],"returns":[{"type":{"names":["function"]},"description":"The custom plugin object."}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.getCustomClass","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":134,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes a core plugin based on the given key.","kind":"function","name":"remove","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the core plugin to remove.","name":"key"}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.remove","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":150,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes a custom plugin based on the given key.","kind":"function","name":"removeCustom","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the custom plugin to remove.","name":"key"}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.removeCustom","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":166,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes all Core Plugins.\n\nThis includes all of the internal system plugins that Phaser needs, like the Input Plugin and Loader Plugin.\nSo be sure you only call this if you do not wish to run Phaser again.","kind":"function","name":"destroyCorePlugins","since":"3.12.0","memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.destroyCorePlugins","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":186,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes all Custom Plugins.","kind":"function","name":"destroyCustomPlugins","since":"3.12.0","memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.destroyCustomPlugins","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"PluginManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PluginManager.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"classdesc":"The PluginManager is responsible for installing and adding plugins to Phaser.\n\nIt is a global system and therefore belongs to the Game instance, not a specific Scene.\n\nIt works in conjunction with the PluginCache. Core internal plugins automatically register themselves \nwith the Cache, but it's the Plugin Manager that is responsible for injecting them into the Scenes.\n\nThere are two types of plugin:\n\n1. A Global Plugin\n2. A Scene Plugin\n\nA Global Plugin is a plugin that lives within the Plugin Manager rather than a Scene. You can get\naccess to it by calling `PluginManager.get` and providing a key. Any Scene that requests a plugin in\nthis way will all get access to the same plugin instance, allowing you to use a single plugin across\nmultiple Scenes.\n\nA Scene Plugin is a plugin dedicated to running within a Scene. These are different to Global Plugins\nin that their instances do not live within the Plugin Manager, but within the Scene Systems class instead.\nAnd that every Scene created is given its own unique instance of a Scene Plugin. Examples of core Scene\nPlugins include the Input Plugin, the Tween Plugin and the physics Plugins.\n\nYou can add a plugin to Phaser in three different ways:\n\n1. Preload it\n2. Include it in your source code and install it via the Game Config\n3. Include it in your source code and install it within a Scene\n\nFor examples of all of these approaches please see the Phaser 3 Examples Repo `plugins` folder.\n\nFor information on creating your own plugin please see the Phaser 3 Plugin Template.","kind":"class","name":"PluginManager","memberof":"Phaser.Plugins","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The game instance that owns this Plugin Manager.","name":"game"}],"scope":"static","longname":"Phaser.Plugins.PluginManager","___s":true},{"meta":{"filename":"PluginManager.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The game instance that owns this Plugin Manager.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PluginManager.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The global plugins currently running and managed by this Plugin Manager.\nA plugin must have been started at least once in order to appear in this list.","name":"plugins","type":{"names":["Array."]},"since":"3.8.0","memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#plugins","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PluginManager.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"A list of plugin keys that should be installed into Scenes as well as the Core Plugins.","name":"scenePlugins","type":{"names":["Array."]},"since":"3.8.0","memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#scenePlugins","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PluginManager.js","lineno":327,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Installs a new Scene Plugin into the Plugin Manager and optionally adds it\nto the given Scene as well. A Scene Plugin added to the manager in this way\nwill be automatically installed into all new Scenes using the key and mapping given.\n\nThe `key` property is what the plugin is injected into Scene.Systems as.\nThe `mapping` property is optional, and if specified is what the plugin is installed into\nthe Scene as. For example:\n\n```javascript\nthis.plugins.installScenePlugin('powerupsPlugin', pluginCode, 'powerups');\n\n// and from within the scene:\nthis.sys.powerupsPlugin; // key value\nthis.powerups; // mapping value\n```\n\nThis method is called automatically by Phaser if you install your plugins using either the\nGame Configuration object, or by preloading them via the Loader.","kind":"function","name":"installScenePlugin","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The property key that will be used to add this plugin to Scene.Systems.","name":"key"},{"type":{"names":["function"]},"description":"The plugin code. This should be the non-instantiated version.","name":"plugin"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is injected into the Phaser.Scene class, this is the property key to use.","name":"mapping"},{"type":{"names":["Phaser.Scene"]},"optional":true,"description":"Optionally automatically add this plugin to the given Scene.","name":"addToScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this being called by the Loader?","name":"fromLoader"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#installScenePlugin","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":395,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Installs a new Global Plugin into the Plugin Manager and optionally starts it running.\nA global plugin belongs to the Plugin Manager, rather than a specific Scene, and can be accessed\nand used by all Scenes in your game.\n\nThe `key` property is what you use to access this plugin from the Plugin Manager.\n\n```javascript\nthis.plugins.install('powerupsPlugin', pluginCode);\n\n// and from within the scene:\nthis.plugins.get('powerupsPlugin');\n```\n\nThis method is called automatically by Phaser if you install your plugins using either the\nGame Configuration object, or by preloading them via the Loader.\n\nThe same plugin can be installed multiple times into the Plugin Manager by simply giving each\ninstance its own unique key.","kind":"function","name":"install","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The unique handle given to this plugin within the Plugin Manager.","name":"key"},{"type":{"names":["function"]},"description":"The plugin code. This should be the non-instantiated version.","name":"plugin"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Automatically start the plugin running? This is always `true` if you provide a mapping value.","name":"start"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is injected into the Phaser.Scene class, this is the property key to use.","name":"mapping"},{"type":{"names":["any"]},"optional":true,"description":"A value passed to the plugin's `init` method.","name":"data"}],"returns":[{"type":{"names":["Phaser.Plugins.BasePlugin"]},"nullable":true,"description":"The plugin that was started, or `null` if `start` was false, or game isn't yet booted."}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#install","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Checks if the given global plugin, based on its key, is active or not.","kind":"function","name":"isActive","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The unique plugin key.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the plugin is active, otherwise `false`."}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#isActive","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":533,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Starts a global plugin running.\n\nIf the plugin was previously active then calling `start` will reset it to an active state and then\ncall its `start` method.\n\nIf the plugin has never been run before a new instance of it will be created within the Plugin Manager,\nits active state set and then both of its `init` and `start` methods called, in that order.\n\nIf the plugin is already running under the given key then nothing happens.","kind":"function","name":"start","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the plugin to start.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"Run the plugin under a new key. This allows you to run one plugin multiple times.","name":"runAs"}],"returns":[{"type":{"names":["Phaser.Plugins.BasePlugin"]},"nullable":true,"description":"The plugin that was started, or `null` if invalid key given or plugin is already stopped."}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#start","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":610,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Stops a global plugin from running.\n\nIf the plugin is active then its active state will be set to false and the plugins `stop` method\nwill be called.\n\nIf the plugin is not already running, nothing will happen.","kind":"function","name":"stop","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the plugin to stop.","name":"key"}],"returns":[{"type":{"names":["Phaser.Plugins.PluginManager"]},"description":"The Plugin Manager."}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#stop","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":638,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Gets a global plugin from the Plugin Manager based on the given key and returns it.\n\nIf it cannot find an active plugin based on the key, but there is one in the Plugin Cache with the same key,\nthen it will create a new instance of the cached plugin and return that.","kind":"function","name":"get","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the plugin to get.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Automatically start a new instance of the plugin if found in the cache, but not actively running.","name":"autoStart"}],"returns":[{"type":{"names":["Phaser.Plugins.BasePlugin","function"]},"nullable":true,"description":"The plugin, or `null` if no plugin was found matching the key."}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#get","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":681,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Returns the plugin class from the cache.\nUsed internally by the Plugin Manager.","kind":"function","name":"getClass","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the plugin to get.","name":"key"}],"returns":[{"type":{"names":["Phaser.Plugins.BasePlugin"]},"description":"A Plugin object"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#getClass","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":697,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes a global plugin from the Plugin Manager and Plugin Cache.\n\nIt is up to you to remove all references to this plugin that you may hold within your game code.","kind":"function","name":"removeGlobalPlugin","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the plugin to remove.","name":"key"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#removeGlobalPlugin","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":719,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes a scene plugin from the Plugin Manager and Plugin Cache.\n\nThis will not remove the plugin from any active Scenes that are already using it.\n\nIt is up to you to remove all references to this plugin that you may hold within your game code.","kind":"function","name":"removeScenePlugin","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the plugin to remove.","name":"key"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#removeScenePlugin","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":738,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Registers a new type of Game Object with the global Game Object Factory and / or Creator.\nThis is usually called from within your Plugin code and is a helpful short-cut for creating\nnew Game Objects.\n\nThe key is the property that will be injected into the factories and used to create the\nGame Object. For example:\n\n```javascript\nthis.plugins.registerGameObject('clown', clownFactoryCallback, clownCreatorCallback);\n// later in your game code:\nthis.add.clown();\nthis.make.clown();\n```\n\nThe callbacks are what are called when the factories try to create a Game Object\nmatching the given key. It's important to understand that the callbacks are invoked within\nthe context of the GameObjectFactory. In this context there are several properties available\nto use:\n\nthis.scene - A reference to the Scene that owns the GameObjectFactory.\nthis.displayList - A reference to the Display List the Scene owns.\nthis.updateList - A reference to the Update List the Scene owns.\n\nSee the GameObjectFactory and GameObjectCreator classes for more details.\nAny public property or method listed is available from your callbacks under `this`.","kind":"function","name":"registerGameObject","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the Game Object that the given callbacks will create, i.e. `image`, `sprite`.","name":"key"},{"type":{"names":["function"]},"optional":true,"description":"The callback to invoke when the Game Object Factory is called.","name":"factoryCallback"},{"type":{"names":["function"]},"optional":true,"description":"The callback to invoke when the Game Object Creator is called.","name":"creatorCallback"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#registerGameObject","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":787,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes a previously registered Game Object from the global Game Object Factory and / or Creator.\nThis is usually called from within your Plugin destruction code to help clean-up after your plugin has been removed.","kind":"function","name":"removeGameObject","since":"3.19.0","params":[{"type":{"names":["string"]},"description":"The key of the Game Object to be removed from the factories.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the Game Object be removed from the Game Object Factory?","name":"removeFromFactory"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the Game Object be removed from the Game Object Creator?","name":"removeFromCreator"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#removeGameObject","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":816,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Registers a new file type with the global File Types Manager, making it available to all Loader\nPlugins created after this.\n\nThis is usually called from within your Plugin code and is a helpful short-cut for creating\nnew loader file types.\n\nThe key is the property that will be injected into the Loader Plugin and used to load the\nfiles. For example:\n\n```javascript\nthis.plugins.registerFileType('wad', doomWadLoaderCallback);\n// later in your preload code:\nthis.load.wad();\n```\n\nThe callback is what is called when the loader tries to load a file matching the given key.\nIt's important to understand that the callback is invoked within\nthe context of the LoaderPlugin. In this context there are several properties / methods available\nto use:\n\nthis.addFile - A method to add the new file to the load queue.\nthis.scene - The Scene that owns the Loader Plugin instance.\n\nSee the LoaderPlugin class for more details. Any public property or method listed is available from\nyour callback under `this`.","kind":"function","name":"registerFileType","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the Game Object that the given callbacks will create, i.e. `image`, `sprite`.","name":"key"},{"type":{"names":["function"]},"description":"The callback to invoke when the Game Object Factory is called.","name":"callback"},{"type":{"names":["Phaser.Scene"]},"optional":true,"description":"Optionally add this file type into the Loader Plugin owned by the given Scene.","name":"addToScene"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#registerFileType","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":860,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Destroys this Plugin Manager and all associated plugins.\nIt will iterate all plugins found and call their `destroy` methods.\n\nThe PluginCache will remove all custom plugins.","kind":"function","name":"destroy","since":"3.8.0","memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#destroy","scope":"instance","___s":true},{"meta":{"range":[215,251],"filename":"ScenePlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"name":"BasePlugin","longname":"BasePlugin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"classdesc":"A Scene Level Plugin is installed into every Scene and belongs to that Scene.\nIt can listen for Scene events and respond to them.\nIt can map itself to a Scene property, or into the Scene Systems, or both.","kind":"class","name":"ScenePlugin","memberof":"Phaser.Plugins","augments":["Phaser.Plugins.BasePlugin"],"since":"3.8.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that has installed this plugin.","name":"scene"},{"type":{"names":["Phaser.Plugins.PluginManager"]},"description":"A reference to the Plugin Manager.","name":"pluginManager"}],"scope":"static","longname":"Phaser.Plugins.ScenePlugin","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":65,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"This method is called when the Scene boots. It is only ever called once.\n\nBy this point the plugin properties `scene` and `systems` will have already been set.\n\nIn here you can listen for {@link Phaser.Scenes.Events Scene events} and set-up whatever you need for this plugin to run.\nHere are the Scene events you can listen to:\n\n- start\n- ready\n- preupdate\n- update\n- postupdate\n- resize\n- pause\n- resume\n- sleep\n- wake\n- transitioninit\n- transitionstart\n- transitioncomplete\n- transitionout\n- shutdown\n- destroy\n\nAt the very least you should offer a destroy handler for when the Scene closes down, i.e:\n\n```javascript\nvar eventEmitter = this.systems.events;\neventEmitter.once('destroy', this.sceneDestroy, this);\n```","kind":"function","name":"boot","since":"3.8.0","memberof":"Phaser.Plugins.ScenePlugin","longname":"Phaser.Plugins.ScenePlugin#boot","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":104,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Game instance has been destroyed.\n\nYou must release everything in here, all references, all objects, free it all up.","kind":"function","name":"destroy","since":"3.8.0","memberof":"Phaser.Plugins.ScenePlugin","longname":"Phaser.Plugins.ScenePlugin#destroy","scope":"instance","overrides":"Phaser.Plugins.BasePlugin#destroy","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"kind":"namespace","name":"Plugins","memberof":"Phaser","longname":"Phaser.Plugins","scope":"static","___s":true},{"meta":{"filename":"CorePluginContainer.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins/typedefs"},"kind":"typedef","name":"CorePluginContainer","type":{"names":["object"]},"since":"3.8.0","properties":[{"type":{"names":["string"]},"description":"The unique name of this plugin in the core plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"The plugin to be stored. Should be the source object, not instantiated.","name":"plugin"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Scene Systems, this is the property key map used.","name":"mapping"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Core Scene plugin or a Custom Scene plugin?","name":"custom"}],"memberof":"Phaser.Types.Plugins","longname":"Phaser.Types.Plugins.CorePluginContainer","scope":"static","___s":true},{"meta":{"filename":"CustomPluginContainer.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins/typedefs"},"kind":"typedef","name":"CustomPluginContainer","type":{"names":["object"]},"since":"3.8.0","properties":[{"type":{"names":["string"]},"description":"The unique name of this plugin in the custom plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"The plugin to be stored. Should be the source object, not instantiated.","name":"plugin"}],"memberof":"Phaser.Types.Plugins","longname":"Phaser.Types.Plugins.CustomPluginContainer","scope":"static","___s":true},{"meta":{"filename":"GlobalPlugin.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins/typedefs"},"kind":"typedef","name":"GlobalPlugin","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The unique name of this plugin within the plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"An instance of the plugin.","name":"plugin"},{"type":{"names":["boolean"]},"optional":true,"description":"Is the plugin active or not?","name":"active"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Scene Systems, this is the property key map used.","name":"mapping"}],"memberof":"Phaser.Types.Plugins","longname":"Phaser.Types.Plugins.GlobalPlugin","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins/typedefs"},"kind":"namespace","name":"Plugins","memberof":"Phaser.Types","longname":"Phaser.Types.Plugins","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Phaser Blend Modes.","kind":"namespace","name":"BlendModes","since":"3.0.0","memberof":"Phaser","longname":"Phaser.BlendModes","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Skips the Blend Mode check in the renderer.","name":"SKIP_CHECK","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SKIP_CHECK","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":26,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Normal blend mode. For Canvas and WebGL.\nThis is the default setting and draws new shapes on top of the existing canvas content.","name":"NORMAL","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.NORMAL","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Add blend mode. For Canvas and WebGL.\nWhere both shapes overlap the color is determined by adding color values.","name":"ADD","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.ADD","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Multiply blend mode. For Canvas and WebGL.\nThe pixels are of the top layer are multiplied with the corresponding pixel of the bottom layer. A darker picture is the result.","name":"MULTIPLY","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.MULTIPLY","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":59,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Screen blend mode. For Canvas and WebGL.\nThe pixels are inverted, multiplied, and inverted again. A lighter picture is the result (opposite of multiply)","name":"SCREEN","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SCREEN","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Overlay blend mode. For Canvas only.\nA combination of multiply and screen. Dark parts on the base layer become darker, and light parts become lighter.","name":"OVERLAY","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.OVERLAY","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Darken blend mode. For Canvas only.\nRetains the darkest pixels of both layers.","name":"DARKEN","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.DARKEN","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Lighten blend mode. For Canvas only.\nRetains the lightest pixels of both layers.","name":"LIGHTEN","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.LIGHTEN","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Color Dodge blend mode. For Canvas only.\nDivides the bottom layer by the inverted top layer.","name":"COLOR_DODGE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.COLOR_DODGE","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Color Burn blend mode. For Canvas only.\nDivides the inverted bottom layer by the top layer, and then inverts the result.","name":"COLOR_BURN","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.COLOR_BURN","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Hard Light blend mode. For Canvas only.\nA combination of multiply and screen like overlay, but with top and bottom layer swapped.","name":"HARD_LIGHT","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.HARD_LIGHT","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Soft Light blend mode. For Canvas only.\nA softer version of hard-light. Pure black or white does not result in pure black or white.","name":"SOFT_LIGHT","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SOFT_LIGHT","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Difference blend mode. For Canvas only.\nSubtracts the bottom layer from the top layer or the other way round to always get a positive value.","name":"DIFFERENCE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.DIFFERENCE","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Exclusion blend mode. For Canvas only.\nLike difference, but with lower contrast.","name":"EXCLUSION","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.EXCLUSION","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Hue blend mode. For Canvas only.\nPreserves the luma and chroma of the bottom layer, while adopting the hue of the top layer.","name":"HUE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.HUE","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Saturation blend mode. For Canvas only.\nPreserves the luma and hue of the bottom layer, while adopting the chroma of the top layer.","name":"SATURATION","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SATURATION","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Color blend mode. For Canvas only.\nPreserves the luma of the bottom layer, while adopting the hue and chroma of the top layer.","name":"COLOR","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.COLOR","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Luminosity blend mode. For Canvas only.\nPreserves the hue and chroma of the bottom layer, while adopting the luma of the top layer.","name":"LUMINOSITY","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.LUMINOSITY","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Alpha erase blend mode. For Canvas and WebGL.","name":"ERASE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.ERASE","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Source-in blend mode. For Canvas only.\nThe new shape is drawn only where both the new shape and the destination canvas overlap. Everything else is made transparent.","name":"SOURCE_IN","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SOURCE_IN","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":234,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Source-out blend mode. For Canvas only.\nThe new shape is drawn where it doesn't overlap the existing canvas content.","name":"SOURCE_OUT","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SOURCE_OUT","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Source-out blend mode. For Canvas only.\nThe new shape is only drawn where it overlaps the existing canvas content.","name":"SOURCE_ATOP","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SOURCE_ATOP","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Destination-over blend mode. For Canvas only.\nNew shapes are drawn behind the existing canvas content.","name":"DESTINATION_OVER","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.DESTINATION_OVER","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":267,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Destination-in blend mode. For Canvas only.\nThe existing canvas content is kept where both the new shape and existing canvas content overlap. Everything else is made transparent.","name":"DESTINATION_IN","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.DESTINATION_IN","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Destination-out blend mode. For Canvas only.\nThe existing content is kept where it doesn't overlap the new shape.","name":"DESTINATION_OUT","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.DESTINATION_OUT","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":289,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Destination-out blend mode. For Canvas only.\nThe existing canvas is only kept where it overlaps the new shape. The new shape is drawn behind the canvas content.","name":"DESTINATION_ATOP","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.DESTINATION_ATOP","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Lighten blend mode. For Canvas only.\nWhere both shapes overlap the color is determined by adding color values.","name":"LIGHTER","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.LIGHTER","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":311,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Copy blend mode. For Canvas only.\nOnly the new shape is shown.","name":"COPY","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.COPY","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":322,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Xor blend mode. For Canvas only.\nShapes are made transparent where both overlap and drawn normal everywhere else.","name":"XOR","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.XOR","scope":"static","___s":true},{"meta":{"filename":"ScaleModes.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Phaser Scale Modes.","kind":"namespace","name":"ScaleModes","since":"3.0.0","memberof":"Phaser","longname":"Phaser.ScaleModes","scope":"static","___s":true},{"meta":{"filename":"ScaleModes.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Default Scale Mode (Linear).","name":"DEFAULT","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.ScaleModes","longname":"Phaser.ScaleModes.DEFAULT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"ScaleModes.js","lineno":26,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Linear Scale Mode.","name":"LINEAR","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.ScaleModes","longname":"Phaser.ScaleModes.LINEAR","scope":"static","kind":"member","___s":true},{"meta":{"filename":"ScaleModes.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Nearest Scale Mode.","name":"NEAREST","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.ScaleModes","longname":"Phaser.ScaleModes.NEAREST","scope":"static","kind":"member","___s":true},{"meta":{"range":[225,279],"filename":"CanvasRenderer.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"name":"CanvasSnapshot","longname":"CanvasSnapshot","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"classdesc":"The Canvas Renderer is responsible for managing 2D canvas rendering contexts, including the one used by the Game's canvas. It tracks the internal state of a given context and can renderer textured Game Objects to it, taking into account alpha, blending, and scaling.","kind":"class","name":"CanvasRenderer","memberof":"Phaser.Renderer.Canvas","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Phaser Game instance that owns this renderer.","name":"game"}],"scope":"static","longname":"Phaser.Renderer.Canvas.CanvasRenderer","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":33,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The Phaser Game instance that owns this renderer.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"A constant which allows the renderer to be easily identified as a Canvas Renderer.","name":"type","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The total number of Game Objects which were rendered in a frame.","name":"drawCount","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#drawCount","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The width of the canvas being rendered to.","name":"width","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The height of the canvas being rendered to.","name":"height","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The local configuration settings of the CanvasRenderer.","name":"config","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The canvas element which the Game uses.","name":"gameCanvas","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#gameCanvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The canvas context used to render all Cameras in all Scenes during the game loop.","name":"gameContext","type":{"names":["CanvasRenderingContext2D"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#gameContext","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The canvas context currently used by the CanvasRenderer for all rendering operations.","name":"currentContext","type":{"names":["CanvasRenderingContext2D"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#currentContext","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Should the Canvas use Image Smoothing or not when drawing Sprites?","name":"antialias","type":{"names":["boolean"]},"since":"3.20.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#antialias","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The blend modes supported by the Canvas Renderer.\n\nThis object maps the {@link Phaser.BlendModes} to canvas compositing operations.","name":"blendModes","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#blendModes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":146,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Details about the currently scheduled snapshot.\n\nIf a non-null `callback` is set in this object, a snapshot of the canvas will be taken after the current frame is fully rendered.","name":"snapshotState","type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotState"]},"since":"3.16.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#snapshotState","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":209,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Prepares the game canvas for rendering.","kind":"function","name":"init","since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#init","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":224,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The event handler that manages the `resize` event dispatched by the Scale Manager.","kind":"function","name":"onResize","since":"3.16.0","params":[{"type":{"names":["Phaser.Structs.Size"]},"description":"The default Game Size object. This is the un-modified game dimensions.","name":"gameSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"The base Size object. The game dimensions multiplied by the resolution. The canvas width / height values match this.","name":"baseSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"The display Size object. The size of the canvas style width / height attributes.","name":"displaySize"},{"type":{"names":["number"]},"optional":true,"description":"The Scale Manager resolution setting.","name":"resolution"}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#onResize","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":244,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Resize the main game canvas.","kind":"function","name":"resize","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The new width of the renderer.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The new height of the renderer.","name":"height"}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#resize","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Resets the transformation matrix of the current context to the identity matrix, thus resetting any transformation.","kind":"function","name":"resetTransform","since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#resetTransform","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Sets the blend mode (compositing operation) of the current context.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The new blend mode which should be used.","name":"blendMode"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"This CanvasRenderer object."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#setBlendMode","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Changes the Canvas Rendering Context that all draw operations are performed against.","kind":"function","name":"setContext","since":"3.12.0","params":[{"type":{"names":["CanvasRenderingContext2D"]},"optional":true,"nullable":true,"description":"The new Canvas Rendering Context to draw everything to. Leave empty to reset to the Game Canvas.","name":"ctx"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"The Canvas Renderer instance."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#setContext","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":304,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Sets the global alpha of the current context.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new alpha to use, where 0 is fully transparent and 1 is fully opaque.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"This CanvasRenderer object."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#setAlpha","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Called at the start of the render loop.","kind":"function","name":"preRender","since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#preRender","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Renders the Scene to the given Camera.","kind":"function","name":"render","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to render.","name":"scene"},{"type":{"names":["Phaser.GameObjects.DisplayList"]},"description":"The Game Objects within the Scene to be rendered.","name":"children"},{"type":{"names":["number"]},"description":"The interpolation percentage to apply. Currently unused.","name":"interpolationPercentage"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Scene Camera to render with.","name":"camera"}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#render","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":463,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Restores the game context's global settings and takes a snapshot if one is scheduled.\n\nThe post-render step happens after all Cameras in all Scenes have been rendered.","kind":"function","name":"postRender","since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#postRender","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":487,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Takes a snapshot of the given area of the given canvas.\n\nUnlike the other snapshot methods, this one is processed immediately and doesn't wait for the next render.\n\nSnapshots work by creating an Image object from the canvas data, this is a blocking process, which gets\nmore expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshotCanvas","since":"3.19.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas to grab from.","name":"canvas"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Grab a single pixel as a Color object, or an area as an Image object?","name":"getPixel"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate to grab from.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate to grab from.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"canvas.width","description":"The width of the area to grab.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"canvas.height","description":"The height of the area to grab.","name":"height"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"This Canvas Renderer."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#snapshotCanvas","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":527,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Schedules a snapshot of the entire game viewport to be taken after the current frame is rendered.\n\nTo capture a specific area see the `snapshotArea` method. To capture a specific pixel, see `snapshotPixel`.\n\nOnly one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\ncalling this method will override it.\n\nSnapshots work by creating an Image object from the canvas data, this is a blocking process, which gets\nmore expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshot","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#snapshot","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":552,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Schedules a snapshot of the given area of the game viewport to be taken after the current frame is rendered.\n\nTo capture the whole game viewport see the `snapshot` method. To capture a specific pixel, see `snapshotPixel`.\n\nOnly one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\ncalling this method will override it.\n\nSnapshots work by creating an Image object from the canvas data, this is a blocking process, which gets\nmore expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshotArea","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate to grab from.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate to grab from.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the area to grab.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the area to grab.","name":"height"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#snapshotArea","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":592,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Schedules a snapshot of the given pixel from the game viewport to be taken after the current frame is rendered.\n\nTo capture the whole game viewport see the `snapshot` method. To capture a specific area, see `snapshotArea`.\n\nOnly one snapshot can be active _per frame_. If you have already called `snapshotArea`, for example, then\ncalling this method will override it.\n\nUnlike the other two snapshot methods, this one will return a `Color` object containing the color data for\nthe requested pixel. It doesn't need to create an internal Canvas or Image object, so is a lot faster to execute,\nusing less memory.","kind":"function","name":"snapshotPixel","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel to get.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel to get.","name":"y"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot pixel data is extracted.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#snapshotPixel","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":622,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Takes a Sprite Game Object, or any object that extends it, and draws it to the current context.","kind":"function","name":"batchSprite","since":"3.12.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The texture based Game Object to draw.","name":"sprite"},{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to draw, doesn't have to be that owned by the Game Object.","name":"frame"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to use for the rendering transform.","name":"camera"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The transform matrix of the parent container, if set.","name":"parentTransformMatrix"}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#batchSprite","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":772,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Destroys all object references in the Canvas Renderer.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"kind":"namespace","name":"Canvas","memberof":"Phaser.Renderer","longname":"Phaser.Renderer.Canvas","scope":"static","___s":true},{"meta":{"range":[180,215],"filename":"GetBlendModes.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas/utils"},"name":"modes","longname":"modes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetBlendModes.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas/utils"},"description":"Returns an array which maps the default blend modes to supported Canvas blend modes.\n\nIf the browser doesn't support a blend mode, it will default to the normal `source-over` blend mode.","kind":"function","name":"GetBlendModes","since":"3.0.0","returns":[{"type":{"names":["array"]},"description":"Which Canvas blend mode corresponds to which default Phaser blend mode."}],"memberof":"Phaser.Renderer.Canvas","longname":"Phaser.Renderer.Canvas.GetBlendModes","scope":"static","___s":true},{"meta":{"filename":"SetTransform.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas/utils"},"description":"Takes a reference to the Canvas Renderer, a Canvas Rendering Context, a Game Object, a Camera and a parent matrix\nand then performs the following steps:\n\n1. Checks the alpha of the source combined with the Camera alpha. If 0 or less it aborts.\n2. Takes the Camera and Game Object matrix and multiplies them, combined with the parent matrix if given.\n3. Sets the blend mode of the context to be that used by the Game Object.\n4. Sets the alpha value of the context to be that used by the Game Object combined with the Camera.\n5. Saves the context state.\n6. Sets the final matrix values into the context via setTransform.\n7. If Renderer.antialias, or the frame.source.scaleMode is set, then imageSmoothingEnabled is set.\n\nThis function is only meant to be used internally. Most of the Canvas Renderer classes use it.","kind":"function","name":"SetTransform","since":"3.12.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"A reference to the current active Canvas renderer.","name":"renderer"},{"type":{"names":["CanvasRenderingContext2D"]},"description":"The canvas context to set the transform on.","name":"ctx"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object being rendered. Can be any type that extends the base class.","name":"src"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera that is rendering the Game Object.","name":"camera"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A parent transform matrix to apply to the Game Object before rendering.","name":"parentMatrix"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Game Object context was set, otherwise `false`."}],"memberof":"Phaser.Renderer.Canvas","longname":"Phaser.Renderer.Canvas.SetTransform","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"kind":"namespace","name":"Renderer","memberof":"Phaser","longname":"Phaser.Renderer","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"kind":"namespace","name":"Renderer","memberof":"Phaser.Types","longname":"Phaser.Types.Renderer","scope":"static","___s":true},{"meta":{"range":[180,235],"filename":"CanvasSnapshot.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CanvasSnapshot.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot"},"description":"Takes a snapshot of an area from the current frame displayed by a canvas.\n\nThis is then copied to an Image object. When this loads, the results are sent\nto the callback provided in the Snapshot Configuration object.","kind":"function","name":"Canvas","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas to take a snapshot of.","name":"sourceCanvas"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotState"]},"description":"The snapshot configuration object.","name":"config"}],"memberof":"Phaser.Renderer.Snapshot","longname":"Phaser.Renderer.Snapshot.Canvas","scope":"static","___s":true},{"meta":{"range":[180,235],"filename":"WebGLSnapshot.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WebGLSnapshot.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot"},"description":"Takes a snapshot of an area from the current frame displayed by a WebGL canvas.\n\nThis is then copied to an Image object. When this loads, the results are sent\nto the callback provided in the Snapshot Configuration object.","kind":"function","name":"WebGL","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas to take a snapshot of.","name":"sourceCanvas"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotState"]},"description":"The snapshot configuration object.","name":"config"}],"memberof":"Phaser.Renderer.Snapshot","longname":"Phaser.Renderer.Snapshot.WebGL","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot"},"kind":"namespace","name":"Snapshot","memberof":"Phaser.Renderer","longname":"Phaser.Renderer.Snapshot","scope":"static","___s":true},{"meta":{"filename":"SnapshotCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/typedefs"},"kind":"typedef","name":"SnapshotCallback","type":{"names":["function"]},"since":"3.16.1","params":[{"type":{"names":["Phaser.Display.Color","HTMLImageElement"]},"description":"Either a Color object if a single pixel is being grabbed, or a new Image which contains a snapshot of the canvas contents.","name":"snapshot"}],"memberof":"Phaser.Types.Renderer.Snapshot","longname":"Phaser.Types.Renderer.Snapshot.SnapshotCallback","scope":"static","___s":true},{"meta":{"filename":"SnapshotState.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/typedefs"},"kind":"typedef","name":"SnapshotState","type":{"names":["object"]},"since":"3.16.1","properties":[{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The function to call after the snapshot is taken.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate to start the snapshot from.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate to start the snapshot from.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the snapshot.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the snapshot.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this a snapshot to get a single pixel, or an area?","name":"getPixel"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this snapshot grabbing from a frame buffer or a canvas?","name":"isFramebuffer"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the frame buffer, if a frame buffer grab.","name":"bufferWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the frame buffer, if a frame buffer grab.","name":"bufferHeight"}],"memberof":"Phaser.Types.Renderer.Snapshot","longname":"Phaser.Types.Renderer.Snapshot.SnapshotState","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/typedefs"},"kind":"namespace","name":"Snapshot","memberof":"Phaser.Types.Renderer","longname":"Phaser.Types.Renderer.Snapshot","scope":"static","___s":true},{"meta":{"filename":"Utils.js","lineno":8,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"kind":"namespace","name":"Utils","since":"3.0.0","memberof":"Phaser.Renderer.WebGL","longname":"Phaser.Renderer.WebGL.Utils","scope":"static","___s":true},{"meta":{"filename":"Utils.js","lineno":14,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Packs four floats on a range from 0.0 to 1.0 into a single Uint32","kind":"function","name":"getTintFromFloats","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Red component in a range from 0.0 to 1.0","name":"r"},{"type":{"names":["number"]},"description":"Green component in a range from 0.0 to 1.0","name":"g"},{"type":{"names":["number"]},"description":"Blue component in a range from 0.0 to 1.0","name":"b"},{"type":{"names":["number"]},"description":"Alpha component in a range from 0.0 to 1.0","name":"a"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Renderer.WebGL.Utils","longname":"Phaser.Renderer.WebGL.Utils.getTintFromFloats","scope":"static","___s":true},{"meta":{"filename":"Utils.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Packs a Uint24, representing RGB components, with a Float32, representing\nthe alpha component, with a range between 0.0 and 1.0 and return a Uint32","kind":"function","name":"getTintAppendFloatAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Uint24 representing RGB components","name":"rgb"},{"type":{"names":["number"]},"description":"Float32 representing Alpha component","name":"a"}],"returns":[{"type":{"names":["number"]},"description":"Packed RGBA as Uint32"}],"memberof":"Phaser.Renderer.WebGL.Utils","longname":"Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlpha","scope":"static","___s":true},{"meta":{"filename":"Utils.js","lineno":55,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Packs a Uint24, representing RGB components, with a Float32, representing\nthe alpha component, with a range between 0.0 and 1.0 and return a \nswizzled Uint32","kind":"function","name":"getTintAppendFloatAlphaAndSwap","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Uint24 representing RGB components","name":"rgb"},{"type":{"names":["number"]},"description":"Float32 representing Alpha component","name":"a"}],"returns":[{"type":{"names":["number"]},"description":"Packed RGBA as Uint32"}],"memberof":"Phaser.Renderer.WebGL.Utils","longname":"Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlphaAndSwap","scope":"static","___s":true},{"meta":{"filename":"Utils.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Unpacks a Uint24 RGB into an array of floats of ranges of 0.0 and 1.0","kind":"function","name":"getFloatsFromUintRGB","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"RGB packed as a Uint24","name":"rgb"}],"returns":[{"type":{"names":["array"]},"description":"Array of floats representing each component as a float"}],"memberof":"Phaser.Renderer.WebGL.Utils","longname":"Phaser.Renderer.WebGL.Utils.getFloatsFromUintRGB","scope":"static","___s":true},{"meta":{"filename":"Utils.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Counts how many attributes of 32 bits a vertex has","kind":"function","name":"getComponentCount","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"Array of attributes","name":"attributes"},{"type":{"names":["WebGLRenderingContext"]},"description":"WebGLContext used for check types","name":"glContext"}],"returns":[{"type":{"names":["number"]},"description":"Count of 32 bit attributes in vertex"}],"memberof":"Phaser.Renderer.WebGL.Utils","longname":"Phaser.Renderer.WebGL.Utils.getComponentCount","scope":"static","___s":true},{"meta":{"range":[225,261],"filename":"WebGLPipeline.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"classdesc":"WebGLPipeline is a class that describes the way elements will be renderered\nin WebGL, specially focused on batching vertices (batching is not provided).\nPipelines are mostly used for describing 2D rendering passes but it's\nflexible enough to be used for any type of rendering including 3D.\nInternally WebGLPipeline will handle things like compiling shaders,\ncreating vertex buffers, assigning primitive topology and binding\nvertex attributes.\n\nThe config properties are:\n- game: Current game instance.\n- renderer: Current WebGL renderer.\n- gl: Current WebGL context.\n- topology: This indicates how the primitives are rendered. The default value is GL_TRIANGLES.\n Here is the full list of rendering primitives (https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Constants).\n- vertShader: Source for vertex shader as a string.\n- fragShader: Source for fragment shader as a string.\n- vertexCapacity: The amount of vertices that shall be allocated\n- vertexSize: The size of a single vertex in bytes.\n- vertices: An optional buffer of vertices\n- attributes: An array describing the vertex attributes\n\nThe vertex attributes properties are:\n- name : String - Name of the attribute in the vertex shader\n- size : integer - How many components describe the attribute. For ex: vec3 = size of 3, float = size of 1\n- type : GLenum - WebGL type (gl.BYTE, gl.SHORT, gl.UNSIGNED_BYTE, gl.UNSIGNED_SHORT, gl.FLOAT)\n- normalized : boolean - Is the attribute normalized\n- offset : integer - The offset in bytes to the current attribute in the vertex. Equivalent to offsetof(vertex, attrib) in C\nHere you can find more information of how to describe an attribute:\n- https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/vertexAttribPointer","kind":"class","name":"WebGLPipeline","memberof":"Phaser.Renderer.WebGL","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object for this WebGL Pipeline, as described above.","name":"config"}],"scope":"static","longname":"Phaser.Renderer.WebGL.WebGLPipeline","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Name of the Pipeline. Used for identifying","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The Game which owns this WebGL Pipeline.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The canvas which this WebGL Pipeline renders to.","name":"view","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#view","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Used to store the current game resolution","name":"resolution","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#resolution","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Width of the current viewport","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Height of the current viewport","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL context this WebGL Pipeline uses.","name":"gl","type":{"names":["WebGLRenderingContext"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#gl","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"How many vertices have been fed to the current pipeline.","name":"vertexCount","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCount","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The limit of vertices that the pipeline can hold","name":"vertexCapacity","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL Renderer which owns this WebGL Pipeline.","name":"renderer","type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Raw byte buffer of vertices.","name":"vertexData","type":{"names":["ArrayBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#vertexData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL vertex buffer object.","name":"vertexBuffer","type":{"names":["WebGLBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL program","name":"program","type":{"names":["WebGLProgram"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#program","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Array of objects that describe the vertex attributes","name":"attributes","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#attributes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The size in bytes of the vertex","name":"vertexSize","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#vertexSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The primitive topology which the pipeline will use to submit draw calls","name":"topology","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#topology","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":201,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Uint8 view to the vertex raw buffer. Used for uploading vertex buffer resources\nto the GPU.","name":"bytes","type":{"names":["Uint8Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#bytes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"This will store the amount of components of 32 bit length","name":"vertexComponentCount","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#vertexComponentCount","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is flushing the contents to the GPU.\nWhen the variable is set the flush function will be locked.","name":"flushLocked","type":{"names":["boolean"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#flushLocked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":230,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is active or not for this frame only.\nReset in the onRender method.","name":"active","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called when the Game has fully booted and the Renderer has finished setting up.\n\nBy this stage all Game level systems are now in place and you can perform any final\ntasks that the pipeline may need that relied on game systems such as the Texture Manager.","kind":"function","name":"boot","since":"3.11.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#boot","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Adds a description of vertex attribute to the pipeline","kind":"function","name":"addAttribute","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"Name of the vertex attribute","name":"name"},{"type":{"names":["integer"]},"description":"Vertex component size","name":"size"},{"type":{"names":["integer"]},"description":"Type of the attribute","name":"type"},{"type":{"names":["boolean"]},"description":"Is the value normalized to a range","name":"normalized"},{"type":{"names":["integer"]},"description":"Byte offset to the beginning of the first element in the vertex","name":"offset"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#addAttribute","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":285,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Check if the current batch of vertices is full.","kind":"function","name":"shouldFlush","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the current batch should be flushed, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Resizes the properties used to describe the viewport","kind":"function","name":"resize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new width of this WebGL Pipeline.","name":"width"},{"type":{"names":["number"]},"description":"The new height of this WebGL Pipeline.","name":"height"},{"type":{"names":["number"]},"description":"The resolution this WebGL Pipeline should be resized to.","name":"resolution"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#resize","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds the pipeline resources, including programs, vertex buffers and binds attributes","kind":"function","name":"bind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#bind","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":358,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set whenever this WebGL Pipeline is bound to a WebGL Renderer.\n\nThis method is called every time the WebGL Pipeline is attempted to be bound, even if it already is the current pipeline.","kind":"function","name":"onBind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#onBind","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":374,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before each frame is rendered, but after the canvas has been cleared.","kind":"function","name":"onPreRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#onPreRender","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":388,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before a Scene's Camera is rendered.","kind":"function","name":"onRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene being rendered.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Scene Camera being rendered with.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#onRender","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":405,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called after each frame has been completely rendered and snapshots have been taken.","kind":"function","name":"onPostRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#onPostRender","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":419,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Uploads the vertex data and emits a draw call\nfor the current batch of vertices.","kind":"function","name":"flush","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#flush","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":454,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes all object references in this WebGL Pipeline and removes its program from the WebGL context.","kind":"function","name":"destroy","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#destroy","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new value of the `float` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec2` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec3` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec3` uniform.","name":"y"},{"type":{"names":["number"]},"description":"The new Z component of the `vec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":533,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["number"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["number"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["number"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1v","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":572,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2v","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3v","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4v","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new value of the `int` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setInt1","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":644,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec2` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setInt2","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":663,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec3` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec3` uniform.","name":"y"},{"type":{"names":["integer"]},"description":"The new Z component of the `ivec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setInt3","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["integer"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["integer"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["integer"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setInt4","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":704,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat2` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat3` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Should the matrix be transpose","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"Matrix data","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4","scope":"instance","___s":true},{"meta":{"range":[225,276],"filename":"WebGLRenderer.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"name":"BaseCamera","longname":"BaseCamera","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":28,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"kind":"typedef","name":"WebGLContextCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The WebGL Renderer which owns the context.","name":"renderer"}],"longname":"WebGLContextCallback","scope":"global","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":34,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"classdesc":"WebGLRenderer is a class that contains the needed functionality to keep the\nWebGLRenderingContext state clean. The main idea of the WebGLRenderer is to keep track of\nany context change that happens for WebGL rendering inside of Phaser. This means\nif raw webgl functions are called outside the WebGLRenderer of the Phaser WebGL\nrendering ecosystem they might pollute the current WebGLRenderingContext state producing\nunexpected behavior. It's recommended that WebGL interaction is done through\nWebGLRenderer and/or WebGLPipeline.","kind":"class","name":"WebGLRenderer","memberof":"Phaser.Renderer.WebGL","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Game instance which owns this WebGL Renderer.","name":"game"}],"scope":"static","longname":"Phaser.Renderer.WebGL.WebGLRenderer","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The local configuration settings of this WebGL Renderer.","name":"config","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The Game instance which owns this WebGL Renderer.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":100,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"A constant which allows the renderer to be easily identified as a WebGL Renderer.","name":"type","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":109,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The width of the canvas being rendered to.\nThis is populated in the onResize event handler.","name":"width","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The height of the canvas being rendered to.\nThis is populated in the onResize event handler.","name":"height","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The canvas which this WebGL Renderer draws to.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"An array of blend modes supported by the WebGL Renderer.\n\nThis array includes the default blend modes as well as any custom blend modes added through {@link #addBlendMode}.","name":"blendModes","type":{"names":["array"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#blendModes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":150,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Keeps track of any WebGLTexture created with the current WebGLRenderingContext","name":"nativeTextures","type":{"names":["array"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#nativeTextures","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":160,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"This property is set to `true` if the WebGL context of the renderer is lost.","name":"contextLost","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#contextLost","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":170,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"This object will store all pipelines created through addPipeline","name":"pipelines","type":{"names":["object"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#pipelines","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":180,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Details about the currently scheduled snapshot.\n\nIf a non-null `callback` is set in this object, a snapshot of the canvas will be taken after the current frame is fully rendered.","name":"snapshotState","type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotState"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#snapshotState","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Cached value for the last texture unit that was used","name":"currentActiveTextureUnit","type":{"names":["integer"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentActiveTextureUnit","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":214,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"An array of the last texture handles that were bound to the WebGLRenderingContext","name":"currentTextures","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentTextures","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":223,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Current framebuffer in use","name":"currentFramebuffer","type":{"names":["WebGLFramebuffer"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentFramebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":233,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Current WebGLPipeline in use","name":"currentPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentPipeline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":243,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Current WebGLProgram in use","name":"currentProgram","type":{"names":["WebGLProgram"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentProgram","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":253,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Current WebGLBuffer (Vertex buffer) in use","name":"currentVertexBuffer","type":{"names":["WebGLBuffer"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentVertexBuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":263,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Current WebGLBuffer (Index buffer) in use","name":"currentIndexBuffer","type":{"names":["WebGLBuffer"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentIndexBuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Current blend mode in use","name":"currentBlendMode","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentBlendMode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":282,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the the scissor state is enabled in WebGLRenderingContext","name":"currentScissorEnabled","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentScissorEnabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":292,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Stores the current scissor data","name":"currentScissor","type":{"names":["Uint32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentScissor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":301,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Stack of scissor data","name":"scissorStack","type":{"names":["Uint32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#scissorStack","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":310,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handler to invoke when the context is lost.\nThis should not be changed and is set in the boot method.","name":"contextLostHandler","type":{"names":["function"]},"since":"3.19.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#contextLostHandler","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":320,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handler to invoke when the context is restored.\nThis should not be changed and is set in the boot method.","name":"contextRestoredHandler","type":{"names":["function"]},"since":"3.19.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#contextRestoredHandler","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":330,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The underlying WebGL context of the renderer.","name":"gl","type":{"names":["WebGLRenderingContext"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#gl","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":340,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Array of strings that indicate which WebGL extensions are supported by the browser","name":"supportedExtensions","type":{"names":["object"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#supportedExtensions","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":350,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Extensions loaded into the current context","name":"extensions","type":{"names":["object"]},"defaultvalue":"{}","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#extensions","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":360,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Stores the current WebGL component formats for further use","name":"glFormats","type":{"names":["array"]},"defaultvalue":"[]","since":"3.2.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#glFormats","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":370,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Stores the supported WebGL texture compression formats.","name":"compression","type":{"names":["array"]},"since":"3.8.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#compression","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":383,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Cached drawing buffer height to reduce gl calls.","name":"drawingBufferHeight","type":{"names":["number"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#drawingBufferHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":393,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"A blank 32x32 transparent texture, as used by the Graphics system where needed.\nThis is set in the `boot` method.","name":"blankTexture","type":{"names":["WebGLTexture"]},"readonly":true,"since":"3.12.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#blankTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":404,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"A default Camera used in calls when no other camera has been provided.","name":"defaultCamera","type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"since":"3.12.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#defaultCamera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":453,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The total number of masks currently stacked.","name":"maskCount","type":{"names":["integer"]},"since":"3.17.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#maskCount","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":462,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The mask stack.","name":"maskStack","type":{"names":["Array."]},"since":"3.17.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#maskStack","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":471,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Internal property that tracks the currently set mask.","name":"currentMask","type":{"names":["any"]},"since":"3.17.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentMask","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":480,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Internal property that tracks the currently set camera mask.","name":"currentCameraMask","type":{"names":["any"]},"since":"3.17.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentCameraMask","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":489,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Internal gl function mapping for uniform look-up.\nhttps://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/uniform","name":"glFuncMap","type":{"names":["any"]},"since":"3.17.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#glFuncMap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":499,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The `type` of the Game Object being currently rendered.\nThis can be used by advanced render functions for batching look-ahead.","name":"currentType","type":{"names":["string"]},"since":"3.19.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":509,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Is the `type` of the Game Object being currently rendered different than the\ntype of the object before it in the display list? I.e. it's a 'new' type.","name":"newType","type":{"names":["boolean"]},"since":"3.19.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#newType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":519,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Does the `type` of the next Game Object in the display list match that\nof the object being currently rendered?","name":"nextTypeMatch","type":{"names":["boolean"]},"since":"3.19.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#nextTypeMatch","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":529,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The mipmap magFilter to be used when creating textures.\n\nYou can specify this as a string in the game config, i.e.:\n\n`renderer: { mipmapFilter: 'NEAREST_MIPMAP_LINEAR' }`\n\nThe 6 options for WebGL1 are, in order from least to most computationally expensive:\n\nNEAREST (for pixel art)\nLINEAR (the default)\nNEAREST_MIPMAP_NEAREST\nLINEAR_MIPMAP_NEAREST\nNEAREST_MIPMAP_LINEAR\nLINEAR_MIPMAP_LINEAR\n\nMipmaps only work with textures that are fully power-of-two in size.\n\nFor more details see https://webglfundamentals.org/webgl/lessons/webgl-3d-textures.html","name":"mipmapFilter","type":{"names":["GLenum"]},"since":"3.21.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#mipmapFilter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":558,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Creates a new WebGLRenderingContext and initializes all internal state.","kind":"function","name":"init","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object for the renderer.","name":"config"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#init","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":761,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The event handler that manages the `resize` event dispatched by the Scale Manager.","kind":"function","name":"onResize","since":"3.16.0","params":[{"type":{"names":["Phaser.Structs.Size"]},"description":"The default Game Size object. This is the un-modified game dimensions.","name":"gameSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"The base Size object. The game dimensions multiplied by the resolution. The canvas width / height values match this.","name":"baseSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"The display Size object. The size of the canvas style width / height attributes.","name":"displaySize"},{"type":{"names":["number"]},"optional":true,"description":"The Scale Manager resolution setting.","name":"resolution"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#onResize","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":781,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Resizes the drawing buffer to match that required by the Scale Manager.","kind":"function","name":"resize","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The new width of the renderer.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The new height of the renderer.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The new resolution of the renderer.","name":"resolution"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#resize","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":819,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Checks if a WebGL extension is supported","kind":"function","name":"hasExtension","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Name of the WebGL extension","name":"extensionName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the extension is supported, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#hasExtension","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":834,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Loads a WebGL extension","kind":"function","name":"getExtension","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the extension to load.","name":"extensionName"}],"returns":[{"type":{"names":["object"]},"description":"WebGL extension if the extension is supported"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#getExtension","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":856,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Flushes the current pipeline if the pipeline is bound","kind":"function","name":"flush","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#flush","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":870,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Checks if a pipeline is present in the current WebGLRenderer","kind":"function","name":"hasPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the given pipeline is loaded, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#hasPipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":885,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Returns the pipeline by name if the pipeline exists","kind":"function","name":"getPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"The pipeline instance, or `null` if not found."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#getPipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":900,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes a pipeline by name.","kind":"function","name":"removePipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to be removed.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#removePipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":917,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Adds a pipeline instance into the collection of pipelines","kind":"function","name":"addPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"A unique string-based key for the pipeline.","name":"pipelineName"},{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"A pipeline instance which must extend WebGLPipeline.","name":"pipelineInstance"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"The pipeline instance that was passed."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#addPipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":946,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Pushes a new scissor state. This is used to set nested scissor states.","kind":"function","name":"pushScissor","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x position of the scissor.","name":"x"},{"type":{"names":["integer"]},"description":"The y position of the scissor.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the scissor.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the scissor.","name":"height"},{"type":{"names":["integer"]},"optional":true,"description":"Optional drawingBufferHeight override value.","name":"drawingBufferHeight"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing the scissor values."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#pushScissor","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":977,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the current scissor state.","kind":"function","name":"setScissor","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x position of the scissor.","name":"x"},{"type":{"names":["integer"]},"description":"The y position of the scissor.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the scissor.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the scissor.","name":"height"},{"type":{"names":["integer"]},"optional":true,"description":"Optional drawingBufferHeight override value.","name":"drawingBufferHeight"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setScissor","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1018,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Pops the last scissor state and sets it.","kind":"function","name":"popScissor","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#popScissor","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1042,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds a WebGLPipeline and sets it as the current pipeline to be used.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"The pipeline instance to be activated.","name":"pipelineInstance"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"The Game Object that invoked this pipeline, if any.","name":"gameObject"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"The pipeline that was activated."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setPipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1069,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Is there an active stencil mask?","kind":"function","name":"hasActiveStencilMask","since":"3.17.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if there is an active stencil mask, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#hasActiveStencilMask","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1085,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Use this to reset the gl context to the state that Phaser requires to continue rendering.\nCalling this will:\n\n* Disable `DEPTH_TEST`, `CULL_FACE` and `STENCIL_TEST`.\n* Clear the depth buffer and stencil buffers.\n* Reset the viewport size.\n* Reset the blend mode.\n* Bind a blank texture as the active texture on texture unit zero.\n* Rebinds the given pipeline instance.\n\nYou should call this having previously called `clearPipeline` and then wishing to return\ncontrol to Phaser again.","kind":"function","name":"rebindPipeline","since":"3.16.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"The pipeline instance to be activated.","name":"pipelineInstance"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#rebindPipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1137,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Flushes the current WebGLPipeline being used and then clears it, along with the\nthe current shader program and vertex buffer. Then resets the blend mode to NORMAL.\nCall this before jumping to your own gl context handler, and then call `rebindPipeline` when\nyou wish to return control to Phaser again.","kind":"function","name":"clearPipeline","since":"3.16.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#clearPipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the blend mode to the value given.\n\nIf the current blend mode is different from the one given, the pipeline is flushed and the new\nblend mode is enabled.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The blend mode to be set. Can be a `BlendModes` const or an integer value.","name":"blendModeId"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the blend mode to be set, regardless of the currently set blend mode.","name":"force"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the blend mode was changed as a result of this call, forcing a flush, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setBlendMode","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1203,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Creates a new custom blend mode for the renderer.\n\nSee https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Constants#Blending_modes","kind":"function","name":"addBlendMode","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array containing the WebGL functions to use for the source and the destination blending factors, respectively. See the possible constants for {@link WebGLRenderingContext#blendFunc()}.","name":"func"},{"type":{"names":["GLenum"]},"description":"The equation to use for combining the RGB and alpha components of a new pixel with a rendered one. See the possible constants for {@link WebGLRenderingContext#blendEquation()}.","name":"equation"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the new blend mode, used for referencing it in the future."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#addBlendMode","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Updates the function bound to a given custom blend mode.","kind":"function","name":"updateBlendMode","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the custom blend mode.","name":"index"},{"type":{"names":["function"]},"description":"The function to use for the blend mode.","name":"func"},{"type":{"names":["function"]},"description":"The equation to use for the blend mode.","name":"equation"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#updateBlendMode","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1250,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes a custom blend mode from the renderer.\nAny Game Objects still using this blend mode will error, so be sure to clear them first.","kind":"function","name":"removeBlendMode","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the custom blend mode to be removed.","name":"index"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#removeBlendMode","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds a texture at a texture unit. If a texture is already\nbound to that unit it will force a flush on the current pipeline.","kind":"function","name":"setTexture2D","since":"3.0.0","params":[{"type":{"names":["WebGLTexture"]},"description":"The WebGL texture that needs to be bound.","name":"texture"},{"type":{"names":["integer"]},"description":"The texture unit to which the texture will be bound.","name":"textureUnit"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Will the current pipeline be flushed if this is a new texture, or not?","name":"flush"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setTexture2D","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds a framebuffer. If there was another framebuffer already bound it will force a pipeline flush.","kind":"function","name":"setFramebuffer","since":"3.0.0","params":[{"type":{"names":["WebGLFramebuffer"]},"description":"The framebuffer that needs to be bound.","name":"framebuffer"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If a framebuffer is given, set the gl scissor to match the frame buffer size? Or, if `null` given, pop the scissor from the stack.","name":"updateScissor"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFramebuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1390,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds a program. If there was another program already bound it will force a pipeline flush.","kind":"function","name":"setProgram","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The program that needs to be bound.","name":"program"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setProgram","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1416,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Bounds a vertex buffer. If there is a vertex buffer already bound it'll force a pipeline flush.","kind":"function","name":"setVertexBuffer","since":"3.0.0","params":[{"type":{"names":["WebGLBuffer"]},"description":"The buffer that needs to be bound.","name":"vertexBuffer"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setVertexBuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1442,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Bounds a index buffer. If there is a index buffer already bound it'll force a pipeline flush.","kind":"function","name":"setIndexBuffer","since":"3.0.0","params":[{"type":{"names":["WebGLBuffer"]},"description":"The buffer the needs to be bound.","name":"indexBuffer"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setIndexBuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Creates a texture from an image source. If the source is not valid it creates an empty texture.","kind":"function","name":"createTextureFromSource","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The source of the texture.","name":"source"},{"type":{"names":["integer"]},"description":"The width of the texture.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the texture.","name":"height"},{"type":{"names":["integer"]},"description":"The scale mode to be used by the texture.","name":"scaleMode"}],"returns":[{"type":{"names":["WebGLTexture"]},"nullable":true,"description":"The WebGL Texture that was created, or `null` if it couldn't be created."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createTextureFromSource","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1517,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"A wrapper for creating a WebGLTexture. If no pixel data is passed it will create an empty texture.","kind":"function","name":"createTexture2D","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"Mip level of the texture.","name":"mipLevel"},{"type":{"names":["integer"]},"description":"Filtering of the texture.","name":"minFilter"},{"type":{"names":["integer"]},"description":"Filtering of the texture.","name":"magFilter"},{"type":{"names":["integer"]},"description":"Wrapping mode of the texture.","name":"wrapT"},{"type":{"names":["integer"]},"description":"Wrapping mode of the texture.","name":"wrapS"},{"type":{"names":["integer"]},"description":"Which format does the texture use.","name":"format"},{"type":{"names":["object"]},"nullable":true,"description":"pixel data.","name":"pixels"},{"type":{"names":["integer"]},"description":"Width of the texture in pixels.","name":"width"},{"type":{"names":["integer"]},"description":"Height of the texture in pixels.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Does the texture have premultiplied alpha?","name":"pma"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` it will use the width and height passed to this method, regardless of the pixels dimension.","name":"forceSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets the `UNPACK_FLIP_Y_WEBGL` flag the WebGL Texture uses during upload.","name":"flipY"}],"returns":[{"type":{"names":["WebGLTexture"]},"description":"The WebGLTexture that was created."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createTexture2D","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1589,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Wrapper for creating WebGLFramebuffer.","kind":"function","name":"createFramebuffer","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"Width in pixels of the framebuffer","name":"width"},{"type":{"names":["integer"]},"description":"Height in pixels of the framebuffer","name":"height"},{"type":{"names":["WebGLTexture"]},"description":"The color texture to where the color pixels are written","name":"renderTexture"},{"type":{"names":["boolean"]},"description":"Indicates if the current framebuffer support depth and stencil buffers","name":"addDepthStencilBuffer"}],"returns":[{"type":{"names":["WebGLFramebuffer"]},"description":"Raw WebGLFramebuffer"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createFramebuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1644,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Wrapper for creating a WebGLProgram","kind":"function","name":"createProgram","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Source to the vertex shader","name":"vertexShader"},{"type":{"names":["string"]},"description":"Source to the fragment shader","name":"fragmentShader"}],"returns":[{"type":{"names":["WebGLProgram"]},"description":"Raw WebGLProgram"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createProgram","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1688,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Wrapper for creating a vertex buffer.","kind":"function","name":"createVertexBuffer","since":"3.0.0","params":[{"type":{"names":["ArrayBuffer"]},"description":"It's either ArrayBuffer or an integer indicating the size of the vbo","name":"initialDataOrSize"},{"type":{"names":["integer"]},"description":"How the buffer is used. gl.DYNAMIC_DRAW, gl.STATIC_DRAW or gl.STREAM_DRAW","name":"bufferUsage"}],"returns":[{"type":{"names":["WebGLBuffer"]},"description":"Raw vertex buffer"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createVertexBuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1713,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Wrapper for creating a vertex buffer.","kind":"function","name":"createIndexBuffer","since":"3.0.0","params":[{"type":{"names":["ArrayBuffer"]},"description":"Either ArrayBuffer or an integer indicating the size of the vbo.","name":"initialDataOrSize"},{"type":{"names":["integer"]},"description":"How the buffer is used. gl.DYNAMIC_DRAW, gl.STATIC_DRAW or gl.STREAM_DRAW.","name":"bufferUsage"}],"returns":[{"type":{"names":["WebGLBuffer"]},"description":"Raw index buffer"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createIndexBuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1738,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes the given texture from the nativeTextures array and then deletes it from the GPU.","kind":"function","name":"deleteTexture","since":"3.0.0","params":[{"type":{"names":["WebGLTexture"]},"description":"The WebGL Texture to be deleted.","name":"texture"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#deleteTexture","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1768,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Deletes a WebGLFramebuffer from the GL instance.","kind":"function","name":"deleteFramebuffer","since":"3.0.0","params":[{"type":{"names":["WebGLFramebuffer"]},"description":"The Framebuffer to be deleted.","name":"framebuffer"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#deleteFramebuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1785,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Deletes a WebGLProgram from the GL instance.","kind":"function","name":"deleteProgram","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The shader program to be deleted.","name":"program"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#deleteProgram","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1802,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Deletes a WebGLBuffer from the GL instance.","kind":"function","name":"deleteBuffer","since":"3.0.0","params":[{"type":{"names":["WebGLBuffer"]},"description":"The WebGLBuffer to be deleted.","name":"vertexBuffer"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#deleteBuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1819,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Controls the pre-render operations for the given camera.\nHandles any clipping needed by the camera and renders the background color if a color is visible.","kind":"function","name":"preRenderCamera","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to pre-render.","name":"camera"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#preRenderCamera","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1915,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Controls the post-render operations for the given camera.\nRenders the foreground camera effects like flash and fading. It resets the current scissor state.","kind":"function","name":"postRenderCamera","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to post-render.","name":"camera"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#postRenderCamera","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1983,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Clears the current vertex buffer and updates pipelines.","kind":"function","name":"preRender","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#preRender","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2033,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The core render step for a Scene Camera.\n\nIterates through the given Game Object's array and renders them with the given Camera.\n\nThis is called by the `CameraManager.render` method. The Camera Manager instance belongs to a Scene, and is invoked\nby the Scene Systems.render method.\n\nThis method is not called if `Camera.visible` is `false`, or `Camera.alpha` is zero.","kind":"function","name":"render","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to render.","name":"scene"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object's within the Scene to be rendered.","name":"children"},{"type":{"names":["number"]},"description":"The interpolation percentage to apply. Currently un-used.","name":"interpolationPercentage"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Scene Camera to render with.","name":"camera"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#render","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2141,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The post-render step happens after all Cameras in all Scenes have been rendered.","kind":"function","name":"postRender","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#postRender","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2172,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Schedules a snapshot of the entire game viewport to be taken after the current frame is rendered.\n\nTo capture a specific area see the `snapshotArea` method. To capture a specific pixel, see `snapshotPixel`.\n\nOnly one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\ncalling this method will override it.\n\nSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\nIt then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\nwhich is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\nwhich gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshot","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#snapshot","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2199,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Schedules a snapshot of the given area of the game viewport to be taken after the current frame is rendered.\n\nTo capture the whole game viewport see the `snapshot` method. To capture a specific pixel, see `snapshotPixel`.\n\nOnly one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\ncalling this method will override it.\n\nSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\nIt then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\nwhich is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\nwhich gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshotArea","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate to grab from.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate to grab from.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the area to grab.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the area to grab.","name":"height"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#snapshotArea","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Schedules a snapshot of the given pixel from the game viewport to be taken after the current frame is rendered.\n\nTo capture the whole game viewport see the `snapshot` method. To capture a specific area, see `snapshotArea`.\n\nOnly one snapshot can be active _per frame_. If you have already called `snapshotArea`, for example, then\ncalling this method will override it.\n\nUnlike the other two snapshot methods, this one will return a `Color` object containing the color data for\nthe requested pixel. It doesn't need to create an internal Canvas or Image object, so is a lot faster to execute,\nusing less memory.","kind":"function","name":"snapshotPixel","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel to get.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel to get.","name":"y"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot pixel data is extracted.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#snapshotPixel","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2271,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Takes a snapshot of the given area of the given frame buffer.\n\nUnlike the other snapshot methods, this one is processed immediately and doesn't wait for the next render.\n\nSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\nIt then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\nwhich is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\nwhich gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshotFramebuffer","since":"3.19.0","params":[{"type":{"names":["WebGLFramebuffer"]},"description":"The framebuffer to grab from.","name":"framebuffer"},{"type":{"names":["integer"]},"description":"The width of the framebuffer.","name":"bufferWidth"},{"type":{"names":["integer"]},"description":"The height of the framebuffer.","name":"bufferHeight"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Grab a single pixel as a Color object, or an area as an Image object?","name":"getPixel"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate to grab from.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate to grab from.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"bufferWidth","description":"The width of the area to grab.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"bufferHeight","description":"The height of the area to grab.","name":"height"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#snapshotFramebuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Creates a new WebGL Texture based on the given Canvas Element.\n\nIf the `dstTexture` parameter is given, the WebGL Texture is updated, rather than created fresh.","kind":"function","name":"canvasToTexture","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas to create the WebGL Texture from","name":"srcCanvas"},{"type":{"names":["WebGLTexture"]},"optional":true,"description":"The destination WebGL Texture to set.","name":"dstTexture"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this canvas be allowed to set `REPEAT` (such as for Text objects?)","name":"noRepeat"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?","name":"flipY"}],"returns":[{"type":{"names":["WebGLTexture"]},"description":"The newly created, or updated, WebGL Texture."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#canvasToTexture","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2360,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Creates a new WebGL Texture based on the given Canvas Element.","kind":"function","name":"createCanvasTexture","since":"3.20.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas to create the WebGL Texture from","name":"srcCanvas"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this canvas be allowed to set `REPEAT` (such as for Text objects?)","name":"noRepeat"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?","name":"flipY"}],"returns":[{"type":{"names":["WebGLTexture"]},"description":"The newly created WebGL Texture."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createCanvasTexture","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Updates a WebGL Texture based on the given Canvas Element.","kind":"function","name":"updateCanvasTexture","since":"3.20.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas to update the WebGL Texture from.","name":"srcCanvas"},{"type":{"names":["WebGLTexture"]},"description":"The destination WebGL Texture to update.","name":"dstTexture"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?","name":"flipY"}],"returns":[{"type":{"names":["WebGLTexture"]},"description":"The updated WebGL Texture."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#updateCanvasTexture","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2440,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Creates a new WebGL Texture based on the given HTML Video Element.","kind":"function","name":"createVideoTexture","since":"3.20.0","params":[{"type":{"names":["HTMLVideoElement"]},"description":"The Video to create the WebGL Texture from","name":"srcVideo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this canvas be allowed to set `REPEAT`?","name":"noRepeat"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?","name":"flipY"}],"returns":[{"type":{"names":["WebGLTexture"]},"description":"The newly created WebGL Texture."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createVideoTexture","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2482,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Updates a WebGL Texture based on the given HTML Video Element.","kind":"function","name":"updateVideoTexture","since":"3.20.0","params":[{"type":{"names":["HTMLVideoElement"]},"description":"The Video to update the WebGL Texture with.","name":"srcVideo"},{"type":{"names":["WebGLTexture"]},"description":"The destination WebGL Texture to update.","name":"dstTexture"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?","name":"flipY"}],"returns":[{"type":{"names":["WebGLTexture"]},"description":"The updated WebGL Texture."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#updateVideoTexture","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2520,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the minification and magnification filter for a texture.","kind":"function","name":"setTextureFilter","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The texture to set the filter for.","name":"texture"},{"type":{"names":["integer"]},"description":"The filter to set. 0 for linear filtering, 1 for nearest neighbor (blocky) filtering.","name":"filter"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setTextureFilter","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2546,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"[description]","kind":"function","name":"setFloat1","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"[description]","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat1","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2567,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"[description]","kind":"function","name":"setFloat2","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat2","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2589,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"[description]","kind":"function","name":"setFloat3","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"description":"[description]","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat3","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2612,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets uniform of a WebGLProgram","kind":"function","name":"setFloat4","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"X component","name":"x"},{"type":{"names":["number"]},"description":"Y component","name":"y"},{"type":{"names":["number"]},"description":"Z component","name":"z"},{"type":{"names":["number"]},"description":"W component","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat4","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2636,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setFloat1v","since":"3.13.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat1v","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2657,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setFloat2v","since":"3.13.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat2v","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2678,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setFloat3v","since":"3.13.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat3v","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2699,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setFloat4v","since":"3.13.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat4v","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2721,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setInt1","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"[description]","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setInt1","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setInt2","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setInt2","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2764,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setInt3","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component","name":"y"},{"type":{"names":["integer"]},"description":"The new Z component","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setInt3","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2787,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setInt4","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"X component","name":"x"},{"type":{"names":["integer"]},"description":"Y component","name":"y"},{"type":{"names":["integer"]},"description":"Z component","name":"z"},{"type":{"names":["integer"]},"description":"W component","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setInt4","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2811,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a 2x2 matrix uniform variable in the given WebGLProgram.","kind":"function","name":"setMatrix2","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"The value indicating whether to transpose the matrix. Must be false.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new matrix value.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setMatrix2","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2833,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"[description]","kind":"function","name":"setMatrix3","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"[description]","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"[description]","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setMatrix3","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2855,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets uniform of a WebGLProgram","kind":"function","name":"setMatrix4","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Is the matrix transposed","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"Matrix data","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setMatrix4","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2877,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Returns the maximum number of texture units that can be used in a fragment shader.","kind":"function","name":"getMaxTextures","since":"3.8.0","returns":[{"type":{"names":["integer"]},"description":"The maximum number of textures WebGL supports."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#getMaxTextures","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2890,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Returns the largest texture size (either width or height) that can be created.\nNote that VRAM may not allow a texture of any given size, it just expresses\nhardware / driver support for a given size.","kind":"function","name":"getMaxTextureSize","since":"3.8.0","returns":[{"type":{"names":["integer"]},"description":"The maximum supported texture size."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#getMaxTextureSize","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2905,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Destroy this WebGLRenderer, cleaning up all related resources such as pipelines, native textures, etc.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"kind":"namespace","name":"WebGL","memberof":"Phaser.Renderer","longname":"Phaser.Renderer.WebGL","scope":"static","___s":true},{"meta":{"range":[225,264],"filename":"BitmapMaskPipeline.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"classdesc":"BitmapMaskPipeline handles all bitmap masking rendering in WebGL. It works by using \nsampling two texture on the fragment shader and using the fragment's alpha to clip the region.\nThe config properties are:\n- game: Current game instance.\n- renderer: Current WebGL renderer.\n- topology: This indicates how the primitives are rendered. The default value is GL_TRIANGLES.\n Here is the full list of rendering primitives (https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Constants).\n- vertShader: Source for vertex shader as a string.\n- fragShader: Source for fragment shader as a string.\n- vertexCapacity: The amount of vertices that shall be allocated\n- vertexSize: The size of a single vertex in bytes.","kind":"class","name":"BitmapMaskPipeline","augments":["Phaser.Renderer.WebGL.WebGLPipeline"],"memberof":"Phaser.Renderer.WebGL.Pipelines","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"Used for overriding shader an pipeline properties if extending this pipeline.","name":"config"}],"scope":"static","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Float32 view of the array buffer containing the pipeline's vertices.","name":"vertexViewF32","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexViewF32","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Size of the batch.","name":"maxQuads","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#maxQuads","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Dirty flag to check if resolution properties need to be updated on the \nmasking shader.","name":"resolutionDirty","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#resolutionDirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Called every time the pipeline needs to be used.\nIt binds all necessary resources.","kind":"function","name":"onBind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onBind","scope":"instance","overrides":"Phaser.Renderer.WebGL.WebGLPipeline#onBind","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":128,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"[description]","kind":"function","name":"resize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"width"},{"type":{"names":["number"]},"description":"[description]","name":"height"},{"type":{"names":["number"]},"description":"[description]","name":"resolution"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#resize","scope":"instance","overrides":"Phaser.Renderer.WebGL.WebGLPipeline#resize","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Binds necessary resources and renders the mask to a separated framebuffer.\nThe framebuffer for the masked object is also bound for further use.","kind":"function","name":"beginMask","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"GameObject used as mask.","name":"mask"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"GameObject masked by the mask GameObject.","name":"maskedObject"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"[description]","name":"camera"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#beginMask","scope":"instance","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"The masked game objects framebuffer is unbound and its texture \nis bound together with the mask texture and the mask shader and \na draw call with a single quad is processed. Here is where the\nmasking effect is applied.","kind":"function","name":"endMask","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"GameObject used as a mask.","name":"mask"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#endMask","scope":"instance","___s":true},{"meta":{"range":[225,264],"filename":"ForwardDiffuseLightPipeline.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"classdesc":"ForwardDiffuseLightPipeline implements a forward rendering approach for 2D lights.\nThis pipeline extends TextureTintPipeline so it implements all it's rendering functions\nand batching system.","kind":"class","name":"ForwardDiffuseLightPipeline","augments":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"],"memberof":"Phaser.Renderer.WebGL.Pipelines","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration of the pipeline, same as the {@link Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline}. The fragment shader will be replaced with the lighting shader.","name":"config"}],"scope":"static","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Called when the Game has fully booted and the Renderer has finished setting up.\n\nBy this stage all Game level systems are now in place and you can perform any final\ntasks that the pipeline may need that relied on game systems such as the Texture Manager.","kind":"function","name":"boot","override":true,"since":"3.11.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#boot","scope":"instance","ignore":true,"___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"This function binds its base class resources and this lights 2D resources.","kind":"function","name":"onBind","override":true,"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"The Game Object that invoked this pipeline, if any.","name":"gameObject"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#onBind","scope":"instance","ignore":true,"___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":113,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"This function sets all the needed resources for each camera pass.","kind":"function","name":"onRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene being rendered.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Scene Camera being rendered with.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#onRender","scope":"instance","overrides":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onRender","___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Generic function for batching a textured quad","kind":"function","name":"batchTexture","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"Source GameObject","name":"gameObject"},{"type":{"names":["WebGLTexture"]},"description":"Raw WebGLTexture associated with the quad","name":"texture"},{"type":{"names":["integer"]},"description":"Real texture width","name":"textureWidth"},{"type":{"names":["integer"]},"description":"Real texture height","name":"textureHeight"},{"type":{"names":["number"]},"description":"X coordinate of the quad","name":"srcX"},{"type":{"names":["number"]},"description":"Y coordinate of the quad","name":"srcY"},{"type":{"names":["number"]},"description":"Width of the quad","name":"srcWidth"},{"type":{"names":["number"]},"description":"Height of the quad","name":"srcHeight"},{"type":{"names":["number"]},"description":"X component of scale","name":"scaleX"},{"type":{"names":["number"]},"description":"Y component of scale","name":"scaleY"},{"type":{"names":["number"]},"description":"Rotation of the quad","name":"rotation"},{"type":{"names":["boolean"]},"description":"Indicates if the quad is horizontally flipped","name":"flipX"},{"type":{"names":["boolean"]},"description":"Indicates if the quad is vertically flipped","name":"flipY"},{"type":{"names":["number"]},"description":"By which factor is the quad affected by the camera horizontal scroll","name":"scrollFactorX"},{"type":{"names":["number"]},"description":"By which factor is the quad effected by the camera vertical scroll","name":"scrollFactorY"},{"type":{"names":["number"]},"description":"Horizontal origin in pixels","name":"displayOriginX"},{"type":{"names":["number"]},"description":"Vertical origin in pixels","name":"displayOriginY"},{"type":{"names":["number"]},"description":"X coordinate of the texture frame","name":"frameX"},{"type":{"names":["number"]},"description":"Y coordinate of the texture frame","name":"frameY"},{"type":{"names":["number"]},"description":"Width of the texture frame","name":"frameWidth"},{"type":{"names":["number"]},"description":"Height of the texture frame","name":"frameHeight"},{"type":{"names":["integer"]},"description":"Tint for top left","name":"tintTL"},{"type":{"names":["integer"]},"description":"Tint for top right","name":"tintTR"},{"type":{"names":["integer"]},"description":"Tint for bottom left","name":"tintBL"},{"type":{"names":["integer"]},"description":"Tint for bottom right","name":"tintBR"},{"type":{"names":["number"]},"description":"The tint effect (0 for additive, 1 for replacement)","name":"tintEffect"},{"type":{"names":["number"]},"description":"Horizontal offset on texture coordinate","name":"uOffset"},{"type":{"names":["number"]},"description":"Vertical offset on texture coordinate","name":"vOffset"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"Current used camera","name":"camera"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"Parent container","name":"parentTransformMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchTexture","scope":"instance","overrides":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTexture","___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":407,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Sets the Game Objects normal map as the active texture.","kind":"function","name":"setNormalMap","since":"3.11.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to update.","name":"gameObject"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setNormalMap","scope":"instance","___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":439,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Rotates the normal map vectors inversely by the given angle.\nOnly works in 2D space.","kind":"function","name":"setNormalMapRotation","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"rotation"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setNormalMapRotation","scope":"instance","___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":481,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Takes a Sprite Game Object, or any object that extends it, which has a normal texture and adds it to the batch.","kind":"function","name":"batchSprite","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"The texture-based Game Object to add to the batch.","name":"sprite"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to use for the rendering transform.","name":"camera"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The transform matrix of the parent container, if set.","name":"parentTransformMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchSprite","scope":"instance","overrides":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchSprite","___s":true},{"meta":{"range":[225,264],"filename":"TextureTintPipeline.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"classdesc":"TextureTintPipeline implements the rendering infrastructure\nfor displaying textured objects\nThe config properties are:\n- game: Current game instance.\n- renderer: Current WebGL renderer.\n- topology: This indicates how the primitives are rendered. The default value is GL_TRIANGLES.\n Here is the full list of rendering primitives (https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Constants).\n- vertShader: Source for vertex shader as a string.\n- fragShader: Source for fragment shader as a string.\n- vertexCapacity: The amount of vertices that shall be allocated\n- vertexSize: The size of a single vertex in bytes.","kind":"class","name":"TextureTintPipeline","augments":["Phaser.Renderer.WebGL.WebGLPipeline"],"memberof":"Phaser.Renderer.WebGL.Pipelines","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration options for this Texture Tint Pipeline, as described above.","name":"config"}],"scope":"static","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Float32 view of the array buffer containing the pipeline's vertices.","name":"vertexViewF32","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexViewF32","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Uint32 view of the array buffer containing the pipeline's vertices.","name":"vertexViewU32","type":{"names":["Uint32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexViewU32","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Size of the batch.","name":"maxQuads","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#maxQuads","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Collection of batch information","name":"batches","type":{"names":["array"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batches","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":266,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Called every time the pipeline needs to be used.\nIt binds all necessary resources.","kind":"function","name":"onBind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onBind","scope":"instance","overrides":"Phaser.Renderer.WebGL.WebGLPipeline#onBind","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":284,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Resizes this pipeline and updates the projection.","kind":"function","name":"resize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new width.","name":"width"},{"type":{"names":["number"]},"description":"The new height.","name":"height"},{"type":{"names":["number"]},"description":"The resolution.","name":"resolution"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#resize","scope":"instance","overrides":"Phaser.Renderer.WebGL.WebGLPipeline#resize","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":305,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Assigns a texture to the current batch. If a different texture is already set it creates a new batch object.","kind":"function","name":"setTexture2D","since":"3.1.0","params":[{"type":{"names":["WebGLTexture"]},"optional":true,"description":"WebGLTexture that will be assigned to the current batch. If not given uses blankTexture.","name":"texture"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This pipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setTexture2D","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":329,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Checks if the current batch has the same texture and texture unit, or if we need to create a new batch.","kind":"function","name":"requireTextureBatch","since":"3.16.0","params":[{"type":{"names":["WebGLTexture"]},"description":"WebGLTexture that will be assigned to the current batch. If not given uses blankTexture.","name":"texture"},{"type":{"names":["integer"]},"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline needs to create a new batch, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#requireTextureBatch","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":356,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Creates a new batch object and pushes it to a batch array.\nThe batch object contains information relevant to the current \nvertex batch like the offset in the vertex buffer, vertex count and \nthe textures used by that batch.","kind":"function","name":"pushBatch","since":"3.1.0","params":[{"type":{"names":["WebGLTexture"]},"description":"Optional WebGLTexture that will be assigned to the created batch.","name":"texture"},{"type":{"names":["integer"]},"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#pushBatch","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Uploads the vertex data and emits a draw call for the current batch of vertices.","kind":"function","name":"flush","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#flush","scope":"instance","overrides":"Phaser.Renderer.WebGL.WebGLPipeline#flush","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":506,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Takes a Sprite Game Object, or any object that extends it, and adds it to the batch.","kind":"function","name":"batchSprite","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Image","Phaser.GameObjects.Sprite"]},"description":"The texture based Game Object to add to the batch.","name":"sprite"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to use for the rendering transform.","name":"camera"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The transform matrix of the parent container, if set.","name":"parentTransformMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchSprite","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":659,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the vertices data into the batch and flushes if full.\n\nAssumes 6 vertices in the following arrangement:\n\n```\n0----3\n|\\ B|\n| \\ |\n| \\ |\n| A \\|\n| \\\n1----2\n```\n\nWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3","kind":"function","name":"batchQuad","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The top-left x position.","name":"x0"},{"type":{"names":["number"]},"description":"The top-left y position.","name":"y0"},{"type":{"names":["number"]},"description":"The bottom-left x position.","name":"x1"},{"type":{"names":["number"]},"description":"The bottom-left y position.","name":"y1"},{"type":{"names":["number"]},"description":"The bottom-right x position.","name":"x2"},{"type":{"names":["number"]},"description":"The bottom-right y position.","name":"y2"},{"type":{"names":["number"]},"description":"The top-right x position.","name":"x3"},{"type":{"names":["number"]},"description":"The top-right y position.","name":"y3"},{"type":{"names":["number"]},"description":"UV u0 value.","name":"u0"},{"type":{"names":["number"]},"description":"UV v0 value.","name":"v0"},{"type":{"names":["number"]},"description":"UV u1 value.","name":"u1"},{"type":{"names":["number"]},"description":"UV v1 value.","name":"v1"},{"type":{"names":["number"]},"description":"The top-left tint color value.","name":"tintTL"},{"type":{"names":["number"]},"description":"The top-right tint color value.","name":"tintTR"},{"type":{"names":["number"]},"description":"The bottom-left tint color value.","name":"tintBL"},{"type":{"names":["number"]},"description":"The bottom-right tint color value.","name":"tintBR"},{"type":{"names":["number","boolean"]},"description":"The tint effect for the shader to use.","name":"tintEffect"},{"type":{"names":["WebGLTexture"]},"optional":true,"description":"WebGLTexture that will be assigned to the current batch if a flush occurs.","name":"texture"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if this method caused the batch to flush, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchQuad","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":766,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the vertices data into the batch and flushes if full.\n\nAssumes 3 vertices in the following arrangement:\n\n```\n0\n|\\\n| \\\n| \\\n| \\\n| \\\n1-----2\n```","kind":"function","name":"batchTri","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The bottom-left x position.","name":"x1"},{"type":{"names":["number"]},"description":"The bottom-left y position.","name":"y1"},{"type":{"names":["number"]},"description":"The bottom-right x position.","name":"x2"},{"type":{"names":["number"]},"description":"The bottom-right y position.","name":"y2"},{"type":{"names":["number"]},"description":"The top-right x position.","name":"x3"},{"type":{"names":["number"]},"description":"The top-right y position.","name":"y3"},{"type":{"names":["number"]},"description":"UV u0 value.","name":"u0"},{"type":{"names":["number"]},"description":"UV v0 value.","name":"v0"},{"type":{"names":["number"]},"description":"UV u1 value.","name":"u1"},{"type":{"names":["number"]},"description":"UV v1 value.","name":"v1"},{"type":{"names":["number"]},"description":"The top-left tint color value.","name":"tintTL"},{"type":{"names":["number"]},"description":"The top-right tint color value.","name":"tintTR"},{"type":{"names":["number"]},"description":"The bottom-left tint color value.","name":"tintBL"},{"type":{"names":["number","boolean"]},"description":"The tint effect for the shader to use.","name":"tintEffect"},{"type":{"names":["WebGLTexture"]},"optional":true,"description":"WebGLTexture that will be assigned to the current batch if a flush occurs.","name":"texture"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if this method caused the batch to flush, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTri","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":847,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Generic function for batching a textured quad using argument values instead of a Game Object.","kind":"function","name":"batchTexture","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"Source GameObject.","name":"gameObject"},{"type":{"names":["WebGLTexture"]},"description":"Raw WebGLTexture associated with the quad.","name":"texture"},{"type":{"names":["integer"]},"description":"Real texture width.","name":"textureWidth"},{"type":{"names":["integer"]},"description":"Real texture height.","name":"textureHeight"},{"type":{"names":["number"]},"description":"X coordinate of the quad.","name":"srcX"},{"type":{"names":["number"]},"description":"Y coordinate of the quad.","name":"srcY"},{"type":{"names":["number"]},"description":"Width of the quad.","name":"srcWidth"},{"type":{"names":["number"]},"description":"Height of the quad.","name":"srcHeight"},{"type":{"names":["number"]},"description":"X component of scale.","name":"scaleX"},{"type":{"names":["number"]},"description":"Y component of scale.","name":"scaleY"},{"type":{"names":["number"]},"description":"Rotation of the quad.","name":"rotation"},{"type":{"names":["boolean"]},"description":"Indicates if the quad is horizontally flipped.","name":"flipX"},{"type":{"names":["boolean"]},"description":"Indicates if the quad is vertically flipped.","name":"flipY"},{"type":{"names":["number"]},"description":"By which factor is the quad affected by the camera horizontal scroll.","name":"scrollFactorX"},{"type":{"names":["number"]},"description":"By which factor is the quad effected by the camera vertical scroll.","name":"scrollFactorY"},{"type":{"names":["number"]},"description":"Horizontal origin in pixels.","name":"displayOriginX"},{"type":{"names":["number"]},"description":"Vertical origin in pixels.","name":"displayOriginY"},{"type":{"names":["number"]},"description":"X coordinate of the texture frame.","name":"frameX"},{"type":{"names":["number"]},"description":"Y coordinate of the texture frame.","name":"frameY"},{"type":{"names":["number"]},"description":"Width of the texture frame.","name":"frameWidth"},{"type":{"names":["number"]},"description":"Height of the texture frame.","name":"frameHeight"},{"type":{"names":["integer"]},"description":"Tint for top left.","name":"tintTL"},{"type":{"names":["integer"]},"description":"Tint for top right.","name":"tintTR"},{"type":{"names":["integer"]},"description":"Tint for bottom left.","name":"tintBL"},{"type":{"names":["integer"]},"description":"Tint for bottom right.","name":"tintBR"},{"type":{"names":["number"]},"description":"The tint effect.","name":"tintEffect"},{"type":{"names":["number"]},"description":"Horizontal offset on texture coordinate.","name":"uOffset"},{"type":{"names":["number"]},"description":"Vertical offset on texture coordinate.","name":"vOffset"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"Current used camera.","name":"camera"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"Parent container.","name":"parentTransformMatrix"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip the renderTexture check.","name":"skipFlip"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTexture","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1030,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds a Texture Frame into the batch for rendering.","kind":"function","name":"batchTextureFrame","since":"3.12.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The Texture Frame to be rendered.","name":"frame"},{"type":{"names":["number"]},"description":"The horizontal position to render the texture at.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position to render the texture at.","name":"y"},{"type":{"names":["number"]},"description":"The tint color.","name":"tint"},{"type":{"names":["number"]},"description":"The alpha value.","name":"alpha"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The Transform Matrix to use for the texture.","name":"transformMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A parent Transform Matrix.","name":"parentTransformMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTextureFrame","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a filled rectangle into the vertex batch.\nRectangle has no transform values and isn't transformed into the local space.\nUsed for directly batching untransformed rectangles, such as Camera background colors.","kind":"function","name":"drawFillRect","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Horizontal top left coordinate of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"Vertical top left coordinate of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["number"]},"description":"Color of the rectangle to draw.","name":"color"},{"type":{"names":["number"]},"description":"Alpha value of the rectangle to draw.","name":"alpha"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#drawFillRect","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1115,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a filled rectangle into the vertex batch.\nRectangle factors in the given transform matrices before adding to the batch.","kind":"function","name":"batchFillRect","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Horizontal top left coordinate of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"Vertical top left coordinate of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchFillRect","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a filled triangle into the vertex batch.\nTriangle factors in the given transform matrices before adding to the batch.","kind":"function","name":"batchFillTriangle","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Point 0 x coordinate.","name":"x0"},{"type":{"names":["number"]},"description":"Point 0 y coordinate.","name":"y0"},{"type":{"names":["number"]},"description":"Point 1 x coordinate.","name":"x1"},{"type":{"names":["number"]},"description":"Point 1 y coordinate.","name":"y1"},{"type":{"names":["number"]},"description":"Point 2 x coordinate.","name":"x2"},{"type":{"names":["number"]},"description":"Point 2 y coordinate.","name":"y2"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchFillTriangle","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a stroked triangle into the vertex batch.\nTriangle factors in the given transform matrices before adding to the batch.\nThe triangle is created from 3 lines and drawn using the `batchStrokePath` method.","kind":"function","name":"batchStrokeTriangle","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Point 0 x coordinate.","name":"x0"},{"type":{"names":["number"]},"description":"Point 0 y coordinate.","name":"y0"},{"type":{"names":["number"]},"description":"Point 1 x coordinate.","name":"x1"},{"type":{"names":["number"]},"description":"Point 1 y coordinate.","name":"y1"},{"type":{"names":["number"]},"description":"Point 2 x coordinate.","name":"x2"},{"type":{"names":["number"]},"description":"Point 2 y coordinate.","name":"y2"},{"type":{"names":["number"]},"description":"The width of the line in pixels.","name":"lineWidth"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchStrokeTriangle","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the given path to the vertex batch for rendering.\n\nIt works by taking the array of path data and then passing it through Earcut, which\ncreates a list of polygons. Each polygon is then added to the batch.\n\nThe path is always automatically closed because it's filled.","kind":"function","name":"batchFillPath","since":"3.12.0","params":[{"type":{"names":["array"]},"description":"Collection of points that represent the path.","name":"path"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchFillPath","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1335,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the given path to the vertex batch for rendering.\n\nIt works by taking the array of path data and calling `batchLine` for each section\nof the path.\n\nThe path is optionally closed at the end.","kind":"function","name":"batchStrokePath","since":"3.12.0","params":[{"type":{"names":["array"]},"description":"Collection of points that represent the path.","name":"path"},{"type":{"names":["number"]},"description":"The width of the line segments in pixels.","name":"lineWidth"},{"type":{"names":["boolean"]},"description":"Indicates if the path should be closed or left open.","name":"pathOpen"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchStrokePath","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1383,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Creates a quad and adds it to the vertex batch based on the given line values.","kind":"function","name":"batchLine","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"X coordinate to the start of the line","name":"ax"},{"type":{"names":["number"]},"description":"Y coordinate to the start of the line","name":"ay"},{"type":{"names":["number"]},"description":"X coordinate to the end of the line","name":"bx"},{"type":{"names":["number"]},"description":"Y coordinate to the end of the line","name":"by"},{"type":{"names":["number"]},"description":"Width of the start of the line","name":"aLineWidth"},{"type":{"names":["number"]},"description":"Width of the end of the line","name":"bLineWidth"},{"type":{"names":["Float32Array"]},"description":"Parent matrix, generally used by containers","name":"currentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchLine","scope":"instance","___s":true},{"meta":{"range":[225,264],"filename":"TextureTintStripPipeline.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextureTintStripPipeline.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"classdesc":"TextureTintStripPipeline implements the rendering infrastructure\nfor displaying textured objects\nThe config properties are:\n- game: Current game instance.\n- renderer: Current WebGL renderer.\n- vertShader: Source for vertex shader as a string.\n- fragShader: Source for fragment shader as a string.\n- vertexCapacity: The amount of vertices that shall be allocated\n- vertexSize: The size of a single vertex in bytes.","kind":"class","name":"TextureTintStripPipeline","augments":["Phaser.Renderer.WebGL.WebGLPipeline"],"memberof":"Phaser.Renderer.WebGL.Pipelines","since":"3.23.0","params":[{"type":{"names":["object"]},"description":"The configuration options for this Texture Tint Pipeline, as described above.","name":"config"}],"scope":"static","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","___s":true},{"meta":{"filename":"TextureTintStripPipeline.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Float32 view of the array buffer containing the pipeline's vertices.","name":"vertexViewF32","type":{"names":["Float32Array"]},"since":"3.23.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#vertexViewF32","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureTintStripPipeline.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Uint32 view of the array buffer containing the pipeline's vertices.","name":"vertexViewU32","type":{"names":["Uint32Array"]},"since":"3.23.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#vertexViewU32","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureTintStripPipeline.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Size of the batch.","name":"maxQuads","type":{"names":["integer"]},"since":"3.23.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#maxQuads","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureTintStripPipeline.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Collection of batch information","name":"batches","type":{"names":["array"]},"since":"3.23.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#batches","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureTintStripPipeline.js","lineno":162,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Called every time the pipeline needs to be used.\nIt binds all necessary resources.","kind":"function","name":"onBind","since":"3.23.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#onBind","scope":"instance","overrides":"Phaser.Renderer.WebGL.WebGLPipeline#onBind","___s":true},{"meta":{"filename":"TextureTintStripPipeline.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Resizes this pipeline and updates the projection.","kind":"function","name":"resize","since":"3.23.0","params":[{"type":{"names":["number"]},"description":"The new width.","name":"width"},{"type":{"names":["number"]},"description":"The new height.","name":"height"},{"type":{"names":["number"]},"description":"The resolution.","name":"resolution"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#resize","scope":"instance","overrides":"Phaser.Renderer.WebGL.WebGLPipeline#resize","___s":true},{"meta":{"filename":"TextureTintStripPipeline.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Assigns a texture to the current batch. If a different texture is already set it creates a new batch object.","kind":"function","name":"setTexture2D","since":"3.23.0","params":[{"type":{"names":["WebGLTexture"]},"optional":true,"description":"WebGLTexture that will be assigned to the current batch. If not given uses blankTexture.","name":"texture"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This pipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setTexture2D","scope":"instance","___s":true},{"meta":{"filename":"TextureTintStripPipeline.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Checks if the current batch has the same texture and texture unit, or if we need to create a new batch.","kind":"function","name":"requireTextureBatch","since":"3.23.0","params":[{"type":{"names":["WebGLTexture"]},"description":"WebGLTexture that will be assigned to the current batch. If not given uses blankTexture.","name":"texture"},{"type":{"names":["integer"]},"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline needs to create a new batch, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#requireTextureBatch","scope":"instance","___s":true},{"meta":{"filename":"TextureTintStripPipeline.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Creates a new batch object and pushes it to a batch array.\nThe batch object contains information relevant to the current \nvertex batch like the offset in the vertex buffer, vertex count and \nthe textures used by that batch.","kind":"function","name":"pushBatch","since":"3.23.0","params":[{"type":{"names":["WebGLTexture"]},"description":"Optional WebGLTexture that will be assigned to the created batch.","name":"texture"},{"type":{"names":["integer"]},"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#pushBatch","scope":"instance","___s":true},{"meta":{"filename":"TextureTintStripPipeline.js","lineno":288,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Uploads the vertex data and emits a draw call for the current batch of vertices.","kind":"function","name":"flush","since":"3.23.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#flush","scope":"instance","overrides":"Phaser.Renderer.WebGL.WebGLPipeline#flush","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Implements a model view projection matrices.\nPipelines can implement this for doing 2D and 3D rendering.","kind":"namespace","name":"ModelViewProjection","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","scope":"static","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Dirty flag for checking if model matrix needs to be updated on GPU.","name":"modelMatrixDirty","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelMatrixDirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":25,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Dirty flag for checking if view matrix needs to be updated on GPU.","name":"viewMatrixDirty","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewMatrixDirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Dirty flag for checking if projection matrix needs to be updated on GPU.","name":"projectionMatrixDirty","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#projectionMatrixDirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Model matrix","name":"modelMatrix","type":{"names":["Float32Array"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelMatrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"View matrix","name":"viewMatrix","type":{"names":["Float32Array"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewMatrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Projection matrix","name":"projectionMatrix","type":{"names":["Float32Array"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#projectionMatrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Initializes MVP matrices with an identity matrix","kind":"function","name":"mvpInit","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#mvpInit","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"If dirty flags are set then the matrices are uploaded to the GPU.","kind":"function","name":"mvpUpdate","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#mvpUpdate","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":137,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Loads an identity matrix to the model matrix","kind":"function","name":"modelIdentity","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelIdentity","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Scale model matrix","kind":"function","name":"modelScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x component.","name":"x"},{"type":{"names":["number"]},"description":"The y component.","name":"y"},{"type":{"names":["number"]},"description":"The z component.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelScale","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":203,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Translate model matrix","kind":"function","name":"modelTranslate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x component.","name":"x"},{"type":{"names":["number"]},"description":"The y component.","name":"y"},{"type":{"names":["number"]},"description":"The z component.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelTranslate","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Rotates the model matrix in the X axis.","kind":"function","name":"modelRotateX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to rotate by.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelRotateX","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":267,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Rotates the model matrix in the Y axis.","kind":"function","name":"modelRotateY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to rotate by.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelRotateY","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":305,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Rotates the model matrix in the Z axis.","kind":"function","name":"modelRotateZ","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to rotate by.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelRotateZ","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":343,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Loads identity matrix into the view matrix","kind":"function","name":"viewIdentity","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewIdentity","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":377,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Scales view matrix","kind":"function","name":"viewScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x component.","name":"x"},{"type":{"names":["number"]},"description":"The y component.","name":"y"},{"type":{"names":["number"]},"description":"The z component.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewScale","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Translates view matrix","kind":"function","name":"viewTranslate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x component.","name":"x"},{"type":{"names":["number"]},"description":"The y component.","name":"y"},{"type":{"names":["number"]},"description":"The z component.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewTranslate","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":437,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Rotates view matrix in the X axis.","kind":"function","name":"viewRotateX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to rotate by.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewRotateX","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":475,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Rotates view matrix in the Y axis.","kind":"function","name":"viewRotateY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to rotate by.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewRotateY","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Rotates view matrix in the Z axis.","kind":"function","name":"viewRotateZ","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to rotate by.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewRotateZ","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":551,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Loads a 2D view matrix (3x2 matrix) into a 4x4 view matrix","kind":"function","name":"viewLoad2D","since":"3.0.0","params":[{"type":{"names":["Float32Array"]},"description":"The Matrix2D.","name":"matrix2D"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewLoad2D","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":588,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Copies a 4x4 matrix into the view matrix","kind":"function","name":"viewLoad","since":"3.0.0","params":[{"type":{"names":["Float32Array"]},"description":"The Matrix2D.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewLoad","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":624,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Loads identity matrix into the projection matrix.","kind":"function","name":"projIdentity","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#projIdentity","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":658,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Sets up an orthographic projection matrix","kind":"function","name":"projOrtho","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The left value.","name":"left"},{"type":{"names":["number"]},"description":"The right value.","name":"right"},{"type":{"names":["number"]},"description":"The bottom value.","name":"bottom"},{"type":{"names":["number"]},"description":"The top value.","name":"top"},{"type":{"names":["number"]},"description":"The near value.","name":"near"},{"type":{"names":["number"]},"description":"The far value.","name":"far"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#projOrtho","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":702,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Sets up a perspective projection matrix","kind":"function","name":"projPersp","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The fov value.","name":"fovY"},{"type":{"names":["number"]},"description":"The aspectRatio value.","name":"aspectRatio"},{"type":{"names":["number"]},"description":"The near value.","name":"near"},{"type":{"names":["number"]},"description":"The far value.","name":"far"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#projPersp","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"kind":"namespace","name":"Pipelines","memberof":"Phaser.Renderer.WebGL","longname":"Phaser.Renderer.WebGL.Pipelines","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"ScaleManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScaleManager.js","lineno":21,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"classdesc":"The Scale Manager handles the scaling, resizing and alignment of the game canvas.\n\nThe way scaling is handled is by setting the game canvas to a fixed size, which is defined in the\ngame configuration. You also define the parent container in the game config. If no parent is given,\nit will default to using the document body. The Scale Manager will then look at the available space\nwithin the _parent_ and scale the canvas accordingly. Scaling is handled by setting the canvas CSS\nwidth and height properties, leaving the width and height of the canvas element itself untouched.\nScaling is therefore achieved by keeping the core canvas the same size and 'stretching'\nit via its CSS properties. This gives the same result and speed as using the `transform-scale` CSS\nproperty, without the need for browser prefix handling.\n\nThe calculations for the scale are heavily influenced by the bounding parent size, which is the computed\ndimensions of the canvas's parent. The CSS rules of the parent element play an important role in the\noperation of the Scale Manager. For example, if the parent has no defined width or height, then actions\nlike auto-centering will fail to achieve the required result. The Scale Manager works in tandem with the\nCSS you set-up on the page hosting your game, rather than taking control of it.\n\n#### Parent and Display canvas containment guidelines:\n\n- Style the Parent element (of the game canvas) to control the Parent size and thus the games size and layout.\n\n- The Parent element's CSS styles should _effectively_ apply maximum (and minimum) bounding behavior.\n\n- The Parent element should _not_ apply a padding as this is not accounted for.\n If a padding is required apply it to the Parent's parent or apply a margin to the Parent.\n If you need to add a border, margin or any other CSS around your game container, then use a parent element and\n apply the CSS to this instead, otherwise you'll be constantly resizing the shape of the game container.\n\n- The Display canvas layout CSS styles (i.e. margins, size) should not be altered / specified as\n they may be updated by the Scale Manager.\n\n#### Scale Modes\n\nThe way the scaling is handled is determined by the `scaleMode` property. The default is `NONE`,\nwhich prevents Phaser from scaling or touching the canvas, or its parent, at all. In this mode, you are\nresponsible for all scaling. The other scaling modes afford you automatic scaling.\n\nIf you wish to scale your game so that it always fits into the available space within the parent, you\nshould use the scale mode `FIT`. Look at the documentation for other scale modes to see what options are\navailable. Here is a basic config showing how to set this scale mode:\n\n```javascript\nscale: {\n parent: 'yourgamediv',\n mode: Phaser.Scale.FIT,\n width: 800,\n height: 600\n}\n```\n\nPlace the `scale` config object within your game config.\n\nIf you wish for the canvas to be resized directly, so that the canvas itself fills the available space\n(i.e. it isn't scaled, it's resized) then use the `RESIZE` scale mode. This will give you a 1:1 mapping\nof canvas pixels to game size. In this mode CSS isn't used to scale the canvas, it's literally adjusted\nto fill all available space within the parent. You should be extremely careful about the size of the\ncanvas you're creating when doing this, as the larger the area, the more work the GPU has to do and it's\nvery easy to hit fill-rate limits quickly.\n\nFor complex, custom-scaling requirements, you should probably consider using the `RESIZE` scale mode,\nwith your own limitations in place re: canvas dimensions and managing the scaling with the game scenes\nyourself. For the vast majority of games, however, the `FIT` mode is likely to be the most used.\n\nPlease appreciate that the Scale Manager cannot perform miracles. All it does is scale your game canvas\nas best it can, based on what it can infer from its surrounding area. There are all kinds of environments\nwhere it's up to you to guide and help the canvas position itself, especially when built into rendering\nframeworks like React and Vue. If your page requires meta tags to prevent user scaling gestures, or such\nlike, then it's up to you to ensure they are present in the html.\n\n#### Centering\n\nYou can also have the game canvas automatically centered. Again, this relies heavily on the parent being\nproperly configured and styled, as the centering offsets are based entirely on the available space\nwithin the parent element. Centering is disabled by default, or can be applied horizontally, vertically,\nor both. Here's an example:\n\n```javascript\nscale: {\n parent: 'yourgamediv',\n autoCenter: Phaser.Scale.CENTER_BOTH,\n width: 800,\n height: 600\n}\n```\n\n#### Fullscreen API\n\nIf the browser supports it, you can send your game into fullscreen mode. In this mode, the game will fill\nthe entire display, removing all browser UI and anything else present on the screen. It will remain in this\nmode until your game either disables it, or until the user tabs out or presses ESCape if on desktop. It's a\ngreat way to achieve a desktop-game like experience from the browser, but it does require a modern browser\nto handle it. Some mobile browsers also support this.","kind":"class","name":"ScaleManager","memberof":"Phaser.Scale","augments":["Phaser.Events.EventEmitter"],"since":"3.16.0","params":[{"type":{"names":["Phaser.Game"]},"description":"A reference to the Phaser.Game instance.","name":"game"}],"scope":"static","longname":"Phaser.Scale.ScaleManager","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"A reference to the Phaser.Game instance.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.15.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"A reference to the HTML Canvas Element that Phaser uses to render the game.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":153,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The DOM bounds of the canvas element.","name":"canvasBounds","type":{"names":["Phaser.Geom.Rectangle"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#canvasBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":162,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The parent object of the Canvas. Often a div, or the browser window, or nothing in non-browser environments.\n\nThis is set in the Game Config as the `parent` property. If undefined (or just not present), it will default\nto use the document body. If specifically set to `null` Phaser will ignore all parent operations.","name":"parent","type":{"names":["any"]},"nullable":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Is the parent element the browser window?","name":"parentIsWindow","type":{"names":["boolean"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#parentIsWindow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The Parent Size component.","name":"parentSize","type":{"names":["Phaser.Structs.Size"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#parentSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The Game Size component.\n\nThe un-modified game size, as requested in the game config (the raw width / height),\nas used for world bounds, cameras, etc","name":"gameSize","type":{"names":["Phaser.Structs.Size"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#gameSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":204,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The Base Size component.\n\nThe modified game size, which is the gameSize * resolution, used to set the canvas width and height\n(but not the CSS style)","name":"baseSize","type":{"names":["Phaser.Structs.Size"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#baseSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":216,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The Display Size component.\n\nThe size used for the canvas style, factoring in the scale mode, parent and other values.","name":"displaySize","type":{"names":["Phaser.Structs.Size"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#displaySize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":227,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The game scale mode.","name":"scaleMode","type":{"names":["Phaser.Scale.ScaleModeType"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#scaleMode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":236,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The canvas resolution.\n\nThis is hard-coded to a value of 1 in the 3.16 release of Phaser and will be enabled at a later date.","name":"resolution","type":{"names":["number"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#resolution","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":247,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The game zoom factor.\n\nThis value allows you to multiply your games base size by the given zoom factor.\nThis is then used when calculating the display size, even in `NONE` situations.\nIf you don't want Phaser to touch the canvas style at all, this value should be 1.\n\nCan also be set to `MAX_ZOOM` in which case the zoom value will be derived based\non the game size and available space within the parent.","name":"zoom","type":{"names":["number"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#zoom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":263,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Internal flag set when the game zoom factor is modified.","name":"_resetZoom","type":{"names":["boolean"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#_resetZoom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The scale factor between the baseSize and the canvasBounds.","name":"displayScale","type":{"names":["Phaser.Math.Vector2"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#displayScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":282,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"If set, the canvas sizes will be automatically passed through Math.floor.\nThis results in rounded pixel display values, which is important for performance on legacy\nand low powered devices, but at the cost of not achieving a 'perfect' fit in some browser windows.","name":"autoRound","type":{"names":["boolean"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#autoRound","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":293,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Automatically center the canvas within the parent? The different centering modes are:\n\n1. No centering.\n2. Center both horizontally and vertically.\n3. Center horizontally.\n4. Center vertically.\n\nPlease be aware that in order to center the game canvas, you must have specified a parent\nthat has a size set, or the canvas parent is the document.body.","name":"autoCenter","type":{"names":["Phaser.Scale.CenterType"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#autoCenter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":310,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The current device orientation.\n\nOrientation events are dispatched via the Device Orientation API, typically only on mobile browsers.","name":"orientation","type":{"names":["Phaser.Scale.OrientationType"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#orientation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":321,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"A reference to the Device.Fullscreen object.","name":"fullscreen","type":{"names":["Phaser.Device.Fullscreen"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#fullscreen","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":330,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The DOM Element which is sent into fullscreen mode.","name":"fullscreenTarget","type":{"names":["any"]},"nullable":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#fullscreenTarget","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":349,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The dirty state of the Scale Manager.\nSet if there is a change between the parent size and the current size.","name":"dirty","type":{"names":["boolean"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":359,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"How many milliseconds should elapse before checking if the browser size has changed?\n\nMost modern browsers dispatch a 'resize' event, which the Scale Manager will listen for.\nHowever, older browsers fail to do this, or do it consistently, so we fall back to a\nmore traditional 'size check' based on a time interval. You can control how often it is\nchecked here.","name":"resizeInterval","type":{"names":["integer"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#resizeInterval","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":589,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Determines the parent element of the game canvas, if any, based on the game configuration.","kind":"function","name":"getParent","since":"3.16.0","params":[{"type":{"names":["Phaser.Types.Core.GameConfig"]},"description":"The Game configuration object.","name":"config"}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#getParent","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":639,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Calculates the size of the parent bounds and updates the `parentSize` component, if the canvas has a dom parent.","kind":"function","name":"getParentBounds","since":"3.16.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the parent bounds have changed size, otherwise `false`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#getParentBounds","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":681,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Attempts to lock the orientation of the web browser using the Screen Orientation API.\n\nThis API is only available on modern mobile browsers.\nSee https://developer.mozilla.org/en-US/docs/Web/API/Screen/lockOrientation for details.","kind":"function","name":"lockOrientation","since":"3.16.0","params":[{"type":{"names":["string"]},"description":"The orientation you'd like to lock the browser in. Should be an API string such as 'landscape', 'landscape-primary', 'portrait', etc.","name":"orientation"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the orientation was successfully locked, otherwise `false`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#lockOrientation","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":706,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"This method will set the size of the Parent Size component, which is used in scaling\nand centering calculations. You only need to call this method if you have explicitly\ndisabled the use of a parent in your game config, but still wish to take advantage of\nother Scale Manager features.","kind":"function","name":"setParentSize","fires":["Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new width of the parent.","name":"width"},{"type":{"names":["number"]},"description":"The new height of the parent.","name":"height"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"The Scale Manager instance."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#setParentSize","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":728,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"This method will set a new size for your game.\n\nIt should only be used if you're looking to change the base size of your game and are using\none of the Scale Manager scaling modes, i.e. `FIT`. If you're using `NONE` and wish to\nchange the game and canvas size directly, then please use the `resize` method instead.","kind":"function","name":"setGameSize","fires":["Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new width of the game.","name":"width"},{"type":{"names":["number"]},"description":"The new height of the game.","name":"height"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"The Scale Manager instance."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#setGameSize","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":780,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Call this to modify the size of the Phaser canvas element directly.\nYou should only use this if you are using the `NONE` scale mode,\nit will update all internal components completely.\n\nIf all you want to do is change the size of the parent, see the `setParentSize` method.\n\nIf all you want is to change the base size of the game, but still have the Scale Manager\nmanage all the scaling (i.e. you're **not** using `NONE`), then see the `setGameSize` method.\n\nThis method will set the `gameSize`, `baseSize` and `displaySize` components to the given\ndimensions. It will then resize the canvas width and height to the values given, by\ndirectly setting the properties. Finally, if you have set the Scale Manager zoom value\nto anything other than 1 (the default), it will set the canvas CSS width and height to\nbe the given size multiplied by the zoom factor (the canvas pixel size remains untouched).\n\nIf you have enabled `autoCenter`, it is then passed to the `updateCenter` method and\nthe margins are set, allowing the canvas to be centered based on its parent element\nalone. Finally, the `displayScale` is adjusted and the RESIZE event dispatched.","kind":"function","name":"resize","fires":["Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new width of the game.","name":"width"},{"type":{"names":["number"]},"description":"The new height of the game.","name":"height"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"The Scale Manager instance."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#resize","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":863,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Sets the zoom value of the Scale Manager.","kind":"function","name":"setZoom","fires":["Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The new zoom value of the game.","name":"value"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"The Scale Manager instance."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#setZoom","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":882,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Sets the zoom to be the maximum possible based on the _current_ parent size.","kind":"function","name":"setMaxZoom","fires":["Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"The Scale Manager instance."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#setMaxZoom","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":899,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Refreshes the internal scale values, bounds sizes and orientation checks.\n\nOnce finished, dispatches the resize event.\n\nThis is called automatically by the Scale Manager when the browser window size changes,\nas long as it is using a Scale Mode other than 'NONE'.","kind":"function","name":"refresh","fires":["Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The previous width of the game. Only set if the gameSize has changed.","name":"previousWidth"},{"type":{"names":["number"]},"optional":true,"description":"The previous height of the game. Only set if the gameSize has changed.","name":"previousHeight"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"The Scale Manager instance."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#refresh","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":947,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Internal method that checks the current screen orientation, only if the internal check flag is set.\n\nIf the orientation has changed it updates the orientation property and then dispatches the orientation change event.","kind":"function","name":"updateOrientation","fires":["Phaser.Scale.Events#event:ORIENTATION_CHANGE"],"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#updateOrientation","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":973,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Internal method that manages updating the size components based on the scale mode.","kind":"function","name":"updateScale","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#updateScale","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1063,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Calculates and returns the largest possible zoom factor, based on the current\nparent and game sizes. If the parent has no dimensions (i.e. an unstyled div),\nor is smaller than the un-zoomed game, then this will return a value of 1 (no zoom)","kind":"function","name":"getMaxZoom","since":"3.16.0","returns":[{"type":{"names":["integer"]},"description":"The maximum possible zoom factor. At a minimum this value is always at least 1."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#getMaxZoom","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1081,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Calculates and updates the canvas CSS style in order to center it within the\nbounds of its parent. If you have explicitly set parent to be `null` in your\ngame config then this method will likely give incorrect results unless you have called the\n`setParentSize` method first.\n\nIt works by modifying the canvas CSS `marginLeft` and `marginTop` properties.\n\nIf they have already been set by your own style sheet, or code, this will overwrite them.\n\nTo prevent the Scale Manager from centering the canvas, either do not set the\n`autoCenter` property in your game config, or make sure it is set to `NO_CENTER`.","kind":"function","name":"updateCenter","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#updateCenter","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Updates the `canvasBounds` rectangle to match the bounding client rectangle of the\ncanvas element being used to track input events.","kind":"function","name":"updateBounds","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#updateBounds","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Transforms the pageX value into the scaled coordinate space of the Scale Manager.","kind":"function","name":"transformX","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The DOM pageX value.","name":"pageX"}],"returns":[{"type":{"names":["number"]},"description":"The translated value."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#transformX","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Transforms the pageY value into the scaled coordinate space of the Scale Manager.","kind":"function","name":"transformY","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The DOM pageY value.","name":"pageY"}],"returns":[{"type":{"names":["number"]},"description":"The translated value."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#transformY","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Sends a request to the browser to ask it to go in to full screen mode, using the {@link https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API Fullscreen API}.\n\nIf the browser does not support this, a `FULLSCREEN_UNSUPPORTED` event will be emitted.\n\nThis method _must_ be called from a user-input gesture, such as `pointerup`. You cannot launch\ngames fullscreen without this, as most browsers block it. Games within an iframe will also be blocked\nfrom fullscreen unless the iframe has the `allowfullscreen` attribute.\n\nOn touch devices, such as Android and iOS Safari, you should always use `pointerup` and NOT `pointerdown`,\notherwise the request will fail unless the document in which your game is embedded has already received\nsome form of touch input, which you cannot guarantee. Activating fullscreen via `pointerup` circumvents\nthis issue.\n\nPerforming an action that navigates to another page, or opens another tab, will automatically cancel\nfullscreen mode, as will the user pressing the ESC key. To cancel fullscreen mode directly from your game,\ni.e. by clicking an icon, call the `stopFullscreen` method.\n\nA browser can only send one DOM element into fullscreen. You can control which element this is by\nsetting the `fullscreenTarget` property in your game config, or changing the property in the Scale Manager.\nNote that the game canvas _must_ be a child of the target. If you do not give a target, Phaser will\nautomatically create a blank `
` element and move the canvas into it, before going fullscreen.\nWhen it leaves fullscreen, the div will be removed.","kind":"function","name":"startFullscreen","fires":["Phaser.Scale.Events#event:ENTER_FULLSCREEN","Phaser.Scale.Events#event:FULLSCREEN_FAILED","Phaser.Scale.Events#event:FULLSCREEN_UNSUPPORTED","Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["object"]},"optional":true,"description":"The FullscreenOptions dictionary is used to provide configuration options when entering full screen.","name":"fullscreenOptions"}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#startFullscreen","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1294,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"An internal method that gets the target element that is used when entering fullscreen mode.","kind":"function","name":"getFullscreenTarget","since":"3.16.0","returns":[{"type":{"names":["object"]},"description":"The fullscreen target element."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#getFullscreenTarget","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Removes the fullscreen target that was added to the DOM.","kind":"function","name":"removeFullscreenTarget","since":"3.17.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#removeFullscreenTarget","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1353,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Calling this method will cancel fullscreen mode, if the browser has entered it.","kind":"function","name":"stopFullscreen","fires":["Phaser.Scale.Events#event:LEAVE_FULLSCREEN","Phaser.Scale.Events#event:FULLSCREEN_UNSUPPORTED"],"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#stopFullscreen","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1387,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Toggles the fullscreen mode. If already in fullscreen, calling this will cancel it.\nIf not in fullscreen, this will request the browser to enter fullscreen mode.\n\nIf the browser does not support this, a `FULLSCREEN_UNSUPPORTED` event will be emitted.\n\nThis method _must_ be called from a user-input gesture, such as `pointerdown`. You cannot launch\ngames fullscreen without this, as most browsers block it. Games within an iframe will also be blocked\nfrom fullscreen unless the iframe has the `allowfullscreen` attribute.","kind":"function","name":"toggleFullscreen","fires":["Phaser.Scale.Events#event:ENTER_FULLSCREEN","Phaser.Scale.Events#event:LEAVE_FULLSCREEN","Phaser.Scale.Events#event:FULLSCREEN_UNSUPPORTED","Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["object"]},"optional":true,"description":"The FullscreenOptions dictionary is used to provide configuration options when entering full screen.","name":"fullscreenOptions"}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#toggleFullscreen","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1418,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"An internal method that starts the different DOM event listeners running.","kind":"function","name":"startListeners","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#startListeners","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1471,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Triggered when a fullscreenchange event is dispatched by the DOM.","kind":"function","name":"onFullScreenChange","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#onFullScreenChange","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1486,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Triggered when a fullscreenerror event is dispatched by the DOM.","kind":"function","name":"onFullScreenError","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#onFullScreenError","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1497,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Internal method, called automatically by the game step.\nMonitors the elapsed time and resize interval to see if a parent bounds check needs to take place.","kind":"function","name":"step","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The time value from the most recent Game step. Typically a high-resolution timer value, or Date.now().","name":"time"},{"type":{"names":["number"]},"description":"The delta value since the last frame. This is smoothed to avoid delta spikes by the TimeStep class.","name":"delta"}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#step","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Stops all DOM event listeners.","kind":"function","name":"stopListeners","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#stopListeners","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1555,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Destroys this Scale Manager, releasing all references to external resources.\nOnce destroyed, the Scale Manager cannot be used again.","kind":"function","name":"destroy","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1580,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Is the browser currently in fullscreen mode or not?","name":"isFullscreen","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#isFullscreen","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The game width.\n\nThis is typically the size given in the game configuration.","name":"width","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1616,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The game height.\n\nThis is typically the size given in the game configuration.","name":"height","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1635,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Is the device in a portrait orientation as reported by the Orientation API?\nThis value is usually only available on mobile devices.","name":"isPortrait","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#isPortrait","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1653,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Is the device in a landscape orientation as reported by the Orientation API?\nThis value is usually only available on mobile devices.","name":"isLandscape","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#isLandscape","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1671,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Are the game dimensions portrait? (i.e. taller than they are wide)\n\nThis is different to the device itself being in a portrait orientation.","name":"isGamePortrait","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#isGamePortrait","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1690,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Are the game dimensions landscape? (i.e. wider than they are tall)\n\nThis is different to the device itself being in a landscape orientation.","name":"isGameLandscape","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#isGameLandscape","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for centering the game canvas.","kind":"namespace","name":"Center","memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.Center","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for centering the game canvas.\n\nTo find out what each mode does please see [Phaser.Scale.Center]{@link Phaser.Scale.Center}.","kind":"typedef","name":"CenterType","type":{"names":["Phaser.Scale.Center"]},"memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.CenterType","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is not centered within the parent by Phaser.\nYou can still center it yourself via CSS.","name":"NO_CENTER","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Center","longname":"Phaser.Scale.Center.NO_CENTER","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":38,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is centered both horizontally and vertically within the parent.\nTo do this, the parent has to have a bounds that can be calculated and not be empty.\n\nCentering is achieved by setting the margin left and top properties of the\ngame canvas, and does not factor in any other CSS styles you may have applied.","name":"CENTER_BOTH","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Center","longname":"Phaser.Scale.Center.CENTER_BOTH","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is centered horizontally within the parent.\nTo do this, the parent has to have a bounds that can be calculated and not be empty.\n\nCentering is achieved by setting the margin left and top properties of the\ngame canvas, and does not factor in any other CSS styles you may have applied.","name":"CENTER_HORIZONTALLY","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Center","longname":"Phaser.Scale.Center.CENTER_HORIZONTALLY","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is centered both vertically within the parent.\nTo do this, the parent has to have a bounds that can be calculated and not be empty.\n\nCentering is achieved by setting the margin left and top properties of the\ngame canvas, and does not factor in any other CSS styles you may have applied.","name":"CENTER_VERTICALLY","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Center","longname":"Phaser.Scale.Center.CENTER_VERTICALLY","scope":"static","___s":true},{"meta":{"filename":"ORIENTATION_CONST.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for orientation.","kind":"namespace","name":"Orientation","memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.Orientation","scope":"static","___s":true},{"meta":{"filename":"ORIENTATION_CONST.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for orientation.\n\nTo find out what each mode does please see [Phaser.Scale.Orientation]{@link Phaser.Scale.Orientation}.","kind":"typedef","name":"OrientationType","type":{"names":["Phaser.Scale.Orientation"]},"memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.OrientationType","scope":"static","___s":true},{"meta":{"filename":"ORIENTATION_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"A landscape orientation.","name":"LANDSCAPE","type":{"names":["string"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Orientation","longname":"Phaser.Scale.Orientation.LANDSCAPE","scope":"static","___s":true},{"meta":{"filename":"ORIENTATION_CONST.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"A portrait orientation.","name":"PORTRAIT","type":{"names":["string"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Orientation","longname":"Phaser.Scale.Orientation.PORTRAIT","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for the different scale modes available.","kind":"namespace","name":"ScaleModes","memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.ScaleModes","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for the different scale modes available.\n\nTo find out what each mode does please see [Phaser.Scale.ScaleModes]{@link Phaser.Scale.ScaleModes}.","kind":"typedef","name":"ScaleModeType","type":{"names":["Phaser.Scale.ScaleModes"]},"memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.ScaleModeType","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"No scaling happens at all. The canvas is set to the size given in the game config and Phaser doesn't change it\nagain from that point on. If you change the canvas size, either via CSS, or directly via code, then you need\nto call the Scale Managers `resize` method to give the new dimensions, or input events will stop working.","name":"NONE","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.ScaleModes","longname":"Phaser.Scale.ScaleModes.NONE","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The height is automatically adjusted based on the width.","name":"WIDTH_CONTROLS_HEIGHT","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.ScaleModes","longname":"Phaser.Scale.ScaleModes.WIDTH_CONTROLS_HEIGHT","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":49,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The width is automatically adjusted based on the height.","name":"HEIGHT_CONTROLS_WIDTH","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.ScaleModes","longname":"Phaser.Scale.ScaleModes.HEIGHT_CONTROLS_WIDTH","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":59,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The width and height are automatically adjusted to fit inside the given target area,\nwhile keeping the aspect ratio. Depending on the aspect ratio there may be some space\ninside the area which is not covered.","name":"FIT","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.ScaleModes","longname":"Phaser.Scale.ScaleModes.FIT","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The width and height are automatically adjusted to make the size cover the entire target\narea while keeping the aspect ratio. This may extend further out than the target size.","name":"ENVELOP","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.ScaleModes","longname":"Phaser.Scale.ScaleModes.ENVELOP","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The Canvas is resized to fit all available _parent_ space, regardless of aspect ratio.","name":"RESIZE","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.ScaleModes","longname":"Phaser.Scale.ScaleModes.RESIZE","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for zoom modes.","kind":"namespace","name":"Zoom","memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.Zoom","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for zoom modes.\n\nTo find out what each mode does please see [Phaser.Scale.Zoom]{@link Phaser.Scale.Zoom}.","kind":"typedef","name":"ZoomType","type":{"names":["Phaser.Scale.Zoom"]},"memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.ZoomType","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas will not be zoomed by Phaser.","name":"NO_ZOOM","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Zoom","longname":"Phaser.Scale.Zoom.NO_ZOOM","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas will be 2x zoomed by Phaser.","name":"ZOOM_2X","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Zoom","longname":"Phaser.Scale.Zoom.ZOOM_2X","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas will be 4x zoomed by Phaser.","name":"ZOOM_4X","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Zoom","longname":"Phaser.Scale.Zoom.ZOOM_4X","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Calculate the zoom value based on the maximum multiplied game size that will\nfit into the parent, or browser window if no parent is set.","name":"MAX_ZOOM","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Zoom","longname":"Phaser.Scale.Zoom.MAX_ZOOM","scope":"static","___s":true},{"meta":{"range":[180,362],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ENTER_FULLSCREEN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"description":"The Scale Manager has successfully entered fullscreen mode.","kind":"event","name":"ENTER_FULLSCREEN","since":"3.16.1","memberof":"Phaser.Scale.Events","longname":"Phaser.Scale.Events#event:ENTER_FULLSCREEN","scope":"instance","___s":true},{"meta":{"filename":"FULLSCREEN_FAILED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"description":"The Scale Manager tried to enter fullscreen mode but failed.","kind":"event","name":"FULLSCREEN_FAILED","since":"3.17.0","memberof":"Phaser.Scale.Events","longname":"Phaser.Scale.Events#event:FULLSCREEN_FAILED","scope":"instance","___s":true},{"meta":{"filename":"FULLSCREEN_UNSUPPORTED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"description":"The Scale Manager tried to enter fullscreen mode, but it is unsupported by the browser.","kind":"event","name":"FULLSCREEN_UNSUPPORTED","since":"3.16.1","memberof":"Phaser.Scale.Events","longname":"Phaser.Scale.Events#event:FULLSCREEN_UNSUPPORTED","scope":"instance","___s":true},{"meta":{"filename":"LEAVE_FULLSCREEN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"description":"The Scale Manager was in fullscreen mode, but has since left, either directly via game code,\nor via a user gestured, such as pressing the ESC key.","kind":"event","name":"LEAVE_FULLSCREEN","since":"3.16.1","memberof":"Phaser.Scale.Events","longname":"Phaser.Scale.Events#event:LEAVE_FULLSCREEN","scope":"instance","___s":true},{"meta":{"filename":"ORIENTATION_CHANGE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"description":"The Scale Manager Orientation Change Event.","kind":"event","name":"ORIENTATION_CHANGE","since":"3.16.1","params":[{"type":{"names":["string"]},"description":"-","name":"orientation"}],"memberof":"Phaser.Scale.Events","longname":"Phaser.Scale.Events#event:ORIENTATION_CHANGE","scope":"instance","___s":true},{"meta":{"filename":"RESIZE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"description":"The Scale Manager Resize Event.\n\nThis event is dispatched whenever the Scale Manager detects a resize event from the browser.\nIt sends three parameters to the callback, each of them being Size components. You can read\nthe `width`, `height`, `aspectRatio` and other properties of these components to help with\nscaling your own game content.","kind":"event","name":"RESIZE","since":"3.16.1","params":[{"type":{"names":["Phaser.Structs.Size"]},"description":"A reference to the Game Size component. This is the un-scaled size of your game canvas.","name":"gameSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"A reference to the Base Size component. This is the game size multiplied by resolution.","name":"baseSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"A reference to the Display Size component. This is the scaled canvas size, after applying zoom and scale mode.","name":"displaySize"},{"type":{"names":["number"]},"description":"The current resolution. Defaults to 1 at the moment.","name":"resolution"},{"type":{"names":["number"]},"description":"If the `gameSize` has changed, this value contains its previous width, otherwise it contains the current width.","name":"previousWidth"},{"type":{"names":["number"]},"description":"If the `gameSize` has changed, this value contains its previous height, otherwise it contains the current height.","name":"previousHeight"}],"memberof":"Phaser.Scale.Events","longname":"Phaser.Scale.Events#event:RESIZE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Scale","longname":"Phaser.Scale.Events","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"name":"Extend","longname":"Extend","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"kind":"namespace","name":"Scale","memberof":"Phaser","longname":"Phaser.Scale","scope":"static","___s":true},{"meta":{"range":[180,234],"filename":"GetPhysicsPlugins.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPhysicsPlugins.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Builds an array of which physics plugins should be activated for the given Scene.","kind":"function","name":"GetPhysicsPlugins","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"The scene system to get the physics systems of.","name":"sys"}],"returns":[{"type":{"names":["array"]},"description":"An array of Physics systems to start for this Scene."}],"memberof":"Phaser.Scenes","longname":"Phaser.Scenes.GetPhysicsPlugins","scope":"static","___s":true},{"meta":{"range":[180,234],"filename":"GetScenePlugins.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetScenePlugins.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Builds an array of which plugins (not including physics plugins) should be activated for the given Scene.","kind":"function","name":"GetScenePlugins","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"The Scene Systems object to check for plugins.","name":"sys"}],"returns":[{"type":{"names":["array"]},"description":"An array of all plugins which should be activated, either the default ones or the ones configured in the Scene Systems object."}],"memberof":"Phaser.Scenes","longname":"Phaser.Scenes.GetScenePlugins","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Scene.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Scene.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"classdesc":"A base Phaser.Scene class which can be extended for your own use.\n\nYou can also define the optional methods {@link Phaser.Types.Scenes.SceneInitCallback init()}, {@link Phaser.Types.Scenes.ScenePreloadCallback preload()}, and {@link Phaser.Types.Scenes.SceneCreateCallback create()}.","kind":"class","name":"Scene","memberof":"Phaser","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Scenes.SettingsConfig"]},"description":"Scene specific configuration settings.","name":"config"}],"scope":"static","longname":"Phaser.Scene","___s":true},{"meta":{"filename":"Scene.js","lineno":29,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Scene Systems. You must never overwrite this property, or all hell will break lose.","name":"sys","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#sys","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Phaser.Game instance.\nThis property will only be available if defined in the Scene Injection Map.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Animation Manager.\nThis property will only be available if defined in the Scene Injection Map.","name":"anims","type":{"names":["Phaser.Animations.AnimationManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#anims","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Cache.\nThis property will only be available if defined in the Scene Injection Map.","name":"cache","type":{"names":["Phaser.Cache.CacheManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#cache","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the game level Data Manager.\nThis property will only be available if defined in the Scene Injection Map.","name":"registry","type":{"names":["Phaser.Data.DataManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#registry","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Sound Manager.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"sound","type":{"names":["Phaser.Sound.BaseSoundManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#sound","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Texture Manager.\nThis property will only be available if defined in the Scene Injection Map.","name":"textures","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#textures","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Event Emitter.\nThis property will only be available if defined in the Scene Injection Map.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Camera System.\nThis property will only be available if defined in the Scene Injection Map.","name":"cameras","type":{"names":["Phaser.Cameras.Scene2D.CameraManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#cameras","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Game Object Factory.\nThis property will only be available if defined in the Scene Injection Map.","name":"add","type":{"names":["Phaser.GameObjects.GameObjectFactory"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#add","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Game Object Creator.\nThis property will only be available if defined in the Scene Injection Map.","name":"make","type":{"names":["Phaser.GameObjects.GameObjectCreator"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#make","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene Manager Plugin.\nThis property will only be available if defined in the Scene Injection Map.","name":"scene","type":{"names":["Phaser.Scenes.ScenePlugin"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Game Object Display List.\nThis property will only be available if defined in the Scene Injection Map.","name":"children","type":{"names":["Phaser.GameObjects.DisplayList"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#children","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Lights Manager Plugin.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"lights","type":{"names":["Phaser.GameObjects.LightsManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#lights","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Data Manager Plugin.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Input Manager Plugin.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"input","type":{"names":["Phaser.Input.InputPlugin"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#input","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":188,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Loader Plugin.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"load","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#load","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":198,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Time and Clock Plugin.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"time","type":{"names":["Phaser.Time.Clock"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#time","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":208,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Tween Manager Plugin.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"tweens","type":{"names":["Phaser.Tweens.TweenManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#tweens","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":218,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Arcade Physics Plugin.\nThis property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.","name":"physics","type":{"names":["Phaser.Physics.Arcade.ArcadePhysics"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#physics","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":228,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Impact Physics Plugin.\nThis property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.","name":"impact","type":{"names":["Phaser.Physics.Impact.ImpactPhysics"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#impact","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":238,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Matter Physics Plugin.\nThis property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.","name":"matter","type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#matter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":250,"columnno":12,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Facebook Instant Games Plugin.\nThis property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.","name":"facebook","type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"since":"3.12.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#facebook","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":261,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Scale Manager.\nThis property will only be available if defined in the Scene Injection Map.","name":"scale","type":{"names":["Phaser.Scale.ScaleManager"]},"since":"3.16.2","memberof":"Phaser.Scene","longname":"Phaser.Scene#scale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":271,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Plugin Manager.\n\nThe Plugin Manager is a global system that allows plugins to register themselves with it, and can then install\nthose plugins into Scenes as required.","name":"plugins","type":{"names":["Phaser.Plugins.PluginManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#plugins","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":284,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Should be overridden by your own Scenes.\nThis method is called once per game step while the scene is running.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Scene","longname":"Phaser.Scene#update","scope":"instance","___s":true},{"meta":{"range":[180,213],"filename":"SceneManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SceneManager.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"classdesc":"The Scene Manager.\n\nThe Scene Manager is a Game level system, responsible for creating, processing and updating all of the\nScenes in a Game instance.","kind":"class","name":"SceneManager","memberof":"Phaser.Scenes","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Phaser.Game instance this Scene Manager belongs to.","name":"game"},{"type":{"names":["object"]},"description":"Scene specific configuration settings.","name":"sceneConfig"}],"scope":"static","longname":"Phaser.Scenes.SceneManager","___s":true},{"meta":{"filename":"SceneManager.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Game that this SceneManager belongs to.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SceneManager.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"An object that maps the keys to the scene so we can quickly get a scene from a key without iteration.","name":"keys","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#keys","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SceneManager.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The array in which all of the scenes are kept.","name":"scenes","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#scenes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SceneManager.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is the Scene Manager actively processing the Scenes list?","name":"isProcessing","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#isProcessing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SceneManager.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Has the Scene Manager properly started?","name":"isBooted","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.4.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#isBooted","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SceneManager.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Do any of the Cameras in any of the Scenes require a custom viewport?\nIf not we can skip scissor tests.","name":"customViewports","type":{"names":["number"]},"defaultvalue":"0","since":"3.12.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#customViewports","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SceneManager.js","lineno":244,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Process the Scene operations queue.","kind":"function","name":"processQueue","since":"3.0.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#processQueue","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Adds a new Scene into the SceneManager.\nYou must give each Scene a unique key by which you'll identify it.\n\nThe `sceneConfig` can be:\n\n* A `Phaser.Scene` object, or an object that extends it.\n* A plain JavaScript object\n* A JavaScript ES6 Class that extends `Phaser.Scene`\n* A JavaScript ES5 prototype based Class\n* A JavaScript function\n\nIf a function is given then a new Scene will be created by calling it.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.","name":"key"},{"type":{"names":["Phaser.Scene","Phaser.Types.Scenes.SettingsConfig","Phaser.Types.Scenes.CreateSceneFromObjectConfig","function"]},"description":"The config for the Scene","name":"sceneConfig"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the Scene will be started immediately after being added.","name":"autoStart"},{"type":{"names":["object"]},"optional":true,"description":"Optional data object. This will be set as Scene.settings.data and passed to `Scene.init`.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scene"]},"nullable":true,"description":"The added Scene, if it was added immediately, otherwise `null`."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#add","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":388,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Removes a Scene from the SceneManager.\n\nThe Scene is removed from the local scenes array, it's key is cleared from the keys\ncache and Scene.Systems.destroy is then called on it.\n\nIf the SceneManager is processing the Scenes when this method is called it will\nqueue the operation for the next update sequence.","kind":"function","name":"remove","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#remove","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Updates the Scenes.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Time elapsed.","name":"time"},{"type":{"names":["number"]},"description":"Delta time from the last update.","name":"delta"}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#update","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Renders the Scenes.","kind":"function","name":"render","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The renderer to use.","name":"renderer"}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#render","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":834,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Returns an array of all the current Scenes being managed by this Scene Manager.\n\nYou can filter the output by the active state of the Scene and choose to have\nthe array returned in normal or reversed order.","kind":"function","name":"getScenes","since":"3.16.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Only include Scene's that are currently active?","name":"isActive"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Return the array of Scenes in reverse?","name":"inReverse"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing all of the Scenes in the Scene Manager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#getScenes","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":869,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Retrieves a Scene.","kind":"function","name":"getScene","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to retrieve.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scene"]},"nullable":true,"description":"The Scene."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#getScene","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":902,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Determines whether a Scene is running.","kind":"function","name":"isActive","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is running."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#isActive","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":924,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Determines whether a Scene is paused.","kind":"function","name":"isPaused","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is paused."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#isPaused","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":946,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Determines whether a Scene is visible.","kind":"function","name":"isVisible","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is visible."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#isVisible","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":968,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Determines whether a Scene is sleeping.","kind":"function","name":"isSleeping","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is sleeping."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#isSleeping","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":990,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Pauses the given Scene.","kind":"function","name":"pause","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to pause.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted by its pause event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#pause","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1013,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Resumes the given Scene.","kind":"function","name":"resume","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to resume.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted by its resume event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#resume","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1036,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Puts the given Scene to sleep.","kind":"function","name":"sleep","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to put to sleep.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted by its sleep event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#sleep","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1059,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Awakens the given Scene.","kind":"function","name":"wake","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to wake up.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted by its wake event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#wake","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1082,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Runs the given Scene.\n\nIf the given Scene is paused, it will resume it. If sleeping, it will wake it.\nIf not running at all, it will be started.\n\nUse this if you wish to open a modal Scene by calling `pause` on the current\nScene, then `run` on the modal Scene.","kind":"function","name":"run","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"The Scene to run.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed to the Scene on start, wake, or resume.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This Scene Manager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#run","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1133,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Starts the given Scene.","kind":"function","name":"start","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to start.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"Optional data object to pass to Scene.Settings and Scene.init.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#start","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Stops the given Scene.","kind":"function","name":"stop","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to stop.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"Optional data object to pass to Scene.shutdown.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#stop","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Sleeps one one Scene and starts the other.","kind":"function","name":"switch","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to sleep.","name":"from"},{"type":{"names":["string"]},"description":"The Scene to start.","name":"to"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#switch","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Retrieves a Scene by numeric index.","kind":"function","name":"getAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the Scene to retrieve.","name":"index"}],"returns":[{"type":{"names":["Phaser.Scene","undefined"]},"description":"The Scene."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#getAt","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1275,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Retrieves the numeric index of a Scene.","kind":"function","name":"getIndex","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The key of the Scene.","name":"key"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the Scene."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#getIndex","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1292,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Brings a Scene to the top of the Scenes list.\n\nThis means it will render above all other Scenes.","kind":"function","name":"bringToTop","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#bringToTop","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1326,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Sends a Scene to the back of the Scenes list.\n\nThis means it will render below all other Scenes.","kind":"function","name":"sendToBack","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#sendToBack","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1360,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Moves a Scene down one position in the Scenes list.","kind":"function","name":"moveDown","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#moveDown","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1394,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Moves a Scene up one position in the Scenes list.","kind":"function","name":"moveUp","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#moveUp","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1428,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Moves a Scene so it is immediately above another Scene in the Scenes list.\n\nThis means it will render over the top of the other Scene.","kind":"function","name":"moveAbove","since":"3.2.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene that Scene B will be moved above.","name":"keyA"},{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to be moved.","name":"keyB"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#moveAbove","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Moves a Scene so it is immediately below another Scene in the Scenes list.\n\nThis means it will render behind the other Scene.","kind":"function","name":"moveBelow","since":"3.2.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene that Scene B will be moved above.","name":"keyA"},{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to be moved.","name":"keyB"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#moveBelow","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1543,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Swaps the positions of two Scenes in the Scenes list.","kind":"function","name":"swapPosition","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The first Scene to swap.","name":"keyA"},{"type":{"names":["string","Phaser.Scene"]},"description":"The second Scene to swap.","name":"keyB"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#swapPosition","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1582,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Dumps debug information about each Scene to the developer console.","kind":"function","name":"dump","since":"3.2.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#dump","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1606,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Destroy the SceneManager and all of its Scene's systems.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#destroy","scope":"instance","___s":true},{"meta":{"range":[180,212],"filename":"ScenePlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"classdesc":"A proxy class to the Global Scene Manager.","kind":"class","name":"ScenePlugin","memberof":"Phaser.Scenes","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that this ScenePlugin belongs to.","name":"scene"}],"scope":"static","longname":"Phaser.Scenes.ScenePlugin","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":30,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Scene that this ScenePlugin belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Scene Systems instance of the Scene that this ScenePlugin belongs to.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The settings of the Scene this ScenePlugin belongs to.","name":"settings","type":{"names":["Phaser.Types.Scenes.SettingsObject"]},"since":"3.0.0","memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#settings","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The key of the Scene this ScenePlugin belongs to.","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Game's SceneManager.","name":"manager","type":{"names":["Phaser.Scenes.SceneManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"If this Scene is currently transitioning to another, this holds\nthe current percentage of the transition progress, between 0 and 1.","name":"transitionProgress","type":{"names":["number"]},"since":"3.5.0","memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#transitionProgress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Shutdown this Scene and run the given one.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"start","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to start.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"The Scene data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#start","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":211,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Restarts this Scene.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"restart","since":"3.4.0","params":[{"type":{"names":["object"]},"optional":true,"description":"The Scene data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#restart","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":233,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"This will start a transition from the current Scene to the target Scene given.\n\nThe transition will last for the duration specified in milliseconds.\n\nYou can have the target Scene moved above or below this one in the display list.\n\nYou can specify an update callback. This callback will be invoked _every frame_ for the duration\nof the transition.\n\nThis Scene can either be sent to sleep at the end of the transition, or stopped. The default is to stop.\n\nThere are also 5 transition related events: This scene will emit the event `transitionout` when\nthe transition begins, which is typically the frame after calling this method.\n\nThe target Scene will emit the event `transitioninit` when that Scene's `init` method is called.\nIt will then emit the event `transitionstart` when its `create` method is called.\nIf the Scene was sleeping and has been woken up, it will emit the event `transitionwake` instead of these two,\nas the Scenes `init` and `create` methods are not invoked when a Scene wakes up.\n\nWhen the duration of the transition has elapsed it will emit the event `transitioncomplete`.\nThese events are cleared of all listeners when the Scene shuts down, but not if it is sent to sleep.\n\nIt's important to understand that the duration of the transition begins the moment you call this method.\nIf the Scene you are transitioning to includes delayed processes, such as waiting for files to load, the\ntime still counts down even while that is happening. If the game itself pauses, or something else causes\nthis Scenes update loop to stop, then the transition will also pause for that duration. There are\nchecks in place to prevent you accidentally stopping a transitioning Scene but if you've got code to\noverride this understand that until the target Scene completes it might never be unlocked for input events.","kind":"function","name":"transition","fires":["Phaser.Scenes.Events#event:TRANSITION_OUT"],"since":"3.5.0","params":[{"type":{"names":["Phaser.Types.Scenes.SceneTransitionConfig"]},"description":"The transition configuration object.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` is the transition was started, otherwise `false`."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#transition","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Add the Scene into the Scene Manager and start it if 'autoStart' is true or the Scene config 'active' property is set.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene key.","name":"key"},{"type":{"names":["Phaser.Scene","Phaser.Types.Scenes.SettingsConfig","Phaser.Types.Scenes.CreateSceneFromObjectConfig","function"]},"description":"The config for the Scene.","name":"sceneConfig"},{"type":{"names":["boolean"]},"description":"Whether to start the Scene after it's added.","name":"autoStart"},{"type":{"names":["object"]},"optional":true,"description":"Optional data object. This will be set as Scene.settings.data and passed to `Scene.init`.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scene"]},"description":"An instance of the Scene that was added to the Scene Manager."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#add","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":448,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Launch the given Scene and run it in parallel with this one.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"launch","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to launch.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"The Scene data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#launch","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":471,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Runs the given Scene, but does not change the state of this Scene.\n\nThis will happen at the next Scene Manager update, not immediately.\n\nIf the given Scene is paused, it will resume it. If sleeping, it will wake it.\nIf not running at all, it will be started.\n\nUse this if you wish to open a modal Scene by calling `pause` on the current\nScene, then `run` on the modal Scene.","kind":"function","name":"run","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"The Scene to run.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed to the Scene and emitted in its ready, wake, or resume events.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#run","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":500,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Pause the Scene - this stops the update step from happening but it still renders.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"pause","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to pause.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted in its pause event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#pause","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":522,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Resume the Scene - starts the update loop again.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"resume","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to resume.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted in its resume event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#resume","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":544,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Makes the Scene sleep (no update, no render) but doesn't shutdown.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"sleep","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to put to sleep.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted in its sleep event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#sleep","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":566,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Makes the Scene wake-up (starts update and render)\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"wake","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to wake up.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted in its wake event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#wake","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":588,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Makes this Scene sleep then starts the Scene given.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"switch","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to start.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#switch","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":610,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Shutdown the Scene, clearing display list, timers, etc.\n\nThis happens at the next Scene Manager update, not immediately.","kind":"function","name":"stop","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to stop.","name":"key"},{"type":{"names":["any"]},"optional":true,"description":"Optional data object to pass to Scene.Systems.shutdown.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#stop","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Sets the active state of the given Scene.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"If `true` the Scene will be resumed. If `false` it will be paused.","name":"value"},{"type":{"names":["string"]},"optional":true,"description":"The Scene to set the active state of.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted with its events.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#setActive","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":658,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Sets the visible state of the given Scene.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible value.","name":"value"},{"type":{"names":["string"]},"optional":true,"description":"The Scene to set the visible state for.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#setVisible","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Checks if the given Scene is sleeping or not?","kind":"function","name":"isSleeping","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is sleeping."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#isSleeping","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":700,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Checks if the given Scene is running or not?","kind":"function","name":"isActive","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is running."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#isActive","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Checks if the given Scene is paused or not?","kind":"function","name":"isPaused","since":"3.17.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is paused."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#isPaused","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":734,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Checks if the given Scene is visible or not?","kind":"function","name":"isVisible","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is visible."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#isVisible","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":751,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Swaps the position of two scenes in the Scenes list.\n\nThis controls the order in which they are rendered and updated.","kind":"function","name":"swapPosition","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The first Scene to swap.","name":"keyA"},{"type":{"names":["string"]},"optional":true,"description":"The second Scene to swap. If none is given it defaults to this Scene.","name":"keyB"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#swapPosition","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":776,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Swaps the position of two scenes in the Scenes list, so that Scene B is directly above Scene A.\n\nThis controls the order in which they are rendered and updated.","kind":"function","name":"moveAbove","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The Scene that Scene B will be moved to be above.","name":"keyA"},{"type":{"names":["string"]},"optional":true,"description":"The Scene to be moved. If none is given it defaults to this Scene.","name":"keyB"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#moveAbove","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":801,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Swaps the position of two scenes in the Scenes list, so that Scene B is directly below Scene A.\n\nThis controls the order in which they are rendered and updated.","kind":"function","name":"moveBelow","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The Scene that Scene B will be moved to be below.","name":"keyA"},{"type":{"names":["string"]},"optional":true,"description":"The Scene to be moved. If none is given it defaults to this Scene.","name":"keyB"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#moveBelow","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":826,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Removes a Scene from the SceneManager.\n\nThe Scene is removed from the local scenes array, it's key is cleared from the keys\ncache and Scene.Systems.destroy is then called on it.\n\nIf the SceneManager is processing the Scenes when this method is called it will\nqueue the operation for the next update sequence.","kind":"function","name":"remove","since":"3.2.0","params":[{"type":{"names":["string","Phaser.Scene"]},"optional":true,"description":"The Scene to be removed.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#remove","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":851,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Moves a Scene up one position in the Scenes list.","kind":"function","name":"moveUp","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#moveUp","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":870,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Moves a Scene down one position in the Scenes list.","kind":"function","name":"moveDown","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#moveDown","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":889,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Brings a Scene to the top of the Scenes list.\n\nThis means it will render above all other Scenes.","kind":"function","name":"bringToTop","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#bringToTop","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":910,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Sends a Scene to the back of the Scenes list.\n\nThis means it will render below all other Scenes.","kind":"function","name":"sendToBack","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#sendToBack","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":931,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Retrieve a Scene.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to retrieve.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#get","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":946,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Retrieves the numeric index of a Scene in the Scenes list.","kind":"function","name":"getIndex","since":"3.7.0","params":[{"type":{"names":["string","Phaser.Scene"]},"optional":true,"description":"The Scene to get the index of.","name":"key"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the Scene."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#getIndex","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"Settings.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Settings.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"kind":"namespace","name":"Settings","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.Settings","scope":"static","___s":true},{"meta":{"filename":"Settings.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Takes a Scene configuration object and returns a fully formed System Settings object.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Scenes.SettingsConfig"]},"description":"The Scene configuration object used to create this Scene Settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Types.Scenes.SettingsObject"]},"description":"The Scene Settings object created as a result of the config and default settings."}],"memberof":"Phaser.Scenes.Settings","longname":"Phaser.Scenes.Settings.create","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Systems.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Systems.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"classdesc":"The Scene Systems class.\n\nThis class is available from within a Scene under the property `sys`.\nIt is responsible for managing all of the plugins a Scene has running, including the display list, and\nhandling the update step and renderer. It also contains references to global systems belonging to Game.","kind":"class","name":"Systems","memberof":"Phaser.Scenes","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that owns this Systems instance.","name":"scene"},{"type":{"names":["string","Phaser.Types.Scenes.SettingsConfig"]},"description":"Scene specific configuration settings.","name":"config"}],"scope":"static","longname":"Phaser.Scenes.Systems","___s":true},{"meta":{"filename":"Systems.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene that these Systems belong to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Phaser Game instance.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to either the Canvas or WebGL Renderer that this Game is using.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.17.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":67,"columnno":12,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Facebook Instant Games Plugin.","name":"facebook","type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"since":"3.12.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#facebook","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Scene Configuration object, as passed in when creating the Scene.","name":"config","type":{"names":["string","Phaser.Types.Scenes.SettingsConfig"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Scene Settings. This is the parsed output based on the Scene configuration.","name":"settings","type":{"names":["Phaser.Types.Scenes.SettingsObject"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#settings","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A handy reference to the Scene canvas / context.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Canvas Rendering Context being used by the renderer.","name":"context","type":{"names":["CanvasRenderingContext2D"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Animations Manager.\n\nIn the default set-up you can access this from within a Scene via the `this.anims` property.","name":"anims","type":{"names":["Phaser.Animations.AnimationManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#anims","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Cache. The Cache stores all files bought in to Phaser via\nthe Loader, with the exception of images. Images are stored in the Texture Manager.\n\nIn the default set-up you can access this from within a Scene via the `this.cache` property.","name":"cache","type":{"names":["Phaser.Cache.CacheManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#cache","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Plugins Manager.\n\nIn the default set-up you can access this from within a Scene via the `this.plugins` property.","name":"plugins","type":{"names":["Phaser.Plugins.PluginManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#plugins","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":149,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global registry. This is a game-wide instance of the Data Manager, allowing\nyou to exchange data between Scenes via a universal and shared point.\n\nIn the default set-up you can access this from within a Scene via the `this.registry` property.","name":"registry","type":{"names":["Phaser.Data.DataManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#registry","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Scale Manager.\n\nIn the default set-up you can access this from within a Scene via the `this.scale` property.","name":"scale","type":{"names":["Phaser.Scale.ScaleManager"]},"since":"3.15.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#scale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":172,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Sound Manager.\n\nIn the default set-up you can access this from within a Scene via the `this.sound` property.","name":"sound","type":{"names":["Phaser.Sound.NoAudioSoundManager","Phaser.Sound.HTML5AudioSoundManager","Phaser.Sound.WebAudioSoundManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#sound","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Texture Manager.\n\nIn the default set-up you can access this from within a Scene via the `this.textures` property.","name":"textures","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#textures","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene's Game Object Factory.\n\nUse this to quickly and easily create new Game Object's.\n\nIn the default set-up you can access this from within a Scene via the `this.add` property.","name":"add","type":{"names":["Phaser.GameObjects.GameObjectFactory"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#add","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":209,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene's Camera Manager.\n\nUse this to manipulate and create Cameras for this specific Scene.\n\nIn the default set-up you can access this from within a Scene via the `this.cameras` property.","name":"cameras","type":{"names":["Phaser.Cameras.Scene2D.CameraManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#cameras","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":222,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene's Display List.\n\nUse this to organize the children contained in the display list.\n\nIn the default set-up you can access this from within a Scene via the `this.children` property.","name":"displayList","type":{"names":["Phaser.GameObjects.DisplayList"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#displayList","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":235,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene's Event Manager.\n\nUse this to listen for Scene specific events, such as `pause` and `shutdown`.\n\nIn the default set-up you can access this from within a Scene via the `this.events` property.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":248,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene's Game Object Creator.\n\nUse this to quickly and easily create new Game Object's. The difference between this and the\nGame Object Factory, is that the Creator just creates and returns Game Object instances, it\ndoesn't then add them to the Display List or Update List.\n\nIn the default set-up you can access this from within a Scene via the `this.make` property.","name":"make","type":{"names":["Phaser.GameObjects.GameObjectCreator"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#make","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":263,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene Manager Plugin.\n\nUse this to manipulate both this and other Scene's in your game, for example to launch a parallel Scene,\nor pause or resume a Scene, or switch from this Scene to another.\n\nIn the default set-up you can access this from within a Scene via the `this.scene` property.","name":"scenePlugin","type":{"names":["Phaser.Scenes.ScenePlugin"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#scenePlugin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":277,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene's Update List.\n\nUse this to organize the children contained in the update list.\n\nThe Update List is responsible for managing children that need their `preUpdate` methods called,\nin order to process so internal components, such as Sprites with Animations.\n\nIn the default set-up there is no reference to this from within the Scene itself.","name":"updateList","type":{"names":["Phaser.GameObjects.UpdateList"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#updateList","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":362,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A single game step. Called automatically by the Scene Manager as a result of a Request Animation\nFrame or Set Timeout call to the main Game instance.","kind":"function","name":"step","fires":["Phaser.Scenes.Events#event:PRE_UPDATE","Phaser.Scenes.Events#event:_UPDATE","Phaser.Scenes.Events#event:POST_UPDATE"],"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The time value from the most recent Game step. Typically a high-resolution timer value, or Date.now().","name":"time"},{"type":{"names":["number"]},"description":"The delta value since the last frame. This is smoothed to avoid delta spikes by the TimeStep class.","name":"delta"}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#step","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":386,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Called automatically by the Scene Manager.\nInstructs the Scene to render itself via its Camera Manager to the renderer given.","kind":"function","name":"render","fires":["Phaser.Scenes.Events#event:RENDER"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The renderer that invoked the render call.","name":"renderer"}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#render","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":407,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Force a sort of the display list on the next render.","kind":"function","name":"queueDepthSort","since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#queueDepthSort","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":418,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Immediately sorts the display list if the flag is set.","kind":"function","name":"depthSort","since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#depthSort","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":429,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Pause this Scene.\nA paused Scene still renders, it just doesn't run ANY of its update handlers or systems.","kind":"function","name":"pause","fires":["Phaser.Scenes.Events#event:PAUSE"],"since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed in the 'pause' event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"This Systems object."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#pause","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":455,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Resume this Scene from a paused state.","kind":"function","name":"resume","fires":["Phaser.Scenes.Events#event:RESUME"],"since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed in the 'resume' event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"This Systems object."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#resume","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":480,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Send this Scene to sleep.\n\nA sleeping Scene doesn't run its update step or render anything, but it also isn't shut down\nor has any of its systems or children removed, meaning it can be re-activated at any point and\nwill carry on from where it left off. It also keeps everything in memory and events and callbacks\nfrom other Scenes may still invoke changes within it, so be careful what is left active.","kind":"function","name":"sleep","fires":["Phaser.Scenes.Events#event:SLEEP"],"since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed in the 'sleep' event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"This Systems object."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#sleep","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":508,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Wake-up this Scene if it was previously asleep.","kind":"function","name":"wake","fires":["Phaser.Scenes.Events#event:WAKE"],"since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed in the 'wake' event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"This Systems object."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#wake","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":538,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Returns any data that was sent to this Scene by another Scene.\n\nThe data is also passed to `Scene.init` and in various Scene events, but\nyou can access it at any point via this method.","kind":"function","name":"getData","since":"3.22.0","returns":[{"type":{"names":["any"]}}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#getData","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene sleeping?","kind":"function","name":"isSleeping","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is asleep, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isSleeping","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":567,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene running?","kind":"function","name":"isActive","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is running, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isActive","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":580,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene paused?","kind":"function","name":"isPaused","since":"3.13.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is paused, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isPaused","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":593,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene currently transitioning out to, or in from another Scene?","kind":"function","name":"isTransitioning","since":"3.5.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is currently transitioning, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isTransitioning","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":606,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene currently transitioning out from itself to another Scene?","kind":"function","name":"isTransitionOut","since":"3.5.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is in transition to another Scene, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isTransitionOut","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":619,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene currently transitioning in from another Scene?","kind":"function","name":"isTransitionIn","since":"3.5.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is transitioning in from another Scene, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isTransitionIn","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene visible and rendering?","kind":"function","name":"isVisible","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is visible, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isVisible","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":645,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Sets the visible state of this Scene.\nAn invisible Scene will not render, but will still process updates.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to render this Scene, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"This Systems object."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#setVisible","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":663,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Set the active state of this Scene.\n\nAn active Scene will run its core update loop.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"If `true` the Scene will be resumed, if previously paused. If `false` it will be paused.","name":"value"},{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed in the 'resume' or 'pause' events.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"This Systems object."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#setActive","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":688,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Start this Scene running and rendering.\nCalled automatically by the SceneManager.","kind":"function","name":"start","fires":["Phaser.Scenes.Events#event:START","Phaser.Scenes.Events#event:READY"],"since":"3.0.0","params":[{"type":{"names":["object"]},"description":"Optional data object that may have been passed to this Scene from another.","name":"data"}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#start","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":718,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Shutdown this Scene and send a shutdown event to all of its systems.\nA Scene that has been shutdown will not run its update loop or render, but it does\nnot destroy any of its plugins or references. It is put into hibernation for later use.\nIf you don't ever plan to use this Scene again, then it should be destroyed instead\nto free-up resources.","kind":"function","name":"shutdown","fires":["Phaser.Scenes.Events#event:SHUTDOWN"],"since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed in the 'shutdown' event.","name":"data"}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#shutdown","scope":"instance","___s":true},{"meta":{"range":[221,1790],"filename":"const.js","lineno":13,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene consts.","ignore":true,"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"PENDING","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.PENDING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":25,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"INIT","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.INIT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"START","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.START","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"LOADING","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.LOADING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":55,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"CREATING","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.CREATING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":65,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"RUNNING","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.RUNNING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":75,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"PAUSED","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.PAUSED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"SLEEPING","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.SLEEPING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":95,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"SHUTDOWN","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.SHUTDOWN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"DESTROYED","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.DESTROYED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"BOOT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Boot Event.\n\nThis event is dispatched by a Scene during the Scene Systems boot process. Primarily used by Scene Plugins.\n\nListen to it from a Scene using `this.scene.events.on('boot', listener)`.","kind":"event","name":"BOOT","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:BOOT","scope":"instance","___s":true},{"meta":{"filename":"CREATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Create Event.\n\nThis event is dispatched by a Scene after it has been created by the Scene Manager.\n\nIf a Scene has a `create` method then this event is emitted _after_ that has run.\n\nIf there is a transition, this event will be fired after the `TRANSITION_START` event.\n\nListen to it from a Scene using `this.scene.events.on('create', listener)`.","kind":"event","name":"CREATE","since":"3.17.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that emitted this event.","name":"scene"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:CREATE","scope":"instance","___s":true},{"meta":{"filename":"DESTROY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Destroy Event.\n\nThis event is dispatched by a Scene during the Scene Systems destroy process.\n\nListen to it from a Scene using `this.scene.events.on('destroy', listener)`.\n\nYou should destroy any resources that may be in use by your Scene in this event handler.","kind":"event","name":"DESTROY","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:DESTROY","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Pause Event.\n\nThis event is dispatched by a Scene when it is paused, either directly via the `pause` method, or as an\naction from another Scene.\n\nListen to it from a Scene using `this.scene.events.on('pause', listener)`.","kind":"event","name":"PAUSE","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["any"]},"optional":true,"description":"An optional data object that was passed to this Scene when it was paused.","name":"data"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:PAUSE","scope":"instance","___s":true},{"meta":{"filename":"POST_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Post Update Event.\n\nThis event is dispatched by a Scene during the main game loop step.\n\nThe event flow for a single step of a Scene is as follows:\n\n1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\n2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\n3. The `Scene.update` method is called, if it exists\n4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\n5. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\n\nListen to it from a Scene using `this.scene.events.on('postupdate', listener)`.\n\nA Scene will only run its step if it is active.","kind":"event","name":"POST_UPDATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:POST_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"PRE_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Pre Update Event.\n\nThis event is dispatched by a Scene during the main game loop step.\n\nThe event flow for a single step of a Scene is as follows:\n\n1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\n2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\n3. The `Scene.update` method is called, if it exists\n4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\n5. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\n\nListen to it from a Scene using `this.scene.events.on('preupdate', listener)`.\n\nA Scene will only run its step if it is active.","kind":"event","name":"PRE_UPDATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:PRE_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"READY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Ready Event.\n\nThis event is dispatched by a Scene during the Scene Systems start process.\nBy this point in the process the Scene is now fully active and rendering.\nThis event is meant for your game code to use, as all plugins have responded to the earlier 'start' event.\n\nListen to it from a Scene using `this.scene.events.on('ready', listener)`.","kind":"event","name":"READY","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["any"]},"optional":true,"description":"An optional data object that was passed to this Scene when it was started.","name":"data"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:READY","scope":"instance","___s":true},{"meta":{"filename":"RENDER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Render Event.\n\nThis event is dispatched by a Scene during the main game loop step.\n\nThe event flow for a single step of a Scene is as follows:\n\n1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\n2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\n3. The `Scene.update` method is called, if it exists\n4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\n5. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\n\nListen to it from a Scene using `this.scene.events.on('render', listener)`.\n\nA Scene will only render if it is visible and active.\nBy the time this event is dispatched, the Scene will have already been rendered.","kind":"event","name":"RENDER","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The renderer that rendered the Scene.","name":"renderer"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:RENDER","scope":"instance","___s":true},{"meta":{"filename":"RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Resume Event.\n\nThis event is dispatched by a Scene when it is resumed from a paused state, either directly via the `resume` method,\nor as an action from another Scene.\n\nListen to it from a Scene using `this.scene.events.on('resume', listener)`.","kind":"event","name":"RESUME","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["any"]},"optional":true,"description":"An optional data object that was passed to this Scene when it was resumed.","name":"data"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:RESUME","scope":"instance","___s":true},{"meta":{"filename":"SHUTDOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Shutdown Event.\n\nThis event is dispatched by a Scene during the Scene Systems shutdown process.\n\nListen to it from a Scene using `this.scene.events.on('shutdown', listener)`.\n\nYou should free-up any resources that may be in use by your Scene in this event handler, on the understanding\nthat the Scene may, at any time, become active again. A shutdown Scene is not 'destroyed', it's simply not\ncurrently active. Use the [DESTROY]{@linkcode Phaser.Scenes.Events#event:DESTROY} event to completely clear resources.","kind":"event","name":"SHUTDOWN","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["any"]},"optional":true,"description":"An optional data object that was passed to this Scene when it was shutdown.","name":"data"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:SHUTDOWN","scope":"instance","___s":true},{"meta":{"filename":"SLEEP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Sleep Event.\n\nThis event is dispatched by a Scene when it is sent to sleep, either directly via the `sleep` method,\nor as an action from another Scene.\n\nListen to it from a Scene using `this.scene.events.on('sleep', listener)`.","kind":"event","name":"SLEEP","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["any"]},"optional":true,"description":"An optional data object that was passed to this Scene when it was sent to sleep.","name":"data"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:SLEEP","scope":"instance","___s":true},{"meta":{"filename":"START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Start Event.\n\nThis event is dispatched by a Scene during the Scene Systems start process. Primarily used by Scene Plugins.\n\nListen to it from a Scene using `this.scene.events.on('start', listener)`.","kind":"event","name":"START","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:START","scope":"instance","___s":true},{"meta":{"filename":"TRANSITION_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Transition Complete Event.\n\nThis event is dispatched by the Target Scene of a transition.\n\nIt happens when the transition process has completed. This occurs when the duration timer equals or exceeds the duration\nof the transition.\n\nListen to it from a Scene using `this.scene.events.on('transitioncomplete', listener)`.\n\nThe Scene Transition event flow is as follows:\n\n1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\n2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\n3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\n4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\n5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.","kind":"event","name":"TRANSITION_COMPLETE","since":"3.5.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene on which the transitioned completed.","name":"scene"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:TRANSITION_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"TRANSITION_INIT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Transition Init Event.\n\nThis event is dispatched by the Target Scene of a transition.\n\nIt happens immediately after the `Scene.init` method is called. If the Scene does not have an `init` method,\nthis event is not dispatched.\n\nListen to it from a Scene using `this.scene.events.on('transitioninit', listener)`.\n\nThe Scene Transition event flow is as follows:\n\n1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\n2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\n3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\n4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\n5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.","kind":"event","name":"TRANSITION_INIT","since":"3.5.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that is being transitioned from.","name":"from"},{"type":{"names":["number"]},"description":"The duration of the transition in ms.","name":"duration"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:TRANSITION_INIT","scope":"instance","___s":true},{"meta":{"filename":"TRANSITION_OUT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Transition Out Event.\n\nThis event is dispatched by a Scene when it initiates a transition to another Scene.\n\nListen to it from a Scene using `this.scene.events.on('transitionout', listener)`.\n\nThe Scene Transition event flow is as follows:\n\n1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\n2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\n3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\n4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\n5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.","kind":"event","name":"TRANSITION_OUT","since":"3.5.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that is being transitioned to.","name":"target"},{"type":{"names":["number"]},"description":"The duration of the transition in ms.","name":"duration"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:TRANSITION_OUT","scope":"instance","___s":true},{"meta":{"filename":"TRANSITION_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Transition Start Event.\n\nThis event is dispatched by the Target Scene of a transition, only if that Scene was not asleep.\n\nIt happens immediately after the `Scene.create` method is called. If the Scene does not have a `create` method,\nthis event is dispatched anyway.\n\nIf the Target Scene was sleeping then the [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} event is\ndispatched instead of this event.\n\nListen to it from a Scene using `this.scene.events.on('transitionstart', listener)`.\n\nThe Scene Transition event flow is as follows:\n\n1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\n2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\n3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\n4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\n5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.","kind":"event","name":"TRANSITION_START","since":"3.5.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that is being transitioned from.","name":"from"},{"type":{"names":["number"]},"description":"The duration of the transition in ms.","name":"duration"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:TRANSITION_START","scope":"instance","___s":true},{"meta":{"filename":"TRANSITION_WAKE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Transition Wake Event.\n\nThis event is dispatched by the Target Scene of a transition, only if that Scene was asleep before\nthe transition began. If the Scene was not asleep the [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} event is dispatched instead.\n\nListen to it from a Scene using `this.scene.events.on('transitionwake', listener)`.\n\nThe Scene Transition event flow is as follows:\n\n1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\n2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\n3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\n4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\n5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.","kind":"event","name":"TRANSITION_WAKE","since":"3.5.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that is being transitioned from.","name":"from"},{"type":{"names":["number"]},"description":"The duration of the transition in ms.","name":"duration"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:TRANSITION_WAKE","scope":"instance","___s":true},{"meta":{"filename":"UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Update Event.\n\nThis event is dispatched by a Scene during the main game loop step.\n\nThe event flow for a single step of a Scene is as follows:\n\n1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\n2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\n3. The `Scene.update` method is called, if it exists\n4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\n5. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\n\nListen to it from a Scene using `this.scene.events.on('update', listener)`.\n\nA Scene will only run its step if it is active.","kind":"event","name":"UPDATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:UPDATE","scope":"instance","___s":true},{"meta":{"filename":"WAKE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Wake Event.\n\nThis event is dispatched by a Scene when it is woken from sleep, either directly via the `wake` method,\nor as an action from another Scene.\n\nListen to it from a Scene using `this.scene.events.on('wake', listener)`.","kind":"event","name":"WAKE","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["any"]},"optional":true,"description":"An optional data object that was passed to this Scene when it was woken up.","name":"data"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:WAKE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.Events","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"kind":"namespace","name":"Scenes","memberof":"Phaser","longname":"Phaser.Scenes","scope":"static","___s":true},{"meta":{"filename":"CreateSceneFromObjectConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"kind":"typedef","name":"CreateSceneFromObjectConfig","type":{"names":["object"]},"since":"3.17.0","properties":[{"type":{"names":["Phaser.Types.Scenes.SceneInitCallback"]},"optional":true,"description":"The scene's init callback.","name":"init"},{"type":{"names":["Phaser.Types.Scenes.ScenePreloadCallback"]},"optional":true,"description":"The scene's preload callback.","name":"preload"},{"type":{"names":["Phaser.Types.Scenes.SceneCreateCallback"]},"optional":true,"description":"The scene's create callback.","name":"create"},{"type":{"names":["function"]},"optional":true,"description":"The scene's update callback. See {@link Phaser.Scene#update}.","name":"update"},{"type":{"names":["any"]},"optional":true,"description":"Any additional properties, which will be copied to the Scene after it's created (except `data` or `sys`).","name":"extend"},{"type":{"names":["any"]},"optional":true,"description":"Any values, which will be merged into the Scene's Data Manager store.","name":"extend.data"}],"memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.CreateSceneFromObjectConfig","scope":"static","___s":true},{"meta":{"filename":"SceneCreateCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"description":"Can be defined on your own Scenes. Use it to create your game objects.\nThis method is called by the Scene Manager when the scene starts, after `init()` and `preload()`.\nIf the LoaderPlugin started after `preload()`, then this method is called only after loading is complete.","kind":"typedef","name":"SceneCreateCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["object"]},"description":"Any data passed via `ScenePlugin.add()` or `ScenePlugin.start()`. Same as Scene.settings.data.","name":"data"}],"memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.SceneCreateCallback","scope":"static","___s":true},{"meta":{"filename":"SceneInitCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"description":"Can be defined on your own Scenes.\nThis method is called by the Scene Manager when the scene starts, before `preload()` and `create()`.","kind":"typedef","name":"SceneInitCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["object"]},"description":"Any data passed via `ScenePlugin.add()` or `ScenePlugin.start()`. Same as Scene.settings.data.","name":"data"}],"memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.SceneInitCallback","scope":"static","___s":true},{"meta":{"filename":"ScenePreloadCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"description":"Can be defined on your own Scenes. Use it to load assets.\nThis method is called by the Scene Manager, after `init()` and before `create()`, only if the Scene has a LoaderPlugin.\nAfter this method completes, if the LoaderPlugin's queue isn't empty, the LoaderPlugin will start automatically.","kind":"typedef","name":"ScenePreloadCallback","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.ScenePreloadCallback","scope":"static","___s":true},{"meta":{"filename":"SceneTransitionConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"kind":"typedef","name":"SceneTransitionConfig","type":{"names":["object"]},"since":"3.5.0","properties":[{"type":{"names":["string"]},"description":"The Scene key to transition to.","name":"target"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration, in ms, for the transition to last.","name":"duration"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Will the Scene responsible for the transition be sent to sleep on completion (`true`), or stopped? (`false`)","name":"sleep"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Will the Scenes Input system be able to process events while it is transitioning in or out?","name":"allowInput"},{"type":{"names":["boolean"]},"optional":true,"description":"Move the target Scene to be above this one before the transition starts.","name":"moveAbove"},{"type":{"names":["boolean"]},"optional":true,"description":"Move the target Scene to be below this one before the transition starts.","name":"moveBelow"},{"type":{"names":["function"]},"optional":true,"description":"This callback is invoked every frame for the duration of the transition.","name":"onUpdate"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked.","name":"onUpdateScope"},{"type":{"names":["any"]},"optional":true,"description":"An object containing any data you wish to be passed to the target Scenes init / create methods.","name":"data"}],"memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.SceneTransitionConfig","scope":"static","___s":true},{"meta":{"filename":"SettingsConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"kind":"typedef","name":"SettingsConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"The unique key of this Scene. Must be unique within the entire Game instance.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Does the Scene start as active or not? An active Scene updates each step.","name":"active"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Does the Scene start as visible or not? A visible Scene renders each step.","name":"visible"},{"type":{"names":["false","Phaser.Types.Loader.FileTypes.PackFileConfig"]},"optional":true,"defaultvalue":false,"description":"An optional Loader Packfile to be loaded before the Scene begins.","name":"pack"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.JSONCamera","Array."]},"optional":true,"nullable":true,"defaultvalue":null,"description":"An optional Camera configuration object.","name":"cameras"},{"type":{"names":["Object."]},"optional":true,"description":"Overwrites the default injection map for a scene.","name":"map"},{"type":{"names":["Object."]},"optional":true,"description":"Extends the injection map for a scene.","name":"mapAdd"},{"type":{"names":["Phaser.Types.Core.PhysicsConfig"]},"optional":true,"defaultvalue":"{}","description":"The physics configuration object for the Scene.","name":"physics"},{"type":{"names":["Phaser.Types.Core.LoaderConfig"]},"optional":true,"defaultvalue":"{}","description":"The loader configuration object for the Scene.","name":"loader"},{"type":{"names":["false","*"]},"optional":true,"defaultvalue":false,"description":"The plugin configuration object for the Scene.","name":"plugins"}],"memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.SettingsConfig","scope":"static","___s":true},{"meta":{"filename":"SettingsObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"kind":"typedef","name":"SettingsObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The current status of the Scene. Maps to the Scene constants.","name":"status"},{"type":{"names":["string"]},"description":"The unique key of this Scene. Unique within the entire Game instance.","name":"key"},{"type":{"names":["boolean"]},"description":"The active state of this Scene. An active Scene updates each step.","name":"active"},{"type":{"names":["boolean"]},"description":"The visible state of this Scene. A visible Scene renders each step.","name":"visible"},{"type":{"names":["boolean"]},"description":"Has the Scene finished booting?","name":"isBooted"},{"type":{"names":["boolean"]},"description":"Is the Scene in a state of transition?","name":"isTransition"},{"type":{"names":["Phaser.Scene"]},"nullable":true,"description":"The Scene this Scene is transitioning from, if set.","name":"transitionFrom"},{"type":{"names":["integer"]},"description":"The duration of the transition, if set.","name":"transitionDuration"},{"type":{"names":["boolean"]},"description":"Is this Scene allowed to receive input during transitions?","name":"transitionAllowInput"},{"type":{"names":["object"]},"description":"a data bundle passed to this Scene from the Scene Manager.","name":"data"},{"type":{"names":["false","Phaser.Types.Loader.FileTypes.PackFileConfig"]},"description":"The Loader Packfile to be loaded before the Scene begins.","name":"pack"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.JSONCamera","Array."]},"nullable":true,"description":"The Camera configuration object.","name":"cameras"},{"type":{"names":["Object."]},"description":"The Scene's Injection Map.","name":"map"},{"type":{"names":["Phaser.Types.Core.PhysicsConfig"]},"description":"The physics configuration object for the Scene.","name":"physics"},{"type":{"names":["Phaser.Types.Core.LoaderConfig"]},"description":"The loader configuration object for the Scene.","name":"loader"},{"type":{"names":["false","*"]},"description":"The plugin configuration object for the Scene.","name":"plugins"}],"memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.SettingsObject","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"kind":"namespace","name":"Scenes","memberof":"Phaser.Types","longname":"Phaser.Types.Scenes","scope":"static","___s":true},{"meta":{"range":[266,299],"filename":"BaseSound.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BaseSound.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"classdesc":"Class containing all the shared state and behavior of a sound object, independent of the implementation.","kind":"class","name":"BaseSound","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"Reference to the current sound manager instance.","name":"manager"},{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"scope":"static","longname":"Phaser.Sound.BaseSound","___s":true},{"meta":{"filename":"BaseSound.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Asset key for the sound.","name":"key","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently playing.","name":"isPlaying","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#isPlaying","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently paused.","name":"isPaused","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#isPaused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A property that holds the value of sound's actual playback rate,\nafter its rate and detune values has been combined with global\nrate and detune values.","name":"totalRate","type":{"names":["number"]},"defaultvalue":"1","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#totalRate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A value representing the duration, in seconds.\nIt could be total sound duration or a marker duration.","name":"duration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"The total duration of the sound in seconds.","name":"totalDuration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#totalDuration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Object containing markers definitions.","name":"markers","type":{"names":["Object."]},"defaultvalue":"{}","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#markers","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Currently playing marker.\n'null' if whole sound is playing.","name":"currentMarker","type":{"names":["Phaser.Types.Sound.SoundMarker"]},"defaultvalue":"null","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#currentMarker","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\nThis allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.","kind":"function","name":"addMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was added successfully."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#addMarker","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Updates previously added marker.","kind":"function","name":"updateMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object with updated values.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was updated successfully."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#updateMarker","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a marker from the sound.","kind":"function","name":"removeMarker","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the marker to remove.","name":"markerName"}],"returns":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"nullable":true,"description":"Removed marker object or 'null' if there was no marker with provided name."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#removeMarker","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":283,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Play this sound, or a marked section of it.\nIt always plays the sound from the start. If you want to start playback from a specific time\nyou can set 'seek' setting of the config object, provided to this call, to that value.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"''","description":"If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.","name":"markerName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#play","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":342,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Pauses the sound.","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was paused successfully."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#pause","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":363,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Resumes the sound.","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was resumed successfully."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#resume","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Stop playing this sound.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was stopped successfully."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#stop","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Destroys this sound and all associated events and marks it for removal from the sound manager.","kind":"function","name":"destroy","fires":["Phaser.Sound.Events#event:DESTROY"],"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"range":[266,299],"filename":"BaseSoundManager.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"classdesc":"The sound manager is responsible for playing back audio via Web Audio API or HTML Audio tag as fallback.\nThe audio file type and the encoding of those files are extremely important.\n\nNot all browsers can play all audio formats.\n\nThere is a good guide to what's supported [here](https://developer.mozilla.org/en-US/Apps/Fundamentals/Audio_and_video_delivery/Cross-browser_audio_basics#Audio_Codec_Support).","kind":"class","name":"BaseSoundManager","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"Reference to the current game instance.","name":"game"}],"scope":"static","longname":"Phaser.Sound.BaseSoundManager","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to game.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to the JSON Cache, as used by Audio Sprites.","name":"jsonCache","type":{"names":["Phaser.Cache.BaseCache"]},"readonly":true,"since":"3.7.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#jsonCache","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global mute setting.","name":"mute","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#mute","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global volume setting.","name":"volume","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#volume","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sounds should be paused when game looses focus,\nfor instance when user switches to another tab/program/app.","name":"pauseOnBlur","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#pauseOnBlur","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Mobile devices require sounds to be triggered from an explicit user action,\nsuch as a tap, before any sound can be loaded/played on a web page.\nSet to true if the audio system is currently locked awaiting user interaction.","name":"locked","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#locked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new sound into the sound manager.","kind":"function","name":"add","override":true,"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The new sound instance."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#add","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new audio sprite sound into the sound manager.\nAudio Sprites are a combination of audio files and a JSON configuration.\nThe JSON follows the format of that created by https://github.com/tonistiigi/audiosprite","kind":"function","name":"addAudioSprite","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound","Phaser.Sound.WebAudioSound"]},"description":"The new audio sprite sound instance."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#addAudioSprite","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new sound to the sound manager and plays it.\nThe sound will be automatically removed (destroyed) once playback ends.\nThis lets you play a new sound on the fly without the need to keep a reference to it.","kind":"function","name":"play","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig","Phaser.Types.Sound.SoundMarker"]},"optional":true,"description":"An optional additional object containing settings to be applied to the sound. It could be either config or marker object.","name":"extra"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#play","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Enables playing audio sprite sound on the fly without the need to keep a reference to it.\nSound will auto destroy once its playback ends.","kind":"function","name":"playAudioSprite","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["string"]},"description":"The name of the sound sprite to play.","name":"spriteName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the audio sprite sound started playing successfully."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#playAudioSprite","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a sound from the sound manager.\nThe removed sound is destroyed before removal.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The sound object to remove.","name":"sound"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the sound was removed successfully, otherwise false."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#remove","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes all sounds from the sound manager that have an asset key matching the given value.\nThe removed sounds are destroyed before removal.","kind":"function","name":"removeByKey","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key to match when removing sound objects.","name":"key"}],"returns":[{"type":{"names":["number"]},"description":"The number of matching sound objects that were removed."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#removeByKey","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Pauses all the sounds in the game.","kind":"function","name":"pauseAll","fires":["Phaser.Sound.Events#event:PAUSE_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#pauseAll","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Resumes all the sounds in the game.","kind":"function","name":"resumeAll","fires":["Phaser.Sound.Events#event:RESUME_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#resumeAll","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Stops all the sounds in the game.","kind":"function","name":"stopAll","fires":["Phaser.Sound.Events#event:STOP_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#stopAll","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Destroys all the sounds in the game and all associated events.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global playback rate at which all the sounds will be played.\n\nFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","kind":"function","name":"setRate","fires":["Phaser.Sound.Events#event:GLOBAL_RATE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"Global playback rate at which all the sounds will be played.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#setRate","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global playback rate at which all the sounds will be played.\nValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audio's playback speed.","name":"rate","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#rate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","kind":"function","name":"setDetune","fires":["Phaser.Sound.Events#event:GLOBAL_DETUNE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#setDetune","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"detune","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#detune","scope":"instance","kind":"member","___s":true},{"meta":{"range":[266,332],"filename":"SoundManagerCreator.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"name":"HTML5AudioSoundManager","longname":"HTML5AudioSoundManager","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SoundManagerCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Creates a Web Audio, HTML5 Audio or No Audio Sound Manager based on config and device settings.\n\nBe aware of https://developers.google.com/web/updates/2017/09/autoplay-policy-changes","kind":"function","name":"SoundManagerCreator","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"Reference to the current game instance.","name":"game"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager","Phaser.Sound.WebAudioSoundManager","Phaser.Sound.NoAudioSoundManager"]},"description":"The Sound Manager instance that was created."}],"memberof":"Phaser.Sound","longname":"Phaser.Sound.SoundManagerCreator","scope":"static","___s":true},{"meta":{"filename":"COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Complete Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they complete playback.\n\nListen to it from a Sound instance using `Sound.on('complete', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('complete', listener);\nmusic.play();\n```","kind":"event","name":"COMPLETE","since":"3.16.1","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"DECODED_ALL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Audio Data Decoded All Event.\n\nThis event is dispatched by the Web Audio Sound Manager as a result of calling the `decodeAudio` method,\nonce all files passed to the method have been decoded (or errored).\n\nUse `Phaser.Sound.Events#DECODED` to listen for single sounds being decoded, and `DECODED_ALL` to\nlisten for them all completing.\n\nListen to it from the Sound Manager in a Scene using `this.sound.on('decodedall', listener)`, i.e.:\n\n```javascript\nthis.sound.once('decodedall', handler);\nthis.sound.decodeAudio([ audioFiles ]);\n```","kind":"event","name":"DECODED_ALL","since":"3.18.0","memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:DECODED_ALL","scope":"instance","___s":true},{"meta":{"filename":"DECODED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Audio Data Decoded Event.\n\nThis event is dispatched by the Web Audio Sound Manager as a result of calling the `decodeAudio` method.\n\nListen to it from the Sound Manager in a Scene using `this.sound.on('decoded', listener)`, i.e.:\n\n```javascript\nthis.sound.on('decoded', handler);\nthis.sound.decodeAudio(key, audioData);\n```","kind":"event","name":"DECODED","since":"3.18.0","params":[{"type":{"names":["string"]},"description":"The key of the audio file that was decoded and added to the audio cache.","name":"key"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:DECODED","scope":"instance","___s":true},{"meta":{"filename":"DESTROY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Destroy Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are destroyed, either\ndirectly or via a Sound Manager.\n\nListen to it from a Sound instance using `Sound.on('destroy', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('destroy', listener);\nmusic.destroy();\n```","kind":"event","name":"DESTROY","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:DESTROY","scope":"instance","___s":true},{"meta":{"filename":"DETUNE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Detune Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their detune value changes.\n\nListen to it from a Sound instance using `Sound.on('detune', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('detune', listener);\nmusic.play();\nmusic.setDetune(200);\n```","kind":"event","name":"DETUNE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"},{"type":{"names":["number"]},"description":"The new detune value of the Sound.","name":"detune"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:DETUNE","scope":"instance","___s":true},{"meta":{"filename":"GLOBAL_DETUNE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Manager Global Detune Event.\n\nThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\nor the HTML5 Audio Manager. It is dispatched when the `detune` property of the Sound Manager is changed, which globally\nadjusts the detuning of all active sounds.\n\nListen to it from a Scene using: `this.sound.on('rate', listener)`.","kind":"event","name":"GLOBAL_DETUNE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"},{"type":{"names":["number"]},"description":"The updated detune value.","name":"detune"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:GLOBAL_DETUNE","scope":"instance","___s":true},{"meta":{"filename":"GLOBAL_MUTE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Manager Global Mute Event.\n\nThis event is dispatched by the Sound Manager when its `mute` property is changed, either directly\nor via the `setMute` method. This changes the mute state of all active sounds.\n\nListen to it from a Scene using: `this.sound.on('mute', listener)`.","kind":"event","name":"GLOBAL_MUTE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager","Phaser.Sound.HTML5AudioSoundManager"]},"description":"A reference to the Sound Manager that emitted the event.","name":"soundManager"},{"type":{"names":["boolean"]},"description":"The mute value. `true` if the Sound Manager is now muted, otherwise `false`.","name":"mute"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:GLOBAL_MUTE","scope":"instance","___s":true},{"meta":{"filename":"GLOBAL_RATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Manager Global Rate Event.\n\nThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\nor the HTML5 Audio Manager. It is dispatched when the `rate` property of the Sound Manager is changed, which globally\nadjusts the playback rate of all active sounds.\n\nListen to it from a Scene using: `this.sound.on('rate', listener)`.","kind":"event","name":"GLOBAL_RATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"},{"type":{"names":["number"]},"description":"The updated rate value.","name":"rate"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:GLOBAL_RATE","scope":"instance","___s":true},{"meta":{"filename":"GLOBAL_VOLUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Manager Global Volume Event.\n\nThis event is dispatched by the Sound Manager when its `volume` property is changed, either directly\nor via the `setVolume` method. This changes the volume of all active sounds.\n\nListen to it from a Scene using: `this.sound.on('volume', listener)`.","kind":"event","name":"GLOBAL_VOLUME","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager","Phaser.Sound.HTML5AudioSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"},{"type":{"names":["number"]},"description":"The new global volume of the Sound Manager.","name":"volume"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:GLOBAL_VOLUME","scope":"instance","___s":true},{"meta":{"filename":"LOOPED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Looped Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they loop during playback.\n\nListen to it from a Sound instance using `Sound.on('looped', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('looped', listener);\nmusic.setLoop(true);\nmusic.play();\n```\n\nThis is not to be confused with the [LOOP]{@linkcode Phaser.Sound.Events#event:LOOP} event, which only emits when the loop state of a Sound is changed.","kind":"event","name":"LOOPED","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:LOOPED","scope":"instance","___s":true},{"meta":{"filename":"LOOP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Loop Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their loop state is changed.\n\nListen to it from a Sound instance using `Sound.on('loop', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('loop', listener);\nmusic.setLoop(true);\n```\n\nThis is not to be confused with the [LOOPED]{@linkcode Phaser.Sound.Events#event:LOOPED} event, which emits each time a Sound loops during playback.","kind":"event","name":"LOOP","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"},{"type":{"names":["boolean"]},"description":"The new loop value. `true` if the Sound will loop, otherwise `false`.","name":"loop"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:LOOP","scope":"instance","___s":true},{"meta":{"filename":"MUTE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Mute Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their mute state changes.\n\nListen to it from a Sound instance using `Sound.on('mute', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('mute', listener);\nmusic.play();\nmusic.setMute(true);\n```","kind":"event","name":"MUTE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"},{"type":{"names":["boolean"]},"description":"The mute value. `true` if the Sound is now muted, otherwise `false`.","name":"mute"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:MUTE","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_ALL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Pause All Sounds Event.\n\nThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\nor the HTML5 Audio Manager. It is dispatched when the `pauseAll` method is invoked and after all current Sounds\nhave been paused.\n\nListen to it from a Scene using: `this.sound.on('pauseall', listener)`.","kind":"event","name":"PAUSE_ALL","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:PAUSE_ALL","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Pause Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are paused.\n\nListen to it from a Sound instance using `Sound.on('pause', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('pause', listener);\nmusic.play();\nmusic.pause();\n```","kind":"event","name":"PAUSE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:PAUSE","scope":"instance","___s":true},{"meta":{"filename":"PLAY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Play Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are played.\n\nListen to it from a Sound instance using `Sound.on('play', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('play', listener);\nmusic.play();\n```","kind":"event","name":"PLAY","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:PLAY","scope":"instance","___s":true},{"meta":{"filename":"RATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Rate Change Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their rate changes.\n\nListen to it from a Sound instance using `Sound.on('rate', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('rate', listener);\nmusic.play();\nmusic.setRate(0.5);\n```","kind":"event","name":"RATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"},{"type":{"names":["number"]},"description":"The new rate of the Sound.","name":"rate"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:RATE","scope":"instance","___s":true},{"meta":{"filename":"RESUME_ALL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Resume All Sounds Event.\n\nThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\nor the HTML5 Audio Manager. It is dispatched when the `resumeAll` method is invoked and after all current Sounds\nhave been resumed.\n\nListen to it from a Scene using: `this.sound.on('resumeall', listener)`.","kind":"event","name":"RESUME_ALL","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:RESUME_ALL","scope":"instance","___s":true},{"meta":{"filename":"RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Resume Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are resumed from a paused state.\n\nListen to it from a Sound instance using `Sound.on('resume', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('resume', listener);\nmusic.play();\nmusic.pause();\nmusic.resume();\n```","kind":"event","name":"RESUME","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:RESUME","scope":"instance","___s":true},{"meta":{"filename":"SEEK_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Seek Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are seeked to a new position.\n\nListen to it from a Sound instance using `Sound.on('seek', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('seek', listener);\nmusic.play();\nmusic.setSeek(5000);\n```","kind":"event","name":"SEEK","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"},{"type":{"names":["number"]},"description":"The new detune value of the Sound.","name":"detune"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:SEEK","scope":"instance","___s":true},{"meta":{"filename":"STOP_ALL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Stop All Sounds Event.\n\nThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\nor the HTML5 Audio Manager. It is dispatched when the `stopAll` method is invoked and after all current Sounds\nhave been stopped.\n\nListen to it from a Scene using: `this.sound.on('stopall', listener)`.","kind":"event","name":"STOP_ALL","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:STOP_ALL","scope":"instance","___s":true},{"meta":{"filename":"STOP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Stop Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are stopped.\n\nListen to it from a Sound instance using `Sound.on('stop', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('stop', listener);\nmusic.play();\nmusic.stop();\n```","kind":"event","name":"STOP","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:STOP","scope":"instance","___s":true},{"meta":{"filename":"UNLOCKED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Manager Unlocked Event.\n\nThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\nor the HTML5 Audio Manager. It is dispatched during the update loop when the Sound Manager becomes unlocked. For\nWeb Audio this is on the first user gesture on the page.\n\nListen to it from a Scene using: `this.sound.on('unlocked', listener)`.","kind":"event","name":"UNLOCKED","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:UNLOCKED","scope":"instance","___s":true},{"meta":{"filename":"VOLUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Volume Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their volume changes.\n\nListen to it from a Sound instance using `Sound.on('volume', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('volume', listener);\nmusic.play();\nmusic.setVolume(0.5);\n```","kind":"event","name":"VOLUME","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"},{"type":{"names":["number"]},"description":"The new volume of the Sound.","name":"volume"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:VOLUME","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Sound","longname":"Phaser.Sound.Events","scope":"static","___s":true},{"meta":{"range":[266,301],"filename":"HTML5AudioSound.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"name":"BaseSound","longname":"BaseSound","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"classdesc":"HTML5 Audio implementation of the sound.","kind":"class","name":"HTML5AudioSound","augments":["Phaser.Sound.BaseSound"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"Reference to the current sound manager instance.","name":"manager"},{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"{}","description":"An optional config object containing default sound settings.","name":"config"}],"scope":"static","longname":"Phaser.Sound.HTML5AudioSound","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Play this sound, or a marked section of it.\nIt always plays the sound from the start. If you want to start playback from a specific time\nyou can set 'seek' setting of the config object, provided to this call, to that value.","kind":"function","name":"play","fires":["Phaser.Sound.Events#event:PLAY"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"''","description":"If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.","name":"markerName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#play","scope":"instance","overrides":"Phaser.Sound.BaseSound#play","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":133,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Pauses the sound.","kind":"function","name":"pause","fires":["Phaser.Sound.Events#event:PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was paused successfully."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#pause","scope":"instance","overrides":"Phaser.Sound.BaseSound#pause","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Resumes the sound.","kind":"function","name":"resume","fires":["Phaser.Sound.Events#event:RESUME"],"since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was resumed successfully."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#resume","scope":"instance","overrides":"Phaser.Sound.BaseSound#resume","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Stop playing this sound.","kind":"function","name":"stop","fires":["Phaser.Sound.Events#event:STOP"],"since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was stopped successfully."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#stop","scope":"instance","overrides":"Phaser.Sound.BaseSound#stop","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":510,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Calls Phaser.Sound.BaseSound#destroy method\nand cleans up all HTML5 Audio related stuff.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#destroy","scope":"instance","overrides":"Phaser.Sound.BaseSound#destroy","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":576,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Boolean indicating whether the sound is muted or not.\nGets or sets the muted state of this sound.","name":"mute","type":{"names":["boolean"]},"defaultvalue":"false","fires":["Phaser.Sound.Events#event:MUTE"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#mute","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the muted state of this Sound.","kind":"function","name":"setMute","fires":["Phaser.Sound.Events#event:MUTE"],"since":"3.4.0","params":[{"type":{"names":["boolean"]},"description":"`true` to mute this sound, `false` to unmute it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#setMute","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Gets or sets the volume of this sound, a value between 0 (silence) and 1 (full volume).","name":"volume","type":{"names":["number"]},"defaultvalue":"1","fires":["Phaser.Sound.Events#event:VOLUME"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#volume","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":657,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the volume of this Sound.","kind":"function","name":"setVolume","fires":["Phaser.Sound.Events#event:VOLUME"],"since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The volume of the sound.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#setVolume","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":675,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Rate at which this Sound will be played.\nValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","name":"rate","type":{"names":["number"]},"defaultvalue":"1","fires":["Phaser.Sound.Events#event:RATE"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#rate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":711,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the playback rate of this Sound.\n\nFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","kind":"function","name":"setRate","fires":["Phaser.Sound.Events#event:RATE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The playback rate at of this Sound.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"This Sound."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#setRate","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":732,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"The detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"detune","type":{"names":["number"]},"defaultvalue":"0","fires":["Phaser.Sound.Events#event:DETUNE"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#detune","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":767,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","kind":"function","name":"setDetune","fires":["Phaser.Sound.Events#event:DETUNE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"This Sound."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#setDetune","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":786,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Property representing the position of playback for this sound, in seconds.\nSetting it to a specific value moves current playback to that position.\nThe value given is clamped to the range 0 to current marker duration.\nSetting seek of a stopped sound has no effect.","name":"seek","type":{"names":["number"]},"fires":["Phaser.Sound.Events#event:SEEK"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#seek","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":846,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Seeks to a specific point in this sound.","kind":"function","name":"setSeek","fires":["Phaser.Sound.Events#event:SEEK"],"since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The point in the sound to seek to.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#setSeek","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":864,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Flag indicating whether or not the sound or current sound marker will loop.","name":"loop","type":{"names":["boolean"]},"defaultvalue":"false","fires":["Phaser.Sound.Events#event:LOOP"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#loop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":899,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the loop state of this Sound.","kind":"function","name":"setLoop","fires":["Phaser.Sound.Events#event:LOOP"],"since":"3.4.0","params":[{"type":{"names":["boolean"]},"description":"`true` to loop this sound, `false` to not loop it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#setLoop","scope":"instance","___s":true},{"meta":{"range":[266,315],"filename":"HTML5AudioSoundManager.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"name":"BaseSoundManager","longname":"BaseSoundManager","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[982,12710],"filename":"HTML5AudioSoundManager.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"HTML5 Audio implementation of the Sound Manager.\n\nNote: To play multiple instances of the same HTML5 Audio sound, you need to provide an `instances` value when\nloading the sound with the Loader:\n\n```javascript\nthis.load.audio('explosion', 'explosion.mp3', {\n instances: 2\n});\n```","kind":"class","classdesc":"HTML5AudioSoundManager","augments":["Phaser.Sound.BaseSoundManager"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"Reference to the current game instance.","name":"game"}],"name":"HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager","scope":"static","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Flag indicating whether if there are no idle instances of HTML5 Audio tag,\nfor any particular sound, if one of the used tags should be hijacked and used\nfor succeeding playback or if succeeding Phaser.Sound.HTML5AudioSound#play\ncall should be ignored.","name":"override","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#override","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Value representing time difference, in seconds, between calling\nplay method on an audio tag and when it actually starts playing.\nIt is used to achieve more accurate delayed sound playback.\n\nYou might need to tweak this value to get the desired results\nsince audio play delay varies depending on the browser/platform.","name":"audioPlayDelay","type":{"names":["number"]},"defaultvalue":"0.1","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#audioPlayDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"A value by which we should offset the loop end marker of the\nlooping sound to compensate for lag, caused by changing audio\ntag playback position, in order to achieve gapless looping.\n\nYou might need to tweak this value to get the desired results\nsince loop lag varies depending on the browser/platform.","name":"loopEndOffset","type":{"names":["number"]},"defaultvalue":"0.05","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#loopEndOffset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":138,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Adds a new sound into the sound manager.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"The new sound instance."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#add","scope":"instance","overrides":"Phaser.Sound.BaseSoundManager#add","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Unlocks HTML5 Audio loading and playback on mobile\ndevices on the initial explicit user interaction.","kind":"function","name":"unlock","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#unlock","scope":"instance","overrides":"Phaser.Sound.BaseSoundManager#unlock","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Calls Phaser.Sound.BaseSoundManager#destroy method\nand cleans up all HTML5 Audio related stuff.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#destroy","scope":"instance","overrides":"Phaser.Sound.BaseSoundManager#destroy","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the muted state of all this Sound Manager.","kind":"function","name":"setMute","fires":["Phaser.Sound.Events#event:GLOBAL_MUTE"],"since":"3.3.0","params":[{"type":{"names":["boolean"]},"description":"`true` to mute all sounds, `false` to unmute them.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#setMute","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"name":"mute","type":{"names":["boolean"]},"fires":["Phaser.Sound.Events#event:GLOBAL_MUTE"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#mute","scope":"instance","kind":"member","overrides":"Phaser.Sound.BaseSoundManager#mute","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":412,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the volume of this Sound Manager.","kind":"function","name":"setVolume","fires":["Phaser.Sound.Events#event:GLOBAL_VOLUME"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The global volume of this Sound Manager.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#setVolume","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"name":"volume","type":{"names":["number"]},"fires":["Phaser.Sound.Events#event:GLOBAL_VOLUME"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#volume","scope":"instance","kind":"member","overrides":"Phaser.Sound.BaseSoundManager#volume","___s":true},{"meta":{"filename":"index.js","lineno":8,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"kind":"namespace","name":"Sound","memberof":"Phaser","longname":"Phaser.Sound","scope":"static","___s":true},{"meta":{"range":[266,301],"filename":"NoAudioSound.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/noaudio"},"name":"BaseSound","longname":"BaseSound","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NoAudioSound.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/noaudio"},"classdesc":"No audio implementation of the sound. It is used if audio has been\ndisabled in the game config or the device doesn't support any audio.\n\nIt represents a graceful degradation of sound logic that provides\nminimal functionality and prevents Phaser projects that use audio from\nbreaking on devices that don't support any audio playback technologies.","kind":"class","name":"NoAudioSound","augments":["Phaser.Sound.BaseSound"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"Reference to the current sound manager instance.","name":"manager"},{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"{}","description":"An optional config object containing default sound settings.","name":"config"}],"scope":"static","longname":"Phaser.Sound.NoAudioSound","___s":true},{"meta":{"range":[266,315],"filename":"NoAudioSoundManager.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/noaudio"},"name":"BaseSoundManager","longname":"BaseSoundManager","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NoAudioSoundManager.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/noaudio"},"classdesc":"No audio implementation of the sound manager. It is used if audio has been\ndisabled in the game config or the device doesn't support any audio.\n\nIt represents a graceful degradation of sound manager logic that provides\nminimal functionality and prevents Phaser projects that use audio from\nbreaking on devices that don't support any audio playback technologies.","kind":"class","name":"NoAudioSoundManager","augments":["Phaser.Sound.BaseSoundManager"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"Reference to the current game instance.","name":"game"}],"scope":"static","longname":"Phaser.Sound.NoAudioSoundManager","___s":true},{"meta":{"filename":"AudioSpriteSound.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/typedefs"},"description":"Audio sprite sound type.","kind":"typedef","name":"AudioSpriteSound","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["object"]},"description":"Local reference to 'spritemap' object form json file generated by audiosprite tool.","name":"spritemap"}],"memberof":"Phaser.Types.Sound","longname":"Phaser.Types.Sound.AudioSpriteSound","scope":"static","___s":true},{"meta":{"filename":"DecodeAudioConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/typedefs"},"description":"A Audio Data object.\n\nYou can pass an array of these objects to the WebAudioSoundManager `decodeAudio` method to have it decode\nthem all at once.","kind":"typedef","name":"DecodeAudioConfig","type":{"names":["object"]},"since":"3.18.0","properties":[{"type":{"names":["string"]},"description":"The string-based key to be used to reference the decoded audio in the audio cache.","name":"key"},{"type":{"names":["ArrayBuffer","string"]},"description":"The audio data, either a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance.","name":"data"}],"memberof":"Phaser.Types.Sound","longname":"Phaser.Types.Sound.DecodeAudioConfig","scope":"static","___s":true},{"meta":{"filename":"EachActiveSoundCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/typedefs"},"kind":"typedef","name":"EachActiveSoundCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"The SoundManager","name":"manager"},{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The current active Sound","name":"sound"},{"type":{"names":["number"]},"description":"The index of the current active Sound","name":"index"},{"type":{"names":["Array."]},"description":"All sounds","name":"sounds"}],"memberof":"Phaser.Types.Sound","longname":"Phaser.Types.Sound.EachActiveSoundCallback","scope":"static","___s":true},{"meta":{"filename":"SoundConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/typedefs"},"description":"Config object containing various sound settings.","kind":"typedef","name":"SoundConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Boolean indicating whether the sound should be muted or not.","name":"mute"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A value between 0 (silence) and 1 (full volume).","name":"volume"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Defines the speed at which the sound should be played.","name":"rate"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Represents detuning of sound in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).","name":"detune"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Position of playback for this sound, in seconds.","name":"seek"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether or not the sound or current sound marker should loop.","name":"loop"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time, in seconds, that should elapse before the sound actually starts its playback.","name":"delay"}],"memberof":"Phaser.Types.Sound","longname":"Phaser.Types.Sound.SoundConfig","scope":"static","___s":true},{"meta":{"filename":"SoundMarker.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/typedefs"},"description":"Marked section of a sound represented by name, and optionally start time, duration, and config object.","kind":"typedef","name":"SoundMarker","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"Unique identifier of a sound marker.","name":"name"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sound position offset at witch playback should start.","name":"start"},{"type":{"names":["number"]},"optional":true,"description":"Playback duration of this marker.","name":"duration"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default marker settings.","name":"config"}],"memberof":"Phaser.Types.Sound","longname":"Phaser.Types.Sound.SoundMarker","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/typedefs"},"kind":"namespace","name":"Sound","memberof":"Phaser.Types","longname":"Phaser.Types.Sound","scope":"static","___s":true},{"meta":{"range":[266,301],"filename":"WebAudioSound.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"name":"BaseSound","longname":"BaseSound","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"classdesc":"Web Audio API implementation of the sound.","kind":"class","name":"WebAudioSound","augments":["Phaser.Sound.BaseSound"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"Reference to the current sound manager instance.","name":"manager"},{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"{}","description":"An optional config object containing default sound settings.","name":"config"}],"scope":"static","longname":"Phaser.Sound.WebAudioSound","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":177,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Play this sound, or a marked section of it.\n\nIt always plays the sound from the start. If you want to start playback from a specific time\nyou can set 'seek' setting of the config object, provided to this call, to that value.","kind":"function","name":"play","fires":["Phaser.Sound.Events#event:PLAY"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"''","description":"If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.","name":"markerName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#play","scope":"instance","overrides":"Phaser.Sound.BaseSound#play","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Pauses the sound.","kind":"function","name":"pause","fires":["Phaser.Sound.Events#event:PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was paused successfully."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#pause","scope":"instance","overrides":"Phaser.Sound.BaseSound#pause","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Resumes the sound.","kind":"function","name":"resume","fires":["Phaser.Sound.Events#event:RESUME"],"since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was resumed successfully."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#resume","scope":"instance","overrides":"Phaser.Sound.BaseSound#resume","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":267,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Stop playing this sound.","kind":"function","name":"stop","fires":["Phaser.Sound.Events#event:STOP"],"since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was stopped successfully."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#stop","scope":"instance","overrides":"Phaser.Sound.BaseSound#stop","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":479,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Calls Phaser.Sound.BaseSound#destroy method\nand cleans up all Web Audio API related stuff.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#destroy","scope":"instance","overrides":"Phaser.Sound.BaseSound#destroy","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":585,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Rate at which this Sound will be played.\nValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","name":"rate","type":{"names":["number"]},"defaultvalue":"1","fires":["Phaser.Sound.Events#event:RATE"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#rate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":614,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the playback rate of this Sound.\n\nFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","kind":"function","name":"setRate","fires":["Phaser.Sound.Events#event:RATE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The playback rate at of this Sound.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"This Sound."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#setRate","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":635,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"The detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"detune","type":{"names":["number"]},"defaultvalue":"0","fires":["Phaser.Sound.Events#event:DETUNE"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#detune","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":663,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","kind":"function","name":"setDetune","fires":["Phaser.Sound.Events#event:DETUNE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"This Sound."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#setDetune","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":682,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Boolean indicating whether the sound is muted or not.\nGets or sets the muted state of this sound.","name":"mute","type":{"names":["boolean"]},"defaultvalue":"false","fires":["Phaser.Sound.Events#event:MUTE"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#mute","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":709,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the muted state of this Sound.","kind":"function","name":"setMute","fires":["Phaser.Sound.Events#event:MUTE"],"since":"3.4.0","params":[{"type":{"names":["boolean"]},"description":"`true` to mute this sound, `false` to unmute it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#setMute","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":727,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Gets or sets the volume of this sound, a value between 0 (silence) and 1 (full volume).","name":"volume","type":{"names":["number"]},"defaultvalue":"1","fires":["Phaser.Sound.Events#event:VOLUME"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#volume","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":752,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the volume of this Sound.","kind":"function","name":"setVolume","fires":["Phaser.Sound.Events#event:VOLUME"],"since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The volume of the sound.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#setVolume","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":770,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Property representing the position of playback for this sound, in seconds.\nSetting it to a specific value moves current playback to that position.\nThe value given is clamped to the range 0 to current marker duration.\nSetting seek of a stopped sound has no effect.","name":"seek","type":{"names":["number"]},"fires":["Phaser.Sound.Events#event:SEEK"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#seek","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":828,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Seeks to a specific point in this sound.","kind":"function","name":"setSeek","fires":["Phaser.Sound.Events#event:SEEK"],"since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The point in the sound to seek to.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#setSeek","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":846,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Flag indicating whether or not the sound or current sound marker will loop.","name":"loop","type":{"names":["boolean"]},"defaultvalue":"false","fires":["Phaser.Sound.Events#event:LOOP"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#loop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":880,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the loop state of this Sound.","kind":"function","name":"setLoop","fires":["Phaser.Sound.Events#event:LOOP"],"since":"3.4.0","params":[{"type":{"names":["boolean"]},"description":"`true` to loop this sound, `false` to not loop it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#setLoop","scope":"instance","___s":true},{"meta":{"range":[266,337],"filename":"WebAudioSoundManager.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"name":"Base64ToArrayBuffer","longname":"Base64ToArrayBuffer","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"classdesc":"Web Audio API implementation of the sound manager.","kind":"class","name":"WebAudioSoundManager","augments":["Phaser.Sound.BaseSoundManager"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"Reference to the current game instance.","name":"game"}],"scope":"static","longname":"Phaser.Sound.WebAudioSoundManager","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"This method takes a new AudioContext reference and then sets\nthis Sound Manager to use that context for all playback.\n\nAs part of this call it also disconnects the master mute and volume\nnodes and then re-creates them on the new given context.","kind":"function","name":"setAudioContext","since":"3.21.0","params":[{"type":{"names":["AudioContext"]},"description":"Reference to an already created AudioContext instance.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"The WebAudioSoundManager instance."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#setAudioContext","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":161,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Adds a new sound into the sound manager.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"The new sound instance."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#add","scope":"instance","overrides":"Phaser.Sound.BaseSoundManager#add","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Decode audio data into a format ready for playback via Web Audio.\n\nThe audio data can be a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance.\n\nThe `audioKey` is the key that will be used to save the decoded audio to the audio cache.\n\nInstead of passing a single entry you can instead pass an array of `Phaser.Types.Sound.DecodeAudioConfig`\nobjects as the first and only argument.\n\nDecoding is an async process, so be sure to listen for the events to know when decoding has completed.\n\nOnce the audio has decoded it can be added to the Sound Manager or played via its key.","kind":"function","name":"decodeAudio","fires":["Phaser.Sound.Events#event:DECODED","Phaser.Sound.Events#event:DECODED_ALL"],"since":"3.18.0","params":[{"type":{"names":["Array.","string"]},"optional":true,"description":"The string-based key to be used to reference the decoded audio in the audio cache, or an array of audio config objects.","name":"audioKey"},{"type":{"names":["ArrayBuffer","string"]},"optional":true,"description":"The audio data, either a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance.","name":"audioData"}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#decodeAudio","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":262,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Unlocks Web Audio API on the initial input event.\n\nRead more about how this issue is handled here in [this article](https://medium.com/@pgoloskokovic/unlocking-web-audio-the-smarter-way-8858218c0e09).","kind":"function","name":"unlock","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#unlock","scope":"instance","overrides":"Phaser.Sound.BaseSoundManager#unlock","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":339,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Calls Phaser.Sound.BaseSoundManager#destroy method\nand cleans up all Web Audio API related stuff.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#destroy","scope":"instance","overrides":"Phaser.Sound.BaseSoundManager#destroy","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":371,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the muted state of all this Sound Manager.","kind":"function","name":"setMute","fires":["Phaser.Sound.Events#event:GLOBAL_MUTE"],"since":"3.3.0","params":[{"type":{"names":["boolean"]},"description":"`true` to mute all sounds, `false` to unmute them.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#setMute","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":389,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"name":"mute","type":{"names":["boolean"]},"fires":["Phaser.Sound.Events#event:GLOBAL_MUTE"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#mute","scope":"instance","kind":"member","overrides":"Phaser.Sound.BaseSoundManager#mute","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the volume of this Sound Manager.","kind":"function","name":"setVolume","fires":["Phaser.Sound.Events#event:GLOBAL_VOLUME"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The global volume of this Sound Manager.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#setVolume","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":429,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"name":"volume","type":{"names":["number"]},"fires":["Phaser.Sound.Events#event:GLOBAL_VOLUME"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#volume","scope":"instance","kind":"member","overrides":"Phaser.Sound.BaseSoundManager#volume","___s":true},{"meta":{"range":[180,218],"filename":"List.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"name":"ArrayUtils","longname":"ArrayUtils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"List.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"kind":"typedef","name":"EachListCallback","type":{"names":["function"]},"params":[{"type":{"names":["I"]},"description":"The item which is currently being processed.","name":"item"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"longname":"EachListCallback","scope":"global","___s":true},{"meta":{"filename":"List.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"classdesc":"List is a generic implementation of an ordered list which contains utility methods for retrieving, manipulating, and iterating items.","kind":"class","name":"List","memberof":"Phaser.Structs","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The parent of this list.","name":"parent"}],"scope":"static","longname":"Phaser.Structs.List","___s":true},{"meta":{"filename":"List.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The parent of this list.","name":"parent","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The objects that belong to this collection.","name":"list","type":{"names":["Array.<*>"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#list","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The index of the current element.\n\nThis is used internally when iterating through the list with the {@link #first}, {@link #last}, {@link #get}, and {@link #previous} properties.","name":"position","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#position","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"A callback that is invoked every time a child is added to this list.","name":"addCallback","type":{"names":["function"]},"since":"3.4.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#addCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"A callback that is invoked every time a child is removed from this list.","name":"removeCallback","type":{"names":["function"]},"since":"3.4.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#removeCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The property key to sort by.","name":"_sortKey","type":{"names":["string"]},"since":"3.4.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#_sortKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":99,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Adds the given item to the end of the list. Each item must be unique.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["*","Array.<*>"]},"description":"The item, or array of items, to add to the list.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip calling the List.addCallback if this child is added successfully.","name":"skipCallback"}],"returns":[{"type":{"names":["*"]},"description":"The list's underlying array."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#add","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":124,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Adds an item to list, starting at a specified index. Each item must be unique within the list.","kind":"function","name":"addAt","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item, or array of items, to add to the list.","name":"child"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The index in the list at which the element(s) will be inserted.","name":"index"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip calling the List.addCallback if this child is added successfully.","name":"skipCallback"}],"returns":[{"type":{"names":["*"]},"description":"The List's underlying array."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#addAt","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":150,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Retrieves the item at a given position inside the List.","kind":"function","name":"getAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the item.","name":"index"}],"returns":[{"type":{"names":["*"]},"description":"The retrieved item, or `undefined` if it's outside the List's bounds."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#getAt","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Locates an item within the List and returns its index.","kind":"function","name":"getIndex","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to locate.","name":"child"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the item within the List, or -1 if it's not in the List."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#getIndex","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sort the contents of this List so the items are in order based on the given property.\nFor example, `sort('alpha')` would sort the List contents based on the value of their `alpha` property.","kind":"function","name":"sort","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The property to lexically sort by.","name":"property"},{"type":{"names":["function"]},"optional":true,"description":"Provide your own custom handler function. Will receive 2 children which it should compare and return a boolean.","name":"handler"}],"returns":[{"type":{"names":["Phaser.Structs.List"]},"description":"This List object."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#sort","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":219,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Searches for the first instance of a child with its `name`\nproperty matching the given argument. Should more than one child have\nthe same name only the first is returned.","kind":"function","name":"getByName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to search for.","name":"name"}],"returns":[{"type":{"names":["*"]},"nullable":true,"description":"The first child with a matching name, or null if none were found."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#getByName","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns a random child from the group.","kind":"function","name":"getRandom","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Offset from the front of the group (lowest child).","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"(to top)","description":"Restriction on the number of values you want to randomly select from.","name":"length"}],"returns":[{"type":{"names":["*"]},"nullable":true,"description":"A random child of this Group."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#getRandom","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns the first element in a given part of the List which matches a specific criterion.","kind":"function","name":"getFirst","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the property to test or a falsey value to have no criterion.","name":"property"},{"type":{"names":["*"]},"description":"The value to test the `property` against, or `undefined` to allow any value and only check for existence.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The position in the List to start the search at.","name":"startIndex"},{"type":{"names":["number"]},"optional":true,"description":"The position in the List to optionally stop the search at. It won't be checked.","name":"endIndex"}],"returns":[{"type":{"names":["*"]},"nullable":true,"description":"The first item which matches the given criterion, or `null` if no such item exists."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#getFirst","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":276,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns all children in this List.\n\nYou can optionally specify a matching criteria using the `property` and `value` arguments.\n\nFor example: `getAll('parent')` would return only children that have a property called `parent`.\n\nYou can also specify a value to compare the property to:\n\n`getAll('visible', true)` would return only children that have their visible property set to `true`.\n\nOptionally you can specify a start and end index. For example if this List had 100 children,\nand you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\nthe first 50 children in the List.","kind":"function","name":"getAll","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"An optional property to test against the value argument.","name":"property"},{"type":{"names":["*"]},"optional":true,"description":"If property is set then Child.property must strictly equal this value to be included in the results.","name":"value"},{"type":{"names":["integer"]},"optional":true,"description":"The first child index to start the search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"The last child index to search up until.","name":"endIndex"}],"returns":[{"type":{"names":["Array.<*>"]},"description":"All items of the List which match the given criterion, if any."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#getAll","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":309,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns the total number of items in the List which have a property matching the given value.","kind":"function","name":"count","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The property to test on each item.","name":"property"},{"type":{"names":["*"]},"description":"The value to test the property against.","name":"value"}],"returns":[{"type":{"names":["integer"]},"description":"The total number of matching elements."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#count","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":327,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Swaps the positions of two items in the list.","kind":"function","name":"swap","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The first item to swap.","name":"child1"},{"type":{"names":["*"]},"description":"The second item to swap.","name":"child2"}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#swap","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":343,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Moves an item in the List to a new position.","kind":"function","name":"moveTo","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to move.","name":"child"},{"type":{"names":["integer"]},"description":"Moves an item in the List to a new position.","name":"index"}],"returns":[{"type":{"names":["*"]},"description":"The item that was moved."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#moveTo","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":361,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes one or many items from the List.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item, or array of items, to remove.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip calling the List.removeCallback.","name":"skipCallback"}],"returns":[{"type":{"names":["*"]},"description":"The item, or array of items, which were successfully removed from the List."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#remove","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":386,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes the item at the given position in the List.","kind":"function","name":"removeAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The position to remove the item from.","name":"index"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip calling the List.removeCallback.","name":"skipCallback"}],"returns":[{"type":{"names":["*"]},"description":"The item that was removed."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#removeAt","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes the items within the given range in the List.","kind":"function","name":"removeBetween","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The index to start removing from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"The position to stop removing at. The item at this position won't be removed.","name":"endIndex"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip calling the List.removeCallback.","name":"skipCallback"}],"returns":[{"type":{"names":["Array.<*>"]},"description":"An array of the items which were removed."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#removeBetween","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":437,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes all the items.","kind":"function","name":"removeAll","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip calling the List.removeCallback.","name":"skipCallback"}],"returns":[{"type":{"names":["Phaser.Structs.List"]},"description":"This List object."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#removeAll","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":461,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Brings the given child to the top of this List.","kind":"function","name":"bringToTop","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to bring to the top of the List.","name":"child"}],"returns":[{"type":{"names":["*"]},"description":"The item which was moved."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#bringToTop","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":478,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sends the given child to the bottom of this List.","kind":"function","name":"sendToBack","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to send to the back of the list.","name":"child"}],"returns":[{"type":{"names":["*"]},"description":"The item which was moved."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#sendToBack","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":495,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Moves the given child up one place in this group unless it's already at the top.","kind":"function","name":"moveUp","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to move up.","name":"child"}],"returns":[{"type":{"names":["*"]},"description":"The item which was moved."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#moveUp","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":514,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Moves the given child down one place in this group unless it's already at the bottom.","kind":"function","name":"moveDown","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to move down.","name":"child"}],"returns":[{"type":{"names":["*"]},"description":"The item which was moved."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#moveDown","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":533,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Reverses the order of all children in this List.","kind":"function","name":"reverse","since":"3.0.0","returns":[{"type":{"names":["Phaser.Structs.List"]},"description":"This List object."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#reverse","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":550,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Shuffles the items in the list.","kind":"function","name":"shuffle","since":"3.0.0","returns":[{"type":{"names":["Phaser.Structs.List"]},"description":"This List object."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#shuffle","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":567,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Replaces a child of this List with the given newChild. The newChild cannot be a member of this List.","kind":"function","name":"replace","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The child in this List that will be replaced.","name":"oldChild"},{"type":{"names":["*"]},"description":"The child to be inserted into this List.","name":"newChild"}],"returns":[{"type":{"names":["*"]},"description":"Returns the oldChild that was replaced within this group."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#replace","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":585,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Checks if an item exists within the List.","kind":"function","name":"exists","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to check for the existence of.","name":"child"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the item is found in the list, otherwise `false`."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#exists","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":602,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets the property `key` to the given value on all members of this List.","kind":"function","name":"setAll","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the property to set.","name":"property"},{"type":{"names":["*"]},"description":"The value to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"description":"The first child index to start the search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"The last child index to search up until.","name":"endIndex"}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#setAll","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":622,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Passes all children to the given callback.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["EachListCallback"]},"description":"The function to call.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"Value to use as `this` when executing callback.","name":"context"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#each","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":651,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Clears the List and recreates its internal array.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#shutdown","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":664,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Destroys this List.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#destroy","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":679,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The number of items inside the List.","name":"length","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#length","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":696,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The first item in the List or `null` for an empty List.","name":"first","type":{"names":["*"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#first","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The last item in the List, or `null` for an empty List.","name":"last","type":{"names":["*"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#last","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":750,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The next item in the List, or `null` if the entire List has been traversed.\n\nThis property can be read successively after reading {@link #first} or manually setting the {@link #position} to iterate the List.","name":"next","type":{"names":["*"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#next","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":779,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The previous item in the List, or `null` if the entire List has been traversed.\n\nThis property can be read successively after reading {@link #last} or manually setting the {@link #position} to iterate the List backwards.","name":"previous","type":{"names":["*"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#previous","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,213],"filename":"Map.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Map.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"kind":"typedef","name":"EachMapCallback","type":{"names":["function"]},"params":[{"type":{"names":["string"]},"description":"The key of the Map entry.","name":"key"},{"type":{"names":["E"]},"description":"The value of the Map entry.","name":"entry"}],"returns":[{"type":{"names":["boolean"]},"nullable":true,"description":"The callback result."}],"longname":"EachMapCallback","scope":"global","___s":true},{"meta":{"filename":"Map.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"classdesc":"The keys of a Map can be arbitrary values.\n\n```javascript\nvar map = new Map([\n [ 1, 'one' ],\n [ 2, 'two' ],\n [ 3, 'three' ]\n]);\n```","kind":"class","name":"Map","memberof":"Phaser.Structs","since":"3.0.0","params":[{"type":{"names":["Array.<*>"]},"description":"An optional array of key-value pairs to populate this Map with.","name":"elements"}],"scope":"static","longname":"Phaser.Structs.Map","___s":true},{"meta":{"filename":"Map.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The entries in this Map.","name":"entries","type":{"names":["Object."]},"defaultvalue":"{}","since":"3.0.0","memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#entries","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Map.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The number of key / value pairs in this Map.","name":"size","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#size","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Map.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Adds an element with a specified `key` and `value` to this Map.\nIf the `key` already exists, the value will be replaced.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the element to be added to this Map.","name":"key"},{"type":{"names":["*"]},"description":"The value of the element to be added to this Map.","name":"value"}],"returns":[{"type":{"names":["Phaser.Structs.Map"]},"description":"This Map object."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#set","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns the value associated to the `key`, or `undefined` if there is none.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the element to return from the `Map` object.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The element associated with the specified key or `undefined` if the key can't be found in this Map object."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#get","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns an `Array` of all the values stored in this Map.","kind":"function","name":"getArray","since":"3.0.0","returns":[{"type":{"names":["Array.<*>"]},"description":"An array of the values stored in this Map."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#getArray","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":150,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns a boolean indicating whether an element with the specified key exists or not.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the element to test for presence of in this Map.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if an element with the specified key exists in this Map, otherwise `false`."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#has","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Delete the specified element from this Map.","kind":"function","name":"delete","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the element to delete from this Map.","name":"key"}],"returns":[{"type":{"names":["Phaser.Structs.Map"]},"description":"This Map object."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#delete","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Delete all entries from this Map.","kind":"function","name":"clear","since":"3.0.0","returns":[{"type":{"names":["Phaser.Structs.Map"]},"description":"This Map object."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#clear","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":214,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns all entries keys in this Map.","kind":"function","name":"keys","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"Array containing entries' keys."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#keys","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns an `Array` of all entries.","kind":"function","name":"values","since":"3.0.0","returns":[{"type":{"names":["Array.<*>"]},"description":"An `Array` of entries."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#values","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Dumps the contents of this Map to the console via `console.group`.","kind":"function","name":"dump","since":"3.0.0","memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#dump","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Passes all entries in this Map to the given callback.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["EachMapCallback"]},"description":"The callback which will receive the keys and entries held in this Map.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Structs.Map"]},"description":"This Map object."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#each","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":302,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns `true` if the value exists within this Map. Otherwise, returns `false`.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The value to search for.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the value is found, otherwise `false`."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#contains","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":329,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Merges all new keys from the given Map into this one.\nIf it encounters a key that already exists it will be skipped unless override is set to `true`.","kind":"function","name":"merge","since":"3.0.0","params":[{"type":{"names":["Phaser.Structs.Map"]},"description":"The Map to merge in to this Map.","name":"map"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Set to `true` to replace values in this Map with those from the source map, or `false` to skip them.","name":"override"}],"returns":[{"type":{"names":["Phaser.Structs.Map"]},"description":"This Map object."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#merge","scope":"instance","___s":true},{"meta":{"range":[180,213],"filename":"ProcessQueue.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"classdesc":"A Process Queue maintains three internal lists.\n\nThe `pending` list is a selection of items which are due to be made 'active' in the next update.\nThe `active` list is a selection of items which are considered active and should be updated.\nThe `destroy` list is a selection of items that were active and are awaiting being destroyed in the next update.\n\nWhen new items are added to a Process Queue they are put in the pending list, rather than being added\nimmediately the active list. Equally, items that are removed are put into the destroy list, rather than\nbeing destroyed immediately. This allows the Process Queue to carefully process each item at a specific, fixed\ntime, rather than at the time of the request from the API.","kind":"class","name":"ProcessQueue","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Structs","since":"3.0.0","scope":"static","longname":"Phaser.Structs.ProcessQueue","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Adds a new item to the Process Queue.\n\nThe item is added to the pending list and made active in the next update.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to add to the queue.","name":"item"}],"returns":[{"type":{"names":["*"]},"description":"The item that was added."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#add","scope":"instance","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes an item from the Process Queue.\n\nThe item is added to the pending destroy and fully removed in the next update.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to be removed from the queue.","name":"item"}],"returns":[{"type":{"names":["*"]},"description":"The item that was removed."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#remove","scope":"instance","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":141,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes all active items from this Process Queue.\n\nAll the items are marked as 'pending destroy' and fully removed in the next update.","kind":"function","name":"removeAll","since":"3.20.0","returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"This Process Queue object."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#removeAll","scope":"instance","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Update this queue. First it will process any items awaiting destruction, and remove them.\n\nThen it will check to see if there are any items pending insertion, and move them to an\nactive state. Finally, it will return a list of active items for further processing.","kind":"function","name":"update","since":"3.0.0","returns":[{"type":{"names":["Array.<*>"]},"description":"A list of active items."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#update","scope":"instance","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":233,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns the current list of active items.\n\nThis method returns a reference to the active list array, not a copy of it.\nTherefore, be careful to not modify this array outside of the ProcessQueue.","kind":"function","name":"getActive","since":"3.0.0","returns":[{"type":{"names":["Array.<*>"]},"description":"A list of active items."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#getActive","scope":"instance","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":251,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The number of entries in the active list.","name":"length","type":{"names":["integer"]},"readonly":true,"since":"3.20.0","memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#length","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Immediately destroys this process queue, clearing all of its internal arrays and resetting the process totals.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"range":[216,267],"filename":"RTree.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"name":"quickselect","longname":"quickselect","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RTree.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"classdesc":"RBush is a high-performance JavaScript library for 2D spatial indexing of points and rectangles.\nIt's based on an optimized R-tree data structure with bulk insertion support.\n\nSpatial index is a special data structure for points and rectangles that allows you to perform queries like\n\"all items within this bounding box\" very efficiently (e.g. hundreds of times faster than looping over all items).\n\nThis version of RBush uses a fixed min/max accessor structure of `[ '.left', '.top', '.right', '.bottom' ]`.\nThis is to avoid the eval like function creation that the original library used, which caused CSP policy violations.\n\nrbush is forked from https://github.com/mourner/rbush by Vladimir Agafonkin","kind":"class","name":"RTree","memberof":"Phaser.Structs","since":"3.0.0","scope":"static","longname":"Phaser.Structs.RTree","___s":true},{"meta":{"range":[180,213],"filename":"Set.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Set.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"kind":"typedef","name":"EachSetCallback","type":{"names":["function"]},"params":[{"type":{"names":["E"]},"description":"The Set entry.","name":"entry"},{"type":{"names":["number"]},"description":"The index of the entry within the Set.","name":"index"}],"returns":[{"type":{"names":["boolean"]},"nullable":true,"description":"The callback result."}],"longname":"EachSetCallback","scope":"global","___s":true},{"meta":{"filename":"Set.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"classdesc":"A Set is a collection of unique elements.","kind":"class","name":"Set","memberof":"Phaser.Structs","since":"3.0.0","params":[{"type":{"names":["Array.<*>"]},"optional":true,"description":"An optional array of elements to insert into this Set.","name":"elements"}],"scope":"static","longname":"Phaser.Structs.Set","___s":true},{"meta":{"filename":"Set.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The entries of this Set. Stored internally as an array.","name":"entries","type":{"names":["Array.<*>"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#entries","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Set.js","lineno":59,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Inserts the provided value into this Set. If the value is already contained in this Set this method will have no effect.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The value to insert into this Set.","name":"value"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"This Set object."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#set","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Get an element of this Set which has a property of the specified name, if that property is equal to the specified value.\nIf no elements of this Set satisfy the condition then this method will return `null`.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The property name to check on the elements of this Set.","name":"property"},{"type":{"names":["*"]},"description":"The value to check for.","name":"value"}],"returns":[{"type":{"names":["*"]},"description":"The first element of this Set that meets the required condition, or `null` if this Set contains no elements that meet the condition."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#get","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns an array containing all the values in this Set.","kind":"function","name":"getArray","since":"3.0.0","returns":[{"type":{"names":["Array.<*>"]},"description":"An array containing all the values in this Set."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#getArray","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":124,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes the given value from this Set if this Set contains that value.","kind":"function","name":"delete","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The value to remove from the Set.","name":"value"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"This Set object."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#delete","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Dumps the contents of this Set to the console via `console.group`.","kind":"function","name":"dump","since":"3.0.0","memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#dump","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Passes each value in this Set to the given callback.\nUse this function when you know this Set will be modified during the iteration, otherwise use `iterate`.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["EachSetCallback"]},"description":"The callback to be invoked and passed each value this Set contains.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"The scope of the callback.","name":"callbackScope"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"This Set object."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#each","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Passes each value in this Set to the given callback.\nFor when you absolutely know this Set won't be modified during the iteration.","kind":"function","name":"iterate","since":"3.0.0","params":[{"type":{"names":["EachSetCallback"]},"description":"The callback to be invoked and passed each value this Set contains.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"The scope of the callback.","name":"callbackScope"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"This Set object."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#iterate","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Goes through each entry in this Set and invokes the given function on them, passing in the arguments.","kind":"function","name":"iterateLocal","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the function to be invoked on each Set entry.","name":"callbackKey"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"This Set object."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#iterateLocal","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":294,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Clears this Set so that it no longer contains any values.","kind":"function","name":"clear","since":"3.0.0","returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"This Set object."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#clear","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":311,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns `true` if this Set contains the given value, otherwise returns `false`.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The value to check for in this Set.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the given value was found in this Set, otherwise `false`."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#contains","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":328,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns a new Set containing all values that are either in this Set or in the Set provided as an argument.","kind":"function","name":"union","since":"3.0.0","params":[{"type":{"names":["Phaser.Structs.Set"]},"description":"The Set to perform the union with.","name":"set"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"A new Set containing all the values in this Set and the Set provided as an argument."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#union","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":357,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns a new Set that contains only the values which are in this Set and that are also in the given Set.","kind":"function","name":"intersect","since":"3.0.0","params":[{"type":{"names":["Phaser.Structs.Set"]},"description":"The Set to intersect this set with.","name":"set"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"The result of the intersection, as a new Set."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#intersect","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns a new Set containing all the values in this Set which are *not* also in the given Set.","kind":"function","name":"difference","since":"3.0.0","params":[{"type":{"names":["Phaser.Structs.Set"]},"description":"The Set to perform the difference with.","name":"set"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"A new Set containing all the values in this Set that are not also in the Set provided as an argument to this method."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#difference","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The size of this Set. This is the number of entries within it.\nChanging the size will truncate the Set if the given value is smaller than the current size.\nIncreasing the size larger than the current size has no effect.","name":"size","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#size","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,212],"filename":"Size.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Size.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"classdesc":"The Size component allows you to set `width` and `height` properties and define the relationship between them.\n\nThe component can automatically maintain the aspect ratios between the two values, and clamp them\nto a defined min-max range. You can also control the dominant axis. When dimensions are given to the Size component\nthat would cause it to exceed its min-max range, the dimensions are adjusted based on the dominant axis.","kind":"class","name":"Size","memberof":"Phaser.Structs","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height of the Size component. If not given, it will use the `width`.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The aspect mode of the Size component. Defaults to 0, no mode.","name":"aspectMode"},{"type":{"names":["any"]},"optional":true,"defaultvalue":null,"description":"The parent of this Size component. Can be any object with public `width` and `height` properties. Dimensions are clamped to keep them within the parent bounds where possible.","name":"parent"}],"scope":"static","longname":"Phaser.Structs.Size","___s":true},{"meta":{"filename":"Size.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The aspect mode this Size component will use when calculating its dimensions.\nThis property is read-only. To change it use the `setAspectMode` method.","name":"aspectMode","type":{"names":["integer"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#aspectMode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The proportional relationship between the width and height.\n\nThis property is read-only and is updated automatically when either the `width` or `height` properties are changed,\ndepending on the aspect mode.","name":"aspectRatio","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#aspectRatio","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The minimum allowed width.\nCannot be less than zero.\nThis value is read-only. To change it see the `setMin` method.","name":"minWidth","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#minWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The minimum allowed height.\nCannot be less than zero.\nThis value is read-only. To change it see the `setMin` method.","name":"minHeight","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#minHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The maximum allowed width.\nThis value is read-only. To change it see the `setMax` method.","name":"maxWidth","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#maxWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The maximum allowed height.\nThis value is read-only. To change it see the `setMax` method.","name":"maxHeight","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#maxHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"A Vector2 containing the horizontal and vertical snap values, which the width and height are snapped to during resizing.\n\nBy default this is disabled.\n\nThis property is read-only. To change it see the `setSnap` method.","name":"snapTo","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#snapTo","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":156,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets the aspect mode of this Size component.\n\nThe aspect mode controls what happens when you modify the `width` or `height` properties, or call `setSize`.\n\nIt can be a number from 0 to 4, or a Size constant:\n\n0. NONE = Do not make the size fit the aspect ratio. Change the ratio when the size changes.\n1. WIDTH_CONTROLS_HEIGHT = The height is automatically adjusted based on the width.\n2. HEIGHT_CONTROLS_WIDTH = The width is automatically adjusted based on the height.\n3. FIT = The width and height are automatically adjusted to fit inside the given target area, while keeping the aspect ratio. Depending on the aspect ratio there may be some space inside the area which is not covered.\n4. ENVELOP = The width and height are automatically adjusted to make the size cover the entire target area while keeping the aspect ratio. This may extend further out than the target size.\n\nCalling this method automatically recalculates the `width` and the `height`, if required.","kind":"function","name":"setAspectMode","since":"3.16.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The aspect mode value.","name":"value"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setAspectMode","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":187,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"By setting a Snap To value when this Size component is modified its dimensions will automatically\nby snapped to the nearest grid slice, using floor. For example, if you have snap value of 16,\nand the width changes to 68, then it will snap down to 64 (the closest multiple of 16 when floored)\n\nNote that snapping takes place before adjustments by the parent, or the min / max settings. If these\nvalues are not multiples of the given snap values, then this can result in un-snapped dimensions.\n\nCall this method with no arguments to reset the snap values.\n\nCalling this method automatically recalculates the `width` and the `height`, if required.","kind":"function","name":"setSnap","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The amount to snap the width to. If you don't want to snap the width, pass a value of zero.","name":"snapWidth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"snapWidth","description":"The amount to snap the height to. If not provided it will use the `snapWidth` value. If you don't want to snap the height, pass a value of zero.","name":"snapHeight"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setSnap","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":217,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets, or clears, the parent of this Size component.\n\nTo clear the parent call this method with no arguments.\n\nThe parent influences the maximum extents to which this Size component can expand,\nbased on the aspect mode:\n\nNONE - The parent clamps both the width and height.\nWIDTH_CONTROLS_HEIGHT - The parent clamps just the width.\nHEIGHT_CONTROLS_WIDTH - The parent clamps just the height.\nFIT - The parent clamps whichever axis is required to ensure the size fits within it.\nENVELOP - The parent is used to ensure the size fully envelops the parent.\n\nCalling this method automatically calls `setSize`.","kind":"function","name":"setParent","since":"3.16.0","params":[{"type":{"names":["any"]},"optional":true,"description":"Sets the parent of this Size component. Don't provide a value to clear an existing parent.","name":"parent"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setParent","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":247,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Set the minimum width and height values this Size component will allow.\n\nThe minimum values can never be below zero, or greater than the maximum values.\n\nSetting this will automatically adjust both the `width` and `height` properties to ensure they are within range.\n\nNote that based on the aspect mode, and if this Size component has a parent set or not, the minimums set here\n_can_ be exceed in some situations.","kind":"function","name":"setMin","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The minimum allowed width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The minimum allowed height of the Size component. If not given, it will use the `width`.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setMin","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":276,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Set the maximum width and height values this Size component will allow.\n\nSetting this will automatically adjust both the `width` and `height` properties to ensure they are within range.\n\nNote that based on the aspect mode, and if this Size component has a parent set or not, the maximums set here\n_can_ be exceed in some situations.","kind":"function","name":"setMax","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":"Number.MAX_VALUE","description":"The maximum allowed width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The maximum allowed height of the Size component. If not given, it will use the `width`.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setMax","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":303,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets the width and height of this Size component based on the aspect mode.\n\nIf the aspect mode is 'none' then calling this method will change the aspect ratio, otherwise the current\naspect ratio is honored across all other modes.\n\nIf snapTo values have been set then the given width and height are snapped first, prior to any further\nadjustment via min/max values, or a parent.\n\nIf minimum and/or maximum dimensions have been specified, the values given to this method will be clamped into\nthat range prior to adjustment, but may still exceed them depending on the aspect mode.\n\nIf this Size component has a parent set, and the aspect mode is `fit` or `envelop`, then the given sizes will\nbe clamped to the range specified by the parent.","kind":"function","name":"setSize","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The new width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The new height of the Size component. If not given, it will use the `width`.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setSize","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":361,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets a new aspect ratio, overriding what was there previously.\n\nIt then calls `setSize` immediately using the current dimensions.","kind":"function","name":"setAspectRatio","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new aspect ratio.","name":"ratio"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setAspectRatio","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":380,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets a new width and height for this Size component and updates the aspect ratio based on them.\n\nIt _doesn't_ change the `aspectMode` and still factors in size limits such as the min max and parent bounds.","kind":"function","name":"resize","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The new height of the Size component. If not given, it will use the `width`.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#resize","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Takes a new width and passes it through the min/max clamp and then checks it doesn't exceed the parent width.","kind":"function","name":"getNewWidth","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The value to clamp and check.","name":"value"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Check the given value against the parent, if set.","name":"checkParent"}],"returns":[{"type":{"names":["number"]},"description":"The modified width value."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#getNewWidth","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":427,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Takes a new height and passes it through the min/max clamp and then checks it doesn't exceed the parent height.","kind":"function","name":"getNewHeight","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The value to clamp and check.","name":"value"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Check the given value against the parent, if set.","name":"checkParent"}],"returns":[{"type":{"names":["number"]},"description":"The modified height value."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#getNewHeight","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":452,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The current `width` and `height` are adjusted to fit inside the given dimensions, while keeping the aspect ratio.\n\nIf `fit` is true there may be some space inside the target area which is not covered if its aspect ratio differs.\nIf `fit` is false the size may extend further out than the target area if the aspect ratios differ.\n\nIf this Size component has a parent set, then the width and height passed to this method will be clamped so\nit cannot exceed that of the parent.","kind":"function","name":"constrain","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The new width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The new height of the Size component. If not given, it will use the width value.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Perform a `fit` (true) constraint, or an `envelop` (false) constraint.","name":"fit"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#constrain","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":521,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The current `width` and `height` are adjusted to fit inside the given dimensions, while keeping the aspect ratio.\n\nThere may be some space inside the target area which is not covered if its aspect ratio differs.\n\nIf this Size component has a parent set, then the width and height passed to this method will be clamped so\nit cannot exceed that of the parent.","kind":"function","name":"fitTo","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The new width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The new height of the Size component. If not given, it will use the width value.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#fitTo","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":542,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The current `width` and `height` are adjusted so that they fully envelope the given dimensions, while keeping the aspect ratio.\n\nThe size may extend further out than the target area if the aspect ratios differ.\n\nIf this Size component has a parent set, then the values are clamped so that it never exceeds the parent\non the longest axis.","kind":"function","name":"envelop","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The new width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The new height of the Size component. If not given, it will use the width value.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#envelop","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":563,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets the width of this Size component.\n\nDepending on the aspect mode, changing the width may also update the height and aspect ratio.","kind":"function","name":"setWidth","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new width of the Size component.","name":"width"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setWidth","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":580,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets the height of this Size component.\n\nDepending on the aspect mode, changing the height may also update the width and aspect ratio.","kind":"function","name":"setHeight","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new height of the Size component.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setHeight","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns a string representation of this Size component.","kind":"function","name":"toString","since":"3.16.0","returns":[{"type":{"names":["string"]},"description":"A string representation of this Size component."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#toString","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":610,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets the values of this Size component to the `element.style.width` and `height`\nproperties of the given DOM Element. The properties are set as `px` values.","kind":"function","name":"setCSS","since":"3.17.0","params":[{"type":{"names":["HTMLElement"]},"description":"The DOM Element to set the CSS style on.","name":"element"}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setCSS","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":628,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Copies the aspect mode, aspect ratio, width and height from this Size component\nto the given Size component. Note that the parent, if set, is not copied across.","kind":"function","name":"copy","since":"3.16.0","params":[{"type":{"names":["Phaser.Structs.Size"]},"description":"The Size component to copy the values to.","name":"destination"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"The updated destination Size component."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#copy","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":648,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Destroys this Size component.\n\nThis clears the local properties and any parent object, if set.\n\nA destroyed Size component cannot be re-used.","kind":"function","name":"destroy","since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#destroy","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":664,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The width of this Size component.\n\nThis value is clamped to the range specified by `minWidth` and `maxWidth`, if enabled.\n\nA width can never be less than zero.\n\nChanging this value will automatically update the `height` if the aspect ratio lock is enabled.\nYou can also use the `setWidth` and `getWidth` methods.","name":"width","type":{"names":["number"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":692,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The height of this Size component.\n\nThis value is clamped to the range specified by `minHeight` and `maxHeight`, if enabled.\n\nA height can never be less than zero.\n\nChanging this value will automatically update the `width` if the aspect ratio lock is enabled.\nYou can also use the `setHeight` and `getHeight` methods.","name":"height","type":{"names":["number"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":722,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Do not make the size fit the aspect ratio. Change the ratio when the size changes.","name":"NONE","kind":"constant","type":{"names":["integer"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size.NONE","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":732,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The height is automatically adjusted based on the width.","name":"WIDTH_CONTROLS_HEIGHT","kind":"constant","type":{"names":["integer"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size.WIDTH_CONTROLS_HEIGHT","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":742,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The width is automatically adjusted based on the height.","name":"HEIGHT_CONTROLS_WIDTH","kind":"constant","type":{"names":["integer"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size.HEIGHT_CONTROLS_WIDTH","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":752,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The width and height are automatically adjusted to fit inside the given target area, while keeping the aspect ratio. Depending on the aspect ratio there may be some space inside the area which is not covered.","name":"FIT","kind":"constant","type":{"names":["integer"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size.FIT","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":762,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The width and height are automatically adjusted to make the size cover the entire target area while keeping the aspect ratio. This may extend further out than the target size.","name":"ENVELOP","kind":"constant","type":{"names":["integer"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size.ENVELOP","scope":"static","___s":true},{"meta":{"filename":"PROCESS_QUEUE_ADD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs/events"},"description":"The Process Queue Add Event.\n\nThis event is dispatched by a Process Queue when a new item is successfully moved to its active list.\n\nYou will most commonly see this used by a Scene's Update List when a new Game Object has been added.\n\nIn that instance, listen to this event from within a Scene using: `this.sys.updateList.on('add', listener)`.","kind":"event","name":"PROCESS_QUEUE_ADD","since":"3.20.0","params":[{"type":{"names":["*"]},"description":"The item that was added to the Process Queue.","name":"item"}],"memberof":"Phaser.Structs.Events","longname":"Phaser.Structs.Events#event:PROCESS_QUEUE_ADD","scope":"instance","___s":true},{"meta":{"filename":"PROCESS_QUEUE_REMOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs/events"},"description":"The Process Queue Remove Event.\n\nThis event is dispatched by a Process Queue when a new item is successfully removed from its active list.\n\nYou will most commonly see this used by a Scene's Update List when a Game Object has been removed.\n\nIn that instance, listen to this event from within a Scene using: `this.sys.updateList.on('remove', listener)`.","kind":"event","name":"PROCESS_QUEUE_REMOVE","since":"3.20.0","params":[{"type":{"names":["*"]},"description":"The item that was removed from the Process Queue.","name":"item"}],"memberof":"Phaser.Structs.Events","longname":"Phaser.Structs.Events#event:PROCESS_QUEUE_REMOVE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Structs","longname":"Phaser.Structs.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"kind":"namespace","name":"Structs","memberof":"Phaser","longname":"Phaser.Structs","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"CanvasTexture.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"classdesc":"A Canvas Texture is a special kind of Texture that is backed by an HTML Canvas Element as its source.\n\nYou can use the properties of this texture to draw to the canvas element directly, using all of the standard\ncanvas operations available in the browser. Any Game Object can be given this texture and will render with it.\n\nNote: When running under WebGL the Canvas Texture needs to re-generate its base WebGLTexture and reupload it to\nthe GPU every time you modify it, otherwise the changes you make to this texture will not be visible. To do this\nyou should call `CanvasTexture.refresh()` once you are finished with your changes to the canvas. Try and keep\nthis to a minimum, especially on large canvas sizes, or you may inadvertently thrash the GPU by constantly uploading\ntexture data to it. This restriction does not apply if using the Canvas Renderer.\n\nIt starts with only one frame that covers the whole of the canvas. You can add further frames, that specify\nsections of the canvas using the `add` method.\n\nShould you need to resize the canvas use the `setSize` method so that it accurately updates all of the underlying\ntexture data as well. Forgetting to do this (i.e. by changing the canvas size directly from your code) could cause\ngraphical errors.","kind":"class","name":"CanvasTexture","augments":["Phaser.Textures.Texture"],"memberof":"Phaser.Textures","since":"3.7.0","params":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"A reference to the Texture Manager this Texture belongs to.","name":"manager"},{"type":{"names":["string"]},"description":"The unique string-based key of this Texture.","name":"key"},{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas element that is used as the base of this texture.","name":"source"},{"type":{"names":["integer"]},"description":"The width of the canvas.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the canvas.","name":"height"}],"scope":"static","longname":"Phaser.Textures.CanvasTexture","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The source Canvas Element.","name":"canvas","readonly":true,"type":{"names":["HTMLCanvasElement"]},"since":"3.7.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The 2D Canvas Rendering Context.","name":"context","readonly":true,"type":{"names":["CanvasRenderingContext2D"]},"since":"3.7.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The width of the Canvas.\nThis property is read-only, if you wish to change it use the `setSize` method.","name":"width","readonly":true,"type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The height of the Canvas.\nThis property is read-only, if you wish to change it use the `setSize` method.","name":"height","readonly":true,"type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The context image data.\nUse the `update` method to populate this when the canvas changes.","name":"imageData","type":{"names":["ImageData"]},"since":"3.13.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#imageData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"A Uint8ClampedArray view into the `buffer`.\nUse the `update` method to populate this when the canvas changes.\nNote that this is unavailable in some browsers, such as Epic Browser, due to their security restrictions.","name":"data","type":{"names":["Uint8ClampedArray"]},"since":"3.13.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An Uint32Array view into the `buffer`.","name":"pixels","type":{"names":["Uint32Array"]},"since":"3.13.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#pixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":145,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An ArrayBuffer the same size as the context ImageData.","name":"buffer","type":{"names":["ArrayBuffer"]},"since":"3.13.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#buffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"This re-creates the `imageData` from the current context.\nIt then re-builds the ArrayBuffer, the `data` Uint8ClampedArray reference and the `pixels` Int32Array.\n\nWarning: This is a very expensive operation, so use it sparingly.","kind":"function","name":"update","since":"3.13.0","returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"This CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#update","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Draws the given Image or Canvas element to this CanvasTexture, then updates the internal\nImageData buffer and arrays.","kind":"function","name":"draw","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate to draw the source at.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate to draw the source at.","name":"y"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement"]},"description":"The element to draw to this canvas.","name":"source"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"This CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#draw","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":233,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Draws the given texture frame to this CanvasTexture, then updates the internal\nImageData buffer and arrays.","kind":"function","name":"drawFrame","since":"3.16.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from the Texture.","name":"frame"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate to draw the source at.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate to draw the source at.","name":"y"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"This CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#drawFrame","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets a pixel in the CanvasTexture to the given color and alpha values.\n\nThis is an expensive operation to run in large quantities, so use sparingly.","kind":"function","name":"setPixel","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"y"},{"type":{"names":["integer"]},"description":"The red color value. A number between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"description":"The green color value. A number between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color value. A number between 0 and 255.","name":"blue"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The alpha value. A number between 0 and 255.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"This CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#setPixel","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Puts the ImageData into the context of this CanvasTexture at the given coordinates.","kind":"function","name":"putData","since":"3.16.0","params":[{"type":{"names":["ImageData"]},"description":"The ImageData to put at the given location.","name":"imageData"},{"type":{"names":["integer"]},"description":"The x coordinate to put the imageData. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate to put the imageData. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Horizontal position (x coordinate) of the top-left corner from which the image data will be extracted.","name":"dirtyX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Vertical position (x coordinate) of the top-left corner from which the image data will be extracted.","name":"dirtyY"},{"type":{"names":["integer"]},"optional":true,"description":"Width of the rectangle to be painted. Defaults to the width of the image data.","name":"dirtyWidth"},{"type":{"names":["integer"]},"optional":true,"description":"Height of the rectangle to be painted. Defaults to the height of the image data.","name":"dirtyHeight"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"This CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#putData","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Gets an ImageData region from this CanvasTexture from the position and size specified.\nYou can write this back using `CanvasTexture.putData`, or manipulate it.","kind":"function","name":"getData","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the top-left of the area to get the ImageData from. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the top-left of the area to get the ImageData from. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the rectangle from which the ImageData will be extracted. Positive values are to the right, and negative to the left.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the rectangle from which the ImageData will be extracted. Positive values are down, and negative are up.","name":"height"}],"returns":[{"type":{"names":["ImageData"]},"description":"The ImageData extracted from this CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getData","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":375,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Get the color of a specific pixel from this texture and store it in a Color object.\n\nIf you have drawn anything to this CanvasTexture since it was created you must call `CanvasTexture.update` to refresh the array buffer,\notherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.","kind":"function","name":"getPixel","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"y"},{"type":{"names":["Phaser.Display.Color"]},"optional":true,"description":"A Color object to store the pixel values in. If not provided a new Color object will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"An object with the red, green, blue and alpha values set in the r, g, b and a properties."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getPixel","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":414,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns an array containing all of the pixels in the given region.\n\nIf the requested region extends outside the bounds of this CanvasTexture,\nthe region is truncated to fit.\n\nIf you have drawn anything to this CanvasTexture since it was created you must call `CanvasTexture.update` to refresh the array buffer,\notherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.","kind":"function","name":"getPixels","since":"3.16.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the top-left of the region. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the top-left of the region. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the region to get. Must be an integer. Defaults to the canvas width if not given.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the region to get. Must be an integer. If not given will be set to the `width`.","name":"height"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Pixel objects."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getPixels","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":469,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns the Image Data index for the given pixel in this CanvasTexture.\n\nThe index can be used to read directly from the `this.data` array.\n\nThe index points to the red value in the array. The subsequent 3 indexes\npoint to green, blue and alpha respectively.","kind":"function","name":"getIndex","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"y"}],"returns":[{"type":{"names":["integer"]}}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getIndex","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":500,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"This should be called manually if you are running under WebGL.\nIt will refresh the WebGLTexture from the Canvas source. Only call this if you know that the\ncanvas has changed, as there is a significant GPU texture allocation cost involved in doing so.","kind":"function","name":"refresh","since":"3.7.0","returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"This CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#refresh","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":517,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Gets the Canvas Element.","kind":"function","name":"getCanvas","since":"3.7.0","returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas DOM element this texture is using."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getCanvas","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":530,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Gets the 2D Canvas Rendering Context.","kind":"function","name":"getContext","since":"3.7.0","returns":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context this texture is using."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getContext","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":543,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Clears the given region of this Canvas Texture, resetting it back to transparent.\nIf no region is given, the whole Canvas Texture is cleared.","kind":"function","name":"clear","since":"3.7.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the top-left of the region to clear.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the top-left of the region to clear.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the region.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the region.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"The Canvas Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#clear","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":569,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Changes the size of this Canvas Texture.","kind":"function","name":"setSize","since":"3.7.0","params":[{"type":{"names":["integer"]},"description":"The new width of the Canvas.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The new height of the Canvas. If not given it will use the width as the height.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"The Canvas Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#setSize","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":604,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Destroys this Texture and releases references to its sources and frames.","kind":"function","name":"destroy","since":"3.16.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#destroy","scope":"instance","overrides":"Phaser.Textures.Texture#destroy","___s":true},{"meta":{"range":[180,213],"filename":"Frame.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Frame.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"classdesc":"A Frame is a section of a Texture.","kind":"class","name":"Frame","memberof":"Phaser.Textures","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"The Texture this Frame is a part of.","name":"texture"},{"type":{"names":["integer","string"]},"description":"The name of this Frame. The name is unique within the Texture.","name":"name"},{"type":{"names":["integer"]},"description":"The index of the TextureSource that this Frame is a part of.","name":"sourceIndex"},{"type":{"names":["number"]},"description":"The x coordinate of the top-left of this Frame.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of this Frame.","name":"y"},{"type":{"names":["number"]},"description":"The width of this Frame.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Frame.","name":"height"}],"scope":"static","longname":"Phaser.Textures.Frame","___s":true},{"meta":{"filename":"Frame.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Texture this Frame is a part of.","name":"texture","type":{"names":["Phaser.Textures.Texture"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The name of this Frame.\nThe name is unique within the Texture.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The TextureSource this Frame is part of.","name":"source","type":{"names":["Phaser.Textures.TextureSource"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The index of the TextureSource in the Texture sources array.","name":"sourceIndex","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#sourceIndex","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"A reference to the Texture Source WebGL Texture that this Frame is using.","name":"glTexture","type":{"names":["WebGLTexture"]},"nullable":true,"defaultvalue":"null","since":"3.11.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#glTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"X position within the source image to cut from.","name":"cutX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#cutX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":90,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Y position within the source image to cut from.","name":"cutY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#cutY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The width of the area in the source image to cut.","name":"cutWidth","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#cutWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The height of the area in the source image to cut.","name":"cutHeight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#cutHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The X rendering offset of this Frame, taking trim into account.","name":"x","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Y rendering offset of this Frame, taking trim into account.","name":"y","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The rendering width of this Frame, taking trim into account.","name":"width","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":146,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The rendering height of this Frame, taking trim into account.","name":"height","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Half the width, floored.\nPrecalculated for the renderer.","name":"halfWidth","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#halfWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Half the height, floored.\nPrecalculated for the renderer.","name":"halfHeight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#halfHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":175,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The x center of this frame, floored.","name":"centerX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#centerX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":184,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The y center of this frame, floored.","name":"centerY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#centerY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":193,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The horizontal pivot point of this Frame.","name":"pivotX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#pivotX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":203,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The vertical pivot point of this Frame.","name":"pivotY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#pivotY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":213,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Does this Frame have a custom pivot point?","name":"customPivot","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#customPivot","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":223,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"**CURRENTLY UNSUPPORTED**\n\nIs this frame is rotated or not in the Texture?\nRotation allows you to use rotated frames in texture atlas packing.\nIt has nothing to do with Sprite rotation.","name":"rotated","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#rotated","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":237,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Over-rides the Renderer setting.\n-1 = use Renderer Setting\n0 = No rounding\n1 = Round","name":"autoRound","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#autoRound","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":250,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Any Frame specific custom data can be stored here.","name":"customData","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#customData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":259,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"WebGL UV u0 value.","name":"u0","type":{"names":["number"]},"defaultvalue":"0","since":"3.11.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#u0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":269,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"WebGL UV v0 value.","name":"v0","type":{"names":["number"]},"defaultvalue":"0","since":"3.11.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#v0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":279,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"WebGL UV u1 value.","name":"u1","type":{"names":["number"]},"defaultvalue":"0","since":"3.11.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#u1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":289,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"WebGL UV v1 value.","name":"v1","type":{"names":["number"]},"defaultvalue":"0","since":"3.11.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#v1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":341,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the width, height, x and y of this Frame.\n\nThis is called automatically by the constructor\nand should rarely be changed on-the-fly.","kind":"function","name":"setSize","since":"3.7.0","params":[{"type":{"names":["integer"]},"description":"The width of the frame before being trimmed.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the frame before being trimmed.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the top-left of this Frame.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the top-left of this Frame.","name":"y"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"This Frame object."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#setSize","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":404,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"If the frame was trimmed when added to the Texture Atlas, this records the trim and source data.","kind":"function","name":"setTrim","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the frame before being trimmed.","name":"actualWidth"},{"type":{"names":["number"]},"description":"The height of the frame before being trimmed.","name":"actualHeight"},{"type":{"names":["number"]},"description":"The destination X position of the trimmed frame for display.","name":"destX"},{"type":{"names":["number"]},"description":"The destination Y position of the trimmed frame for display.","name":"destY"},{"type":{"names":["number"]},"description":"The destination width of the trimmed frame for display.","name":"destWidth"},{"type":{"names":["number"]},"description":"The destination height of the trimmed frame for display.","name":"destHeight"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"This Frame object."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#setTrim","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":454,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes a crop data object and, based on the rectangular region given, calculates the\nrequired UV coordinates in order to crop this Frame for WebGL and Canvas rendering.\n\nThis is called directly by the Game Object Texture Components `setCrop` method.\nPlease use that method to crop a Game Object.","kind":"function","name":"setCropUVs","since":"3.11.0","params":[{"type":{"names":["object"]},"description":"The crop data object. This is the `GameObject._crop` property.","name":"crop"},{"type":{"names":["number"]},"description":"The x coordinate to start the crop from. Cannot be negative or exceed the Frame width.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to start the crop from. Cannot be negative or exceed the Frame height.","name":"y"},{"type":{"names":["number"]},"description":"The width of the crop rectangle. Cannot exceed the Frame width.","name":"width"},{"type":{"names":["number"]},"description":"The height of the crop rectangle. Cannot exceed the Frame height.","name":"height"},{"type":{"names":["boolean"]},"description":"Does the parent Game Object have flipX set?","name":"flipX"},{"type":{"names":["boolean"]},"description":"Does the parent Game Object have flipY set?","name":"flipY"}],"returns":[{"type":{"names":["object"]},"description":"The updated crop data object."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#setCropUVs","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":595,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes a crop data object and recalculates the UVs based on the dimensions inside the crop object.\nCalled automatically by `setFrame`.","kind":"function","name":"updateCropUVs","since":"3.11.0","params":[{"type":{"names":["object"]},"description":"The crop data object. This is the `GameObject._crop` property.","name":"crop"},{"type":{"names":["boolean"]},"description":"Does the parent Game Object have flipX set?","name":"flipX"},{"type":{"names":["boolean"]},"description":"Does the parent Game Object have flipY set?","name":"flipY"}],"returns":[{"type":{"names":["object"]},"description":"The updated crop data object."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#updateCropUVs","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":613,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Updates the internal WebGL UV cache and the drawImage cache.","kind":"function","name":"updateUVs","since":"3.0.0","returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"This Frame object."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#updateUVs","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":649,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Updates the internal WebGL UV cache.","kind":"function","name":"updateUVsInverted","since":"3.0.0","returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"This Frame object."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#updateUVsInverted","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":671,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Clones this Frame into a new Frame object.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"A clone of this Frame."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#clone","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":709,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Destroys this Frame by nulling its reference to the parent Texture and and data objects.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#destroy","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":724,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The width of the Frame in its un-trimmed, un-padded state, as prepared in the art package,\nbefore being packed.","name":"realWidth","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#realWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The height of the Frame in its un-trimmed, un-padded state, as prepared in the art package,\nbefore being packed.","name":"realHeight","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#realHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":760,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The radius of the Frame (derived from sqrt(w * w + h * h) / 2)","name":"radius","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#radius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":777,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Is the Frame trimmed or not?","name":"trimmed","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#trimmed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":794,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Canvas drawImage data object.","name":"canvasData","type":{"names":["object"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#canvasData","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,213],"filename":"Texture.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Texture.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"classdesc":"A Texture consists of a source, usually an Image from the Cache, and a collection of Frames.\nThe Frames represent the different areas of the Texture. For example a texture atlas\nmay have many Frames, one for each element within the atlas. Where-as a single image would have\njust one frame, that encompasses the whole image.\n\nEvery Texture, no matter where it comes from, always has at least 1 frame called the `__BASE` frame.\nThis frame represents the entirety of the source image.\n\nTextures are managed by the global TextureManager. This is a singleton class that is\nresponsible for creating and delivering Textures and their corresponding Frames to Game Objects.\n\nSprites and other Game Objects get the texture data they need from the TextureManager.","kind":"class","name":"Texture","memberof":"Phaser.Textures","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"A reference to the Texture Manager this Texture belongs to.","name":"manager"},{"type":{"names":["string"]},"description":"The unique string-based key of this Texture.","name":"key"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"description":"An array of sources that are used to create the texture. Usually Images, but can also be a Canvas.","name":"source"},{"type":{"names":["number"]},"optional":true,"description":"The width of the Texture. This is optional and automatically derived from the source images.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the Texture. This is optional and automatically derived from the source images.","name":"height"}],"scope":"static","longname":"Phaser.Textures.Texture","___s":true},{"meta":{"filename":"Texture.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"A reference to the Texture Manager this Texture belongs to.","name":"manager","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The unique string-based key of this Texture.","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An array of TextureSource instances.\nThese are unique to this Texture and contain the actual Image (or Canvas) data.","name":"source","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An array of TextureSource data instances.\nUsed to store additional data images, such as normal maps or specular maps.","name":"dataSource","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#dataSource","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"A key-value object pair associating the unique Frame keys with the Frames objects.","name":"frames","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#frames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Any additional data that was set in the source JSON (if any),\nor any extra data you'd like to store relating to this texture","name":"customData","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#customData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The name of the first frame of the Texture.","name":"firstFrame","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#firstFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The total number of Frames in this Texture, including the `__BASE` frame.\n\nA Texture will always contain at least 1 frame because every Texture contains a `__BASE` frame by default,\nin addition to any extra frames that have been added to it, such as when parsing a Sprite Sheet or Texture Atlas.","name":"frameTotal","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#frameTotal","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a new Frame to this Texture.\n\nA Frame is a rectangular region of a TextureSource with a unique index or string-based key.\n\nThe name given must be unique within this Texture. If it already exists, this method will return `null`.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["integer","string"]},"description":"The name of this Frame. The name is unique within the Texture.","name":"name"},{"type":{"names":["integer"]},"description":"The index of the TextureSource that this Frame is a part of.","name":"sourceIndex"},{"type":{"names":["number"]},"description":"The x coordinate of the top-left of this Frame.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of this Frame.","name":"y"},{"type":{"names":["number"]},"description":"The width of this Frame.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Frame.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"nullable":true,"description":"The Frame that was added to this Texture, or `null` if the given name already exists."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#add","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Removes the given Frame from this Texture. The Frame is destroyed immediately.\n\nAny Game Objects using this Frame should stop using it _before_ you remove it,\nas it does not happen automatically.","kind":"function","name":"remove","since":"3.19.0","params":[{"type":{"names":["string"]},"description":"The key of the Frame to remove.","name":"name"}],"returns":[{"type":{"names":["boolean"]},"description":"True if a Frame with the matching key was removed from this Texture."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#remove","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":209,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Checks to see if a Frame matching the given key exists within this Texture.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Frame to check for.","name":"name"}],"returns":[{"type":{"names":["boolean"]},"description":"True if a Frame with the matching key exists in this Texture."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#has","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":224,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Gets a Frame from this Texture based on either the key or the index of the Frame.\n\nIn a Texture Atlas Frames are typically referenced by a key.\nIn a Sprite Sheet Frames are referenced by an index.\nPassing no value for the name returns the base texture.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from this Texture.","name":"name"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The Texture Frame."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#get","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes the given TextureSource and returns the index of it within this Texture.\nIf it's not in this Texture, it returns -1.\nUnless this Texture has multiple TextureSources, such as with a multi-atlas, this\nmethod will always return zero or -1.","kind":"function","name":"getTextureSourceIndex","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.TextureSource"]},"description":"The TextureSource to check.","name":"source"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the TextureSource within this Texture, or -1 if not in this Texture."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#getTextureSourceIndex","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":284,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns an array of all the Frames in the given TextureSource.","kind":"function","name":"getFramesFromTextureSource","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the TextureSource to get the Frames from.","name":"sourceIndex"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Include the `__BASE` Frame in the output array?","name":"includeBase"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Texture Frames."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#getFramesFromTextureSource","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns an array with all of the names of the Frames in this Texture.\n\nUseful if you want to randomly assign a Frame to a Game Object, as you can\npick a random element from the returned array.","kind":"function","name":"getFrameNames","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Include the `__BASE` Frame in the output array?","name":"includeBase"}],"returns":[{"type":{"names":["Array."]},"description":"An array of all Frame names in this Texture."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#getFrameNames","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Given a Frame name, return the source image it uses to render with.\n\nThis will return the actual DOM Image or Canvas element.","kind":"function","name":"getSourceImage","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from this Texture.","name":"name"}],"returns":[{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Phaser.GameObjects.RenderTexture"]},"description":"The DOM Image, Canvas Element or Render Texture."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#getSourceImage","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Given a Frame name, return the data source image it uses to render with.\nYou can use this to get the normal map for an image for example.\n\nThis will return the actual DOM Image.","kind":"function","name":"getDataSourceImage","since":"3.7.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from this Texture.","name":"name"}],"returns":[{"type":{"names":["HTMLImageElement","HTMLCanvasElement"]},"description":"The DOM Image or Canvas Element."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#getDataSourceImage","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":421,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a data source image to this Texture.\n\nAn example of a data source image would be a normal map, where all of the Frames for this Texture\nequally apply to the normal map.","kind":"function","name":"setDataSource","since":"3.0.0","params":[{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"description":"The source image.","name":"data"}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#setDataSource","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":447,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the Filter Mode for this Texture.\n\nThe mode can be either Linear, the default, or Nearest.\n\nFor pixel-art you should use Nearest.\n\nThe mode applies to the entire Texture, not just a specific Frame of it.","kind":"function","name":"setFilter","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.FilterMode"]},"description":"The Filter Mode.","name":"filterMode"}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#setFilter","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Destroys this Texture and releases references to its sources and frames.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#destroy","scope":"instance","___s":true},{"meta":{"range":[180,232],"filename":"TextureManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextureManager.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"kind":"typedef","name":"EachTextureCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"Each texture in Texture Manager.","name":"texture"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"longname":"EachTextureCallback","scope":"global","___s":true},{"meta":{"filename":"TextureManager.js","lineno":27,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"classdesc":"Textures are managed by the global TextureManager. This is a singleton class that is\nresponsible for creating and delivering Textures and their corresponding Frames to Game Objects.\n\nSprites and other Game Objects get the texture data they need from the TextureManager.\n\nAccess it via `scene.textures`.","kind":"class","name":"TextureManager","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Textures","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Phaser.Game instance this Texture Manager belongs to.","name":"game"}],"scope":"static","longname":"Phaser.Textures.TextureManager","___s":true},{"meta":{"filename":"TextureManager.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Game that this TextureManager belongs to.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureManager.js","lineno":63,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The name of this manager.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureManager.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An object that has all of textures that Texture Manager creates.\nTextures are assigned to keys so we can access to any texture that this object has directly by key value without iteration.","name":"list","type":{"names":["object"]},"defaultvalue":"{}","since":"3.0.0","memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#list","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureManager.js","lineno":157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Checks the given texture key and throws a console.warn if the key is already in use, then returns false.\nIf you wish to avoid the console.warn then use `TextureManager.exists` instead.","kind":"function","name":"checkKey","since":"3.7.0","params":[{"type":{"names":["string"]},"description":"The texture key to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if it's safe to use the texture key, otherwise `false`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#checkKey","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Removes a Texture from the Texture Manager and destroys it. This will immediately\nclear all references to it from the Texture Manager, and if it has one, destroy its\nWebGLTexture. This will emit a `removetexture` event.\n\nNote: If you have any Game Objects still using this texture they will start throwing\nerrors the next time they try to render. Make sure that removing the texture is the final\nstep when clearing down to avoid this.","kind":"function","name":"remove","fires":["Phaser.Textures.Events#event:REMOVE"],"since":"3.7.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the Texture to remove, or a reference to it.","name":"key"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"The Texture Manager."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#remove","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":224,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Removes a key from the Texture Manager but does not destroy the Texture that was using the key.","kind":"function","name":"removeKey","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key to remove from the texture list.","name":"key"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"The Texture Manager."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#removeKey","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":244,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a new Texture to the Texture Manager created from the given Base64 encoded data.","kind":"function","name":"addBase64","fires":["Phaser.Textures.Events#event:ADD","Phaser.Textures.Events#event:ERROR","Phaser.Textures.Events#event:LOAD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["*"]},"description":"The Base64 encoded data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"This Texture Manager instance."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addBase64","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":288,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Gets an existing texture frame and converts it into a base64 encoded image and returns the base64 data.\n\nYou can also provide the image type and encoder options.\n\nThis will only work with bitmap based texture frames, such as those created from Texture Atlases.\nIt will not work with GL Texture objects, such as Shaders, or Render Textures. For those please\nsee the WebGL Snapshot function instead.","kind":"function","name":"getBase64","since":"3.12.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from the Texture.","name":"frame"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"[description]","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"[description]","name":"encoderOptions"}],"returns":[{"type":{"names":["string"]},"description":"The base64 encoded data, or an empty string if the texture frame could not be found."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#getBase64","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":347,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a new Texture to the Texture Manager created from the given Image element.","kind":"function","name":"addImage","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement"]},"optional":true,"description":"An optional data Image element.","name":"dataSource"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addImage","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":381,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes a WebGL Texture and creates a Phaser Texture from it, which is added to the Texture Manager using the given key.\n\nThis allows you to then use the Texture as a normal texture for texture based Game Objects like Sprites.\n\nThis is a WebGL only feature.","kind":"function","name":"addGLTexture","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.19.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["WebGLTexture"]},"description":"The source Render Texture.","name":"glTexture"},{"type":{"names":["number"]},"description":"The new width of the Texture.","name":"width"},{"type":{"names":["number"]},"description":"The new height of the Texture.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addGLTexture","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":415,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Render Texture to the Texture Manager using the given key.\nThis allows you to then use the Render Texture as a normal texture for texture based Game Objects like Sprites.","kind":"function","name":"addRenderTexture","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.12.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"The source Render Texture.","name":"renderTexture"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addRenderTexture","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":444,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Creates a new Texture using the given config values.\nGenerated textures consist of a Canvas element to which the texture data is drawn.\nSee the Phaser.Create function for the more direct way to create textures.","kind":"function","name":"generate","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["object"]},"description":"The configuration object needed to generate the texture.","name":"config"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#generate","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":475,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Creates a new Texture using a blank Canvas element of the size given.\n\nCanvas elements are automatically pooled and calling this method will\nextract a free canvas from the CanvasPool, or create one if none are available.","kind":"function","name":"createCanvas","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":256,"description":"The width of the Canvas element.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":256,"description":"The height of the Canvas element.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"nullable":true,"description":"The Canvas Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#createCanvas","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Creates a new Canvas Texture object from an existing Canvas element\nand adds it to this Texture Manager, unless `skipCache` is true.","kind":"function","name":"addCanvas","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas element to form the base of the new Texture.","name":"source"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip adding this Texture into the Cache?","name":"skipCache"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"nullable":true,"description":"The Canvas Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addCanvas","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a new Texture Atlas to this Texture Manager.\nIt can accept either JSON Array or JSON Hash formats, as exported by Texture Packer and similar software.","kind":"function","name":"addAtlas","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["object"]},"description":"The Texture Atlas data.","name":"data"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"optional":true,"description":"An optional data Image element.","name":"dataSource"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addAtlas","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Texture Atlas to this Texture Manager.\nThe frame data of the atlas must be stored in an Array within the JSON.\nThis is known as a JSON Array in software such as Texture Packer.","kind":"function","name":"addAtlasJSONArray","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement","Array."]},"description":"The source Image element/s.","name":"source"},{"type":{"names":["object","Array."]},"description":"The Texture Atlas data/s.","name":"data"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"optional":true,"description":"An optional data Image element.","name":"dataSource"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addAtlasJSONArray","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":621,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Texture Atlas to this Texture Manager.\nThe frame data of the atlas must be stored in an Object within the JSON.\nThis is known as a JSON Hash in software such as Texture Packer.","kind":"function","name":"addAtlasJSONHash","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["object"]},"description":"The Texture Atlas data.","name":"data"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"optional":true,"description":"An optional data Image element.","name":"dataSource"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addAtlasJSONHash","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":668,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Texture Atlas to this Texture Manager, where the atlas data is given\nin the XML format.","kind":"function","name":"addAtlasXML","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.7.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["object"]},"description":"The Texture Atlas XML data.","name":"data"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"optional":true,"description":"An optional data Image element.","name":"dataSource"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addAtlasXML","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":704,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Unity Texture Atlas to this Texture Manager.\nThe data must be in the form of a Unity YAML file.","kind":"function","name":"addUnityAtlas","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["object"]},"description":"The Texture Atlas data.","name":"data"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"optional":true,"description":"An optional data Image element.","name":"dataSource"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addUnityAtlas","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":740,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Sprite Sheet to this Texture Manager.\n\nIn Phaser terminology a Sprite Sheet is a texture containing different frames, but each frame is the exact\nsame size and cannot be trimmed or rotated.","kind":"function","name":"addSpriteSheet","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["Phaser.Types.Textures.SpriteSheetConfig"]},"description":"The configuration object for this Sprite Sheet.","name":"config"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addSpriteSheet","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":775,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Sprite Sheet to this Texture Manager, where the Sprite Sheet exists as a Frame within a Texture Atlas.\n\nIn Phaser terminology a Sprite Sheet is a texture containing different frames, but each frame is the exact\nsame size and cannot be trimmed or rotated.","kind":"function","name":"addSpriteSheetFromAtlas","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["Phaser.Types.Textures.SpriteSheetFromAtlasConfig"]},"description":"The configuration object for this Sprite Sheet.","name":"config"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addSpriteSheetFromAtlas","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":828,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Creates a new Texture using the given source and dimensions.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["integer"]},"description":"The width of the Texture.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the Texture.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#create","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":855,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Checks the given key to see if a Texture using it exists within this Texture Manager.","kind":"function","name":"exists","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if a Texture matching the given key exists in this Texture Manager."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#exists","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":870,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns a Texture from the Texture Manager that matches the given key.\n\nIf the key is `undefined` it will return the `__DEFAULT` Texture.\n\nIf the key is an instance of a Texture, it will return the key directly.\n\nFinally. if the key is given, but not found and not a Texture instance, it will return the `__MISSING` Texture.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The unique string-based key of the Texture, or a Texture instance.","name":"key"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"The Texture that was created."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#get","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":904,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes a Texture key and Frame name and returns a clone of that Frame if found.","kind":"function","name":"cloneFrame","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"description":"The string or index of the Frame to be cloned.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"A Clone of the given Frame."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#cloneFrame","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":923,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes a Texture key and Frame name and returns a reference to that Frame, if found.","kind":"function","name":"getFrame","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"A Texture Frame object."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#getFrame","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":942,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns an array with all of the keys of all Textures in this Texture Manager.\nThe output array will exclude the `__DEFAULT` and `__MISSING` keys.","kind":"function","name":"getTextureKeys","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"An array containing all of the Texture keys stored in this Texture Manager."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#getTextureKeys","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":966,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Given a Texture and an `x` and `y` coordinate this method will return a new\nColor object that has been populated with the color and alpha values of the pixel\nat that location in the Texture.","kind":"function","name":"getPixel","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel within the Texture.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel within the Texture.","name":"y"},{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The string or index of the Frame.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"nullable":true,"description":"A Color object populated with the color values of the requested pixel,\nor `null` if the coordinates were out of bounds."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#getPixel","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":1013,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Given a Texture and an `x` and `y` coordinate this method will return a value between 0 and 255\ncorresponding to the alpha value of the pixel at that location in the Texture. If the coordinate\nis out of bounds it will return null.","kind":"function","name":"getPixelAlpha","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel within the Texture.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel within the Texture.","name":"y"},{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The string or index of the Frame.","name":"frame"}],"returns":[{"type":{"names":["integer"]},"description":"A value between 0 and 255, or `null` if the coordinates were out of bounds."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#getPixelAlpha","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":1059,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the given Game Objects `texture` and `frame` properties so that it uses\nthe Texture and Frame specified in the `key` and `frame` arguments to this method.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the texture would be set on.","name":"gameObject"},{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The string or index of the Frame.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the texture was set on."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#setTexture","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":1083,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Changes the key being used by a Texture to the new key provided.\n\nThe old key is removed, allowing it to be re-used.\n\nGame Objects are linked to Textures by a reference to the Texture object, so\nall existing references will be retained.","kind":"function","name":"renameTexture","since":"3.12.0","params":[{"type":{"names":["string"]},"description":"The current string-based key of the Texture you wish to rename.","name":"currentKey"},{"type":{"names":["string"]},"description":"The new unique string-based key to use for the Texture.","name":"newKey"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Texture key was successfully renamed, otherwise `false`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#renameTexture","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":1117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Passes all Textures to the given callback.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["EachTextureCallback"]},"description":"The callback function to be sent the Textures.","name":"callback"},{"type":{"names":["object"]},"description":"The value to use as `this` when executing the callback.","name":"scope"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#each","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":1144,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Destroys the Texture Manager and all Textures stored within it.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"range":[180,232],"filename":"TextureSource.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextureSource.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"classdesc":"A Texture Source is the encapsulation of the actual source data for a Texture.\n\nThis is typically an Image Element, loaded from the file system or network, a Canvas Element or a Video Element.\n\nA Texture can contain multiple Texture Sources, which only happens when a multi-atlas is loaded.","kind":"class","name":"TextureSource","memberof":"Phaser.Textures","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"The Texture this TextureSource belongs to.","name":"texture"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","HTMLVideoElement","Phaser.GameObjects.RenderTexture","WebGLTexture"]},"description":"The source image data.","name":"source"},{"type":{"names":["integer"]},"optional":true,"description":"Optional width of the source image. If not given it's derived from the source itself.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"Optional height of the source image. If not given it's derived from the source itself.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets the `UNPACK_FLIP_Y_WEBGL` flag the WebGL Texture uses during upload.","name":"flipY"}],"scope":"static","longname":"Phaser.Textures.TextureSource","___s":true},{"meta":{"filename":"TextureSource.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Texture this TextureSource belongs to.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.7.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Texture this TextureSource belongs to.","name":"texture","type":{"names":["Phaser.Textures.Texture"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The source of the image data.\n\nThis is either an Image Element, a Canvas Element, a Video Element, a RenderTexture or a WebGLTexture.","name":"source","type":{"names":["HTMLImageElement","HTMLCanvasElement","HTMLVideoElement","Phaser.GameObjects.RenderTexture","WebGLTexture"]},"since":"3.12.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The image data.\n\nThis is either an Image element, Canvas element or a Video Element.","name":"image","type":{"names":["HTMLImageElement","HTMLCanvasElement","HTMLVideoElement"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#image","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Currently un-used.","name":"compressionAlgorithm","type":{"names":["integer"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#compressionAlgorithm","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The resolution of the source image.","name":"resolution","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#resolution","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The width of the source image. If not specified in the constructor it will check\nthe `naturalWidth` and then `width` properties of the source image.","name":"width","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The height of the source image. If not specified in the constructor it will check\nthe `naturalHeight` and then `height` properties of the source image.","name":"height","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Scale Mode the image will use when rendering.\nEither Linear or Nearest.","name":"scaleMode","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#scaleMode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Is the source image a Canvas Element?","name":"isCanvas","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#isCanvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":140,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Is the source image a Video Element?","name":"isVideo","type":{"names":["boolean"]},"since":"3.20.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#isVideo","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":149,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Is the source image a Render Texture?","name":"isRenderTexture","type":{"names":["boolean"]},"since":"3.12.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#isRenderTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Is the source image a WebGLTexture?","name":"isGLTexture","type":{"names":["boolean"]},"since":"3.19.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#isGLTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Are the source image dimensions a power of two?","name":"isPowerOf2","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#isPowerOf2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":176,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The WebGL Texture of the source image. If this TextureSource is driven from a WebGLTexture\nalready, then this is a reference to that WebGLTexture.","name":"glTexture","type":{"names":["WebGLTexture"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#glTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the `UNPACK_FLIP_Y_WEBGL` flag the WebGL Texture uses during upload.","name":"flipY","type":{"names":["boolean"]},"since":"3.20.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#flipY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":199,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Creates a WebGL Texture, if required, and sets the Texture filter mode.","kind":"function","name":"init","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"A reference to the Phaser Game instance.","name":"game"}],"memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#init","scope":"instance","___s":true},{"meta":{"filename":"TextureSource.js","lineno":248,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the Filter Mode for this Texture.\n\nThe mode can be either Linear, the default, or Nearest.\n\nFor pixel-art you should use Nearest.","kind":"function","name":"setFilter","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.FilterMode"]},"description":"The Filter Mode.","name":"filterMode"}],"memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#setFilter","scope":"instance","___s":true},{"meta":{"filename":"TextureSource.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the `UNPACK_FLIP_Y_WEBGL` flag for the WebGL Texture during texture upload.","kind":"function","name":"setFlipY","since":"3.20.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the WebGL Texture be flipped on the Y axis on texture upload or not?","name":"value"}],"memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#setFlipY","scope":"instance","___s":true},{"meta":{"filename":"TextureSource.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"If this TextureSource is backed by a Canvas and is running under WebGL,\nit updates the WebGLTexture using the canvas data.","kind":"function","name":"update","since":"3.7.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#update","scope":"instance","___s":true},{"meta":{"filename":"TextureSource.js","lineno":308,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Destroys this Texture Source and nulls the references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#destroy","scope":"instance","___s":true},{"meta":{"filename":"const.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Filter Types.","kind":"namespace","name":"FilterMode","memberof":"Phaser.Textures","since":"3.0.0","longname":"Phaser.Textures.FilterMode","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Linear filter type.","name":"LINEAR","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Textures.FilterMode","longname":"Phaser.Textures.FilterMode.LINEAR","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":26,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Nearest neighbor filter type.","name":"NEAREST","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Textures.FilterMode","longname":"Phaser.Textures.FilterMode.NEAREST","scope":"static","___s":true},{"meta":{"filename":"ADD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/events"},"description":"The Texture Add Event.\n\nThis event is dispatched by the Texture Manager when a texture is added to it.\n\nListen to this event from within a Scene using: `this.textures.on('addtexture', listener)`.","kind":"event","name":"ADD","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture that was added to the Texture Manager.","name":"key"},{"type":{"names":["Phaser.Textures.Texture"]},"description":"A reference to the Texture that was added to the Texture Manager.","name":"texture"}],"memberof":"Phaser.Textures.Events","longname":"Phaser.Textures.Events#event:ADD","scope":"instance","___s":true},{"meta":{"filename":"ERROR_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/events"},"description":"The Texture Load Error Event.\n\nThis event is dispatched by the Texture Manager when a texture it requested to load failed.\nThis only happens when base64 encoded textures fail. All other texture types are loaded via the Loader Plugin.\n\nListen to this event from within a Scene using: `this.textures.on('onerror', listener)`.","kind":"event","name":"ERROR","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture that failed to load into the Texture Manager.","name":"key"}],"memberof":"Phaser.Textures.Events","longname":"Phaser.Textures.Events#event:ERROR","scope":"instance","___s":true},{"meta":{"filename":"LOAD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/events"},"description":"The Texture Load Event.\n\nThis event is dispatched by the Texture Manager when a texture has finished loading on it.\nThis only happens for base64 encoded textures. All other texture types are loaded via the Loader Plugin.\n\nListen to this event from within a Scene using: `this.textures.on('onload', listener)`.\n\nThis event is dispatched after the [ADD]{@linkcode Phaser.Textures.Events#event:ADD} event.","kind":"event","name":"LOAD","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture that was loaded by the Texture Manager.","name":"key"},{"type":{"names":["Phaser.Textures.Texture"]},"description":"A reference to the Texture that was loaded by the Texture Manager.","name":"texture"}],"memberof":"Phaser.Textures.Events","longname":"Phaser.Textures.Events#event:LOAD","scope":"instance","___s":true},{"meta":{"filename":"READY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/events"},"description":"This internal event signifies that the Texture Manager is now ready and the Game can continue booting.\n\nWhen a Phaser Game instance is booting for the first time, the Texture Manager has to wait on a couple of non-blocking\nasync events before it's fully ready to carry on. When those complete the Texture Manager emits this event via the Game\ninstance, which tells the Game to carry on booting.","kind":"event","name":"READY","since":"3.16.1","memberof":"Phaser.Textures.Events","longname":"Phaser.Textures.Events#event:READY","scope":"instance","___s":true},{"meta":{"filename":"REMOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/events"},"description":"The Texture Remove Event.\n\nThis event is dispatched by the Texture Manager when a texture is removed from it.\n\nListen to this event from within a Scene using: `this.textures.on('removetexture', listener)`.\n\nIf you have any Game Objects still using the removed texture, they will start throwing\nerrors the next time they try to render. Be sure to clear all use of the texture in this event handler.","kind":"event","name":"REMOVE","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture that was removed from the Texture Manager.","name":"key"}],"memberof":"Phaser.Textures.Events","longname":"Phaser.Textures.Events#event:REMOVE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Textures","longname":"Phaser.Textures.Events","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"name":"Extend","longname":"Extend","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"kind":"namespace","name":"Textures","memberof":"Phaser","longname":"Phaser.Textures","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Linear filter type.","name":"LINEAR","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Textures","longname":"Phaser.Textures.LINEAR","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":23,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Nearest Neighbor filter type.","name":"NEAREST","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Textures","longname":"Phaser.Textures.NEAREST","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"JSONArray.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures/parsers"},"name":"Clone","longname":"Clone","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"JSONHash.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures/parsers"},"name":"Clone","longname":"Clone","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,237],"filename":"SpriteSheet.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures/parsers"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,237],"filename":"SpriteSheetFromAtlas.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures/parsers"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,195],"filename":"UnityYAML.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures/parsers"},"name":"imageHeight","longname":"imageHeight","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/parsers"},"kind":"namespace","name":"Parsers","memberof":"Phaser.Textures","longname":"Phaser.Textures.Parsers","scope":"static","___s":true},{"meta":{"filename":"PixelConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/typedefs"},"description":"An object containing the position and color data for a single pixel in a CanvasTexture.","kind":"typedef","name":"PixelConfig","type":{"names":["object"]},"since":"3.16.0","properties":[{"type":{"names":["integer"]},"description":"The x-coordinate of the pixel.","name":"x"},{"type":{"names":["integer"]},"description":"The y-coordinate of the pixel.","name":"y"},{"type":{"names":["integer"]},"description":"The color of the pixel, not including the alpha channel.","name":"color"},{"type":{"names":["number"]},"description":"The alpha of the pixel, between 0 and 1.","name":"alpha"}],"memberof":"Phaser.Types.Textures","longname":"Phaser.Types.Textures.PixelConfig","scope":"static","___s":true},{"meta":{"filename":"SpriteSheetConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/typedefs"},"kind":"typedef","name":"SpriteSheetConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["integer"]},"description":"The fixed width of each frame.","name":"frameWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The fixed height of each frame. If not set it will use the frameWidth as the height.","name":"frameHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Skip a number of frames. Useful when there are multiple sprite sheets in one Texture.","name":"startFrame"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":-1,"description":"The total number of frames to extract from the Sprite Sheet. The default value of -1 means \"extract all frames\".","name":"endFrame"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If the frames have been drawn with a margin, specify the amount here.","name":"margin"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If the frames have been drawn with spacing between them, specify the amount here.","name":"spacing"}],"memberof":"Phaser.Types.Textures","longname":"Phaser.Types.Textures.SpriteSheetConfig","scope":"static","___s":true},{"meta":{"filename":"SpriteSheetFromAtlasConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/typedefs"},"kind":"typedef","name":"SpriteSheetFromAtlasConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The key of the Texture Atlas in which this Sprite Sheet can be found.","name":"atlas"},{"type":{"names":["string"]},"description":"The key of the Texture Atlas Frame in which this Sprite Sheet can be found.","name":"frame"},{"type":{"names":["integer"]},"description":"The fixed width of each frame.","name":"frameWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The fixed height of each frame. If not set it will use the frameWidth as the height.","name":"frameHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Skip a number of frames. Useful when there are multiple sprite sheets in one Texture.","name":"startFrame"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":-1,"description":"The total number of frames to extract from the Sprite Sheet. The default value of -1 means \"extract all frames\".","name":"endFrame"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If the frames have been drawn with a margin, specify the amount here.","name":"margin"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If the frames have been drawn with spacing between them, specify the amount here.","name":"spacing"}],"memberof":"Phaser.Types.Textures","longname":"Phaser.Types.Textures.SpriteSheetFromAtlasConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/typedefs"},"kind":"namespace","name":"Textures","memberof":"Phaser.Types","longname":"Phaser.Types.Textures","scope":"static","___s":true},{"meta":{"filename":"Formats.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"kind":"namespace","name":"Formats","memberof":"Phaser.Tilemaps","longname":"Phaser.Tilemaps.Formats","scope":"static","___s":true},{"meta":{"filename":"Formats.js","lineno":13,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"CSV Map Type","name":"CSV","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Formats","longname":"Phaser.Tilemaps.Formats.CSV","scope":"static","kind":"member","___s":true},{"meta":{"filename":"Formats.js","lineno":22,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Tiled JSON Map Type","name":"TILED_JSON","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Formats","longname":"Phaser.Tilemaps.Formats.TILED_JSON","scope":"static","kind":"member","___s":true},{"meta":{"filename":"Formats.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"2D Array Map Type","name":"ARRAY_2D","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Formats","longname":"Phaser.Tilemaps.Formats.ARRAY_2D","scope":"static","kind":"member","___s":true},{"meta":{"filename":"Formats.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Weltmeister (Impact.js) Map Type","name":"WELTMEISTER","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Formats","longname":"Phaser.Tilemaps.Formats.WELTMEISTER","scope":"static","kind":"member","___s":true},{"meta":{"range":[180,213],"filename":"ImageCollection.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImageCollection.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"classdesc":"An Image Collection is a special Tile Set containing multiple images, with no slicing into each image.\n\nImage Collections are normally created automatically when Tiled data is loaded.","kind":"class","name":"ImageCollection","memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the image collection in the map data.","name":"name"},{"type":{"names":["integer"]},"description":"The first image index this image collection contains.","name":"firstgid"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"Width of widest image (in pixels).","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"Height of tallest image (in pixels).","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The margin around all images in the collection (in pixels).","name":"margin"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The spacing between each image in the collection (in pixels).","name":"spacing"},{"type":{"names":["object"]},"optional":true,"defaultvalue":"{}","description":"Custom Image Collection properties.","name":"properties"}],"scope":"static","longname":"Phaser.Tilemaps.ImageCollection","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The name of the Image Collection.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The Tiled firstgid value.\nThis is the starting index of the first image index this Image Collection contains.","name":"firstgid","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#firstgid","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The width of the widest image (in pixels).","name":"imageWidth","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#imageWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The height of the tallest image (in pixels).","name":"imageHeight","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#imageHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The margin around the images in the collection (in pixels).\nUse `setSpacing` to change.","name":"imageMarge","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#imageMarge","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The spacing between each image in the collection (in pixels).\nUse `setSpacing` to change.","name":"imageSpacing","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#imageSpacing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":100,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Image Collection-specific properties that are typically defined in the Tiled editor.","name":"properties","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#properties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":109,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The cached images that are a part of this collection.","name":"images","type":{"names":["array"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#images","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The total number of images in the image collection.","name":"total","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#total","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":130,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Returns true if and only if this image collection contains the given image index.","kind":"function","name":"containsImageIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The image index to search for.","name":"imageIndex"}],"returns":[{"type":{"names":["boolean"]},"description":"True if this Image Collection contains the given index."}],"memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#containsImageIndex","scope":"instance","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Add an image to this Image Collection.","kind":"function","name":"addImage","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The gid of the image in the Image Collection.","name":"gid"},{"type":{"names":["string"]},"description":"The the key of the image in the Image Collection and in the cache.","name":"image"}],"returns":[{"type":{"names":["Phaser.Tilemaps.ImageCollection"]},"description":"This ImageCollection object."}],"memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#addImage","scope":"instance","___s":true},{"meta":{"range":[180,210],"filename":"ParseToTilemap.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"Formats","longname":"Formats","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseToTilemap.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Create a Tilemap from the given key or data. If neither is given, make a blank Tilemap. When\nloading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing from\na map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map data. For\nan empty map, you should specify tileWidth, tileHeight, width & height.","kind":"function","name":"ParseToTilemap","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Tilemap belongs.","name":"scene"},{"type":{"names":["string"]},"optional":true,"description":"The key in the Phaser cache that corresponds to the loaded tilemap data.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The width of a tile in pixels.","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The height of a tile in pixels.","name":"tileHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The width of the map in tiles.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The height of the map in tiles.","name":"height"},{"type":{"names":["Array.>"]},"optional":true,"description":"Instead of loading from the cache, you can also load directly from\na 2D array of tile indexes.","name":"data"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Controls how empty tiles, tiles with an index of -1, in the\nmap data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]}}],"memberof":"Phaser.Tilemaps","longname":"Phaser.Tilemaps.ParseToTilemap","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Tile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Tile.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"classdesc":"A Tile is a representation of a single tile within the Tilemap. This is a lightweight data\nrepresentation, so its position information is stored without factoring in scroll, layer\nscale or layer position.","kind":"class","name":"Tile","memberof":"Phaser.Tilemaps","since":"3.0.0","augments":["Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.Visible"],"params":[{"type":{"names":["Phaser.Tilemaps.LayerData"]},"description":"The LayerData object in the Tilemap that this tile belongs to.","name":"layer"},{"type":{"names":["integer"]},"description":"The unique index of this tile within the map.","name":"index"},{"type":{"names":["integer"]},"description":"The x coordinate of this tile in tile coordinates.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of this tile in tile coordinates.","name":"y"},{"type":{"names":["integer"]},"description":"Width of the tile in pixels.","name":"width"},{"type":{"names":["integer"]},"description":"Height of the tile in pixels.","name":"height"},{"type":{"names":["integer"]},"description":"The base width a tile in the map (in pixels). Tiled maps support\nmultiple tileset sizes within one map, but they are still placed at intervals of the base\ntile width.","name":"baseWidth"},{"type":{"names":["integer"]},"description":"The base height of the tile in pixels (in pixels). Tiled maps\nsupport multiple tileset sizes within one map, but they are still placed at intervals of the\nbase tile height.","name":"baseHeight"}],"scope":"static","longname":"Phaser.Tilemaps.Tile","___s":true},{"meta":{"filename":"Tile.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The LayerData in the Tilemap data that this tile belongs to.","name":"layer","type":{"names":["Phaser.Tilemaps.LayerData"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#layer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The index of this tile within the map data corresponding to the tileset, or -1 if this\nrepresents a blank tile.","name":"index","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#index","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The x map coordinate of this tile in tile units.","name":"x","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The y map coordinate of this tile in tile units.","name":"y","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The width of the tile in pixels.","name":"width","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The height of the tile in pixels.","name":"height","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The map's base width of a tile in pixels. Tiled maps support multiple tileset sizes\nwithin one map, but they are still placed at intervals of the base tile size.","name":"baseWidth","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#baseWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The map's base height of a tile in pixels. Tiled maps support multiple tileset sizes\nwithin one map, but they are still placed at intervals of the base tile size.","name":"baseHeight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#baseHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The x coordinate of the top left of this tile in pixels. This is relative to the top left\nof the layer this tile is being rendered within. This property does NOT factor in camera\nscroll, layer scale or layer position.","name":"pixelX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#pixelX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The y coordinate of the top left of this tile in pixels. This is relative to the top left\nof the layer this tile is being rendered within. This property does NOT factor in camera\nscroll, layer scale or layer position.","name":"pixelY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#pixelY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":150,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Tile specific properties. These usually come from Tiled.","name":"properties","type":{"names":["any"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#properties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The rotation angle of this tile.","name":"rotation","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile should collide with any object on the left side.","name":"collideLeft","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collideLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile should collide with any object on the right side.","name":"collideRight","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collideRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":186,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile should collide with any object on the top side.","name":"collideUp","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collideUp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":195,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile should collide with any object on the bottom side.","name":"collideDown","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collideDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":204,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile's left edge is interesting for collisions.","name":"faceLeft","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#faceLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":213,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile's right edge is interesting for collisions.","name":"faceRight","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#faceRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":222,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile's top edge is interesting for collisions.","name":"faceTop","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#faceTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":231,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile's bottom edge is interesting for collisions.","name":"faceBottom","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#faceBottom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":240,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Tile collision callback.","name":"collisionCallback","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collisionCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":249,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The context in which the collision callback will be called.","name":"collisionCallbackContext","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collisionCallbackContext","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":258,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The tint to apply to this tile. Note: tint is currently a single color value instead of\nthe 4 corner tint component on other GameObjects.","name":"tint","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#tint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":269,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"An empty object where physics-engine specific information (e.g. bodies) may be stored.","name":"physics","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#physics","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":279,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Check if the given x and y world coordinates are within this Tile. This does not factor in\ncamera scroll, layer scale or layer position.","kind":"function","name":"containsPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to test.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to test.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the coordinates are within this Tile, otherwise false."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#containsPoint","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":296,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Copies the tile data & properties from the given tile to this tile. This copies everything\nexcept for position and interesting faces.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile to copy from.","name":"tile"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#copy","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":326,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The collision group for this Tile, defined within the Tileset. This returns a reference to\nthe collision group stored within the Tileset, so any modification of the returned object\nwill impact all tiles that have the same index as this tile.","kind":"function","name":"getCollisionGroup","since":"3.0.0","returns":[{"type":{"names":["object"]},"nullable":true,"description":"tileset"}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":341,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The tile data for this Tile, defined within the Tileset. This typically contains Tiled\ncollision data, tile animations and terrain information. This returns a reference to the tile\ndata stored within the Tileset, so any modification of the returned object will impact all\ntiles that have the same index as this tile.","kind":"function","name":"getTileData","since":"3.0.0","returns":[{"type":{"names":["object"]},"nullable":true,"description":"tileset"}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getTileData","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":357,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world X position of the left side of the tile, factoring in the layers position,\nscale and scroll.","kind":"function","name":"getLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getLeft","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":375,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world X position of the right side of the tile, factoring in the layer's position,\nscale and scroll.","kind":"function","name":"getRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getRight","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":393,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world Y position of the top side of the tile, factoring in the layer's position,\nscale and scroll.","kind":"function","name":"getTop","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getTop","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":416,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world Y position of the bottom side of the tile, factoring in the layer's position,\nscale and scroll.","kind":"function","name":"getBottom","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getBottom","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":436,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world rectangle bounding box for the tile, factoring in the layers position,\nscale and scroll.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"},{"type":{"names":["object"]},"optional":true,"description":"[description]","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getBounds","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world X position of the center of the tile, factoring in the layer's position,\nscale and scroll.","kind":"function","name":"getCenterX","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getCenterX","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world Y position of the center of the tile, factoring in the layer's position,\nscale and scroll.","kind":"function","name":"getCenterY","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getCenterY","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":492,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Clean up memory.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#destroy","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Check for intersection with this tile. This does not factor in camera scroll, layer scale or\nlayer position.","kind":"function","name":"intersects","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x axis in pixels.","name":"x"},{"type":{"names":["number"]},"description":"The y axis in pixels.","name":"y"},{"type":{"names":["number"]},"description":"The right point.","name":"right"},{"type":{"names":["number"]},"description":"The bottom point.","name":"bottom"}],"returns":[{"type":{"names":["boolean"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#intersects","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":527,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Checks if the tile is interesting.","kind":"function","name":"isInteresting","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"If true, will consider the tile interesting if it collides on any side.","name":"collides"},{"type":{"names":["boolean"]},"description":"If true, will consider the tile interesting if it has an interesting face.","name":"faces"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Tile is interesting, otherwise false."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#isInteresting","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":546,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Reset collision status flags.","kind":"function","name":"resetCollision","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate interesting faces for this tile and its neighbors.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#resetCollision","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":583,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Reset faces.","kind":"function","name":"resetFaces","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#resetFaces","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":601,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the collision flags for each side of this tile and updates the interesting faces list.","kind":"function","name":"setCollision","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Indicating collide with any object on the left.","name":"left"},{"type":{"names":["boolean"]},"optional":true,"description":"Indicating collide with any object on the right.","name":"right"},{"type":{"names":["boolean"]},"optional":true,"description":"Indicating collide with any object on the top.","name":"up"},{"type":{"names":["boolean"]},"optional":true,"description":"Indicating collide with any object on the bottom.","name":"down"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate interesting faces\nfor this tile and its neighbors.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setCollision","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":646,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Set a callback to be called when this tile is hit by an object. The callback must true for\ncollision processing to take place.","kind":"function","name":"setCollisionCallback","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"Callback function.","name":"callback"},{"type":{"names":["object"]},"description":"Callback will be called within this context.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setCollisionCallback","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":674,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the size of the tile and updates its pixelX and pixelY.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The width of the tile in pixels.","name":"tileWidth"},{"type":{"names":["integer"]},"description":"The height of the tile in pixels.","name":"tileHeight"},{"type":{"names":["integer"]},"description":"The base width a tile in the map (in pixels).","name":"baseWidth"},{"type":{"names":["integer"]},"description":"The base height of the tile in pixels (in pixels).","name":"baseHeight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setSize","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":699,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Used internally. Updates the tile's world XY position based on the current tile size.","kind":"function","name":"updatePixelXY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#updatePixelXY","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":720,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"True if this tile can collide on any of its faces or has a collision callback set.","name":"canCollide","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#canCollide","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":735,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"True if this tile can collide on any of its faces.","name":"collides","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collides","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":750,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"True if this tile has any interesting faces.","name":"hasInterestingFace","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#hasInterestingFace","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":765,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The tileset that contains this Tile. This is null if accessed from a LayerData instance\nbefore the tile is placed in a StaticTilemapLayer or DynamicTilemapLayer, or if the tile has\nan index that doesn't correspond to any of the map's tilesets.","name":"tileset","type":{"names":["Phaser.Tilemaps.Tileset"]},"nullable":true,"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#tileset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":796,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The tilemap layer that contains this Tile. This will only return null if accessed from a\nLayerData instance before the tile is placed within a StaticTilemapLayer or\nDynamicTilemapLayer.","name":"tilemapLayer","type":{"names":["Phaser.Tilemaps.StaticTilemapLayer","Phaser.Tilemaps.DynamicTilemapLayer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#tilemapLayer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":813,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The tilemap that contains this Tile. This will only return null if accessed from a LayerData\ninstance before the tile is placed within a StaticTilemapLayer or DynamicTilemapLayer.","name":"tilemap","type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#tilemap","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,213],"filename":"Tilemap.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Tilemap.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"kind":"typedef","name":"TilemapFilterCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"An object found in the filtered area.","name":"value"},{"type":{"names":["number"]},"description":"The index of the object within the array.","name":"index"},{"type":{"names":["Array."]},"description":"An array of all the objects found.","name":"array"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The object."}],"longname":"TilemapFilterCallback","scope":"global","___s":true},{"meta":{"filename":"Tilemap.js","lineno":30,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"kind":"typedef","name":"TilemapFindCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"An object found.","name":"value"},{"type":{"names":["number"]},"description":"The index of the object within the array.","name":"index"},{"type":{"names":["Array."]},"description":"An array of all the objects found.","name":"array"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the callback should be invoked, otherwise `false`."}],"longname":"TilemapFindCallback","scope":"global","___s":true},{"meta":{"filename":"Tilemap.js","lineno":40,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"classdesc":"A Tilemap is a container for Tilemap data. This isn't a display object, rather, it holds data\nabout the map and allows you to add tilesets and tilemap layers to it. A map can have one or\nmore tilemap layers (StaticTilemapLayer or DynamicTilemapLayer), which are the display\nobjects that actually render tiles.\n\nThe Tilemap data be parsed from a Tiled JSON file, a CSV file or a 2D array. Tiled is a free\nsoftware package specifically for creating tile maps, and is available from:\nhttp://www.mapeditor.org\n\nA Tilemap has handy methods for getting & manipulating the tiles within a layer. You can only\nuse the methods that change tiles (e.g. removeTileAt) on a DynamicTilemapLayer.\n\nNote that all Tilemaps use a base tile size to calculate dimensions from, but that a\nStaticTilemapLayer or DynamicTilemapLayer may have its own unique tile size that overrides\nit.\n\nAs of Phaser 3.21.0, if your tilemap includes layer groups (a feature of Tiled 1.2.0+) these\nwill be traversed and the following properties will affect children:\n- opacity (blended with parent) and visibility (parent overrides child)\n- Vertical and horizontal offset\nThe grouping hierarchy is not preserved and all layers will be flattened into a single array.\nGroup layers are parsed during Tilemap construction but are discarded after parsing so dynamic\nlayers will NOT continue to be affected by a parent.\n\nTo avoid duplicate layer names, a layer that is a child of a group layer will have its parent\ngroup name prepended with a '/'. For example, consider a group called 'ParentGroup' with a\nchild called 'Layer 1'. In the Tilemap object, 'Layer 1' will have the name\n'ParentGroup/Layer 1'.","kind":"class","name":"Tilemap","memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Tilemap belongs.","name":"scene"},{"type":{"names":["Phaser.Tilemaps.MapData"]},"description":"A MapData instance containing Tilemap data.","name":"mapData"}],"scope":"static","longname":"Phaser.Tilemaps.Tilemap","___s":true},{"meta":{"filename":"Tilemap.js","lineno":85,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The base width of a tile in pixels. Note that individual layers may have a different tile\nwidth.","name":"tileWidth","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#tileWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The base height of a tile in pixels. Note that individual layers may have a different\ntile height.","name":"tileHeight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#tileHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The width of the map (in tiles).","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The height of the map (in tiles).","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The orientation of the map data (as specified in Tiled), usually 'orthogonal'.","name":"orientation","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#orientation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":139,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The render (draw) order of the map data (as specified in Tiled), usually 'right-down'.\n\nThe draw orders are:\n\nright-down\nleft-down\nright-up\nleft-up\n\nThis can be changed via the `setRenderOrder` method.","name":"renderOrder","type":{"names":["string"]},"since":"3.12.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#renderOrder","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The format of the map data.","name":"format","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#format","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The version of the map data (as specified in Tiled, usually 1).","name":"version","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#version","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":175,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Map specific properties as specified in Tiled.","name":"properties","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#properties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":184,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The width of the map in pixels based on width * tileWidth.","name":"widthInPixels","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#widthInPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":193,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The height of the map in pixels based on height * tileHeight.","name":"heightInPixels","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#heightInPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":202,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"imageCollections","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#imageCollections","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":210,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"An array of Tiled Image Layers.","name":"images","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#images","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":219,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"An array of Tilemap layer data.","name":"layers","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#layers","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":228,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"An array of Tilesets used in the map.","name":"tilesets","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#tilesets","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":237,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"An array of ObjectLayer instances parsed from Tiled object layers.","name":"objects","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#objects","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":246,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The index of the currently selected LayerData object.","name":"currentLayerIndex","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#currentLayerIndex","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the rendering (draw) order of the tiles in this map.\n\nThe default is 'right-down', meaning it will order the tiles starting from the top-left,\ndrawing to the right and then moving down to the next row.\n\nThe draw orders are:\n\n0 = right-down\n1 = left-down\n2 = right-up\n3 = left-up\n\nSetting the render order does not change the tiles or how they are stored in the layer,\nit purely impacts the order in which they are rendered.\n\nYou can provide either an integer (0 to 3), or the string version of the order.\n\nCalling this method _after_ creating Static or Dynamic Tilemap Layers will **not** automatically\nupdate them to use the new render order. If you call this method after creating layers, use their\nown `setRenderOrder` methods to change them as needed.","kind":"function","name":"setRenderOrder","since":"3.12.0","params":[{"type":{"names":["integer","string"]},"description":"The render (draw) order value. Either an integer between 0 and 3, or a string: 'right-down', 'left-down', 'right-up' or 'left-up'.","name":"renderOrder"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"This Tilemap object."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setRenderOrder","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":302,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Adds an image to the map to be used as a tileset. A single map may use multiple tilesets.\nNote that the tileset name can be found in the JSON file exported from Tiled, or in the Tiled\neditor.","kind":"function","name":"addTilesetImage","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tileset as specified in the map data.","name":"tilesetName"},{"type":{"names":["string"]},"optional":true,"description":"The key of the Phaser.Cache image used for this tileset. If\n`undefined` or `null` it will look for an image with a key matching the tilesetName parameter.","name":"key"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the tile (in pixels) in the Tileset Image. If not\ngiven it will default to the map's tileWidth value, or the tileWidth specified in the Tiled\nJSON file.","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the tiles (in pixels) in the Tileset Image. If\nnot given it will default to the map's tileHeight value, or the tileHeight specified in the\nTiled JSON file.","name":"tileHeight"},{"type":{"names":["integer"]},"optional":true,"description":"The margin around the tiles in the sheet (in pixels). If not\nspecified, it will default to 0 or the value specified in the Tiled JSON file.","name":"tileMargin"},{"type":{"names":["integer"]},"optional":true,"description":"The spacing between each the tile in the sheet (in pixels).\nIf not specified, it will default to 0 or the value specified in the Tiled JSON file.","name":"tileSpacing"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If adding multiple tilesets to a blank map, specify the starting\nGID this set will use here.","name":"gid"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tileset"]},"nullable":true,"description":"Returns the Tileset object that was created or updated, or null if it\nfailed."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#addTilesetImage","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":376,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Turns the DynamicTilemapLayer associated with the given layer into a StaticTilemapLayer. If\nno layer specified, the map's current layer is used. This is useful if you want to manipulate\na map at the start of a scene, but then make it non-manipulable and optimize it for speed.\nNote: the DynamicTilemapLayer passed in is destroyed, so make sure to store the value\nreturned from this method if you want to manipulate the new StaticTilemapLayer.","kind":"function","name":"convertLayerToStatic","since":"3.0.0","params":[{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer"]},"optional":true,"description":"The name of the layer from Tiled, the\nindex of the layer in the map, or a DynamicTilemapLayer.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"nullable":true,"description":"Returns the new layer that was created, or null if it\nfailed."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#convertLayerToStatic","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":421,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Copies the tiles in the source rectangular area to a new destination (all specified in tile\ncoordinates) within the layer. This copies all tile properties & recalculates collision\ninformation in the destination region.\n\nIf no layer specified, the map's current layer is used. This cannot be applied to StaticTilemapLayers.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the area to copy from, in tiles, not pixels.","name":"srcTileX"},{"type":{"names":["integer"]},"description":"The y coordinate of the area to copy from, in tiles, not pixels.","name":"srcTileY"},{"type":{"names":["integer"]},"description":"The width of the area to copy, in tiles, not pixels.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the area to copy, in tiles, not pixels.","name":"height"},{"type":{"names":["integer"]},"description":"The x coordinate of the area to copy to, in tiles, not pixels.","name":"destTileX"},{"type":{"names":["integer"]},"description":"The y coordinate of the area to copy to, in tiles, not pixels.","name":"destTileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#copy","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a new and empty DynamicTilemapLayer. The currently selected layer in the map is set to this new layer.","kind":"function","name":"createBlankDynamicLayer","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of this layer. Must be unique within the map.","name":"name"},{"type":{"names":["string","Array.","Phaser.Tilemaps.Tileset","Array."]},"description":"The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.","name":"tileset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world x position where the top left of this layer will be placed.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world y position where the top left of this layer will be placed.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the layer in tiles. If not specified, it will default to the map's width.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the layer in tiles. If not specified, it will default to the map's height.","name":"height"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the tiles the layer uses for calculations. If not specified, it will default to the map's tileWidth.","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the tiles the layer uses for calculations. If not specified, it will default to the map's tileHeight.","name":"tileHeight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"nullable":true,"description":"Returns the new layer that was created, or `null` if it failed."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#createBlankDynamicLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":534,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a new DynamicTilemapLayer that renders the LayerData associated with the given\n`layerID`. The currently selected layer in the map is set to this new layer.\n\nThe `layerID` is important. If you've created your map in Tiled then you can get this by\nlooking in Tiled and looking at the layer name. Or you can open the JSON file it exports and\nlook at the layers[].name value. Either way it must match.\n\nUnlike a static layer, a dynamic layer can be modified. See DynamicTilemapLayer for more\ninformation.","kind":"function","name":"createDynamicLayer","since":"3.0.0","params":[{"type":{"names":["integer","string"]},"description":"The layer array index value, or if a string is given, the layer name from Tiled.","name":"layerID"},{"type":{"names":["string","Array.","Phaser.Tilemaps.Tileset","Array."]},"description":"The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.","name":"tileset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position to place the layer in the world. If not specified, it will default to the layer offset from Tiled or 0.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position to place the layer in the world. If not specified, it will default to the layer offset from Tiled or 0.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"nullable":true,"description":"Returns the new layer was created, or null if it failed."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#createDynamicLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":603,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a Sprite for every object matching the given gid in the map data. All properties from\nthe map data objectgroup are copied into the `spriteConfig`, so you can use this as an easy\nway to configure Sprite properties from within the map editor. For example giving an object a\nproperty of alpha: 0.5 in the map editor will duplicate that when the Sprite is created.\n\nCustom object properties not sharing names with the Sprite's own properties are copied to the\nSprite's {@link Phaser.GameObjects.Sprite#data data store}.","kind":"function","name":"createFromObjects","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the object layer (from Tiled) to create Sprites from.","name":"name"},{"type":{"names":["integer","string"]},"description":"Either the id (object), gid (tile object) or name (object or\ntile object) from Tiled. Ids are unique in Tiled, but a gid is shared by all tile objects\nwith the same graphic. The same name can be used on multiple objects.","name":"id"},{"type":{"names":["Phaser.Types.GameObjects.Sprite.SpriteConfig"]},"description":"The config object to pass into the Sprite creator (i.e.\nscene.make.sprite).","name":"spriteConfig"},{"type":{"names":["Phaser.Scene"]},"optional":true,"defaultvalue":"the scene the map is within","description":"The Scene to create the Sprites within.","name":"scene"}],"returns":[{"type":{"names":["Array."]},"description":"An array of the Sprites that were created."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#createFromObjects","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":714,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a Sprite for every object matching the given tile indexes in the layer. You can\noptionally specify if each tile will be replaced with a new tile after the Sprite has been\ncreated. This is useful if you want to lay down special tiles in a level that are converted to\nSprites, but want to replace the tile itself with a floor tile or similar once converted.","kind":"function","name":"createFromTiles","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"The tile index, or array of indexes, to create Sprites from.","name":"indexes"},{"type":{"names":["integer","array"]},"description":"The tile index, or array of indexes, to change a converted\ntile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a\none-to-one mapping with the indexes array.","name":"replacements"},{"type":{"names":["Phaser.Types.GameObjects.Sprite.SpriteConfig"]},"description":"The config object to pass into the Sprite creator (i.e. scene.make.sprite).","name":"spriteConfig"},{"type":{"names":["Phaser.Scene"]},"optional":true,"defaultvalue":"scene the map is within","description":"The Scene to create the Sprites within.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Array."]},"nullable":true,"description":"Returns an array of Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#createFromTiles","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":743,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a new StaticTilemapLayer that renders the LayerData associated with the given\n`layerID`. The currently selected layer in the map is set to this new layer.\n\nThe `layerID` is important. If you've created your map in Tiled then you can get this by\nlooking in Tiled and looking at the layer name. Or you can open the JSON file it exports and\nlook at the layers[].name value. Either way it must match.\n\nIt's important to remember that a static layer cannot be modified. See StaticTilemapLayer for\nmore information.","kind":"function","name":"createStaticLayer","since":"3.0.0","params":[{"type":{"names":["integer","string"]},"description":"The layer array index value, or if a string is given, the layer name from Tiled.","name":"layerID"},{"type":{"names":["string","Array.","Phaser.Tilemaps.Tileset","Array."]},"description":"The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.","name":"tileset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position to place the layer in the world. If not specified, it will default to the layer offset from Tiled or 0.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position to place the layer in the world. If not specified, it will default to the layer offset from Tiled or 0.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"nullable":true,"description":"Returns the new layer was created, or null if it failed."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#createStaticLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":802,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Removes all layer data from this Tilemap and nulls the scene reference. This will destroy any\nStaticTilemapLayers or DynamicTilemapLayers that have been linked to LayerData.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#destroy","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":817,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the tiles in the given rectangular area (in tile coordinates) of the layer with the\nspecified index. Tiles will be set to collide if the given index is a colliding index.\nCollision information in the region will be recalculated.\n\nIf no layer specified, the map's current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"fill","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The tile index to fill the area with.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#fill","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":851,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"For each object in the given object layer, run the given filter callback function. Any\nobjects that pass the filter test (i.e. where the callback returns true) will returned as a\nnew array. Similar to Array.prototype.Filter in vanilla JS.","kind":"function","name":"filterObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.ObjectLayer","string"]},"description":"The name of an object layer (from Tiled) or an ObjectLayer instance.","name":"objectLayer"},{"type":{"names":["TilemapFilterCallback"]},"description":"The callback. Each object in the given area will be passed to this callback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"}],"returns":[{"type":{"names":["Array."]},"nullable":true,"description":"An array of object that match the search, or null if the objectLayer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#filterObjects","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":883,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\nfilter callback function. Any tiles that pass the filter test (i.e. where the callback returns\ntrue) will returned as a new array. Similar to Array.prototype.Filter in vanilla JS.\nIf no layer specified, the map's current layer is used.","kind":"function","name":"filterTiles","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"The callback. Each tile in the given area will be passed to this\ncallback as the first and only parameter. The callback should return true for tiles that pass the\nfilter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Array."]},"nullable":true,"description":"Returns an array of Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#filterTiles","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":914,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Searches the entire map layer for the first tile matching the given index, then returns that Tile\nobject. If no match is found, it returns null. The search starts from the top-left tile and\ncontinues horizontally until it hits the end of the row, then it drops down to the next column.\nIf the reverse boolean is true, it scans starting from the bottom-right corner traveling up to\nthe top-left.\nIf no layer specified, the map's current layer is used.","kind":"function","name":"findByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The tile index value to search for.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The number of times to skip a matching tile before returning.","name":"skip"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left.","name":"reverse"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#findByIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":941,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Find the first object in the given object layer that satisfies the provided testing function.\nI.e. finds the first object for which `callback` returns true. Similar to\nArray.prototype.find in vanilla JS.","kind":"function","name":"findObject","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.ObjectLayer","string"]},"description":"The name of an object layer (from Tiled) or an ObjectLayer instance.","name":"objectLayer"},{"type":{"names":["TilemapFindCallback"]},"description":"The callback. Each object in the given area will be passed to this callback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"description":"An object that matches the search, or null if no object found."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#findObject","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":973,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Find the first tile in the given rectangular area (in tile coordinates) of the layer that\nsatisfies the provided testing function. I.e. finds the first tile for which `callback` returns\ntrue. Similar to Array.prototype.find in vanilla JS.\nIf no layer specified, the maps current layer is used.","kind":"function","name":"findTile","since":"3.0.0","params":[{"type":{"names":["FindTileCallback"]},"description":"The callback. Each tile in the given area will be passed to this callback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The Tile layer to run the search on. If not provided will use the current layer.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#findTile","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1002,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\ncallback. Similar to Array.prototype.forEach in vanilla JS.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"forEachTile","since":"3.0.0","params":[{"type":{"names":["EachTileCallback"]},"description":"The callback. Each tile in the given area will be passed to this callback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The Tile layer to run the search on. If not provided will use the current layer.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#forEachTile","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1033,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the image layer index based on its name.","kind":"function","name":"getImageIndex","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the image to get.","name":"name"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the image in this tilemap, or null if not found."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getImageIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1048,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Return a list of all valid imagelayer names loaded in this Tilemap.","kind":"function","name":"getImageLayerNames","since":"3.21.0","returns":[{"type":{"names":["Array."]},"description":"Array of valid imagelayer names / IDs loaded into this Tilemap."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getImageLayerNames","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1069,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Internally used. Returns the index of the object in one of the Tilemaps arrays whose name\nproperty matches the given `name`.","kind":"function","name":"getIndex","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The Tilemap array to search.","name":"location"},{"type":{"names":["string"]},"description":"The name of the array element to get.","name":"name"}],"returns":[{"type":{"names":["number"]},"description":"The index of the element in the array, or null if not found."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1094,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the LayerData from this.layers that is associated with `layer`, or null if an invalid\n`layer` is given.","kind":"function","name":"getLayer","since":"3.0.0","params":[{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The name of the\nlayer from Tiled, the index of the layer in the map, a DynamicTilemapLayer or a\nStaticTilemapLayer. If not given will default to the maps current layer index.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.LayerData"]},"description":"The corresponding LayerData within this.layers."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the ObjectLayer from this.objects that has the given `name`, or null if no ObjectLayer\nis found with that name.","kind":"function","name":"getObjectLayer","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The name of the object layer from Tiled.","name":"name"}],"returns":[{"type":{"names":["Phaser.Tilemaps.ObjectLayer"]},"nullable":true,"description":"The corresponding ObjectLayer within this.objects or null."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getObjectLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Return a list of all valid objectgroup names loaded in this Tilemap.","kind":"function","name":"getObjectLayerNames","since":"3.21.0","returns":[{"type":{"names":["Array."]},"description":"Array of valid objectgroup names / IDs loaded into this Tilemap."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getObjectLayerNames","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1153,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the LayerData index of the given `layer` within this.layers, or null if an invalid\n`layer` is given.","kind":"function","name":"getLayerIndex","since":"3.0.0","params":[{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The name of the\nlayer from Tiled, the index of the layer in the map, a DynamicTilemapLayer or a\nStaticTilemapLayer. If not given will default to the map's current layer index.","name":"layer"}],"returns":[{"type":{"names":["integer"]},"description":"The LayerData index within this.layers."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getLayerIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the index of the LayerData within this.layers that has the given `name`, or null if an\ninvalid `name` is given.","kind":"function","name":"getLayerIndexByName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the layer to get.","name":"name"}],"returns":[{"type":{"names":["integer"]},"description":"The LayerData index within this.layers."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getLayerIndexByName","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets a tile at the given tile coordinates from the given layer.\nIf no layer specified, the map's current layer is used.","kind":"function","name":"getTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"X position to get the tile from (given in tile units, not pixels).","name":"tileX"},{"type":{"names":["integer"]},"description":"Y position to get the tile from (given in tile units, not pixels).","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true getTile won't return null for empty tiles, but a Tile object with an index of -1.","name":"nonNull"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tile, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTileAt","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets a tile at the given world coordinates from the given layer.\nIf no layer specified, the map's current layer is used.","kind":"function","name":"getTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"X position to get the tile from (given in pixels)","name":"worldX"},{"type":{"names":["number"]},"description":"Y position to get the tile from (given in pixels)","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, function won't return null for empty tiles, but a Tile object with an index of -1.","name":"nonNull"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tile, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1253,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Return a list of all valid tilelayer names loaded in this Tilemap.","kind":"function","name":"getTileLayerNames","since":"3.21.0","returns":[{"type":{"names":["Array."]},"description":"Array of valid tilelayer names / IDs loaded into this Tilemap."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTileLayerNames","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the tiles in the given rectangular area (in tile coordinates) of the layer.\nIf no layer specified, the maps current layer is used.","kind":"function","name":"getTilesWithin","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Array."]},"nullable":true,"description":"Returns an array of Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTilesWithin","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1299,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the tiles that overlap with the given shape in the given layer. The shape must be a Circle,\nLine, Rectangle or Triangle. The shape should be in world coordinates.\nIf no layer specified, the maps current layer is used.","kind":"function","name":"getTilesWithinShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle","Phaser.Geom.Line","Phaser.Geom.Rectangle","Phaser.Geom.Triangle"]},"description":"A shape in world (pixel) coordinates","name":"shape"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Array."]},"nullable":true,"description":"Returns an array of Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTilesWithinShape","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1323,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the tiles in the given rectangular area (in world coordinates) of the layer.\nIf no layer specified, the maps current layer is used.","kind":"function","name":"getTilesWithinWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The world x coordinate for the top-left of the area.","name":"worldX"},{"type":{"names":["number"]},"description":"The world y coordinate for the top-left of the area.","name":"worldY"},{"type":{"names":["number"]},"description":"The width of the area.","name":"width"},{"type":{"names":["number"]},"description":"The height of the area.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Array."]},"nullable":true,"description":"Returns an array of Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTilesWithinWorldXY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the Tileset that has the given `name`, or null if an invalid `name` is given.","kind":"function","name":"getTileset","since":"3.14.0","params":[{"type":{"names":["string"]},"description":"The name of the Tileset to get.","name":"name"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tileset"]},"nullable":true,"description":"The Tileset, or `null` if no matching named tileset was found."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTileset","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1366,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the index of the Tileset within this.tilesets that has the given `name`, or null if an\ninvalid `name` is given.","kind":"function","name":"getTilesetIndex","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the Tileset to get.","name":"name"}],"returns":[{"type":{"names":["integer"]},"description":"The Tileset index within this.tilesets."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTilesetIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1382,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns\nfalse if there is no tile or if the tile at that location has an index of -1.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"hasTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["boolean"]},"nullable":true,"description":"Returns a boolean, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#hasTileAt","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1406,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns\nfalse if there is no tile or if the tile at that location has an index of -1.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"hasTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate, in pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate, in pixels.","name":"worldY"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["boolean"]},"nullable":true,"description":"Returns a boolean, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#hasTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The LayerData object that is currently selected in the map. You can set this property using\nany type supported by setLayer.","name":"layer","type":{"names":["Phaser.Tilemaps.LayerData"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#layer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Puts a tile at the given tile coordinates in the specified layer. You can pass in either an index\nor a Tile object. If you pass in a Tile, all attributes will be copied over to the specified\nlocation. If you pass in an index, only the index at the specified location will be changed.\nCollision information will be recalculated at the specified location.\n\nIf no layer specified, the maps current layer is used.\n\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"putTileAt","since":"3.0.0","params":[{"type":{"names":["integer","Phaser.Tilemaps.Tile"]},"description":"The index of this tile to set or a Tile object.","name":"tile"},{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tile, or null if the layer given was invalid or the coordinates were out of bounds."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#putTileAt","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Puts a tile at the given world coordinates (pixels) in the specified layer. You can pass in either\nan index or a Tile object. If you pass in a Tile, all attributes will be copied over to the\nspecified location. If you pass in an index, only the index at the specified location will be\nchanged. Collision information will be recalculated at the specified location.\n\nIf no layer specified, the maps current layer is used. This\ncannot be applied to StaticTilemapLayers.","kind":"function","name":"putTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["integer","Phaser.Tilemaps.Tile"]},"description":"The index of this tile to set or a Tile object.","name":"tile"},{"type":{"names":["number"]},"description":"The x coordinate, in pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate, in pixels.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tile, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#putTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1515,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Puts an array of tiles or a 2D array of tiles at the given tile coordinates in the specified\nlayer. The array can be composed of either tile indexes or Tile objects. If you pass in a Tile,\nall attributes will be copied over to the specified location. If you pass in an index, only the\nindex at the specified location will be changed. Collision information will be recalculated\nwithin the region tiles were changed.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"putTilesAt","since":"3.0.0","params":[{"type":{"names":["Array.","Array.>","Array.","Array.>"]},"description":"A row (array) or grid (2D array) of Tiles or tile indexes to place.","name":"tile"},{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#putTilesAt","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1549,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\nspecified layer. Each tile will receive a new index. If an array of indexes is passed in, then\nthose will be used for randomly assigning new tile indexes. If an array is not provided, the\nindexes found within the region (excluding -1) will be used for randomly assigning new tile\nindexes. This method only modifies tile indexes and does not change collision information.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"randomize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Array."]},"optional":true,"description":"An array of indexes to randomly draw from during randomization.","name":"indexes"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#randomize","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1584,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Calculates interesting faces at the given tile coordinates of the specified layer. Interesting\nfaces are used internally for optimizing collisions against tiles. This method is mostly used\ninternally to optimize recalculating faces when only one tile has been changed.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"calculateFacesAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#calculateFacesAt","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1611,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Calculates interesting faces within the rectangular area specified (in tile coordinates) of the\nlayer. Interesting faces are used internally for optimizing collisions against tiles. This method\nis mostly used internally.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"calculateFacesWithin","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#calculateFacesWithin","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1640,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Removes the given TilemapLayer from this Tilemap without destroying it.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"removeLayer","since":"3.17.0","params":[{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to be removed.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#removeLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1680,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Destroys the given TilemapLayer and removes it from this Tilemap.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"destroyLayer","since":"3.17.0","params":[{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to be destroyed.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#destroyLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Removes all layers from this Tilemap and destroys any associated StaticTilemapLayers or\nDynamicTilemapLayers.","kind":"function","name":"removeAllLayers","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"This Tilemap object."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#removeAllLayers","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1746,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Removes the given Tile, or an array of Tiles, from the layer to which they belong,\nand optionally recalculates the collision information.\n\nThis cannot be applied to Tiles that belong to Static Tilemap Layers.","kind":"function","name":"removeTile","since":"3.17.0","params":[{"type":{"names":["Phaser.Tilemaps.Tile","Array."]},"description":"The Tile to remove, or an array of Tiles.","name":"tiles"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":-1,"description":"After removing the Tile, insert a brand new Tile into its location with the given index. Leave as -1 to just remove the tile.","name":"replaceIndex"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Array."]},"description":"Returns an array of Tiles that were removed."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#removeTile","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1788,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Removes the tile at the given tile coordinates in the specified layer and updates the layer's\ncollision information.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"removeTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.","name":"replaceWithNull"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns the Tile that was removed, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#removeTileAt","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1817,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Removes the tile at the given world coordinates in the specified layer and updates the layer's\ncollision information.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"removeTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate, in pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate, in pixels.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.","name":"replaceWithNull"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tile, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#removeTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1847,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Draws a debug representation of the layer to the given Graphics. This is helpful when you want to\nget a quick idea of which of your tiles are colliding and which have interesting faces. The tiles\nare drawn starting at (0, 0) in the Graphics, allowing you to place the debug representation\nwherever you want on the screen.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"renderDebug","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The target Graphics object to draw upon.","name":"graphics"},{"type":{"names":["Phaser.Types.Tilemaps.StyleConfig"]},"description":"An object specifying the colors to use for the debug drawing.","name":"styleConfig"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#renderDebug","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1875,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Draws a debug representation of all layers within this Tilemap to the given Graphics object.\n\nThis is helpful when you want to get a quick idea of which of your tiles are colliding and which\nhave interesting faces. The tiles are drawn starting at (0, 0) in the Graphics, allowing you to\nplace the debug representation wherever you want on the screen.","kind":"function","name":"renderDebugFull","since":"3.17.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The target Graphics object to draw upon.","name":"graphics"},{"type":{"names":["Phaser.Types.Tilemaps.StyleConfig"]},"description":"An object specifying the colors to use for the debug drawing.","name":"styleConfig"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#renderDebugFull","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1904,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\n`findIndex` and updates their index to match `newIndex`. This only modifies the index and does\nnot change collision information.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"replaceByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the tile to search for.","name":"findIndex"},{"type":{"names":["integer"]},"description":"The index of the tile to replace it with.","name":"newIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#replaceByIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1938,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets collision on the given tile or tiles within a layer by index. You can pass in either a\nsingle numeric index or an array of indexes: [2, 3, 15, 20]. The `collides` parameter controls if\ncollision will be enabled (true) or disabled (false).\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setCollision","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"Either a single tile index, or an array of tile indexes.","name":"indexes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, updates the current tiles on the layer. Set to false if no tiles have been placed for significant performance boost.","name":"updateLayer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setCollision","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1967,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets collision on a range of tiles in a layer whose index is between the specified `start` and\n`stop` (inclusive). Calling this with a start value of 10 and a stop value of 14 would set\ncollision for tiles 10, 11, 12, 13 and 14. The `collides` parameter controls if collision will be\nenabled (true) or disabled (false).\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setCollisionBetween","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The first index of the tile to be set for collision.","name":"start"},{"type":{"names":["integer"]},"description":"The last index of the tile to be set for collision.","name":"stop"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setCollisionBetween","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1997,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets collision on the tiles within a layer by checking tile properties. If a tile has a property\nthat matches the given properties object, its collision flag will be set. The `collides`\nparameter controls if collision will be enabled (true) or disabled (false). Passing in\n`{ collides: true }` would update the collision flag on any tiles with a \"collides\" property that\nhas a value of true. Any tile that doesn't have \"collides\" set to true will be ignored. You can\nalso use an array of values, e.g. `{ types: [\"stone\", \"lava\", \"sand\" ] }`. If a tile has a\n\"types\" property that matches any of those values, its collision flag will be updated.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setCollisionByProperty","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"An object with tile properties and corresponding values that should be checked.","name":"properties"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setCollisionByProperty","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2029,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets collision on all tiles in the given layer, except for tiles that have an index specified in\nthe given array. The `collides` parameter controls if collision will be enabled (true) or\ndisabled (false).\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setCollisionByExclusion","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of the tile indexes to not be counted for collision.","name":"indexes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setCollisionByExclusion","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2057,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets collision on the tiles within a layer by checking each tile's collision group data\n(typically defined in Tiled within the tileset collision editor). If any objects are found within\na tile's collision group, the tile's colliding information will be set. The `collides` parameter\ncontrols if collision will be enabled (true) or disabled (false).\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setCollisionFromCollisionGroup","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setCollisionFromCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2085,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets a global collision callback for the given tile index within the layer. This will affect all\ntiles on this layer that have the same index. If a callback is already set for the tile index it\nwill be replaced. Set the callback to null to remove it. If you want to set a callback for a tile\nat a specific location on the map then see setTileLocationCallback.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setTileIndexCallback","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"Either a single tile index, or an array of tile indexes to have a collision callback set for.","name":"indexes"},{"type":{"names":["function"]},"description":"The callback that will be invoked when the tile is collided with.","name":"callback"},{"type":{"names":["object"]},"description":"The context under which the callback is called.","name":"callbackContext"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setTileIndexCallback","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets a collision callback for the given rectangular area (in tile coordinates) within the layer.\nIf a callback is already set for the tile index it will be replaced. Set the callback to null to\nremove it.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setTileLocationCallback","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["function"]},"description":"The callback that will be invoked when the tile is collided with.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback is called.","name":"callbackContext"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setTileLocationCallback","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the current layer to the LayerData associated with `layer`.","kind":"function","name":"setLayer","since":"3.0.0","params":[{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The name of the\nlayer from Tiled, the index of the layer in the map, a DynamicTilemapLayer or a\nStaticTilemapLayer. If not given will default to the map's current layer index.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"This Tilemap object."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the base tile size for the map. Note: this does not necessarily match the tileWidth and\ntileHeight for all layers. This also updates the base size on all tiles across all layers.","kind":"function","name":"setBaseTileSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The width of the tiles the map uses for calculations.","name":"tileWidth"},{"type":{"names":["integer"]},"description":"The height of the tiles the map uses for calculations.","name":"tileHeight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"This Tilemap object."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setBaseTileSize","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the tile size for a specific `layer`. Note: this does not necessarily match the map's\ntileWidth and tileHeight for all layers. This will set the tile size for the layer and any\ntiles the layer has.","kind":"function","name":"setLayerTileSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The width of the tiles (in pixels) in the layer.","name":"tileWidth"},{"type":{"names":["integer"]},"description":"The height of the tiles (in pixels) in the layer.","name":"tileHeight"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The name of the\nlayer from Tiled, the index of the layer in the map, a DynamicTilemapLayer or a\nStaticTilemapLayer. If not given will default to the map's current layer index.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"This Tilemap object."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setLayerTileSize","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Shuffles the tiles in a rectangular region (specified in tile coordinates) within the given\nlayer. It will only randomize the tiles in that area, so if they're all the same nothing will\nappear to have changed! This method only modifies tile indexes and does not change collision\ninformation.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"shuffle","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#shuffle","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2293,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\n`indexA` and swaps then with `indexB`. This only modifies the index and does not change collision\ninformation.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"swapByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"First tile index.","name":"tileA"},{"type":{"names":["integer"]},"description":"Second tile index.","name":"tileB"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#swapByIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2327,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Converts from tile X coordinates (tile units) to world X coordinates (pixels), factoring in the\nlayers position, scale and scroll.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"tileToWorldX","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["number"]},"nullable":true,"description":"Returns a number, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#tileToWorldX","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Converts from tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\nlayers position, scale and scroll.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"tileToWorldY","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer\nto use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["number"]},"nullable":true,"description":"Returns a number, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#tileToWorldY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2376,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Converts from tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\nlayers position, scale and scroll. This will return a new Vector2 object or update the given\n`point` object.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"tileToWorldXY","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the coordinates in. If not given a new Vector2 is created.","name":"point"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"nullable":true,"description":"Returns a point, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#tileToWorldXY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2403,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\nspecified layer. Each tile will receive a new index. New indexes are drawn from the given\nweightedIndexes array. An example weighted array:\n\n[\n { index: 6, weight: 4 }, // Probability of index 6 is 4 / 8\n { index: 7, weight: 2 }, // Probability of index 7 would be 2 / 8\n { index: 8, weight: 1.5 }, // Probability of index 8 would be 1.5 / 8\n { index: 26, weight: 0.5 } // Probability of index 27 would be 0.5 / 8\n]\n\nThe probability of any index being choose is (the index's weight) / (sum of all weights). This\nmethod only modifies tile indexes and does not change collision information.\n\nIf no layer specified, the map's current layer is used. This\ncannot be applied to StaticTilemapLayers.","kind":"function","name":"weightedRandomize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Array."]},"optional":true,"description":"An array of objects to randomly draw from during\nrandomization. They should be in the form: { index: 0, weight: 4 } or\n{ index: [0, 1], weight: 4 } if you wish to draw from multiple tile indexes.","name":"weightedIndexes"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#weightedRandomize","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2448,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Converts from world X coordinates (pixels) to tile X coordinates (tile units), factoring in the\nlayers position, scale and scroll.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"worldToTileX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to be converted, in pixels, not tiles.","name":"worldX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the nearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer\nto use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["number"]},"nullable":true,"description":"Returns a number, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#worldToTileX","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2474,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Converts from world Y coordinates (pixels) to tile Y coordinates (tile units), factoring in the\nlayers position, scale and scroll.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"worldToTileY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The y coordinate to be converted, in pixels, not tiles.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the nearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["number"]},"nullable":true,"description":"Returns a number, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#worldToTileY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2499,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Converts from world XY coordinates (pixels) to tile XY coordinates (tile units), factoring in the\nlayers position, scale and scroll. This will return a new Vector2 object or update the given\n`point` object.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"worldToTileXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to be converted, in pixels, not tiles.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate to be converted, in pixels, not tiles.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the nearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the coordinates in. If not given a new Vector2 is created.","name":"point"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"nullable":true,"description":"Returns a point, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#worldToTileXY","scope":"instance","___s":true},{"meta":{"range":[180,243],"filename":"TilemapCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"GameObjectCreator","longname":"GameObjectCreator","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TilemapCreator.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided.\nWhen loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing\nfrom a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map\ndata. For an empty map, you should specify tileWidth, tileHeight, width & height.","kind":"function","name":"tilemap","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tilemaps.TilemapConfig"]},"optional":true,"description":"The config options for the Tilemap.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]}}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#tilemap","scope":"instance","___s":true},{"meta":{"range":[180,243],"filename":"TilemapFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TilemapFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided.\nWhen loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing\nfrom a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map\ndata. For an empty map, you should specify tileWidth, tileHeight, width & height.","kind":"function","name":"tilemap","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The key in the Phaser cache that corresponds to the loaded tilemap data.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The width of a tile in pixels. Pass in `null` to leave as the\ndefault.","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The height of a tile in pixels. Pass in `null` to leave as the\ndefault.","name":"tileHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The width of the map in tiles. Pass in `null` to leave as the\ndefault.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The height of the map in tiles. Pass in `null` to leave as the\ndefault.","name":"height"},{"type":{"names":["Array.>"]},"optional":true,"description":"Instead of loading from the cache, you can also load directly from\na 2D array of tile indexes. Pass in `null` for no data.","name":"data"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Controls how empty tiles, tiles with an index of -1, in the\nmap data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]}}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#tilemap","scope":"instance","___s":true},{"meta":{"range":[180,213],"filename":"Tileset.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Tileset.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"classdesc":"A Tileset is a combination of an image containing the tiles and a container for data about\neach tile.","kind":"class","name":"Tileset","memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tileset in the map data.","name":"name"},{"type":{"names":["integer"]},"description":"The first tile index this tileset contains.","name":"firstgid"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"Width of each tile (in pixels).","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"Height of each tile (in pixels).","name":"tileHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The margin around all tiles in the sheet (in pixels).","name":"tileMargin"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The spacing between each tile in the sheet (in pixels).","name":"tileSpacing"},{"type":{"names":["object"]},"optional":true,"defaultvalue":"{}","description":"Custom properties defined per tile in the Tileset.\nThese typically are custom properties created in Tiled when editing a tileset.","name":"tileProperties"},{"type":{"names":["object"]},"optional":true,"defaultvalue":"{}","description":"Data stored per tile. These typically are created in Tiled\nwhen editing a tileset, e.g. from Tiled's tile collision editor or terrain editor.","name":"tileData"}],"scope":"static","longname":"Phaser.Tilemaps.Tileset","___s":true},{"meta":{"filename":"Tileset.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The name of the Tileset.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The starting index of the first tile index this Tileset contains.","name":"firstgid","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#firstgid","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The width of each tile (in pixels). Use setTileSize to change.","name":"tileWidth","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#tileWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The height of each tile (in pixels). Use setTileSize to change.","name":"tileHeight","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#tileHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The margin around the tiles in the sheet (in pixels). Use `setSpacing` to change.","name":"tileMargin","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#tileMargin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The spacing between each the tile in the sheet (in pixels). Use `setSpacing` to change.","name":"tileSpacing","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#tileSpacing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Tileset-specific properties per tile that are typically defined in the Tiled editor in the\nTileset editor.","name":"tileProperties","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#tileProperties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Tileset-specific data per tile that are typically defined in the Tiled editor, e.g. within\nthe Tileset collision editor. This is where collision objects and terrain are stored.","name":"tileData","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#tileData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The cached image that contains the individual tiles. Use setImage to set.","name":"image","type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#image","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The gl texture used by the WebGL renderer.","name":"glTexture","type":{"names":["WebGLTexture"]},"nullable":true,"readonly":true,"since":"3.11.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#glTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The number of tile rows in the the tileset.","name":"rows","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#rows","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The number of tile columns in the tileset.","name":"columns","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#columns","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The total number of tiles in the tileset.","name":"total","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#total","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":171,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The look-up table to specific tile image texture coordinates (UV in pixels). Each element\ncontains the coordinates for a tile in an object of the form {x, y}.","name":"texCoordinates","type":{"names":["Array."]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#texCoordinates","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Get a tiles properties that are stored in the Tileset. Returns null if tile index is not\ncontained in this Tileset. This is typically defined in Tiled under the Tileset editor.","kind":"function","name":"getTileProperties","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The unique id of the tile across all tilesets in the map.","name":"tileIndex"}],"returns":[{"type":{"names":["object","undefined"]},"nullable":true}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#getTileProperties","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Get a tile's data that is stored in the Tileset. Returns null if tile index is not contained\nin this Tileset. This is typically defined in Tiled and will contain both Tileset collision\ninfo and terrain mapping.","kind":"function","name":"getTileData","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The unique id of the tile across all tilesets in the map.","name":"tileIndex"}],"returns":[{"type":{"names":["object","undefined"]}}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#getTileData","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Get a tile's collision group that is stored in the Tileset. Returns null if tile index is not\ncontained in this Tileset. This is typically defined within Tiled's tileset collision editor.","kind":"function","name":"getTileCollisionGroup","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The unique id of the tile across all tilesets in the map.","name":"tileIndex"}],"returns":[{"type":{"names":["object"]},"nullable":true}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#getTileCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Returns true if and only if this Tileset contains the given tile index.","kind":"function","name":"containsTileIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The unique id of the tile across all tilesets in the map.","name":"tileIndex"}],"returns":[{"type":{"names":["boolean"]}}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#containsTileIndex","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Returns the texture coordinates (UV in pixels) in the Tileset image for the given tile index.\nReturns null if tile index is not contained in this Tileset.","kind":"function","name":"getTileTextureCoordinates","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The unique id of the tile across all tilesets in the map.","name":"tileIndex"}],"returns":[{"type":{"names":["object"]},"nullable":true,"description":"Object in the form { x, y } representing the top-left UV coordinate\nwithin the Tileset image."}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#getTileTextureCoordinates","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":275,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the image associated with this Tileset and updates the tile data (rows, columns, etc.).","kind":"function","name":"setImage","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"The image that contains the tiles.","name":"texture"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tileset"]},"description":"This Tileset object."}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#setImage","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":296,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the tile width & height and updates the tile data (rows, columns, etc.).","kind":"function","name":"setTileSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The width of a tile in pixels.","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The height of a tile in pixels.","name":"tileHeight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tileset"]},"description":"This Tileset object."}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#setTileSize","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":320,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the tile margin & spacing and updates the tile data (rows, columns, etc.).","kind":"function","name":"setSpacing","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The margin around the tiles in the sheet (in pixels).","name":"margin"},{"type":{"names":["integer"]},"optional":true,"description":"The spacing between the tiles in the sheet (in pixels).","name":"spacing"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tileset"]},"description":"This Tileset object."}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#setSpacing","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":344,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Updates tile texture coordinates and tileset data.","kind":"function","name":"updateTileData","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The (expected) width of the image to slice.","name":"imageWidth"},{"type":{"names":["integer"]},"description":"The (expected) height of the image to slice.","name":"imageHeight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tileset"]},"description":"This Tileset object."}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#updateTileData","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"CalculateFacesAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTileAt","longname":"GetTileAt","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,214],"filename":"CalculateFacesWithin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTileAt","longname":"GetTileAt","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"Copy.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,220],"filename":"CreateFromTiles.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"TileToWorldX","longname":"TileToWorldX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"CullTiles.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"SnapFloor","longname":"SnapFloor","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"Fill.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"FilterTiles.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"FindTile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FindTile.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"kind":"typedef","name":"FindTileCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The Tile.","name":"value"},{"type":{"names":["integer"]},"description":"The index of the tile.","name":"index"},{"type":{"names":["Array."]},"description":"An array of Tile objects.","name":"array"}],"returns":[{"type":{"names":["boolean"]},"description":"Return `true` if the callback should run, otherwise `false`."}],"longname":"FindTileCallback","scope":"global","___s":true},{"meta":{"range":[180,224],"filename":"ForEachTile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ForEachTile.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"kind":"typedef","name":"EachTileCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The Tile.","name":"value"},{"type":{"names":["integer"]},"description":"The index of the tile.","name":"index"},{"type":{"names":["Array."]},"description":"An array of Tile objects.","name":"array"}],"longname":"EachTileCallback","scope":"global","___s":true},{"meta":{"range":[180,226],"filename":"GetTileAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"IsInLayerBounds","longname":"IsInLayerBounds","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,214],"filename":"GetTileAtWorldXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTileAt","longname":"GetTileAt","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,237],"filename":"GetTilesWithin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,209],"filename":"GetTilesWithinShape.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"Geom","longname":"Geom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"GetTilesWithinWorldXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,226],"filename":"HasTileAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"IsInLayerBounds","longname":"IsInLayerBounds","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,214],"filename":"HasTileAtWorldXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"HasTileAt","longname":"HasTileAt","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,205],"filename":"PutTileAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"Tile","longname":"Tile","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,214],"filename":"PutTileAtWorldXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"PutTileAt","longname":"PutTileAt","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,236],"filename":"PutTilesAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"CalculateFacesWithin","longname":"CalculateFacesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"Randomize.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,205],"filename":"RemoveTileAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"Tile","longname":"Tile","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,220],"filename":"RemoveTileAtWorldXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"RemoveTileAt","longname":"RemoveTileAt","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"RenderDebug.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"ReplaceByIndex.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"SetCollision.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"SetTileCollision","longname":"SetTileCollision","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"SetCollisionBetween.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"SetTileCollision","longname":"SetTileCollision","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"SetCollisionByExclusion.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"SetTileCollision","longname":"SetTileCollision","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"SetCollisionByProperty.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"SetTileCollision","longname":"SetTileCollision","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"SetCollisionFromCollisionGroup.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"SetTileCollision","longname":"SetTileCollision","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"SetTileLocationCallback.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"Shuffle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"SwapByIndex.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,220],"filename":"TileToWorldXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"TileToWorldX","longname":"TileToWorldX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"WeightedRandomize.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,220],"filename":"WorldToTileXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"WorldToTileX","longname":"WorldToTileX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"kind":"namespace","name":"Components","memberof":"Phaser.Tilemaps","longname":"Phaser.Tilemaps.Components","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"DynamicTilemapLayer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"classdesc":"A Dynamic Tilemap Layer is a Game Object that renders LayerData from a Tilemap when used in combination\nwith one, or more, Tilesets.\n\nA Dynamic Tilemap Layer trades some speed for being able to apply powerful effects. Unlike a\nStatic Tilemap Layer, you can apply per-tile effects like tint or alpha, and you can change the\ntiles in a DynamicTilemapLayer.\n\nUse this over a Static Tilemap Layer when you need those features.","kind":"class","name":"DynamicTilemapLayer","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs.","name":"scene"},{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"The Tilemap this layer is a part of.","name":"tilemap"},{"type":{"names":["integer"]},"description":"The index of the LayerData associated with this layer.","name":"layerIndex"},{"type":{"names":["string","Array.","Phaser.Tilemaps.Tileset","Array."]},"description":"The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.","name":"tileset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world x position where the top left of this layer will be placed.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world y position where the top left of this layer will be placed.","name":"y"}],"scope":"static","longname":"Phaser.Tilemaps.DynamicTilemapLayer","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Used internally by physics system to perform fast type checks.","name":"isTilemap","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#isTilemap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The Tilemap that this layer is a part of.","name":"tilemap","type":{"names":["Phaser.Tilemaps.Tilemap"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tilemap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The index of the LayerData associated with this layer.","name":"layerIndex","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#layerIndex","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The LayerData associated with this layer. LayerData can only be associated with one\ntilemap layer.","name":"layer","type":{"names":["Phaser.Tilemaps.LayerData"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#layer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The Tileset/s associated with this layer.\n\nAs of Phaser 3.14 this property is now an array of Tileset objects, previously it was a single reference.","name":"tileset","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tileset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Used internally with the canvas render. This holds the tiles that are visible within the\ncamera.","name":"culledTiles","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#culledTiles","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"You can control if the Cameras should cull tiles before rendering them or not.\nBy default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.\n\nHowever, there are some instances when you may wish to disable this, and toggling this flag allows\nyou to do so. Also see `setSkipCull` for a chainable method that does the same thing.","name":"skipCull","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#skipCull","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":149,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The total number of tiles drawn by the renderer in the last frame.","name":"tilesDrawn","type":{"names":["integer"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tilesDrawn","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The total number of tiles in this layer. Updated every frame.","name":"tilesTotal","type":{"names":["integer"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tilesTotal","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":169,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The amount of extra tiles to add into the cull rectangle when calculating its horizontal size.\n\nSee the method `setCullPadding` for more details.","name":"cullPaddingX","type":{"names":["integer"]},"defaultvalue":"1","since":"3.11.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#cullPaddingX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":181,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The amount of extra tiles to add into the cull rectangle when calculating its vertical size.\n\nSee the method `setCullPadding` for more details.","name":"cullPaddingY","type":{"names":["integer"]},"defaultvalue":"1","since":"3.11.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#cullPaddingY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":193,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The callback that is invoked when the tiles are culled.\n\nBy default it will call `TilemapComponents.CullTiles` but you can override this to call any function you like.\n\nIt will be sent 3 arguments:\n\n1. The Phaser.Tilemaps.LayerData object for this Layer\n2. The Camera that is culling the layer. You can check its `dirty` property to see if it has changed since the last cull.\n3. A reference to the `culledTiles` array, which should be used to store the tiles you want rendered.\n\nSee the `TilemapComponents.CullTiles` source code for details on implementing your own culling system.","name":"cullCallback","type":{"names":["function"]},"since":"3.11.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#cullCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":235,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"An array holding the mapping between the tile indexes and the tileset they belong to.","name":"gidMap","type":{"names":["Array."]},"since":"3.14.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#gidMap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":299,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets the rendering (draw) order of the tiles in this layer.\n\nThe default is 'right-down', meaning it will order the tiles starting from the top-left,\ndrawing to the right and then moving down to the next row.\n\nThe draw orders are:\n\n0 = right-down\n1 = left-down\n2 = right-up\n3 = left-up\n\nSetting the render order does not change the tiles or how they are stored in the layer,\nit purely impacts the order in which they are rendered.\n\nYou can provide either an integer (0 to 3), or the string version of the order.","kind":"function","name":"setRenderOrder","since":"3.12.0","params":[{"type":{"names":["integer","string"]},"description":"The render (draw) order value. Either an integer between 0 and 3, or a string: 'right-down', 'left-down', 'right-up' or 'left-up'.","name":"renderOrder"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setRenderOrder","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":341,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Calculates interesting faces at the given tile coordinates of the specified layer. Interesting\nfaces are used internally for optimizing collisions against tiles. This method is mostly used\ninternally to optimize recalculating faces when only one tile has been changed.","kind":"function","name":"calculateFacesAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate.","name":"tileY"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#calculateFacesAt","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":361,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Calculates interesting faces within the rectangular area specified (in tile coordinates) of the\nlayer. Interesting faces are used internally for optimizing collisions against tiles. This method\nis mostly used internally.","kind":"function","name":"calculateFacesWithin","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#calculateFacesWithin","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":383,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Creates a Sprite for every object matching the given tile indexes in the layer. You can\noptionally specify if each tile will be replaced with a new tile after the Sprite has been\ncreated. This is useful if you want to lay down special tiles in a level that are converted to\nSprites, but want to replace the tile itself with a floor tile or similar once converted.","kind":"function","name":"createFromTiles","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"The tile index, or array of indexes, to create Sprites from.","name":"indexes"},{"type":{"names":["integer","array"]},"description":"The tile index, or array of indexes, to change a converted\ntile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a\none-to-one mapping with the indexes array.","name":"replacements"},{"type":{"names":["Phaser.Types.GameObjects.Sprite.SpriteConfig"]},"description":"The config object to pass into the Sprite creator (i.e.\nscene.make.sprite).","name":"spriteConfig"},{"type":{"names":["Phaser.Scene"]},"optional":true,"defaultvalue":"scene the map is within","description":"The Scene to create the Sprites within.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when determining the world XY","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of the Sprites that were created."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#createFromTiles","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":408,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Returns the tiles in the given layer that are within the cameras viewport.\nThis is used internally.","kind":"function","name":"cull","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to run the cull check against.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#cull","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":424,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Copies the tiles in the source rectangular area to a new destination (all specified in tile\ncoordinates) within the layer. This copies all tile properties & recalculates collision\ninformation in the destination region.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the area to copy from, in tiles, not pixels.","name":"srcTileX"},{"type":{"names":["integer"]},"description":"The y coordinate of the area to copy from, in tiles, not pixels.","name":"srcTileY"},{"type":{"names":["integer"]},"description":"The width of the area to copy, in tiles, not pixels.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the area to copy, in tiles, not pixels.","name":"height"},{"type":{"names":["integer"]},"description":"The x coordinate of the area to copy to, in tiles, not pixels.","name":"destTileX"},{"type":{"names":["integer"]},"description":"The y coordinate of the area to copy to, in tiles, not pixels.","name":"destTileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#copy","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Destroys this DynamicTilemapLayer and removes its link to the associated LayerData.","kind":"function","name":"destroy","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Remove this layer from the parent Tilemap?","name":"removeFromTilemap"}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#destroy","scope":"instance","overrides":"Phaser.GameObjects.GameObject#destroy","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":489,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets the tiles in the given rectangular area (in tile coordinates) of the layer with the\nspecified index. Tiles will be set to collide if the given index is a colliding index.\nCollision information in the region will be recalculated.","kind":"function","name":"fill","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The tile index to fill the area with.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#fill","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\nfilter callback function. Any tiles that pass the filter test (i.e. where the callback returns\ntrue) will returned as a new array. Similar to Array.prototype.Filter in vanilla JS.","kind":"function","name":"filterTiles","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"The callback. Each tile in the given area will be passed to this\ncallback as the first and only parameter. The callback should return true for tiles that pass the\nfilter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#filterTiles","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":538,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Searches the entire map layer for the first tile matching the given index, then returns that Tile\nobject. If no match is found, it returns null. The search starts from the top-left tile and\ncontinues horizontally until it hits the end of the row, then it drops down to the next column.\nIf the reverse boolean is true, it scans starting from the bottom-right corner traveling up to\nthe top-left.","kind":"function","name":"findByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The tile index value to search for.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The number of times to skip a matching tile before returning.","name":"skip"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true it will scan the layer in reverse, starting at the\nbottom-right. Otherwise it scans from the top-left.","name":"reverse"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"A Tile object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#findByIndex","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":560,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Find the first tile in the given rectangular area (in tile coordinates) of the layer that\nsatisfies the provided testing function. I.e. finds the first tile for which `callback` returns\ntrue. Similar to Array.prototype.find in vanilla JS.","kind":"function","name":"findTile","since":"3.0.0","params":[{"type":{"names":["FindTileCallback"]},"description":"The callback. Each tile in the given area will be passed to this callback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#findTile","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":583,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\ncallback. Similar to Array.prototype.forEach in vanilla JS.","kind":"function","name":"forEachTile","since":"3.0.0","params":[{"type":{"names":["EachTileCallback"]},"description":"The callback. Each tile in the given area will be passed to this callback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#forEachTile","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":607,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Gets a tile at the given tile coordinates from the given layer.","kind":"function","name":"getTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"X position to get the tile from (given in tile units, not pixels).","name":"tileX"},{"type":{"names":["integer"]},"description":"Y position to get the tile from (given in tile units, not pixels).","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true getTile won't return null for empty tiles, but a Tile object with an index of -1.","name":"nonNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile at the given coordinates or null if no tile was found or the coordinates were invalid."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTileAt","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":624,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Gets a tile at the given world coordinates from the given layer.","kind":"function","name":"getTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"X position to get the tile from (given in pixels)","name":"worldX"},{"type":{"names":["number"]},"description":"Y position to get the tile from (given in pixels)","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, function won't return null for empty tiles, but a Tile object with an index of -1.","name":"nonNull"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile at the given coordinates or null if no tile was found or the coordinates\nwere invalid."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":643,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Gets the tiles in the given rectangular area (in tile coordinates) of the layer.","kind":"function","name":"getTilesWithin","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTilesWithin","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":662,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Gets the tiles that overlap with the given shape in the given layer. The shape must be a Circle,\nLine, Rectangle or Triangle. The shape should be in world coordinates.","kind":"function","name":"getTilesWithinShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle","Phaser.Geom.Line","Phaser.Geom.Rectangle","Phaser.Geom.Triangle"]},"description":"A shape in world (pixel) coordinates","name":"shape"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTilesWithinShape","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":680,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Gets the tiles in the given rectangular area (in world coordinates) of the layer.","kind":"function","name":"getTilesWithinWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The world x coordinate for the top-left of the area.","name":"worldX"},{"type":{"names":["number"]},"description":"The world y coordinate for the top-left of the area.","name":"worldY"},{"type":{"names":["number"]},"description":"The width of the area.","name":"width"},{"type":{"names":["number"]},"description":"The height of the area.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTilesWithinWorldXY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":700,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns\nfalse if there is no tile or if the tile at that location has an index of -1.","kind":"function","name":"hasTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if a tile was found at the given location, otherwise `false`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#hasTileAt","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns\nfalse if there is no tile or if the tile at that location has an index of -1.","kind":"function","name":"hasTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate, in pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate, in pixels.","name":"worldY"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if a tile was found at the given location, otherwise `false`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#hasTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":735,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Puts a tile at the given tile coordinates in the specified layer. You can pass in either an index\nor a Tile object. If you pass in a Tile, all attributes will be copied over to the specified\nlocation. If you pass in an index, only the index at the specified location will be changed.\nCollision information will be recalculated at the specified location.","kind":"function","name":"putTileAt","since":"3.0.0","params":[{"type":{"names":["integer","Phaser.Tilemaps.Tile"]},"description":"The index of this tile to set or a Tile object.","name":"tile"},{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"A Tile object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#putTileAt","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":756,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Puts a tile at the given world coordinates (pixels) in the specified layer. You can pass in either\nan index or a Tile object. If you pass in a Tile, all attributes will be copied over to the\nspecified location. If you pass in an index, only the index at the specified location will be\nchanged. Collision information will be recalculated at the specified location.","kind":"function","name":"putTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["integer","Phaser.Tilemaps.Tile"]},"description":"The index of this tile to set or a Tile object.","name":"tile"},{"type":{"names":["number"]},"description":"The x coordinate, in pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate, in pixels.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"A Tile object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#putTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":778,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Puts an array of tiles or a 2D array of tiles at the given tile coordinates in the specified\nlayer. The array can be composed of either tile indexes or Tile objects. If you pass in a Tile,\nall attributes will be copied over to the specified location. If you pass in an index, only the\nindex at the specified location will be changed. Collision information will be recalculated\nwithin the region tiles were changed.","kind":"function","name":"putTilesAt","since":"3.0.0","params":[{"type":{"names":["Array.","Array.>","Array.","Array.>"]},"description":"A row (array) or grid (2D array) of Tiles or tile indexes to place.","name":"tile"},{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#putTilesAt","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":802,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\nspecified layer. Each tile will receive a new index. If an array of indexes is passed in, then\nthose will be used for randomly assigning new tile indexes. If an array is not provided, the\nindexes found within the region (excluding -1) will be used for randomly assigning new tile\nindexes. This method only modifies tile indexes and does not change collision information.","kind":"function","name":"randomize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Array."]},"optional":true,"description":"An array of indexes to randomly draw from during randomization.","name":"indexes"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#randomize","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":827,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Removes the tile at the given tile coordinates in the specified layer and updates the layer's\ncollision information.","kind":"function","name":"removeTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.","name":"replaceWithNull"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"A Tile object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#removeTileAt","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":846,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Removes the tile at the given world coordinates in the specified layer and updates the layer's\ncollision information.","kind":"function","name":"removeTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate, in pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate, in pixels.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.","name":"replaceWithNull"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"A Tile object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#removeTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":866,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Draws a debug representation of the layer to the given Graphics. This is helpful when you want to\nget a quick idea of which of your tiles are colliding and which have interesting faces. The tiles\nare drawn starting at (0, 0) in the Graphics, allowing you to place the debug representation\nwherever you want on the screen.","kind":"function","name":"renderDebug","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The target Graphics object to draw upon.","name":"graphics"},{"type":{"names":["Phaser.Types.Tilemaps.StyleConfig"]},"description":"An object specifying the colors to use for the debug drawing.","name":"styleConfig"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#renderDebug","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":887,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\n`findIndex` and updates their index to match `newIndex`. This only modifies the index and does\nnot change collision information.","kind":"function","name":"replaceByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the tile to search for.","name":"findIndex"},{"type":{"names":["integer"]},"description":"The index of the tile to replace it with.","name":"newIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#replaceByIndex","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":911,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"You can control if the Cameras should cull tiles before rendering them or not.\nBy default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.\n\nHowever, there are some instances when you may wish to disable this.","kind":"function","name":"setSkipCull","since":"3.11.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Set to `true` to stop culling tiles. Set to `false` to enable culling again.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setSkipCull","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":933,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"When a Camera culls the tiles in this layer it does so using its view into the world, building up a\nrectangle inside which the tiles must exist or they will be culled. Sometimes you may need to expand the size\nof this 'cull rectangle', especially if you plan on rotating the Camera viewing the layer. Do so\nby providing the padding values. The values given are in tiles, not pixels. So if the tile width was 32px\nand you set `paddingX` to be 4, it would add 32px x 4 to the cull rectangle (adjusted for scale)","kind":"function","name":"setCullPadding","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The amount of extra horizontal tiles to add to the cull check padding.","name":"paddingX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The amount of extra vertical tiles to add to the cull check padding.","name":"paddingY"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setCullPadding","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":959,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets collision on the given tile or tiles within a layer by index. You can pass in either a\nsingle numeric index or an array of indexes: [2, 3, 15, 20]. The `collides` parameter controls if\ncollision will be enabled (true) or disabled (false).\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setCollision","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"Either a single tile index, or an array of tile indexes.","name":"indexes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, updates the current tiles on the layer. Set to\nfalse if no tiles have been placed for significant performance boost.","name":"updateLayer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setCollision","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":984,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets collision on a range of tiles in a layer whose index is between the specified `start` and\n`stop` (inclusive). Calling this with a start value of 10 and a stop value of 14 would set\ncollision for tiles 10, 11, 12, 13 and 14. The `collides` parameter controls if collision will be\nenabled (true) or disabled (false).","kind":"function","name":"setCollisionBetween","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The first index of the tile to be set for collision.","name":"start"},{"type":{"names":["integer"]},"description":"The last index of the tile to be set for collision.","name":"stop"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setCollisionBetween","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1007,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets collision on the tiles within a layer by checking tile properties. If a tile has a property\nthat matches the given properties object, its collision flag will be set. The `collides`\nparameter controls if collision will be enabled (true) or disabled (false). Passing in\n`{ collides: true }` would update the collision flag on any tiles with a \"collides\" property that\nhas a value of true. Any tile that doesn't have \"collides\" set to true will be ignored. You can\nalso use an array of values, e.g. `{ types: [\"stone\", \"lava\", \"sand\" ] }`. If a tile has a\n\"types\" property that matches any of those values, its collision flag will be updated.","kind":"function","name":"setCollisionByProperty","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"An object with tile properties and corresponding values that should be checked.","name":"properties"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setCollisionByProperty","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1032,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets collision on all tiles in the given layer, except for tiles that have an index specified in\nthe given array. The `collides` parameter controls if collision will be enabled (true) or\ndisabled (false).","kind":"function","name":"setCollisionByExclusion","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of the tile indexes to not be counted for collision.","name":"indexes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setCollisionByExclusion","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1053,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets collision on the tiles within a layer by checking each tiles collision group data\n(typically defined in Tiled within the tileset collision editor). If any objects are found within\na tiles collision group, the tile's colliding information will be set. The `collides` parameter\ncontrols if collision will be enabled (true) or disabled (false).","kind":"function","name":"setCollisionFromCollisionGroup","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setCollisionFromCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1074,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets a global collision callback for the given tile index within the layer. This will affect all\ntiles on this layer that have the same index. If a callback is already set for the tile index it\nwill be replaced. Set the callback to null to remove it. If you want to set a callback for a tile\nat a specific location on the map then see setTileLocationCallback.","kind":"function","name":"setTileIndexCallback","since":"3.0.0","params":[{"type":{"names":["integer","Array."]},"description":"Either a single tile index, or an array of tile indexes to have a collision callback set for.","name":"indexes"},{"type":{"names":["function"]},"description":"The callback that will be invoked when the tile is collided with.","name":"callback"},{"type":{"names":["object"]},"description":"The context under which the callback is called.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setTileIndexCallback","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1096,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets a collision callback for the given rectangular area (in tile coordinates) within the layer.\nIf a callback is already set for the tile index it will be replaced. Set the callback to null to\nremove it.","kind":"function","name":"setTileLocationCallback","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["function"]},"optional":true,"description":"The callback that will be invoked when the tile is collided with.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback is called.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setTileLocationCallback","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Shuffles the tiles in a rectangular region (specified in tile coordinates) within the given\nlayer. It will only randomize the tiles in that area, so if they're all the same nothing will\nappear to have changed! This method only modifies tile indexes and does not change collision\ninformation.","kind":"function","name":"shuffle","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#shuffle","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1143,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\n`indexA` and swaps then with `indexB`. This only modifies the index and does not change collision\ninformation.","kind":"function","name":"swapByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"First tile index.","name":"tileA"},{"type":{"names":["integer"]},"description":"Second tile index.","name":"tileB"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#swapByIndex","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Converts from tile X coordinates (tile units) to world X coordinates (pixels), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"tileToWorldX","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tileToWorldX","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Converts from tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"tileToWorldY","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tileToWorldY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Converts from tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\nlayers position, scale and scroll. This will return a new Vector2 object or update the given\n`point` object.","kind":"function","name":"tileToWorldXY","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the coordinates in. If not given a new Vector2 is created.","name":"point"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tileToWorldXY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\nspecified layer. Each tile will receive a new index. New indexes are drawn from the given\nweightedIndexes array. An example weighted array:\n\n[\n { index: 6, weight: 4 }, // Probability of index 6 is 4 / 8\n { index: 7, weight: 2 }, // Probability of index 7 would be 2 / 8\n { index: 8, weight: 1.5 }, // Probability of index 8 would be 1.5 / 8\n { index: 26, weight: 0.5 } // Probability of index 27 would be 0.5 / 8\n]\n\nThe probability of any index being choose is (the index's weight) / (sum of all weights). This\nmethod only modifies tile indexes and does not change collision information.","kind":"function","name":"weightedRandomize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Array."]},"optional":true,"description":"An array of objects to randomly draw from during\nrandomization. They should be in the form: { index: 0, weight: 4 } or\n{ index: [0, 1], weight: 4 } if you wish to draw from multiple tile indexes.","name":"weightedIndexes"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#weightedRandomize","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Converts from world X coordinates (pixels) to tile X coordinates (tile units), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"worldToTileX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to be converted, in pixels, not tiles.","name":"worldX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the nearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#worldToTileX","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Converts from world Y coordinates (pixels) to tile Y coordinates (tile units), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"worldToTileY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The y coordinate to be converted, in pixels, not tiles.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the nearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#worldToTileY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1292,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Converts from world XY coordinates (pixels) to tile XY coordinates (tile units), factoring in the\nlayers position, scale and scroll. This will return a new Vector2 object or update the given\n`point` object.","kind":"function","name":"worldToTileXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to be converted, in pixels, not tiles.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate to be converted, in pixels, not tiles.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the nearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the coordinates in. If not given a new Vector2 is created.","name":"point"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#worldToTileXY","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"DynamicTilemapLayerRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"DynamicTilemapLayerWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"kind":"namespace","name":"Tilemaps","memberof":"Phaser","longname":"Phaser.Tilemaps","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"LayerData.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LayerData.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"classdesc":"A class for representing data about about a layer in a map. Maps are parsed from CSV, Tiled,\netc. into this format. Tilemap, StaticTilemapLayer and DynamicTilemapLayer have a reference\nto this data and use it to look up and perform operations on tiles.","kind":"class","name":"LayerData","memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"[description]","name":"config"}],"scope":"static","longname":"Phaser.Tilemaps.LayerData","___s":true},{"meta":{"filename":"LayerData.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The name of the layer, if specified in Tiled.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The x offset of where to draw from the top left","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The y offset of where to draw from the top left","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The width in tile of the layer.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The height in tiles of the layer.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The pixel width of the tiles.","name":"tileWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#tileWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":85,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The pixel height of the tiles.","name":"tileHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#tileHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"baseTileWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#baseTileWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"baseTileHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#baseTileHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The width in pixels of the entire layer.","name":"widthInPixels","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#widthInPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The height in pixels of the entire layer.","name":"heightInPixels","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#heightInPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":139,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#visible","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"Layer specific properties (can be specified in Tiled)","name":"properties","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#properties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"indexes","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#indexes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"collideIndexes","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#collideIndexes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":175,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"callbacks","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#callbacks","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":184,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"bodies","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#bodies","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":193,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An array of the tile indexes","name":"data","type":{"names":["Array.>"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":202,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"tilemapLayer","type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#tilemapLayer","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"MapData.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MapData.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"classdesc":"A class for representing data about a map. Maps are parsed from CSV, Tiled, etc. into this\nformat. A Tilemap object get a copy of this data and then unpacks the needed properties into\nitself.","kind":"class","name":"MapData","memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tilemaps.MapDataConfig"]},"optional":true,"description":"The Map configuration object.","name":"config"}],"scope":"static","longname":"Phaser.Tilemaps.MapData","___s":true},{"meta":{"filename":"MapData.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The key in the Phaser cache that corresponds to the loaded tilemap data.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The width of the entire tilemap.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The height of the entire tilemap.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"If the map is infinite or not.","name":"infinite","type":{"names":["boolean"]},"since":"3.17.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#infinite","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The width of the tiles.","name":"tileWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#tileWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The height of the tiles.","name":"tileHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#tileHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":85,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The width in pixels of the entire tilemap.","name":"widthInPixels","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#widthInPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The height in pixels of the entire tilemap.","name":"heightInPixels","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#heightInPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"format","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#format","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The orientation of the map data (i.e. orthogonal, isometric, hexagonal), default 'orthogonal'.","name":"orientation","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#orientation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"Determines the draw order of tilemap. Default is right-down\n\n0, or 'right-down'\n1, or 'left-down'\n2, or 'right-up'\n3, or 'left-up'","name":"renderOrder","type":{"names":["string"]},"since":"3.12.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#renderOrder","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The version of the map data (as specified in Tiled).","name":"version","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#version","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"Map specific properties (can be specified in Tiled)","name":"properties","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#properties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":153,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An array with all the layers configured to the MapData.","name":"layers","type":{"names":["Array.","Phaser.Tilemaps.ObjectLayer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#layers","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":162,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An array of Tiled Image Layers.","name":"images","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#images","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":171,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An object of Tiled Object Layers.","name":"objects","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#objects","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":180,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An object of collision data. Must be created as physics object or will return undefined.","name":"collision","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#collision","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":189,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An array of Tilesets.","name":"tilesets","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#tilesets","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":198,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The collection of images the map uses(specified in Tiled)","name":"imageCollections","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#imageCollections","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":207,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"tiles","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#tiles","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"ObjectLayer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"classdesc":"A class for representing a Tiled object layer in a map. This mirrors the structure of a Tiled\nobject layer, except:\n - \"x\" & \"y\" properties are ignored since these cannot be changed in Tiled.\n - \"offsetx\" & \"offsety\" are applied to the individual object coordinates directly, so they\n are ignored as well.\n - \"draworder\" is ignored.","kind":"class","name":"ObjectLayer","memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tilemaps.ObjectLayerConfig"]},"optional":true,"description":"The data for the layer from the Tiled JSON object.","name":"config"}],"scope":"static","longname":"Phaser.Tilemaps.ObjectLayer","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The name of the Object Layer.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The opacity of the layer, between 0 and 1.","name":"opacity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#opacity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The custom properties defined on the Object Layer, keyed by their name.","name":"properties","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#properties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The type of each custom property defined on the Object Layer, keyed by its name.","name":"propertyTypes","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#propertyTypes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The type of the layer, which should be `objectgroup`.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"Whether the layer is shown (`true`) or hidden (`false`).","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#visible","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An array of all objects on this Object Layer.\n\nEach Tiled object corresponds to a JavaScript object in this array. It has an `id` (unique),\n`name` (as assigned in Tiled), `type` (as assigned in Tiled), `rotation` (in clockwise degrees),\n`properties` (if any), `visible` state (`true` if visible, `false` otherwise),\n`x` and `y` coordinates (in pixels, relative to the tilemap), and a `width` and `height` (in pixels).\n\nAn object tile has a `gid` property (GID of the represented tile), a `flippedHorizontal` property,\na `flippedVertical` property, and `flippedAntiDiagonal` property.\nThe {@link http://docs.mapeditor.org/en/latest/reference/tmx-map-format/|Tiled documentation} contains\ninformation on flipping and rotation.\n\nPolylines have a `polyline` property, which is an array of objects corresponding to points,\nwhere each point has an `x` property and a `y` property. Polygons have an identically structured\narray in their `polygon` property. Text objects have a `text` property with the text's properties.\n\nRectangles and ellipses have a `rectangle` or `ellipse` property set to `true`.","name":"objects","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#objects","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,211],"filename":"Parse.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"name":"Formats","longname":"Formats","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Parse.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"description":"Parses raw data of a given Tilemap format into a new MapData object. If no recognized data format\nis found, returns `null`. When loading from CSV or a 2D array, you should specify the tileWidth &\ntileHeight. When parsing from a map from Tiled, the tileWidth & tileHeight will be pulled from\nthe map data.","kind":"function","name":"Parse","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tilemap, used to set the name on the MapData.","name":"name"},{"type":{"names":["integer"]},"description":"See ../Formats.js.","name":"mapFormat"},{"type":{"names":["Array.>","string","object"]},"description":"2D array, CSV string or Tiled JSON object.","name":"data"},{"type":{"names":["integer"]},"description":"The width of a tile in pixels. Required for 2D array and CSV, but\nignored for Tiled JSON.","name":"tileWidth"},{"type":{"names":["integer"]},"description":"The height of a tile in pixels. Required for 2D array and CSV, but\nignored for Tiled JSON.","name":"tileHeight"},{"type":{"names":["boolean"]},"description":"Controls how empty tiles, tiles with an index of -1, in the map\ndata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.MapData"]},"description":"The created `MapData` object."}],"memberof":"Phaser.Tilemaps.Parsers","longname":"Phaser.Tilemaps.Parsers.Parse","scope":"static","___s":true},{"meta":{"range":[180,211],"filename":"Parse2DArray.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"name":"Formats","longname":"Formats","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Parse2DArray.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"description":"Parses a 2D array of tile indexes into a new MapData object with a single layer.","kind":"function","name":"Parse2DArray","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tilemap, used to set the name on the MapData.","name":"name"},{"type":{"names":["Array.>"]},"description":"2D array, CSV string or Tiled JSON object.","name":"data"},{"type":{"names":["integer"]},"description":"The width of a tile in pixels.","name":"tileWidth"},{"type":{"names":["integer"]},"description":"The height of a tile in pixels.","name":"tileHeight"},{"type":{"names":["boolean"]},"description":"Controls how empty tiles, tiles with an index of -1, in the map\ndata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.MapData"]},"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers","longname":"Phaser.Tilemaps.Parsers.Parse2DArray","scope":"static","___s":true},{"meta":{"range":[180,211],"filename":"ParseCSV.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"name":"Formats","longname":"Formats","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseCSV.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"description":"Parses a CSV string of tile indexes into a new MapData object with a single layer.","kind":"function","name":"ParseCSV","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tilemap, used to set the name on the MapData.","name":"name"},{"type":{"names":["string"]},"description":"CSV string of tile indexes.","name":"data"},{"type":{"names":["integer"]},"description":"The width of a tile in pixels.","name":"tileWidth"},{"type":{"names":["integer"]},"description":"The height of a tile in pixels.","name":"tileHeight"},{"type":{"names":["boolean"]},"description":"Controls how empty tiles, tiles with an index of -1, in the map\ndata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.MapData"]},"description":"The resulting MapData object."}],"memberof":"Phaser.Tilemaps.Parsers","longname":"Phaser.Tilemaps.Parsers.ParseCSV","scope":"static","___s":true},{"meta":{"range":[180,226],"filename":"ParseTileLayers.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"name":"LayerData","longname":"LayerData","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseTileLayers.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"description":"[description]","kind":"function","name":"ParseTileLayers","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"[description]","name":"json"},{"type":{"names":["boolean"]},"description":"[description]","name":"insertNull"}],"returns":[{"type":{"names":["array"]},"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers.Impact","longname":"Phaser.Tilemaps.Parsers.Impact.ParseTileLayers","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"ParseTilesets.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"name":"Tileset","longname":"Tileset","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseTilesets.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"description":"[description]","kind":"function","name":"ParseTilesets","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"[description]","name":"json"}],"returns":[{"type":{"names":["array"]},"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers.Impact","longname":"Phaser.Tilemaps.Parsers.Impact.ParseTilesets","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"ParseWeltmeister.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"name":"Formats","longname":"Formats","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseWeltmeister.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"description":"Parses a Weltmeister JSON object into a new MapData object.","kind":"function","name":"ParseWeltmeister","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tilemap, used to set the name on the MapData.","name":"name"},{"type":{"names":["object"]},"description":"The Weltmeister JSON object.","name":"json"},{"type":{"names":["boolean"]},"description":"Controls how empty tiles, tiles with an index of -1, in the map\ndata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["object"]},"nullable":true,"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers.Impact","longname":"Phaser.Tilemaps.Parsers.Impact.ParseWeltmeister","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"kind":"namespace","name":"Impact","memberof":"Phaser.Tilemaps.Parsers","longname":"Phaser.Tilemaps.Parsers.Impact","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"kind":"namespace","name":"Parsers","memberof":"Phaser.Tilemaps","longname":"Phaser.Tilemaps.Parsers","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"AssignTileProperties.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"Extend","longname":"Extend","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AssignTileProperties.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Copy properties from tileset to tiles.","kind":"function","name":"AssignTileProperties","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.MapData"]},"description":"[description]","name":"mapData"}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.AssignTileProperties","scope":"static","___s":true},{"meta":{"filename":"Base64Decode.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Decode base-64 encoded data, for example as exported by Tiled.","kind":"function","name":"Base64Decode","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"Base-64 encoded data to decode.","name":"data"}],"returns":[{"type":{"names":["array"]},"description":"Array containing the decoded bytes."}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.Base64Decode","scope":"static","___s":true},{"meta":{"filename":"BuildTilesetIndex.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Master list of tiles -> x, y, index in tileset.","kind":"function","name":"BuildTilesetIndex","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.MapData"]},"description":"[description]","name":"mapData"}],"returns":[{"type":{"names":["array"]},"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.BuildTilesetIndex","scope":"static","___s":true},{"meta":{"range":[179,239],"filename":"CreateGroupLayer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CreateGroupLayer.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Parse a Tiled group layer and create a state object for inheriting.","kind":"function","name":"CreateGroupLayer","since":"3.21.0","params":[{"type":{"names":["object"]},"description":"The Tiled JSON object.","name":"json"},{"type":{"names":["object"]},"optional":true,"description":"The current group layer from the Tiled JSON file.","name":"currentl"},{"type":{"names":["object"]},"optional":true,"description":"The state of the parent group (if any).","name":"parentstate"}],"returns":[{"type":{"names":["object"]},"description":"A group state object with proper values for updating children layers."}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.CreateGroupLayer","scope":"static","___s":true},{"meta":{"range":[180,211],"filename":"ParseGID.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"FLIPPED_HORIZONTAL","longname":"FLIPPED_HORIZONTAL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseGID.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"See Tiled documentation on tile flipping:\nhttp://docs.mapeditor.org/en/latest/reference/tmx-map-format/","kind":"function","name":"ParseGID","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"gid"}],"returns":[{"type":{"names":["object"]},"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseGID","scope":"static","___s":true},{"meta":{"range":[180,240],"filename":"ParseImageLayers.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseImageLayers.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Parses a Tiled JSON object into an array of objects with details about the image layers.","kind":"function","name":"ParseImageLayers","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The Tiled JSON object.","name":"json"}],"returns":[{"type":{"names":["array"]},"description":"Array of objects that include critical info about the map's image layers"}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseImageLayers","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"ParseJSONTiled.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"Formats","longname":"Formats","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseJSONTiled.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Parses a Tiled JSON object into a new MapData object.","kind":"function","name":"ParseJSONTiled","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tilemap, used to set the name on the MapData.","name":"name"},{"type":{"names":["object"]},"description":"The Tiled JSON object.","name":"json"},{"type":{"names":["boolean"]},"description":"Controls how empty tiles, tiles with an index of -1, in the map\ndata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.MapData"]},"nullable":true,"description":"The created MapData object, or `null` if the data can't be parsed."}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseJSONTiled","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"ParseObject.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"Pick","longname":"Pick","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseObject.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Convert a Tiled object to an internal parsed object normalising and copying properties over, while applying optional x and y offsets. The parsed object will always have the properties `id`, `name`, `type`, `rotation`, `properties`, `visible`, `x`, `y`, `width` and `height`. Other properties will be added according to the object type (such as text, polyline, gid etc.)","kind":"function","name":"ParseObject","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"Tiled object to convert to an internal parsed object normalising and copying properties over.","name":"tiledObject"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional additional offset to apply to the object's x property. Defaults to 0.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional additional offset to apply to the object's y property. Defaults to 0.","name":"offsetY"}],"returns":[{"type":{"names":["object"]},"description":"The parsed object containing properties read from the Tiled object according to it's type with x and y values updated according to the given offsets."}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseObject","scope":"static","___s":true},{"meta":{"range":[180,240],"filename":"ParseObjectLayers.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseObjectLayers.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Parses a Tiled JSON object into an array of ObjectLayer objects.","kind":"function","name":"ParseObjectLayers","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The Tiled JSON object.","name":"json"}],"returns":[{"type":{"names":["array"]},"description":"An array of all object layers in the tilemap as `ObjectLayer`s."}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseObjectLayers","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"ParseTileLayers.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"Base64Decode","longname":"Base64Decode","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseTileLayers.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Parses all tilemap layers in a Tiled JSON object into new LayerData objects.","kind":"function","name":"ParseTileLayers","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The Tiled JSON object.","name":"json"},{"type":{"names":["boolean"]},"description":"Controls how empty tiles, tiles with an index of -1, in the map\ndata are handled (see {@link Phaser.Tilemaps.Parsers.Tiled.ParseJSONTiled}).","name":"insertNull"}],"returns":[{"type":{"names":["Array."]},"description":"- An array of LayerData objects, one for each entry in\njson.layers with the type 'tilelayer'."}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseTileLayers","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"ParseTilesets.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"Tileset","longname":"Tileset","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseTilesets.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Tilesets and Image Collections","kind":"function","name":"ParseTilesets","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"[description]","name":"json"}],"returns":[{"type":{"names":["object"]},"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseTilesets","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"kind":"namespace","name":"Tiled","memberof":"Phaser.Tilemaps.Parsers","longname":"Phaser.Tilemaps.Parsers.Tiled","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"StaticTilemapLayer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"classdesc":"A Static Tilemap Layer is a Game Object that renders LayerData from a Tilemap when used in combination\nwith one, or more, Tilesets.\n\nA Static Tilemap Layer is optimized for rendering speed over flexibility. You cannot apply per-tile\neffects like tint or alpha, or change the tiles or tilesets the layer uses.\n\nUse a Static Tilemap Layer instead of a Dynamic Tilemap Layer when you don't need tile manipulation features.","kind":"class","name":"StaticTilemapLayer","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible","Phaser.GameObjects.Components.ScrollFactor"],"memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs.","name":"scene"},{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"The Tilemap this layer is a part of.","name":"tilemap"},{"type":{"names":["integer"]},"description":"The index of the LayerData associated with this layer.","name":"layerIndex"},{"type":{"names":["string","Array.","Phaser.Tilemaps.Tileset","Array."]},"description":"The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.","name":"tileset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world x position where the top left of this layer will be placed.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world y position where the top left of this layer will be placed.","name":"y"}],"scope":"static","longname":"Phaser.Tilemaps.StaticTilemapLayer","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Used internally by physics system to perform fast type checks.","name":"isTilemap","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#isTilemap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"The Tilemap that this layer is a part of.","name":"tilemap","type":{"names":["Phaser.Tilemaps.Tilemap"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tilemap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"The index of the LayerData associated with this layer.","name":"layerIndex","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#layerIndex","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"The LayerData associated with this layer. LayerData can only be associated with one\ntilemap layer.","name":"layer","type":{"names":["Phaser.Tilemaps.LayerData"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#layer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"The Tileset/s associated with this layer.\n\nAs of Phaser 3.14 this property is now an array of Tileset objects, previously it was a single reference.","name":"tileset","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tileset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Used internally by the Canvas renderer.\nThis holds the tiles that are visible within the camera in the last frame.","name":"culledTiles","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#culledTiles","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nYou can control if the Cameras should cull tiles before rendering them or not.\nBy default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.\n\nHowever, there are some instances when you may wish to disable this, and toggling this flag allows\nyou to do so. Also see `setSkipCull` for a chainable method that does the same thing.","name":"skipCull","type":{"names":["boolean"]},"since":"3.12.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#skipCull","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":153,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nThe total number of tiles drawn by the renderer in the last frame.\n\nThis only works when rending with Canvas.","name":"tilesDrawn","type":{"names":["integer"]},"readonly":true,"since":"3.12.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tilesDrawn","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nThe total number of tiles in this layer. Updated every frame.","name":"tilesTotal","type":{"names":["integer"]},"readonly":true,"since":"3.12.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tilesTotal","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":179,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nThe amount of extra tiles to add into the cull rectangle when calculating its horizontal size.\n\nSee the method `setCullPadding` for more details.","name":"cullPaddingX","type":{"names":["integer"]},"defaultvalue":"1","since":"3.12.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#cullPaddingX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":193,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nThe amount of extra tiles to add into the cull rectangle when calculating its vertical size.\n\nSee the method `setCullPadding` for more details.","name":"cullPaddingY","type":{"names":["integer"]},"defaultvalue":"1","since":"3.12.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#cullPaddingY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":207,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nThe callback that is invoked when the tiles are culled.\n\nBy default it will call `TilemapComponents.CullTiles` but you can override this to call any function you like.\n\nIt will be sent 3 arguments:\n\n1. The Phaser.Tilemaps.LayerData object for this Layer\n2. The Camera that is culling the layer. You can check its `dirty` property to see if it has changed since the last cull.\n3. A reference to the `culledTiles` array, which should be used to store the tiles you want rendered.\n\nSee the `TilemapComponents.CullTiles` source code for details on implementing your own culling system.","name":"cullCallback","type":{"names":["function"]},"since":"3.12.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#cullCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":343,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"An array holding the mapping between the tile indexes and the tileset they belong to.","name":"gidMap","type":{"names":["Array."]},"since":"3.14.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#gidMap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":438,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Upload the tile data to a VBO.","kind":"function","name":"upload","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera to render to.","name":"camera"},{"type":{"names":["integer"]},"description":"The tileset index.","name":"tilesetIndex"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#upload","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":722,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets the rendering (draw) order of the tiles in this layer.\n\nThe default is 'right-down', meaning it will order the tiles starting from the top-left,\ndrawing to the right and then moving down to the next row.\n\nThe draw orders are:\n\n0 = right-down\n1 = left-down\n2 = right-up\n3 = left-up\n\nSetting the render order does not change the tiles or how they are stored in the layer,\nit purely impacts the order in which they are rendered.\n\nYou can provide either an integer (0 to 3), or the string version of the order.","kind":"function","name":"setRenderOrder","since":"3.12.0","params":[{"type":{"names":["integer","string"]},"description":"The render (draw) order value. Either an integer between 0 and 3, or a string: 'right-down', 'left-down', 'right-up' or 'left-up'.","name":"renderOrder"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setRenderOrder","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":769,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Calculates interesting faces at the given tile coordinates of the specified layer. Interesting\nfaces are used internally for optimizing collisions against tiles. This method is mostly used\ninternally to optimize recalculating faces when only one tile has been changed.","kind":"function","name":"calculateFacesAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate.","name":"tileY"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#calculateFacesAt","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":789,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Calculates interesting faces within the rectangular area specified (in tile coordinates) of the\nlayer. Interesting faces are used internally for optimizing collisions against tiles. This method\nis mostly used internally.","kind":"function","name":"calculateFacesWithin","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#calculateFacesWithin","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":811,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Creates a Sprite for every object matching the given tile indexes in the layer. You can\noptionally specify if each tile will be replaced with a new tile after the Sprite has been\ncreated. This is useful if you want to lay down special tiles in a level that are converted to\nSprites, but want to replace the tile itself with a floor tile or similar once converted.","kind":"function","name":"createFromTiles","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"The tile index, or array of indexes, to create Sprites from.","name":"indexes"},{"type":{"names":["integer","array"]},"description":"The tile index, or array of indexes, to change a converted\ntile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a\none-to-one mapping with the indexes array.","name":"replacements"},{"type":{"names":["Phaser.Types.GameObjects.Sprite.SpriteConfig"]},"description":"The config object to pass into the Sprite creator (i.e.\nscene.make.sprite).","name":"spriteConfig"},{"type":{"names":["Phaser.Scene"]},"optional":true,"defaultvalue":"scene the map is within","description":"The Scene to create the Sprites within.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when determining the world XY","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of the Sprites that were created."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#createFromTiles","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":836,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Returns the tiles in the given layer that are within the cameras viewport.\nThis is used internally.","kind":"function","name":"cull","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to run the cull check against.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#cull","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":852,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nYou can control if the Cameras should cull tiles before rendering them or not.\nBy default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.\n\nHowever, there are some instances when you may wish to disable this.","kind":"function","name":"setSkipCull","since":"3.12.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Set to `true` to stop culling tiles. Set to `false` to enable culling again.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setSkipCull","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":876,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nWhen a Camera culls the tiles in this layer it does so using its view into the world, building up a\nrectangle inside which the tiles must exist or they will be culled. Sometimes you may need to expand the size\nof this 'cull rectangle', especially if you plan on rotating the Camera viewing the layer. Do so\nby providing the padding values. The values given are in tiles, not pixels. So if the tile width was 32px\nand you set `paddingX` to be 4, it would add 32px x 4 to the cull rectangle (adjusted for scale)","kind":"function","name":"setCullPadding","since":"3.12.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The amount of extra horizontal tiles to add to the cull check padding.","name":"paddingX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The amount of extra vertical tiles to add to the cull check padding.","name":"paddingY"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setCullPadding","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":904,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Searches the entire map layer for the first tile matching the given index, then returns that Tile\nobject. If no match is found, it returns null. The search starts from the top-left tile and\ncontinues horizontally until it hits the end of the row, then it drops down to the next column.\nIf the reverse boolean is true, it scans starting from the bottom-right corner traveling up to\nthe top-left.","kind":"function","name":"findByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The tile index value to search for.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The number of times to skip a matching tile before returning.","name":"skip"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true it will scan the layer in reverse, starting at the\nbottom-right. Otherwise it scans from the top-left.","name":"reverse"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"A Tile object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#findByIndex","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":926,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Find the first tile in the given rectangular area (in tile coordinates) of the layer that\nsatisfies the provided testing function. I.e. finds the first tile for which `callback` returns\ntrue. Similar to Array.prototype.find in vanilla JS.","kind":"function","name":"findTile","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"The callback. Each tile in the given area will be passed to this\ncallback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The topmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#findTile","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":950,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\nfilter callback function. Any tiles that pass the filter test (i.e. where the callback returns\ntrue) will returned as a new array. Similar to Array.prototype.Filter in vanilla JS.","kind":"function","name":"filterTiles","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"The callback. Each tile in the given area will be passed to this\ncallback as the first and only parameter. The callback should return true for tiles that pass the\nfilter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The leftmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The topmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#filterTiles","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":975,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\ncallback. Similar to Array.prototype.forEach in vanilla JS.","kind":"function","name":"forEachTile","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"The callback. Each tile in the given area will be passed to this\ncallback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The leftmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The topmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#forEachTile","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1000,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Gets a tile at the given tile coordinates from the given layer.","kind":"function","name":"getTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"X position to get the tile from (given in tile units, not pixels).","name":"tileX"},{"type":{"names":["integer"]},"description":"Y position to get the tile from (given in tile units, not pixels).","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true getTile won't return null for empty tiles, but a Tile\nobject with an index of -1.","name":"nonNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile at the given coordinates or null if no tile was found or the coordinates were invalid."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTileAt","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1018,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Gets a tile at the given world coordinates from the given layer.","kind":"function","name":"getTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"X position to get the tile from (given in pixels)","name":"worldX"},{"type":{"names":["number"]},"description":"Y position to get the tile from (given in pixels)","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, function won't return null for empty tiles, but a Tile\nobject with an index of -1.","name":"nonNull"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile at the given coordinates or null if no tile was found or the coordinates\nwere invalid."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1038,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Gets the tiles in the given rectangular area (in tile coordinates) of the layer.","kind":"function","name":"getTilesWithin","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The leftmost tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The topmost tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTilesWithin","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1057,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Gets the tiles in the given rectangular area (in world coordinates) of the layer.","kind":"function","name":"getTilesWithinWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The leftmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"worldX"},{"type":{"names":["number"]},"description":"The topmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"worldY"},{"type":{"names":["number"]},"description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["number"]},"description":"How many tiles high from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTilesWithinWorldXY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1077,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Gets the tiles that overlap with the given shape in the given layer. The shape must be a Circle,\nLine, Rectangle or Triangle. The shape should be in world coordinates.","kind":"function","name":"getTilesWithinShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle","Phaser.Geom.Line","Phaser.Geom.Rectangle","Phaser.Geom.Triangle"]},"description":"A shape in world (pixel) coordinates","name":"shape"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTilesWithinShape","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1095,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns\nfalse if there is no tile or if the tile at that location has an index of -1.","kind":"function","name":"hasTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"X position to get the tile from in tile coordinates.","name":"tileX"},{"type":{"names":["integer"]},"description":"Y position to get the tile from in tile coordinates.","name":"tileY"}],"returns":[{"type":{"names":["boolean"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#hasTileAt","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1112,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns\nfalse if there is no tile or if the tile at that location has an index of -1.","kind":"function","name":"hasTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the world position.","name":"worldX"},{"type":{"names":["number"]},"description":"The Y coordinate of the world position.","name":"worldY"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["boolean"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#hasTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1130,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Draws a debug representation of the layer to the given Graphics. This is helpful when you want to\nget a quick idea of which of your tiles are colliding and which have interesting faces. The tiles\nare drawn starting at (0, 0) in the Graphics, allowing you to place the debug representation\nwherever you want on the screen.","kind":"function","name":"renderDebug","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The target Graphics object to draw upon.","name":"graphics"},{"type":{"names":["Phaser.Types.Tilemaps.StyleConfig"]},"description":"An object specifying the colors to use for the debug drawing.","name":"styleConfig"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#renderDebug","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1151,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets collision on the given tile or tiles within a layer by index. You can pass in either a\nsingle numeric index or an array of indexes: [2, 3, 15, 20]. The `collides` parameter controls if\ncollision will be enabled (true) or disabled (false).","kind":"function","name":"setCollision","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"Either a single tile index, or an array of tile indexes.","name":"indexes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear\ncollision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the\nupdate.","name":"recalculateFaces"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, updates the current tiles on the layer. Set to\nfalse if no tiles have been placed for significant performance boost.","name":"updateLayer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setCollision","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1176,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets collision on a range of tiles in a layer whose index is between the specified `start` and\n`stop` (inclusive). Calling this with a start value of 10 and a stop value of 14 would set\ncollision for tiles 10, 11, 12, 13 and 14. The `collides` parameter controls if collision will be\nenabled (true) or disabled (false).","kind":"function","name":"setCollisionBetween","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The first index of the tile to be set for collision.","name":"start"},{"type":{"names":["integer"]},"description":"The last index of the tile to be set for collision.","name":"stop"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear\ncollision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the\nupdate.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setCollisionBetween","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets collision on the tiles within a layer by checking tile properties. If a tile has a property\nthat matches the given properties object, its collision flag will be set. The `collides`\nparameter controls if collision will be enabled (true) or disabled (false). Passing in\n`{ collides: true }` would update the collision flag on any tiles with a \"collides\" property that\nhas a value of true. Any tile that doesn't have \"collides\" set to true will be ignored. You can\nalso use an array of values, e.g. `{ types: [\"stone\", \"lava\", \"sand\" ] }`. If a tile has a\n\"types\" property that matches any of those values, its collision flag will be updated.","kind":"function","name":"setCollisionByProperty","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"An object with tile properties and corresponding values that should\nbe checked.","name":"properties"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear\ncollision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the\nupdate.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setCollisionByProperty","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets collision on all tiles in the given layer, except for tiles that have an index specified in\nthe given array. The `collides` parameter controls if collision will be enabled (true) or\ndisabled (false).","kind":"function","name":"setCollisionByExclusion","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of the tile indexes to not be counted for collision.","name":"indexes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear\ncollision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the\nupdate.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setCollisionByExclusion","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets a global collision callback for the given tile index within the layer. This will affect all\ntiles on this layer that have the same index. If a callback is already set for the tile index it\nwill be replaced. Set the callback to null to remove it. If you want to set a callback for a tile\nat a specific location on the map then see setTileLocationCallback.","kind":"function","name":"setTileIndexCallback","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"Either a single tile index, or an array of tile indexes to have a\ncollision callback set for.","name":"indexes"},{"type":{"names":["function"]},"description":"The callback that will be invoked when the tile is collided with.","name":"callback"},{"type":{"names":["object"]},"description":"The context under which the callback is called.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setTileIndexCallback","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1275,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets collision on the tiles within a layer by checking each tiles collision group data\n(typically defined in Tiled within the tileset collision editor). If any objects are found within\na tiles collision group, the tile's colliding information will be set. The `collides` parameter\ncontrols if collision will be enabled (true) or disabled (false).","kind":"function","name":"setCollisionFromCollisionGroup","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear\ncollision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the\nupdate.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setCollisionFromCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets a collision callback for the given rectangular area (in tile coordinates) within the layer.\nIf a callback is already set for the tile index it will be replaced. Set the callback to null to\nremove it.","kind":"function","name":"setTileLocationCallback","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The leftmost tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"description":"The topmost tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["function"]},"description":"The callback that will be invoked when the tile is collided with.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback is called.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setTileLocationCallback","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1322,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Converts from tile X coordinates (tile units) to world X coordinates (pixels), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"tileToWorldX","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The X coordinate, in tile coordinates.","name":"tileX"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the world values from the tile index.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tileToWorldX","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1339,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Converts from tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"tileToWorldY","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The Y coordinate, in tile coordinates.","name":"tileY"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the world values from the tile index.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tileToWorldY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1356,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Converts from tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\nlayers position, scale and scroll. This will return a new Vector2 object or update the given\n`point` object.","kind":"function","name":"tileToWorldXY","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The X coordinate, in tile coordinates.","name":"tileX"},{"type":{"names":["integer"]},"description":"The Y coordinate, in tile coordinates.","name":"tileY"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the coordinates in. If not given, a new Vector2 is created.","name":"point"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the world values from the tile index.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tileToWorldXY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1376,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Converts from world X coordinates (pixels) to tile X coordinates (tile units), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"worldToTileX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate, in world pixels.","name":"worldX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the\nnearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.]","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#worldToTileX","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1395,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Converts from world Y coordinates (pixels) to tile Y coordinates (tile units), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"worldToTileY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The Y coordinate, in world pixels.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the\nnearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#worldToTileY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1414,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Converts from world XY coordinates (pixels) to tile XY coordinates (tile units), factoring in the\nlayers position, scale and scroll. This will return a new Vector2 object or update the given\n`point` object.","kind":"function","name":"worldToTileXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate, in world pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The Y coordinate, in world pixels.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the\nnearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the coordinates in. If not given, a new Vector2 is created.","name":"point"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#worldToTileXY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1436,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Destroys this StaticTilemapLayer and removes its link to the associated LayerData.","kind":"function","name":"destroy","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Remove this layer from the parent Tilemap?","name":"removeFromTilemap"}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#destroy","scope":"instance","overrides":"Phaser.GameObjects.GameObject#destroy","___s":true},{"meta":{"range":[180,221],"filename":"StaticTilemapLayerRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FilteringOptions.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"FilteringOptions","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, only return tiles that don't have -1 for an index.","name":"isNotEmpty"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, only return tiles that collide on at least one side.","name":"isColliding"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, only return tiles that have at least one interesting face.","name":"hasInterestingFace"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.FilteringOptions","scope":"static","___s":true},{"meta":{"filename":"GetTilesWithinFilteringOptions.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"GetTilesWithinFilteringOptions","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, only return tiles that don't have -1 for an index.","name":"isNotEmpty"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, only return tiles that collide on at least one side.","name":"isColliding"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, only return tiles that have at least one interesting face.","name":"hasInterestingFace"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.GetTilesWithinFilteringOptions","scope":"static","___s":true},{"meta":{"filename":"MapDataConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"MapDataConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"The key in the Phaser cache that corresponds to the loaded tilemap data.","name":"name"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The width of the entire tilemap.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The height of the entire tilemap.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The width of the tiles.","name":"tileWidth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The height of the tiles.","name":"tileHeight"},{"type":{"names":["number"]},"optional":true,"description":"The width in pixels of the entire tilemap.","name":"widthInPixels"},{"type":{"names":["number"]},"optional":true,"description":"The height in pixels of the entire tilemap.","name":"heightInPixels"},{"type":{"names":["integer"]},"optional":true,"description":"The format of the Tilemap, as defined in Tiled.","name":"format"},{"type":{"names":["string"]},"optional":true,"description":"The orientation of the map data (i.e. orthogonal, isometric, hexagonal), default 'orthogonal'.","name":"orientation"},{"type":{"names":["string"]},"optional":true,"description":"Determines the draw order of tilemap. Default is right-down.","name":"renderOrder"},{"type":{"names":["number"]},"optional":true,"description":"The version of Tiled the map uses.","name":"version"},{"type":{"names":["number"]},"optional":true,"description":"Map specific properties (can be specified in Tiled).","name":"properties"},{"type":{"names":["Array."]},"optional":true,"description":"The layers of the tilemap.","name":"layers"},{"type":{"names":["array"]},"optional":true,"description":"An array with all the layers configured to the MapData.","name":"images"},{"type":{"names":["object"]},"optional":true,"description":"An array of Tiled Image Layers.","name":"objects"},{"type":{"names":["object"]},"optional":true,"description":"An object of Tiled Object Layers.","name":"collision"},{"type":{"names":["Array."]},"optional":true,"description":"The tilesets the map uses.","name":"tilesets"},{"type":{"names":["array"]},"optional":true,"description":"The collection of images the map uses(specified in Tiled).","name":"imageCollections"},{"type":{"names":["array"]},"optional":true,"description":"[description]","name":"tiles"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.MapDataConfig","scope":"static","___s":true},{"meta":{"filename":"ObjectLayerConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"ObjectLayerConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'object layer'","description":"The name of the Object Layer.","name":"name"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The opacity of the layer, between 0 and 1.","name":"opacity"},{"type":{"names":["any"]},"optional":true,"description":"The custom properties defined on the Object Layer, keyed by their name.","name":"properties"},{"type":{"names":["any"]},"optional":true,"description":"The type of each custom property defined on the Object Layer, keyed by its name.","name":"propertytypes"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'objectgroup'","description":"The type of the layer, which should be `objectgroup`.","name":"type"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether the layer is shown (`true`) or hidden (`false`).","name":"visible"},{"type":{"names":["Array."]},"optional":true,"description":"An array of all objects on this Object Layer.","name":"objects"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.ObjectLayerConfig","scope":"static","___s":true},{"meta":{"filename":"StyleConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"StyleConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Display.Color","number","null"]},"optional":true,"nullable":true,"defaultvalue":"blue","description":"Color to use for drawing a filled rectangle at non-colliding tile locations. If set to null, non-colliding tiles will not be drawn.","name":"tileColor"},{"type":{"names":["Phaser.Display.Color","number","null"]},"optional":true,"nullable":true,"defaultvalue":"orange","description":"Color to use for drawing a filled rectangle at colliding tile locations. If set to null, colliding tiles will not be drawn.","name":"collidingTileColor"},{"type":{"names":["Phaser.Display.Color","number","null"]},"optional":true,"nullable":true,"defaultvalue":"grey","description":"Color to use for drawing a line at interesting tile faces. If set to null, interesting tile faces will not be drawn.","name":"faceColor"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.StyleConfig","scope":"static","___s":true},{"meta":{"filename":"TiledObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"TiledObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["integer"]},"description":"The unique object ID.","name":"id"},{"type":{"names":["string"]},"description":"The name this object was assigned in Tiled.","name":"name"},{"type":{"names":["string"]},"description":"The type, as assigned in Tiled.","name":"type"},{"type":{"names":["boolean"]},"optional":true,"description":"The visible state of this object.","name":"visible"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of this object, in pixels, relative to the tilemap.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of this object, in pixels, relative to the tilemap.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of this object, in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of this object, in pixels.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The rotation of the object in clockwise degrees.","name":"rotation"},{"type":{"names":["any"]},"optional":true,"description":"Custom properties object.","name":"properties"},{"type":{"names":["integer"]},"optional":true,"description":"Only set if of type 'tile'.","name":"gid"},{"type":{"names":["boolean"]},"optional":true,"description":"Only set if a tile object. The horizontal flip value.","name":"flippedHorizontal"},{"type":{"names":["boolean"]},"optional":true,"description":"Only set if a tile object. The vertical flip value.","name":"flippedVertical"},{"type":{"names":["boolean"]},"optional":true,"description":"Only set if a tile object. The diagonal flip value.","name":"flippedAntiDiagonal"},{"type":{"names":["Array."]},"optional":true,"description":"Only set if a polyline object. An array of objects corresponding to points, where each point has an `x` property and a `y` property.","name":"polyline"},{"type":{"names":["Array."]},"optional":true,"description":"Only set if a polygon object. An array of objects corresponding to points, where each point has an `x` property and a `y` property.","name":"polygon"},{"type":{"names":["any"]},"optional":true,"description":"Only set if a text object. Contains the text objects properties.","name":"text"},{"type":{"names":["boolean"]},"optional":true,"description":"Only set, and set to `true`, if a rectangle object.","name":"rectangle"},{"type":{"names":["boolean"]},"optional":true,"description":"Only set, and set to `true`, if a ellipse object.","name":"ellipse"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.TiledObject","scope":"static","___s":true},{"meta":{"filename":"TilemapConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"TilemapConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"The key in the Phaser cache that corresponds to the loaded tilemap data.","name":"key"},{"type":{"names":["Array.>"]},"optional":true,"description":"Instead of loading from the cache, you can also load directly from a 2D array of tile indexes.","name":"data"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The width of a tile in pixels.","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The height of a tile in pixels.","name":"tileHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The width of the map in tiles.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The height of the map in tiles.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Controls how empty tiles, tiles with an index of -1,\nin the map data are handled. If `true`, empty locations will get a value of `null`. If `false`,\nempty location will get a Tile object with an index of -1. If you've a large sparsely populated\nmap and the tile data doesn't need to change then setting this value to `true` will help with\nmemory consumption. However if your map is small or you need to update the tiles dynamically,\nthen leave the default value set.","name":"insertNull"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.TilemapConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"namespace","name":"Tilemaps","memberof":"Phaser.Types","longname":"Phaser.Types.Tilemaps","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Clock.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clock.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"classdesc":"The Clock is a Scene plugin which creates and updates Timer Events for its Scene.","kind":"class","name":"Clock","memberof":"Phaser.Time","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene which owns this Clock.","name":"scene"}],"scope":"static","longname":"Phaser.Time.Clock","___s":true},{"meta":{"filename":"Clock.js","lineno":29,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The Scene which owns this Clock.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Clock.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The Scene Systems object of the Scene which owns this Clock.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Clock.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The current time of the Clock, in milliseconds.\n\nIf accessed externally, this is equivalent to the `time` parameter normally passed to a Scene's `update` method.","name":"now","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#now","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Clock.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The scale of the Clock's time delta.\n\nThe time delta is the time elapsed between two consecutive frames and influences the speed of time for this Clock and anything which uses it, such as its Timer Events. Values higher than 1 increase the speed of time, while values smaller than 1 decrease it. A value of 0 freezes time and is effectively equivalent to pausing the Clock.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Clock.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Whether the Clock is paused (`true`) or active (`false`).\n\nWhen paused, the Clock will not update any of its Timer Events, thus freezing time.","name":"paused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#paused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Clock.js","lineno":156,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Creates a Timer Event and adds it to the Clock at the start of the frame.","kind":"function","name":"addEvent","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Time.TimerEventConfig"]},"description":"The configuration for the Timer Event.","name":"config"}],"returns":[{"type":{"names":["Phaser.Time.TimerEvent"]},"description":"The Timer Event which was created."}],"memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#addEvent","scope":"instance","___s":true},{"meta":{"filename":"Clock.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Creates a Timer Event and adds it to the Clock at the start of the frame.\n\nThis is a shortcut for {@link #addEvent} which can be shorter and is compatible with the syntax of the GreenSock Animation Platform (GSAP).","kind":"function","name":"delayedCall","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delay of the function call, in milliseconds.","name":"delay"},{"type":{"names":["function"]},"description":"The function to call after the delay expires.","name":"callback"},{"type":{"names":["Array.<*>"]},"optional":true,"description":"The arguments to call the function with.","name":"args"},{"type":{"names":["*"]},"optional":true,"description":"The scope (`this` object) to call the function with.","name":"callbackScope"}],"returns":[{"type":{"names":["Phaser.Time.TimerEvent"]},"description":"The Timer Event which was created."}],"memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#delayedCall","scope":"instance","___s":true},{"meta":{"filename":"Clock.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Clears and recreates the array of pending Timer Events.","kind":"function","name":"clearPendingEvents","since":"3.0.0","returns":[{"type":{"names":["Phaser.Time.Clock"]},"description":"This Clock object."}],"memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#clearPendingEvents","scope":"instance","___s":true},{"meta":{"filename":"Clock.js","lineno":210,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Schedules all active Timer Events for removal at the start of the frame.","kind":"function","name":"removeAllEvents","since":"3.0.0","returns":[{"type":{"names":["Phaser.Time.Clock"]},"description":"This Clock object."}],"memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#removeAllEvents","scope":"instance","___s":true},{"meta":{"filename":"Clock.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Updates the arrays of active and pending Timer Events. Called at the start of the frame.","kind":"function","name":"preUpdate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#preUpdate","scope":"instance","___s":true},{"meta":{"filename":"Clock.js","lineno":276,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Updates the Clock's internal time and all of its Timer Events.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#update","scope":"instance","___s":true},{"meta":{"range":[180,213],"filename":"TimerEvent.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TimerEvent.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"classdesc":"A Timer Event represents a delayed function call. It's managed by a Scene's {@link Clock} and will call its function after a set amount of time has passed. The Timer Event can optionally repeat - i.e. call its function multiple times before finishing, or loop indefinitely.\n\nBecause it's managed by a Clock, a Timer Event is based on game time, will be affected by its Clock's time scale, and will pause if its Clock pauses.","kind":"class","name":"TimerEvent","memberof":"Phaser.Time","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Time.TimerEventConfig"]},"description":"The configuration for the Timer Event, including its delay and callback.","name":"config"}],"scope":"static","longname":"Phaser.Time.TimerEvent","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":29,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The delay in ms at which this TimerEvent fires.","name":"delay","type":{"names":["number"]},"defaultvalue":"0","readonly":true,"since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#delay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The total number of times this TimerEvent will repeat before finishing.","name":"repeat","type":{"names":["number"]},"defaultvalue":"0","readonly":true,"since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#repeat","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"If repeating this contains the current repeat count.","name":"repeatCount","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#repeatCount","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"True if this TimerEvent loops, otherwise false.","name":"loop","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#loop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The callback that will be called when the TimerEvent occurs.","name":"callback","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#callback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The scope in which the callback will be called.","name":"callbackScope","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#callbackScope","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":90,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Additional arguments to be passed to the callback.","name":"args","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#args","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Scale the time causing this TimerEvent to update.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":109,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Start this many MS into the elapsed (useful if you want a long duration with repeat, but for the first loop to fire quickly)","name":"startAt","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#startAt","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The time in milliseconds which has elapsed since the Timer Event's creation.\n\nThis value is local for the Timer Event and is relative to its Clock. As such, it's influenced by the Clock's time scale and paused state, the Timer Event's initial {@link #startAt} property, and the Timer Event's {@link #timeScale} and {@link #paused} state.","name":"elapsed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#elapsed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Whether or not this timer is paused.","name":"paused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#paused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Whether the Timer Event's function has been called.\n\nWhen the Timer Event fires, this property will be set to `true` before the callback function is invoked and will be reset immediately afterward if the Timer Event should repeat. The value of this property does not directly influence whether the Timer Event will be removed from its Clock, but can prevent it from firing.","name":"hasDispatched","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#hasDispatched","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":156,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Completely reinitializes the Timer Event, regardless of its current state, according to a configuration object.","kind":"function","name":"reset","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Time.TimerEventConfig"]},"description":"The new state for the Timer Event.","name":"config"}],"returns":[{"type":{"names":["Phaser.Time.TimerEvent"]},"description":"This TimerEvent object."}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#reset","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":194,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Gets the progress of the current iteration, not factoring in repeats.","kind":"function","name":"getProgress","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A number between 0 and 1 representing the current progress."}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#getProgress","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":207,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Gets the progress of the timer overall, factoring in repeats.","kind":"function","name":"getOverallProgress","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The overall progress of the Timer Event, between 0 and 1."}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#getOverallProgress","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":230,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Returns the number of times this Timer Event will repeat before finishing.\n\nThis should not be confused with the number of times the Timer Event will fire before finishing. A return value of 0 doesn't indicate that the Timer Event has finished running - it indicates that it will not repeat after the next time it fires.","kind":"function","name":"getRepeatCount","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"How many times the Timer Event will repeat."}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#getRepeatCount","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Returns the local elapsed time for the current iteration of the Timer Event.","kind":"function","name":"getElapsed","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The local elapsed time in milliseconds."}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#getElapsed","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Returns the local elapsed time for the current iteration of the Timer Event in seconds.","kind":"function","name":"getElapsedSeconds","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The local elapsed time in seconds."}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#getElapsedSeconds","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":271,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Forces the Timer Event to immediately expire, thus scheduling its removal in the next frame.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true`, the function of the Timer Event will be called before its removal.","name":"dispatchCallback"}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#remove","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":290,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Destroys all object references in the Timer Event, i.e. its callback, scope, and arguments.\n\nNormally, this method is only called by the Clock when it shuts down. As such, it doesn't stop the Timer Event. If called manually, the Timer Event will still be updated by the Clock, but it won't do anything when it fires.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"kind":"namespace","name":"Time","memberof":"Phaser","longname":"Phaser.Time","scope":"static","___s":true},{"meta":{"filename":"TimerEventConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/time/typedefs"},"kind":"typedef","name":"TimerEventConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The delay after which the Timer Event should fire, in milliseconds.","name":"delay"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The total number of times the Timer Event will repeat before finishing.","name":"repeat"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"`true` if the Timer Event should repeat indefinitely.","name":"loop"},{"type":{"names":["function"]},"optional":true,"description":"The callback which will be called when the Timer Event fires.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"The scope (`this` object) with which to invoke the `callback`.","name":"callbackScope"},{"type":{"names":["Array.<*>"]},"optional":true,"description":"Additional arguments to be passed to the `callback`.","name":"args"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The scale of the elapsed time.","name":"timeScale"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The initial elapsed time in milliseconds. Useful if you want a long duration with repeat, but for the first loop to fire quickly.","name":"startAt"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"`true` if the Timer Event should be paused.","name":"paused"}],"memberof":"Phaser.Types.Time","longname":"Phaser.Types.Time.TimerEventConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/time/typedefs"},"kind":"namespace","name":"Time","memberof":"Phaser.Types","longname":"Phaser.Types.Time","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Timeline.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Timeline.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"classdesc":"A Timeline combines multiple Tweens into one. Its overall behavior is otherwise similar to a single Tween.\n\nThe Timeline updates all of its Tweens simultaneously. Its methods allow you to easily build a sequence\nof Tweens (each one starting after the previous one) or run multiple Tweens at once during given parts of the Timeline.","kind":"class","name":"Timeline","memberof":"Phaser.Tweens","augments":["Phaser.Events.EventEmitter"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"The Tween Manager which owns this Timeline.","name":"manager"}],"scope":"static","longname":"Phaser.Tweens.Timeline","___s":true},{"meta":{"filename":"Timeline.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The Tween Manager which owns this Timeline.","name":"manager","type":{"names":["Phaser.Tweens.TweenManager"]},"since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"A constant value which allows this Timeline to be easily identified as one.","name":"isTimeline","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#isTimeline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"An array of Tween objects, each containing a unique property and target being tweened.","name":"data","type":{"names":["array"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The cached size of the data array.","name":"totalData","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#totalData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"If true then duration, delay, etc values are all frame totals, rather than ms.","name":"useFrames","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#useFrames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Scales the time applied to this Timeline. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.\nValue isn't used when calculating total duration of the Timeline, it's a run-time delta adjustment only.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Loop this Timeline? Can be -1 for an infinite loop, or an integer.\nWhen enabled it will play through ALL Tweens again (use Tween.repeat to loop a single tween)","name":"loop","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#loop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":109,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Time in ms/frames before this Timeline loops.","name":"loopDelay","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#loopDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"How many loops are left to run?","name":"loopCounter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#loopCounter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Time in ms/frames before the 'onComplete' event fires. This never fires if loop = true (as it never completes)","name":"completeDelay","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#completeDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":139,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Countdown timer value, as used by `loopDelay` and `completeDelay`.","name":"countdown","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#countdown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":149,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The current state of the Timeline.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#state","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Does the Timeline start off paused? (if so it needs to be started with Timeline.play)","name":"paused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#paused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Elapsed time in ms/frames of this run through of the Timeline.","name":"elapsed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#elapsed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":188,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Total elapsed time in ms/frames of the entire Timeline, including looping.","name":"totalElapsed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#totalElapsed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":198,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Time in ms/frames for the whole Timeline to play through once, excluding loop amounts and loop delays.","name":"duration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":208,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Value between 0 and 1. The amount of progress through the Timeline, _excluding loops_.","name":"progress","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":218,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Time in ms/frames for all Tweens in this Timeline to complete (including looping)","name":"totalDuration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#totalDuration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":228,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Value between 0 and 1. The amount through the entire Timeline, including looping.","name":"totalProgress","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#totalProgress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":238,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"An object containing the different Tween callback functions.\n\nYou can either set these in the Tween config, or by calling the `Tween.setCallback` method.\n\n`onComplete` When the Timeline finishes playback fully or `Timeline.stop` is called. Never invoked if timeline is set to repeat infinitely.\n`onLoop` When a Timeline loops.\n`onStart` When the Timeline starts playing.\n`onUpdate` When a Timeline updates a child Tween.\n`onYoyo` When a Timeline starts a yoyo.","name":"callbacks","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#callbacks","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":261,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The context in which all callbacks are invoked.","name":"callbackScope","type":{"names":["any"]},"since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#callbackScope","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":271,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Internal method that will emit a Timeline based Event and invoke the given callback.","kind":"function","name":"dispatchTimelineEvent","since":"3.19.0","params":[{"type":{"names":["Phaser.Types.Tweens.Event"]},"description":"The Event to be dispatched.","name":"event"},{"type":{"names":["function"]},"description":"The callback to be invoked. Can be `null` or `undefined` to skip invocation.","name":"callback"}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#dispatchTimelineEvent","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":290,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Sets the value of the time scale applied to this Timeline. A value of 1 runs in real-time.\nA value of 0.5 runs 50% slower, and so on.\n\nThe value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.","kind":"function","name":"setTimeScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The time scale value to set.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"This Timeline object."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#setTimeScale","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Gets the value of the time scale applied to this Timeline. A value of 1 runs in real-time.\nA value of 0.5 runs 50% slower, and so on.","kind":"function","name":"getTimeScale","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The value of the time scale applied to this Timeline."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#getTimeScale","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":324,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Check whether or not the Timeline is playing.","kind":"function","name":"isPlaying","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Timeline is active, otherwise `false`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#isPlaying","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Creates a new Tween, based on the given Tween Config, and adds it to this Timeline.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig","object"]},"description":"The configuration object for the Tween.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"This Timeline object."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#add","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":352,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Adds an existing Tween to this Timeline.","kind":"function","name":"queue","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to be added to this Timeline.","name":"tween"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"This Timeline object."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#queue","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":377,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Checks whether a Tween has an offset value.","kind":"function","name":"hasOffset","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to check.","name":"tween"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the tween has a non-null offset."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#hasOffset","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Checks whether the offset value is a number or a directive that is relative to previous tweens.","kind":"function","name":"isOffsetAbsolute","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The offset value to be evaluated.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the result is a number, `false` if it is a directive like \" -= 1000\"."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#isOffsetAbsolute","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":407,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Checks if the offset is a relative value rather than an absolute one.\nIf the value is just a number, this returns false.","kind":"function","name":"isOffsetRelative","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The offset value to be evaluated.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the value is relative, i.e \" -= 1000\". If `false`, the offset is absolute."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#isOffsetRelative","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":435,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Parses the relative offset value, returning a positive or negative number.","kind":"function","name":"getRelativeOffset","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The relative offset, in the format of '-=500', for example. The first character determines whether it will be a positive or negative number. Spacing matters here.","name":"value"},{"type":{"names":["number"]},"description":"The value to use as the offset.","name":"base"}],"returns":[{"type":{"names":["number"]},"description":"The parsed offset value."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#getRelativeOffset","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":467,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Calculates the total duration of the timeline.\n\nComputes all tween durations and returns the full duration of the timeline.\n\nThe resulting number is stored in the timeline, not as a return value.","kind":"function","name":"calcDuration","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#calcDuration","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":534,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Initializes the timeline, which means all Tweens get their init() called, and the total duration will be computed.\nReturns a boolean indicating whether the timeline is auto-started or not.","kind":"function","name":"init","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Timeline is started. `false` if it is paused."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#init","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":562,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Resets all of the timeline's tweens back to their initial states.\nThe boolean parameter indicates whether tweens that are looping should reset as well, or not.","kind":"function","name":"resetTweens","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"If `true`, resets all looping tweens to their initial values.","name":"resetFromLoop"}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#resetTweens","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":581,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Sets a callback for the Timeline.","kind":"function","name":"setCallback","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The internal type of callback to set.","name":"type"},{"type":{"names":["function"]},"description":"Timeline allows multiple tweens to be linked together to create a streaming sequence.","name":"callback"},{"type":{"names":["array"]},"optional":true,"description":"The parameters to pass to the callback.","name":"params"},{"type":{"names":["object"]},"optional":true,"description":"The context scope of the callback.","name":"scope"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"This Timeline object."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#setCallback","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":604,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Passed a Tween to the Tween Manager and requests it be made active.","kind":"function","name":"makeActive","since":"3.3.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween object to make active.","name":"tween"}],"returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"The Timeline's Tween Manager reference."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#makeActive","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":619,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Starts playing the Timeline.","kind":"function","name":"play","fires":["Phaser.Tweens.Events#event:TIMELINE_START"],"since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#play","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":651,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Updates the Timeline's `state` and fires callbacks and events.","kind":"function","name":"nextState","fires":["Phaser.Tweens.Events#event:TIMELINE_COMPLETE","Phaser.Tweens.Events#event:TIMELINE_LOOP"],"since":"3.0.0","see":["Phaser.Tweens.Timeline#update"],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#nextState","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":700,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Returns 'true' if this Timeline has finished and should be removed from the Tween Manager.\nOtherwise, returns false.","kind":"function","name":"update","fires":["Phaser.Tweens.Events#event:TIMELINE_COMPLETE","Phaser.Tweens.Events#event:TIMELINE_UPDATE"],"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"timestamp"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if this Timeline has finished and should be removed from the Tween Manager."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#update","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":790,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Stops the Timeline immediately, whatever stage of progress it is at and flags it for removal by the TweenManager.","kind":"function","name":"stop","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#stop","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":801,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Pauses the Timeline, retaining its internal state.\n\nCalling this on a Timeline that is already paused has no effect and fires no event.","kind":"function","name":"pause","fires":["Phaser.Tweens.Events#event:TIMELINE_PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"This Timeline object."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#pause","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":830,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Resumes a paused Timeline from where it was when it was paused.\n\nCalling this on a Timeline that isn't paused has no effect and fires no event.","kind":"function","name":"resume","fires":["Phaser.Tweens.Events#event:TIMELINE_RESUME"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"This Timeline object."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#resume","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":855,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Checks if any of the Tweens in this Timeline as operating on the target object.\n\nReturns `false` if no Tweens operate on the target object.","kind":"function","name":"hasTarget","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The target to check all Tweens against.","name":"target"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if there is at least a single Tween that operates on the target object, otherwise `false`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#hasTarget","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":880,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Stops all the Tweens in the Timeline immediately, whatever stage of progress they are at and flags\nthem for removal by the TweenManager.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"range":[180,226],"filename":"TweenManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"name":"ArrayRemove","longname":"ArrayRemove","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TweenManager.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"classdesc":"The Tween Manager is a default Scene Plugin which controls and updates Tweens and Timelines.","kind":"class","name":"TweenManager","memberof":"Phaser.Tweens","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene which owns this Tween Manager.","name":"scene"}],"scope":"static","longname":"Phaser.Tweens.TweenManager","___s":true},{"meta":{"filename":"TweenManager.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The Scene which owns this Tween Manager.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TweenManager.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The Systems object of the Scene which owns this Tween Manager.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TweenManager.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The time scale of the Tween Manager.\n\nThis value scales the time delta between two frames, thus influencing the speed of time for all Tweens owned by this Tween Manager.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TweenManager.js","lineno":152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Create a Tween Timeline and return it, but do NOT add it to the active or pending Tween lists.","kind":"function","name":"createTimeline","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TimelineBuilderConfig"]},"optional":true,"description":"The configuration object for the Timeline and its Tweens.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The created Timeline object."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#createTimeline","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Create a Tween Timeline and add it to the active Tween list/","kind":"function","name":"timeline","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TimelineBuilderConfig"]},"optional":true,"description":"The configuration object for the Timeline and its Tweens.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The created Timeline object."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#timeline","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Create a Tween and return it, but do NOT add it to the active or pending Tween lists.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig","object"]},"description":"The configuration object for the Tween.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The created Tween object."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#create","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Create a Tween and add it to the active Tween list.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig","object"]},"description":"The configuration object for the Tween.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The created Tween."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#add","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Add an existing tween into the active Tween list.","kind":"function","name":"existing","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to add.","name":"tween"}],"returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager object."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#existing","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":246,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Create a Number Tween and add it to the active Tween list.","kind":"function","name":"addCounter","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.NumberTweenBuilderConfig"]},"description":"The configuration object for the Number Tween.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The created Number Tween."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#addCounter","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":267,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Creates a Stagger function to be used by a Tween property.\n\nThe stagger function will allow you to stagger changes to the value of the property across all targets of the tween.\n\nThis is only worth using if the tween has multiple targets.\n\nThe following will stagger the delay by 100ms across all targets of the tween, causing them to scale down to 0.2\nover the duration specified:\n\n```javascript\nthis.tweens.add({\n targets: [ ... ],\n scale: 0.2,\n ease: 'linear',\n duration: 1000,\n delay: this.tweens.stagger(100)\n});\n```\n\nThe following will stagger the delay by 500ms across all targets of the tween using a 10 x 6 grid, staggering\nfrom the center out, using a cubic ease.\n\n```javascript\nthis.tweens.add({\n targets: [ ... ],\n scale: 0.2,\n ease: 'linear',\n duration: 1000,\n delay: this.tweens.stagger(500, { grid: [ 10, 6 ], from: 'center', ease: 'cubic.out' })\n});\n```","kind":"function","name":"stagger","since":"3.19.0","params":[{"type":{"names":["number","Array."]},"description":"The amount to stagger by, or an array containing two elements representing the min and max values to stagger between.","name":"value"},{"type":{"names":["Phaser.Types.Tweens.StaggerConfig"]},"description":"The configuration object for the Stagger function.","name":"config"}],"returns":[{"type":{"names":["function"]},"description":"The stagger function."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#stagger","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":313,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Updates the Tween Manager's internal lists at the start of the frame.\n\nThis method will return immediately if no changes have been indicated.","kind":"function","name":"preUpdate","since":"3.0.0","memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#preUpdate","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":393,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Updates all Tweens and Timelines of the Tween Manager.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time in milliseconds.","name":"timestamp"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#update","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Removes the given tween from the Tween Manager, regardless of its state (pending or active).","kind":"function","name":"remove","since":"3.17.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to be removed.","name":"tween"}],"returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager object."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#remove","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":447,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Checks if a Tween or Timeline is active and adds it to the Tween Manager at the start of the frame if it isn't.","kind":"function","name":"makeActive","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to check.","name":"tween"}],"returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager object."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#makeActive","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":480,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Passes all Tweens to the given callback.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"The function to call.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The scope (`this` object) to call the function with.","name":"scope"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"The arguments to pass into the function. Its first argument will always be the Tween currently being iterated.","name":"args"}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#each","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":507,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Returns an array of all active Tweens and Timelines in the Tween Manager.","kind":"function","name":"getAllTweens","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"A new array containing references to all active Tweens and Timelines."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#getAllTweens","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":528,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Returns the scale of the time delta for all Tweens and Timelines owned by this Tween Manager.","kind":"function","name":"getGlobalTimeScale","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The scale of the time delta, usually 1."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#getGlobalTimeScale","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Returns an array of all Tweens or Timelines in the Tween Manager which affect the given target or array of targets.","kind":"function","name":"getTweensOf","since":"3.0.0","params":[{"type":{"names":["object","array"]},"description":"The target to look for. Provide an array to look for multiple targets.","name":"target"}],"returns":[{"type":{"names":["Array."]},"description":"A new array containing all Tweens and Timelines which affect the given target(s)."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#getTweensOf","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":589,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Checks if the given object is being affected by a playing Tween.","kind":"function","name":"isTweening","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"target Phaser.Tweens.Tween object","name":"target"}],"returns":[{"type":{"names":["boolean"]},"description":"returns if target tween object is active or not"}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#isTweening","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":617,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Stops all Tweens in this Tween Manager. They will be removed at the start of the frame.","kind":"function","name":"killAll","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#killAll","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":637,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Stops all Tweens which affect the given target or array of targets. The Tweens will be removed from the Tween Manager at the start of the frame.","see":["{@link #getTweensOf}"],"kind":"function","name":"killTweensOf","since":"3.0.0","params":[{"type":{"names":["object","array"]},"description":"The target to look for. Provide an array to look for multiple targets.","name":"target"}],"returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#killTweensOf","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":661,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Pauses all Tweens in this Tween Manager.","kind":"function","name":"pauseAll","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#pauseAll","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":681,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Resumes all Tweens in this Tween Manager.","kind":"function","name":"resumeAll","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#resumeAll","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":701,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Sets a new scale of the time delta for this Tween Manager.\n\nThe time delta is the time elapsed between two consecutive frames and influences the speed of time for this Tween Manager and all Tweens it owns. Values higher than 1 increase the speed of time, while values smaller than 1 decrease it. A value of 0 freezes time and is effectively equivalent to pausing all Tweens.","kind":"function","name":"setGlobalTimeScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new scale of the time delta, where 1 is the normal speed.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#setGlobalTimeScale","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":720,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The Scene that owns this plugin is shutting down.\nWe need to kill and reset all internal properties as well as stop listening to Scene events.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#shutdown","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":745,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The Scene that owns this plugin is being destroyed.\nWe need to shutdown and then kill off all external references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#destroy","scope":"instance","___s":true},{"meta":{"filename":"GetBoolean.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Retrieves the value of the given key from an object.","kind":"function","name":"GetBoolean","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to retrieve the value from.","name":"source"},{"type":{"names":["string"]},"description":"The key to look for in the `source` object.","name":"key"},{"type":{"names":["*"]},"description":"The default value to return if the `key` doesn't exist or if no `source` object is provided.","name":"defaultValue"}],"returns":[{"type":{"names":["*"]},"description":"The retrieved value."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetBoolean","scope":"static","___s":true},{"meta":{"range":[180,226],"filename":"GetEaseFunction.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"EaseMap","longname":"EaseMap","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetEaseFunction.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"This internal function is used to return the correct ease function for a Tween.\n\nIt can take a variety of input, including an EaseMap based string, or a custom function.","kind":"function","name":"GetEaseFunction","since":"3.0.0","params":[{"type":{"names":["string","function"]},"description":"The ease to find. This can be either a string from the EaseMap, or a custom function.","name":"ease"},{"type":{"names":["Array."]},"optional":true,"description":"An optional array of ease parameters to go with the ease.","name":"easeParams"}],"returns":[{"type":{"names":["function"]},"description":"The ease function."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetEaseFunction","scope":"static","___s":true},{"meta":{"filename":"GetNewValue.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Internal function used by the Tween Builder to create a function that will return\nthe given value from the source.","kind":"function","name":"GetNewValue","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"The source object to get the value from.","name":"source"},{"type":{"names":["string"]},"description":"The property to get from the source.","name":"key"},{"type":{"names":["any"]},"description":"A default value to return should the source not have the property set.","name":"defaultValue"}],"returns":[{"type":{"names":["function"]},"description":"A function which when called will return the property value from the source."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetNewValue","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"GetProps.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"RESERVED","longname":"RESERVED","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetProps.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Internal function used by the Tween Builder to return an array of properties\nthat the Tween will be operating on. It takes a tween configuration object\nand then checks that none of the `props` entries start with an underscore, or that\nnone of the direct properties are on the Reserved list.","kind":"function","name":"GetProps","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig"]},"description":"The configuration object of the Tween to get the properties from.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"An array of all the properties the tween will operate on."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetProps","scope":"static","___s":true},{"meta":{"range":[180,229],"filename":"GetTargets.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"GetValue","longname":"GetValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetTargets.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Extracts an array of targets from a Tween configuration object.\n\nThe targets will be looked for in a `targets` property. If it's a function, its return value will be used as the result.","kind":"function","name":"GetTargets","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object to use.","name":"config"}],"returns":[{"type":{"names":["array"]},"description":"An array of targets (may contain only one element), or `null` if no targets were specified."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetTargets","scope":"static","___s":true},{"meta":{"range":[180,229],"filename":"GetTweens.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"GetValue","longname":"GetValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetTweens.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Internal function used by the Timeline Builder.\n\nIt returns an array of all tweens in the given timeline config.","kind":"function","name":"GetTweens","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TimelineBuilderConfig"]},"description":"The configuration object for the Timeline.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tween instances that the Timeline will manage."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetTweens","scope":"static","___s":true},{"meta":{"range":[195,295],"filename":"GetValueOp.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"ignore":true,"name":"hasGetActive","longname":"hasGetActive","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[316,413],"filename":"GetValueOp.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"ignore":true,"name":"hasGetStart","longname":"hasGetStart","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[434,525],"filename":"GetValueOp.js","lineno":26,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"ignore":true,"name":"hasGetEnd","longname":"hasGetEnd","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[546,643],"filename":"GetValueOp.js","lineno":34,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"ignore":true,"name":"hasGetters","longname":"hasGetters","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetValueOp.js","lineno":39,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Returns `getActive`, `getStart` and `getEnd` functions for a TweenData based on a target property and end value.\n\n`getActive` if not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.\n`getEnd` is invoked once any start delays have expired and returns what the value should tween to.\n`getStart` is invoked when the tween reaches the end and needs to either repeat or yoyo, it returns the value to go back to.\n\nIf the end value is a number, it will be treated as an absolute value and the property will be tweened to it.\nA string can be provided to specify a relative end value which consists of an operation\n(`+=` to add to the current value, `-=` to subtract from the current value, `*=` to multiply the current\nvalue, or `/=` to divide the current value) followed by its operand.\n\nA function can be provided to allow greater control over the end value; it will receive the target\nobject being tweened, the name of the property being tweened, and the current value of the property\nas its arguments.\n\nIf both the starting and the ending values need to be controlled, an object with `getStart` and `getEnd`\ncallbacks, which will receive the same arguments, can be provided instead. If an object with a `value`\nproperty is provided, the property will be used as the effective value under the same rules described here.","kind":"function","name":"GetValueOp","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the property to modify.","name":"key"},{"type":{"names":["*"]},"description":"The ending value of the property, as described above.","name":"propertyValue"}],"returns":[{"type":{"names":["function"]},"description":"An array of functions, `getActive`, `getStart` and `getEnd`, which return the starting and the ending value of the property based on the provided value."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetValueOp","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"NumberTweenBuilder.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"Defaults","longname":"Defaults","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NumberTweenBuilder.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Creates a new Number Tween.","kind":"function","name":"NumberTweenBuilder","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.TweenManager","Phaser.Tweens.Timeline"]},"description":"The owner of the new Tween.","name":"parent"},{"type":{"names":["Phaser.Types.Tweens.NumberTweenBuilderConfig"]},"description":"Configuration for the new Tween.","name":"config"},{"type":{"names":["Phaser.Types.Tweens.TweenConfigDefaults"]},"description":"Tween configuration defaults.","name":"defaults"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The new tween."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.NumberTweenBuilder","scope":"static","___s":true},{"meta":{"range":[180,226],"filename":"StaggerBuilder.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"GetEaseFunction","longname":"GetEaseFunction","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"StaggerBuilder.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Creates a Stagger function to be used by a Tween property.\n\nThe stagger function will allow you to stagger changes to the value of the property across all targets of the tween.\n\nThis is only worth using if the tween has multiple targets.\n\nThe following will stagger the delay by 100ms across all targets of the tween, causing them to scale down to 0.2\nover the duration specified:\n\n```javascript\nthis.tweens.add({\n targets: [ ... ],\n scale: 0.2,\n ease: 'linear',\n duration: 1000,\n delay: this.tweens.stagger(100)\n});\n```\n\nThe following will stagger the delay by 500ms across all targets of the tween using a 10 x 6 grid, staggering\nfrom the center out, using a cubic ease.\n\n```javascript\nthis.tweens.add({\n targets: [ ... ],\n scale: 0.2,\n ease: 'linear',\n duration: 1000,\n delay: this.tweens.stagger(500, { grid: [ 10, 6 ], from: 'center', ease: 'cubic.out' })\n});\n```","kind":"function","name":"StaggerBuilder","since":"3.19.0","params":[{"type":{"names":["number","Array."]},"description":"The amount to stagger by, or an array containing two elements representing the min and max values to stagger between.","name":"value"},{"type":{"names":["Phaser.Types.Tweens.StaggerConfig"]},"optional":true,"description":"A Stagger Configuration object.","name":"config"}],"returns":[{"type":{"names":["function"]},"description":"The stagger function."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.StaggerBuilder","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"TimelineBuilder.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"Clone","longname":"Clone","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TimelineBuilder.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Builds a Timeline of Tweens based on a configuration object.","kind":"function","name":"TimelineBuilder","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"The Tween Manager to which the Timeline will belong.","name":"manager"},{"type":{"names":["Phaser.Types.Tweens.TimelineBuilderConfig"]},"description":"The configuration object for the Timeline.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The created Timeline."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.TimelineBuilder","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"TweenBuilder.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"Defaults","longname":"Defaults","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TweenBuilder.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Creates a new Tween.","kind":"function","name":"TweenBuilder","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.TweenManager","Phaser.Tweens.Timeline"]},"description":"The owner of the new Tween.","name":"parent"},{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig","object"]},"description":"Configuration for the new Tween.","name":"config"},{"type":{"names":["Phaser.Types.Tweens.TweenConfigDefaults"]},"description":"Tween configuration defaults.","name":"defaults"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The new tween."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.TweenBuilder","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"kind":"namespace","name":"Builders","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.Builders","scope":"static","___s":true},{"meta":{"filename":"TIMELINE_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Timeline Complete Event.\n\nThis event is dispatched by a Tween Timeline when it completes playback.\n\nListen to it from a Timeline instance using `Timeline.on('complete', listener)`, i.e.:\n\n```javascript\nvar timeline = this.tweens.timeline({\n targets: image,\n ease: 'Power1',\n duration: 3000,\n tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]\n});\ntimeline.on('complete', listener);\ntimeline.play();\n```","kind":"event","name":"TIMELINE_COMPLETE","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"A reference to the Timeline instance that emitted the event.","name":"timeline"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TIMELINE_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"TIMELINE_LOOP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Timeline Loop Event.\n\nThis event is dispatched by a Tween Timeline every time it loops.\n\nListen to it from a Timeline instance using `Timeline.on('loop', listener)`, i.e.:\n\n```javascript\nvar timeline = this.tweens.timeline({\n targets: image,\n ease: 'Power1',\n duration: 3000,\n loop: 4,\n tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]\n});\ntimeline.on('loop', listener);\ntimeline.play();\n```","kind":"event","name":"TIMELINE_LOOP","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"A reference to the Timeline instance that emitted the event.","name":"timeline"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TIMELINE_LOOP","scope":"instance","___s":true},{"meta":{"filename":"TIMELINE_PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Timeline Pause Event.\n\nThis event is dispatched by a Tween Timeline when it is paused.\n\nListen to it from a Timeline instance using `Timeline.on('pause', listener)`, i.e.:\n\n```javascript\nvar timeline = this.tweens.timeline({\n targets: image,\n ease: 'Power1',\n duration: 3000,\n tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]\n});\ntimeline.on('pause', listener);\n// At some point later ...\ntimeline.pause();\n```","kind":"event","name":"TIMELINE_PAUSE","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"A reference to the Timeline instance that emitted the event.","name":"timeline"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TIMELINE_PAUSE","scope":"instance","___s":true},{"meta":{"filename":"TIMELINE_RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Timeline Resume Event.\n\nThis event is dispatched by a Tween Timeline when it is resumed from a paused state.\n\nListen to it from a Timeline instance using `Timeline.on('resume', listener)`, i.e.:\n\n```javascript\nvar timeline = this.tweens.timeline({\n targets: image,\n ease: 'Power1',\n duration: 3000,\n tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]\n});\ntimeline.on('resume', listener);\n// At some point later ...\ntimeline.resume();\n```","kind":"event","name":"TIMELINE_RESUME","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"A reference to the Timeline instance that emitted the event.","name":"timeline"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TIMELINE_RESUME","scope":"instance","___s":true},{"meta":{"filename":"TIMELINE_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Timeline Start Event.\n\nThis event is dispatched by a Tween Timeline when it starts.\n\nListen to it from a Timeline instance using `Timeline.on('start', listener)`, i.e.:\n\n```javascript\nvar timeline = this.tweens.timeline({\n targets: image,\n ease: 'Power1',\n duration: 3000,\n tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]\n});\ntimeline.on('start', listener);\ntimeline.play();\n```","kind":"event","name":"TIMELINE_START","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"A reference to the Timeline instance that emitted the event.","name":"timeline"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TIMELINE_START","scope":"instance","___s":true},{"meta":{"filename":"TIMELINE_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Timeline Update Event.\n\nThis event is dispatched by a Tween Timeline every time it updates, which can happen a lot of times per second,\nso be careful about listening to this event unless you absolutely require it.\n\nListen to it from a Timeline instance using `Timeline.on('update', listener)`, i.e.:\n\n```javascript\nvar timeline = this.tweens.timeline({\n targets: image,\n ease: 'Power1',\n duration: 3000,\n tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]\n});\ntimeline.on('update', listener);\ntimeline.play();\n```","kind":"event","name":"TIMELINE_UPDATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"A reference to the Timeline instance that emitted the event.","name":"timeline"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TIMELINE_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_ACTIVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Active Event.\n\nThis event is dispatched by a Tween when it becomes active within the Tween Manager.\n\nAn 'active' Tween is one that is now progressing, although it may not yet be updating\nany target properties, due to settings such as `delay`. If you need an event for when\nthe Tween starts actually updating its first property, see `TWEEN_START`.\n\nListen to it from a Tween instance using `Tween.on('active', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000\n});\ntween.on('active', listener);\n```","kind":"event","name":"TWEEN_ACTIVE","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["Array."]},"description":"An array of references to the target/s the Tween is operating on.","name":"targets"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_ACTIVE","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Complete Event.\n\nThis event is dispatched by a Tween when it completes playback entirely, factoring in repeats and loops.\n\nIf the Tween has been set to loop or repeat infinitely, this event will not be dispatched\nunless the `Tween.stop` method is called.\n\nIf a Tween has a `completeDelay` set, this event will fire after that delay expires.\n\nListen to it from a Tween instance using `Tween.on('complete', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000\n});\ntween.on('complete', listener);\n```","kind":"event","name":"TWEEN_COMPLETE","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["Array."]},"description":"An array of references to the target/s the Tween is operating on.","name":"targets"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_LOOP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Loop Event.\n\nThis event is dispatched by a Tween when it loops.\n\nThis event will only be dispatched if the Tween has a loop count set.\n\nIf a Tween has a `loopDelay` set, this event will fire after that delay expires.\n\nThe difference between `loop` and `repeat` is that `repeat` is a property setting,\nwhere-as `loop` applies to the entire Tween.\n\nListen to it from a Tween instance using `Tween.on('loop', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000,\n loop: 6\n});\ntween.on('loop', listener);\n```","kind":"event","name":"TWEEN_LOOP","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["Array."]},"description":"An array of references to the target/s the Tween is operating on.","name":"targets"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_LOOP","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_REPEAT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Repeat Event.\n\nThis event is dispatched by a Tween when one of the properties it is tweening repeats.\n\nThis event will only be dispatched if the Tween has a property with a repeat count set.\n\nIf a Tween has a `repeatDelay` set, this event will fire after that delay expires.\n\nThe difference between `loop` and `repeat` is that `repeat` is a property setting,\nwhere-as `loop` applies to the entire Tween.\n\nListen to it from a Tween instance using `Tween.on('repeat', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000,\n repeat: 4\n});\ntween.on('repeat', listener);\n```","kind":"event","name":"TWEEN_REPEAT","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["string"]},"description":"The key of the property that just repeated.","name":"key"},{"type":{"names":["any"]},"description":"The target that the property just repeated on.","name":"target"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_REPEAT","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Start Event.\n\nThis event is dispatched by a Tween when it starts tweening its first property.\n\nA Tween will only emit this event once, as it can only start once.\n\nIf a Tween has a `delay` set, this event will fire after that delay expires.\n\nListen to it from a Tween instance using `Tween.on('start', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000\n});\ntween.on('start', listener);\n```","kind":"event","name":"TWEEN_START","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["Array."]},"description":"An array of references to the target/s the Tween is operating on.","name":"targets"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_START","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Update Event.\n\nThis event is dispatched by a Tween every time it updates _any_ of the properties it is tweening.\n\nA Tween that is changing 3 properties of a target will emit this event 3 times per change, once per property.\n\n**Note:** This is a very high frequency event and may be dispatched multiple times, every single frame.\n\nListen to it from a Tween instance using `Tween.on('update', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000,\n});\ntween.on('update', listener);\n```","kind":"event","name":"TWEEN_UPDATE","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["string"]},"description":"The property that was updated, i.e. `x` or `scale`.","name":"key"},{"type":{"names":["any"]},"description":"The target object that was updated. Usually a Game Object, but can be of any type.","name":"target"},{"type":{"names":["number"]},"description":"The current value of the property that was tweened.","name":"current"},{"type":{"names":["number"]},"description":"The previous value of the property that was tweened, prior to this update.","name":"previous"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_YOYO_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Yoyo Event.\n\nThis event is dispatched by a Tween whenever a property it is tweening yoyos.\n\nThis event will only be dispatched if the Tween has a property with `yoyo` set.\n\nIf the Tween has a `hold` value, this event is dispatched when the hold expires.\n\nThis event is dispatched for every property, and for every target, that yoyos.\nFor example, if a Tween was updating 2 properties and had 10 targets, this event\nwould be dispatched 20 times (twice per target). So be careful how you use it!\n\nListen to it from a Tween instance using `Tween.on('yoyo', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000,\n yoyo: true\n});\ntween.on('yoyo', listener);\n```","kind":"event","name":"TWEEN_YOYO","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["string"]},"description":"The property that yoyo'd, i.e. `x` or `scale`.","name":"key"},{"type":{"names":["any"]},"description":"The target object that was yoyo'd. Usually a Game Object, but can be of any type.","name":"target"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_YOYO","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.Events","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"kind":"namespace","name":"Tweens","memberof":"Phaser","longname":"Phaser.Tweens","scope":"static","___s":true},{"meta":{"filename":"Defaults.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"kind":"typedef","name":"TweenConfigDefaults","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["object","Array."]},"description":"The object, or an array of objects, to run the tween on.","name":"targets"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to delay before the tween will start.","name":"delay"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1000,"description":"The duration of the tween in milliseconds.","name":"duration"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'Power0'","description":"The easing equation to use for the tween.","name":"ease"},{"type":{"names":["array"]},"optional":true,"description":"Optional easing parameters.","name":"easeParams"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to hold the tween for before yoyo'ing.","name":"hold"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of times to repeat the tween.","name":"repeat"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to pause before a tween will repeat.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.","name":"yoyo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipX` property.","name":"flipX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipY` property.","name":"flipY"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenConfigDefaults","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Tween.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Tween.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"classdesc":"A Tween is able to manipulate the properties of one or more objects to any given value, based\non a duration and type of ease. They are rarely instantiated directly and instead should be\ncreated via the TweenManager.","kind":"class","name":"Tween","memberof":"Phaser.Tweens","augments":["Phaser.Events.EventEmitter"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.TweenManager","Phaser.Tweens.Timeline"]},"description":"A reference to the parent of this Tween. Either the Tween Manager or a Tween Timeline instance.","name":"parent"},{"type":{"names":["Array."]},"description":"An array of TweenData objects, each containing a unique property to be tweened.","name":"data"},{"type":{"names":["array"]},"description":"An array of targets to be tweened.","name":"targets"}],"scope":"static","longname":"Phaser.Tweens.Tween","___s":true},{"meta":{"filename":"Tween.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"A reference to the parent of this Tween.\nEither the Tween Manager or a Tween Timeline instance.","name":"parent","type":{"names":["Phaser.Tweens.TweenManager","Phaser.Tweens.Timeline"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Is the parent of this Tween a Timeline?","name":"parentIsTimeline","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#parentIsTimeline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"An array of TweenData objects, each containing a unique property and target being tweened.","name":"data","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"The cached length of the data array.","name":"totalData","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#totalData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"An array of references to the target/s this Tween is operating on.","name":"targets","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#targets","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Cached target total (not necessarily the same as the data total)","name":"totalTargets","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#totalTargets","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"If `true` then duration, delay, etc values are all frame totals.","name":"useFrames","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#useFrames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Scales the time applied to this Tween. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.\nValue isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Loop this tween? Can be -1 for an infinite loop, or an integer.\nWhen enabled it will play through ALL TweenDatas again. Use TweenData.repeat to loop a single element.","name":"loop","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#loop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Time in ms/frames before the tween loops.","name":"loopDelay","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#loopDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"How many loops are left to run?","name":"loopCounter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#loopCounter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Time in ms/frames before the 'onStart' event fires.\nThis is the shortest `delay` value across all of the TweenDatas of this Tween.","name":"startDelay","type":{"names":["number"]},"defaultvalue":"0","since":"3.19.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#startDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Has this Tween started playback yet?\nThis boolean is toggled when the Tween leaves the 'delayed' state and starts running.","name":"hasStarted","type":{"names":["boolean"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#hasStarted","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":170,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Is this Tween currently seeking?\nThis boolean is toggled in the `Tween.seek` method.\nWhen a tween is seeking it will not dispatch any events or callbacks.","name":"isSeeking","type":{"names":["boolean"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#isSeeking","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":182,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Time in ms/frames before the 'onComplete' event fires. This never fires if loop = -1 (as it never completes)","name":"completeDelay","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#completeDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Countdown timer (used by timeline offset, loopDelay and completeDelay)","name":"countdown","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#countdown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":202,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Set only if this Tween is part of a Timeline.","name":"offset","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":212,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Set only if this Tween is part of a Timeline. The calculated offset amount.","name":"calculatedOffset","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#calculatedOffset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":222,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"The current state of the tween","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#state","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":241,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Does the Tween start off paused? (if so it needs to be started with Tween.play)","name":"paused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#paused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":251,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Elapsed time in ms/frames of this run through the Tween.","name":"elapsed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#elapsed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":261,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Total elapsed time in ms/frames of the entire Tween, including looping.","name":"totalElapsed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#totalElapsed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":271,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Time in ms/frames for the whole Tween to play through once, excluding loop amounts and loop delays.","name":"duration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":281,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Value between 0 and 1. The amount through the Tween, excluding loops.","name":"progress","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":291,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Time in ms/frames for the Tween to complete (including looping)","name":"totalDuration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#totalDuration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":301,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Value between 0 and 1. The amount through the entire Tween, including looping.","name":"totalProgress","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#totalProgress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":311,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"An object containing the different Tween callback functions.\n\nYou can either set these in the Tween config, or by calling the `Tween.setCallback` method.\n\n`onActive` When the Tween is moved from the pending to the active list in the Tween Manager, even if playback paused.\n`onStart` When the Tween starts playing after a delayed state. Will happen at the same time as `onActive` if it has no delay.\n`onYoyo` When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\n`onRepeat` When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\n`onComplete` When the Tween finishes playback fully or `Tween.stop` is called. Never invoked if tween is set to repeat infinitely.\n`onUpdate` When a TweenData updates a property on a source target during playback.\n`onLoop` When a Tween loops. This happens _after_ the `loopDelay` expires, if set.","name":"callbacks","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#callbacks","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":338,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"The context in which all callbacks are invoked.","name":"callbackScope","type":{"names":["any"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#callbackScope","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":348,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Returns the current value of the specified Tween Data.","kind":"function","name":"getValue","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The Tween Data to return the value from.","name":"index"}],"returns":[{"type":{"names":["number"]},"description":"The value of the requested Tween Data."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#getValue","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":365,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Set the scale the time applied to this Tween. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.","kind":"function","name":"setTimeScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The scale factor for timescale.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"- This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#setTimeScale","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":382,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Returns the scale of the time applied to this Tween.","kind":"function","name":"getTimeScale","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The timescale of this tween (between 0 and 1)"}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#getTimeScale","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":395,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Checks if the Tween is currently active.","kind":"function","name":"isPlaying","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Tween is active, otherwise `false`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#isPlaying","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":408,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Checks if the Tween is currently paused.","kind":"function","name":"isPaused","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Tween is paused, otherwise `false`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#isPaused","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":421,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"See if this Tween is currently acting upon the given target.","kind":"function","name":"hasTarget","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The target to check against this Tween.","name":"target"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the given target is a target of this Tween, otherwise `false`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#hasTarget","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":436,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Updates the 'end' value of the given property across all matching targets.\n\nCalling this does not adjust the duration of the tween, or the current progress.\n\nYou can optionally tell it to set the 'start' value to be the current value (before the change).","kind":"function","name":"updateTo","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The property to set the new value for.","name":"key"},{"type":{"names":["*"]},"description":"The new value of the property.","name":"value"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this change set the start value to be the current value?","name":"startToCurrent"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"- This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#updateTo","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":474,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Restarts the tween from the beginning.","kind":"function","name":"restart","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#restart","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":511,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that calculates the overall duration of the Tween.","kind":"function","name":"calcDuration","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#calcDuration","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":584,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Called by TweenManager.preUpdate as part of its loop to check pending and active tweens.\nShould not be called directly.","kind":"function","name":"init","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if this Tween should be moved from the pending list to the active list by the Tween Manager."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#init","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":637,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that makes this Tween active within the TweenManager\nand emits the onActive event and callback.","kind":"function","name":"makeActive","fires":["Phaser.Tweens.Events#event:TWEEN_ACTIVE"],"since":"3.19.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#makeActive","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":652,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that advances to the next state of the Tween during playback.","kind":"function","name":"nextState","fires":["Phaser.Tweens.Events#event:TWEEN_COMPLETE","Phaser.Tweens.Events#event:TWEEN_LOOP"],"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#nextState","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":696,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Pauses the Tween immediately. Use `resume` to continue playback.","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"- This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#pause","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":720,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Starts a Tween playing.\n\nYou only need to call this method if you have configured the tween to be paused on creation.\n\nIf the Tween is already playing, calling this method again will have no effect. If you wish to\nrestart the Tween, use `Tween.restart` instead.\n\nCalling this method after the Tween has completed will start the Tween playing again from the start.\nThis is the same as calling `Tween.seek(0)` and then `Tween.play()`.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Tween being played as part of a Timeline?","name":"resetFromTimeline"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#play","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":797,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that resets all of the Tween Data, including the progress and elapsed values.","kind":"function","name":"resetTweenData","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Has this method been called as part of a loop?","name":"resetFromLoop"}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#resetTweenData","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":853,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Resumes the playback of a previously paused Tween.","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"- This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#resume","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":877,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Seeks to a specific point in the Tween.\n\n**Note:** You cannot seek a Tween that repeats or loops forever, or that has an unusually long total duration.\n\nThe given position is a value between 0 and 1 which represents how far through the Tween to seek to.\nA value of 0.5 would seek to half-way through the Tween, where-as a value of zero would seek to the start.\n\nNote that the seek takes the entire duration of the Tween into account, including delays, loops and repeats.\nFor example, a Tween that lasts for 2 seconds, but that loops 3 times, would have a total duration of 6 seconds,\nso seeking to 0.5 would seek to 3 seconds into the Tween, as that's half-way through its _entire_ duration.\n\nSeeking works by resetting the Tween to its initial values and then iterating through the Tween at `delta`\njumps per step. The longer the Tween, the longer this can take.","kind":"function","name":"seek","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1 which represents the progress point to seek to.","name":"toPosition"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16.6,"description":"The size of each step when seeking through the Tween. A higher value completes faster but at a cost of less precision.","name":"delta"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#seek","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":987,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Sets an event based callback to be invoked during playback.\n\nCalling this method will replace a previously set callback for the given type, if any exists.\n\nThe types available are:\n\n`onActive` When the Tween is moved from the pending to the active list in the Tween Manager, even if playback paused.\n`onStart` When the Tween starts playing after a delayed state. Will happen at the same time as `onActive` if it has no delay.\n`onYoyo` When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\n`onRepeat` When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\n`onComplete` When the Tween finishes playback fully or `Tween.stop` is called. Never invoked if tween is set to repeat infinitely.\n`onUpdate` When a TweenData updates a property on a source target during playback.\n`onLoop` When a Tween loops. This happens _after_ the `loopDelay` expires, if set.","kind":"function","name":"setCallback","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Type of the callback to set.","name":"type"},{"type":{"names":["function"]},"description":"The function to invoke when this callback happens.","name":"callback"},{"type":{"names":["array"]},"optional":true,"description":"An array of parameters for specified callbacks types.","name":"params"},{"type":{"names":["any"]},"optional":true,"description":"The context the callback will be invoked in.","name":"scope"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#setCallback","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1019,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Flags the Tween as being complete, whatever stage of progress it is at.\n\nIf an onComplete callback has been defined it will automatically invoke it, unless a `delay`\nargument is provided, in which case the Tween will delay for that period of time before calling the callback.\n\nIf you don't need a delay, or have an onComplete callback, then call `Tween.stop` instead.","kind":"function","name":"complete","fires":["Phaser.Tweens.Events#event:TWEEN_COMPLETE"],"since":"3.2.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The time to wait before invoking the complete callback. If zero it will fire immediately.","name":"delay"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#complete","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1055,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Immediately removes this Tween from the TweenManager and all of its internal arrays,\nno matter what stage it as it. Then sets the tween state to `REMOVED`.\n\nYou should dispose of your reference to this tween after calling this method, to\nfree it from memory.","kind":"function","name":"remove","since":"3.17.0","returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#remove","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1074,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Stops the Tween immediately, whatever stage of progress it is at and flags it for removal by the TweenManager.","kind":"function","name":"stop","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"If you want to seek the tween, provide a value between 0 and 1.","name":"resetTo"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#stop","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1118,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that advances the Tween based on the time values.","kind":"function","name":"update","fires":["Phaser.Tweens.Events#event:TWEEN_COMPLETE","Phaser.Tweens.Events#event:TWEEN_LOOP","Phaser.Tweens.Events#event:TWEEN_START"],"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"timestamp"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if this Tween has finished and should be removed from the Tween Manager, otherwise returns `false`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#update","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that will emit a TweenData based Event and invoke the given callback.","kind":"function","name":"dispatchTweenDataEvent","since":"3.19.0","params":[{"type":{"names":["Phaser.Types.Tweens.Event"]},"description":"The Event to be dispatched.","name":"event"},{"type":{"names":["function"]},"description":"The callback to be invoked. Can be `null` or `undefined` to skip invocation.","name":"callback"},{"type":{"names":["Phaser.Types.Tweens.TweenDataConfig"]},"description":"The TweenData object that caused this event.","name":"tweenData"}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#dispatchTweenDataEvent","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that will emit a Tween based Event and invoke the given callback.","kind":"function","name":"dispatchTweenEvent","since":"3.19.0","params":[{"type":{"names":["Phaser.Types.Tweens.Event"]},"description":"The Event to be dispatched.","name":"event"},{"type":{"names":["function"]},"description":"The callback to be invoked. Can be `null` or `undefined` to skip invocation.","name":"callback"}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#dispatchTweenEvent","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method used as part of the playback process that sets a tween to play in reverse.","kind":"function","name":"setStateFromEnd","fires":["Phaser.Tweens.Events#event:TWEEN_REPEAT","Phaser.Tweens.Events#event:TWEEN_YOYO"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to update.","name":"tween"},{"type":{"names":["Phaser.Types.Tweens.TweenDataConfig"]},"description":"The TweenData property to update.","name":"tweenData"},{"type":{"names":["number"]},"description":"Any extra time that needs to be accounted for in the elapsed and progress values.","name":"diff"}],"returns":[{"type":{"names":["integer"]},"description":"The state of this Tween."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#setStateFromEnd","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1365,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method used as part of the playback process that sets a tween to play from the start.","kind":"function","name":"setStateFromStart","fires":["Phaser.Tweens.Events#event:TWEEN_REPEAT"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to update.","name":"tween"},{"type":{"names":["Phaser.Types.Tweens.TweenDataConfig"]},"description":"The TweenData property to update.","name":"tweenData"},{"type":{"names":["number"]},"description":"Any extra time that needs to be accounted for in the elapsed and progress values.","name":"diff"}],"returns":[{"type":{"names":["integer"]},"description":"The state of this Tween."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#setStateFromStart","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1422,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that advances the TweenData based on the time value given.","kind":"function","name":"updateTweenData","fires":["Phaser.Tweens.Events#event:TWEEN_UPDATE","Phaser.Tweens.Events#event:TWEEN_REPEAT"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to update.","name":"tween"},{"type":{"names":["Phaser.Types.Tweens.TweenDataConfig"]},"description":"The TweenData property to update.","name":"tweenData"},{"type":{"names":["number"]},"description":"Either a value in ms, or 1 if Tween.useFrames is true.","name":"delta"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the tween is not complete (e.g., playing), or false if the tween is complete."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#updateTweenData","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1594,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Creates a new Tween object.\n\nNote: This method will only be available if Tweens have been built into Phaser.","kind":"function","name":"tween","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig","object"]},"description":"The Tween configuration.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#tween","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1619,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Creates a new Tween object and returns it.\n\nNote: This method will only be available if Tweens have been built into Phaser.","kind":"function","name":"tween","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig","object"]},"description":"The Tween configuration.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#tween","scope":"instance","___s":true},{"meta":{"filename":"TweenData.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Returns a TweenDataConfig object that describes the tween data for a unique property of a unique target.\nA single Tween consists of multiple TweenDatas, depending on how many properties are being changed by the Tween.\n\nThis is an internal function used by the TweenBuilder and should not be accessed directly, instead,\nTweens should be created using the GameObjectFactory or GameObjectCreator.","kind":"function","name":"TweenData","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"The target to tween.","name":"target"},{"type":{"names":["integer"]},"description":"The target index within the Tween targets array.","name":"index"},{"type":{"names":["string"]},"description":"The property of the target to tween.","name":"key"},{"type":{"names":["function"]},"description":"What the property will be at the END of the Tween.","name":"getEnd"},{"type":{"names":["function"]},"description":"What the property will be at the START of the Tween.","name":"getStart"},{"type":{"names":["function"]},"nullable":true,"description":"If not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.","name":"getActive"},{"type":{"names":["function"]},"description":"The ease function this tween uses.","name":"ease"},{"type":{"names":["number"]},"description":"Time in ms/frames before tween will start.","name":"delay"},{"type":{"names":["number"]},"description":"Duration of the tween in ms/frames.","name":"duration"},{"type":{"names":["boolean"]},"description":"Determines whether the tween should return back to its start value after hold has expired.","name":"yoyo"},{"type":{"names":["number"]},"description":"Time in ms/frames the tween will pause before repeating or returning to its starting value if yoyo is set to true.","name":"hold"},{"type":{"names":["number"]},"description":"Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.","name":"repeat"},{"type":{"names":["number"]},"description":"Time in ms/frames before the repeat will start.","name":"repeatDelay"},{"type":{"names":["boolean"]},"description":"Should toggleFlipX be called when yoyo or repeat happens?","name":"flipX"},{"type":{"names":["boolean"]},"description":"Should toggleFlipY be called when yoyo or repeat happens?","name":"flipY"}],"returns":[{"type":{"names":["Phaser.Types.Tweens.TweenDataConfig"]},"description":"The config object describing this TweenData."}],"memberof":"Phaser.Tweens","longname":"Phaser.Tweens.TweenData","scope":"static","___s":true},{"meta":{"range":[180,2806],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"name":"TWEEN_CONST","longname":"TWEEN_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"CREATED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.CREATED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"INIT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.INIT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"DELAY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.DELAY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"OFFSET_DELAY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.OFFSET_DELAY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"PENDING_RENDER","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.PENDING_RENDER","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"PLAYING_FORWARD","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.PLAYING_FORWARD","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"PLAYING_BACKWARD","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.PLAYING_BACKWARD","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"HOLD_DELAY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.HOLD_DELAY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"REPEAT_DELAY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.REPEAT_DELAY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"COMPLETE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.COMPLETE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"PENDING_ADD","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.PENDING_ADD","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"PAUSED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.PAUSED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":119,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"LOOP_DELAY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.LOOP_DELAY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":128,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"ACTIVE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.ACTIVE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":137,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"COMPLETE_DELAY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.COMPLETE_DELAY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":146,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"PENDING_REMOVE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.PENDING_REMOVE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"REMOVED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.REMOVED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"Event.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"Event","type":{"names":["string"]},"description":"A Tween Event.","since":"3.19.0","memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.Event","scope":"static","___s":true},{"meta":{"filename":"GetActiveCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"GetActiveCallback","type":{"names":["function"]},"since":"3.19.0","params":[{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["string"]},"description":"The target property.","name":"key"},{"type":{"names":["number"]},"description":"The current value of the target property.","name":"value"},{"type":{"names":["integer"]},"description":"The index of the target within the Tween.","name":"targetIndex"},{"type":{"names":["integer"]},"description":"The total number of targets in this Tween.","name":"totalTargets"},{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween that invoked this callback.","name":"tween"}],"returns":[{"type":{"names":["number"]},"description":"- The new value."}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.GetActiveCallback","scope":"static","___s":true},{"meta":{"filename":"GetEndCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"GetEndCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["string"]},"description":"The target property.","name":"key"},{"type":{"names":["number"]},"description":"The current value of the target property.","name":"value"},{"type":{"names":["integer"]},"description":"The index of the target within the Tween.","name":"targetIndex"},{"type":{"names":["integer"]},"description":"The total number of targets in this Tween.","name":"totalTargets"},{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween that invoked this callback.","name":"tween"}],"returns":[{"type":{"names":["number"]},"description":"- The new value."}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.GetEndCallback","scope":"static","___s":true},{"meta":{"filename":"GetStartCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"GetStartCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["string"]},"description":"The target property.","name":"key"},{"type":{"names":["number"]},"description":"The current value of the target property.","name":"value"},{"type":{"names":["integer"]},"description":"The index of the target within the Tween.","name":"targetIndex"},{"type":{"names":["integer"]},"description":"The total number of targets in this Tween.","name":"totalTargets"},{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween that invoked this callback.","name":"tween"}],"returns":[{"type":{"names":["number"]},"description":"- The new value."}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.GetStartCallback","scope":"static","___s":true},{"meta":{"filename":"NumberTweenBuilderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"NumberTweenBuilderConfig","type":{"names":["object"]},"since":"3.18.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The start number.","name":"from"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The end number.","name":"to"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to delay before the tween will start.","name":"delay"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1000,"description":"The duration of the tween in milliseconds.","name":"duration"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Power0'","description":"The easing equation to use for the tween.","name":"ease"},{"type":{"names":["array"]},"optional":true,"description":"Optional easing parameters.","name":"easeParams"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to hold the tween for before yoyo'ing.","name":"hold"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of times to repeat the tween.","name":"repeat"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to pause before a tween will repeat.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.","name":"yoyo"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":null,"description":"Used when the Tween is part of a Timeline.","name":"offset"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.","name":"completeDelay"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property tween has completed once.","name":"loop"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The time the tween will pause before starting either a yoyo or returning to the start for a repeat.","name":"loopDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Does the tween start in a paused state (true) or playing (false)?","name":"paused"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use frames or milliseconds?","name":"useFrames"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for the callbacks. The default scope is the tween.","name":"callbackScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnCompleteCallback"]},"optional":true,"description":"A function to call when the tween completes.","name":"onComplete"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onComplete`.","name":"onCompleteParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onComplete`.","name":"onCompleteScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnLoopCallback"]},"optional":true,"description":"A function to call each time the tween loops.","name":"onLoop"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onLoop`.","name":"onLoopParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onLoop`.","name":"onLoopScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnRepeatCallback"]},"optional":true,"description":"A function to call each time the tween repeats. Called once per property per target.","name":"onRepeat"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onRepeat`.","name":"onRepeatParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onRepeat`.","name":"onRepeatScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnStartCallback"]},"optional":true,"description":"A function to call when the tween starts.","name":"onStart"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onStart`.","name":"onStartParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onStart`.","name":"onStartScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnUpdateCallback"]},"optional":true,"description":"A function to call each time the tween steps. Called once per property per target.","name":"onUpdate"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onUpdate`.","name":"onUpdateParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onUpdate`.","name":"onUpdateScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnYoyoCallback"]},"optional":true,"description":"A function to call each time the tween yoyos. Called once per property per target.","name":"onYoyo"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onYoyo`.","name":"onYoyoParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onYoyo`.","name":"onYoyoScope"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.NumberTweenBuilderConfig","scope":"static","___s":true},{"meta":{"filename":"StaggerConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"StaggerConfig","type":{"names":["object"]},"since":"3.19.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The value to start the stagger from. Can be used as a way to offset the stagger while still using a range for the value.","name":"start"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Linear'","description":"An ease to apply across the staggered values. Can either be a string, such as 'sine.inout', or a function.","name":"ease"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":0,"description":"The index to start the stagger from. Can be the strings `first`, `last` or `center`, or an integer representing the stagger position.","name":"from"},{"type":{"names":["Array."]},"optional":true,"description":"Set the stagger to run across a grid by providing an array where element 0 is the width of the grid and element 1 is the height. Combine with the 'from' property to control direction.","name":"grid"}],"examples":["{\n grid: [ 20, 8 ],\n from: 'center',\n ease: 'Power0',\n start: 100\n};"],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.StaggerConfig","scope":"static","___s":true},{"meta":{"filename":"TimelineBuilderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TimelineBuilderConfig","type":{"names":["object"]},"since":"3.18.0","properties":[{"type":{"names":["Array.","Array.","function"]},"optional":true,"description":"An array of tween configuration objects to create and add into the new Timeline. If this doesn't exist or is empty, the Timeline will start off paused and none of the other configuration settings will be read. If it's a function, it will be called and its return value will be used as the array.","name":"tweens"},{"type":{"names":["any"]},"optional":true,"description":"An array (or function which returns one) of default targets to which to apply the Timeline. Each individual Tween configuration can override this value.","name":"targets"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"If specified, each Tween in the Timeline will get an equal portion of this duration, usually in milliseconds, by default. Each individual Tween configuration can override the Tween's duration.","name":"totalDuration"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1000,"description":"If `totalDuration` is not specified, the default duration, usually in milliseconds, of each Tween which will be created. Each individual Tween configuration can override the Tween's duration.","name":"duration"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to delay before the tween will start. Each individual Tween configuration can override this value.","name":"delay"},{"type":{"names":["array"]},"optional":true,"description":"Optional easing parameters. Each individual Tween configuration can override this value.","name":"easeParams"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Power0'","description":"The easing equation to use for each tween. Each individual Tween configuration can override this value.","name":"ease"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to hold each tween before yoyo'ing. Each individual Tween configuration can override this value.","name":"hold"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The number of times to repeat each tween. Each individual Tween configuration can override this value.","name":"repeat"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to pause before each tween will repeat. Each individual Tween configuration can override this value.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should each tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete. Each individual Tween configuration can override this value.","name":"yoyo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipX` property. Each individual Tween configuration can override this value.","name":"flipX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipY` property. Each individual Tween configuration can override this value.","name":"flipY"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"If specified, the time to wait, usually in milliseconds, before the Timeline completes.","name":"completeDelay"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"How many times the Timeline should loop, or -1 to loop indefinitely.","name":"loop"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The time, usually in milliseconds, between each loop.","name":"loopDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true`, the Timeline will start paused.","name":"paused"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true`, all duration in the Timeline will be in frames instead of milliseconds.","name":"useFrames"},{"type":{"names":["any"]},"optional":true,"description":"The default scope (`this` value) to use for each callback registered by the Timeline Builder. If not specified, the Timeline itself will be used.","name":"callbackScope"},{"type":{"names":["Phaser.Types.Tweens.TimelineOnStartCallback"]},"optional":true,"description":"If specified, the `onStart` callback for the Timeline, called every time it starts playing.","name":"onStart"},{"type":{"names":["any"]},"optional":true,"description":"The scope (`this` value) to use for the `onStart` callback. If not specified, the `callbackScope` will be used.","name":"onStartScope"},{"type":{"names":["array"]},"optional":true,"description":"Additional arguments to pass to the `onStart` callback. The Timeline will always be the first argument.","name":"onStartParams"},{"type":{"names":["Phaser.Types.Tweens.TimelineOnUpdateCallback"]},"optional":true,"description":"If specified, the `onUpdate` callback for the Timeline, called every frame it's active, regardless of its Tweens.","name":"onUpdate"},{"type":{"names":["any"]},"optional":true,"description":"The scope (`this` value) to use for the `onUpdate` callback. If not specified, the `callbackScope` will be used.","name":"onUpdateScope"},{"type":{"names":["array"]},"optional":true,"description":"Additional arguments to pass to the `onUpdate` callback. The Timeline will always be the first argument.","name":"onUpdateParams"},{"type":{"names":["Phaser.Types.Tweens.TimelineOnLoopCallback"]},"optional":true,"description":"If specified, the `onLoop` callback for the Timeline, called every time it loops.","name":"onLoop"},{"type":{"names":["any"]},"optional":true,"description":"The scope (`this` value) to use for the `onLoop` callback. If not specified, the `callbackScope` will be used.","name":"onLoopScope"},{"type":{"names":["array"]},"optional":true,"description":"Additional arguments to pass to the `onLoop` callback. The Timeline will always be the first argument.","name":"onLoopParams"},{"type":{"names":["Phaser.Types.Tweens.TimelineOnYoyoCallback"]},"optional":true,"description":"If specified, the `onYoyo` callback for the Timeline, called every time it yoyos.","name":"onYoyo"},{"type":{"names":["any"]},"optional":true,"description":"The scope (`this` value) to use for the `onYoyo` callback. If not specified, the `callbackScope` will be used.","name":"onYoyoScope"},{"type":{"names":["array"]},"optional":true,"description":"Additional arguments to pass to the `onYoyo` callback. The first argument will always be `null`, while the Timeline will always be the second argument.","name":"onYoyoParams"},{"type":{"names":["Phaser.Types.Tweens.TimelineOnCompleteCallback"]},"optional":true,"description":"If specified, the `onComplete` callback for the Timeline, called after it completes.","name":"onComplete"},{"type":{"names":["any"]},"optional":true,"description":"The scope (`this` value) to use for the `onComplete` callback. If not specified, the `callbackScope` will be used.","name":"onCompleteScope"},{"type":{"names":["array"]},"optional":true,"description":"Additional arguments to pass to the `onComplete` callback. The Timeline will always be the first argument.","name":"onCompleteParams"}],"see":["Phaser.Tweens.Builders.TimelineBuilder"],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TimelineBuilderConfig","scope":"static","___s":true},{"meta":{"filename":"TimelineOnCompleteCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TimelineOnCompleteCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The timeline.","name":"timeline"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onCompleteParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TimelineOnCompleteCallback","scope":"static","___s":true},{"meta":{"filename":"TimelineOnLoopCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TimelineOnLoopCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The timeline.","name":"timeline"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onLoopParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TimelineOnLoopCallback","scope":"static","___s":true},{"meta":{"filename":"TimelineOnStartCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TimelineOnStartCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The timeline.","name":"timeline"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onStartParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TimelineOnStartCallback","scope":"static","___s":true},{"meta":{"filename":"TimelineOnUpdateCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TimelineOnUpdateCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The timeline.","name":"timeline"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onUpdateParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TimelineOnUpdateCallback","scope":"static","___s":true},{"meta":{"filename":"TimelineOnYoyoCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TimelineOnYoyoCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The timeline.","name":"timeline"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onYoyoParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TimelineOnYoyoCallback","scope":"static","___s":true},{"meta":{"filename":"TweenBuilderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenBuilderConfig","type":{"names":["object"]},"since":"3.18.0","properties":[{"type":{"names":["any"]},"description":"The object, or an array of objects, to run the tween on.","name":"targets"},{"type":{"names":["number","function"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to delay before the tween will start.","name":"delay"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1000,"description":"The duration of the tween in milliseconds.","name":"duration"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Power0'","description":"The easing equation to use for the tween.","name":"ease"},{"type":{"names":["array"]},"optional":true,"description":"Optional easing parameters.","name":"easeParams"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to hold the tween for before yoyo'ing.","name":"hold"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of times each property tween repeats.","name":"repeat"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to pause before a repeat.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.","name":"yoyo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipX` property.","name":"flipX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipY` property.","name":"flipY"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":null,"description":"Used when the Tween is part of a Timeline.","name":"offset"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.","name":"completeDelay"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property tween has completed once.","name":"loop"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The time the tween will pause before starting either a yoyo or returning to the start for a repeat.","name":"loopDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Does the tween start in a paused state (true) or playing (false)?","name":"paused"},{"type":{"names":["Object."]},"optional":true,"description":"The properties to tween.","name":"props"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use frames or milliseconds?","name":"useFrames"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for the callbacks. The default scope is the tween.","name":"callbackScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnCompleteCallback"]},"optional":true,"description":"A function to call when the tween completes.","name":"onComplete"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onComplete`.","name":"onCompleteParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onComplete`.","name":"onCompleteScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnLoopCallback"]},"optional":true,"description":"A function to call each time the tween loops.","name":"onLoop"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onLoop`.","name":"onLoopParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onLoop`.","name":"onLoopScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnRepeatCallback"]},"optional":true,"description":"A function to call each time the tween repeats. Called once per property per target.","name":"onRepeat"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onRepeat`.","name":"onRepeatParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onRepeat`.","name":"onRepeatScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnStartCallback"]},"optional":true,"description":"A function to call when the tween starts playback, after any delays have expired.","name":"onStart"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onStart`.","name":"onStartParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onStart`.","name":"onStartScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnUpdateCallback"]},"optional":true,"description":"A function to call each time the tween steps. Called once per property per target.","name":"onUpdate"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onUpdate`.","name":"onUpdateParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onUpdate`.","name":"onUpdateScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnYoyoCallback"]},"optional":true,"description":"A function to call each time the tween yoyos. Called once per property per target.","name":"onYoyo"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onYoyo`.","name":"onYoyoParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onYoyo`.","name":"onYoyoScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnActiveCallback"]},"optional":true,"description":"A function to call when the tween becomes active within the Tween Manager.","name":"onActive"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onActive`.","name":"onActiveParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onActive`.","name":"onActiveScope"}],"examples":["{\n targets: null,\n delay: 0,\n duration: 1000,\n ease: 'Power0',\n easeParams: null,\n hold: 0,\n repeat: 0,\n repeatDelay: 0,\n yoyo: false,\n flipX: false,\n flipY: false\n};"],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenBuilderConfig","scope":"static","___s":true},{"meta":{"filename":"TweenDataConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenDataConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["any"]},"description":"The target to tween.","name":"target"},{"type":{"names":["integer"]},"description":"The target index within the Tween targets array.","name":"index"},{"type":{"names":["string"]},"description":"The property of the target being tweened.","name":"key"},{"type":{"names":["Phaser.Types.Tweens.GetActiveCallback"]},"nullable":true,"description":"If not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.","name":"getActiveValue"},{"type":{"names":["Phaser.Types.Tweens.GetEndCallback"]},"description":"The returned value sets what the property will be at the END of the Tween.","name":"getEndValue"},{"type":{"names":["Phaser.Types.Tweens.GetStartCallback"]},"description":"The returned value sets what the property will be at the START of the Tween.","name":"getStartValue"},{"type":{"names":["function"]},"description":"The ease function this tween uses.","name":"ease"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Duration of the tween in ms/frames, excludes time for yoyo or repeats.","name":"duration"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The total calculated duration of this TweenData (based on duration, repeat, delay and yoyo)","name":"totalDuration"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time in ms/frames before tween will start.","name":"delay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Cause the tween to return back to its start value after hold has expired.","name":"yoyo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time in ms/frames the tween will pause before running the yoyo or starting a repeat.","name":"hold"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.","name":"repeat"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time in ms/frames before the repeat will start.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Automatically call toggleFlipX when the TweenData yoyos or repeats","name":"flipX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Automatically call toggleFlipY when the TweenData yoyos or repeats","name":"flipY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Between 0 and 1 showing completion of this TweenData.","name":"progress"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Delta counter","name":"elapsed"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"How many repeats are left to run?","name":"repeatCounter"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The property value at the start of the ease.","name":"start"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The current propety value.","name":"current"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The previous property value.","name":"previous"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The property value at the end of the ease.","name":"end"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time duration 1.","name":"t1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time duration 2.","name":"t2"},{"type":{"names":["Phaser.Types.Tweens.TweenDataGenConfig"]},"optional":true,"description":"LoadValue generation functions.","name":"gen"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"TWEEN_CONST.CREATED","name":"state"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenDataConfig","scope":"static","___s":true},{"meta":{"filename":"TweenDataGenConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenDataGenConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["function"]},"description":"Time in ms/frames before tween will start.","name":"delay"},{"type":{"names":["function"]},"description":"Duration of the tween in ms/frames, excludes time for yoyo or repeats.","name":"duration"},{"type":{"names":["function"]},"description":"Time in ms/frames the tween will pause before running the yoyo or starting a repeat.","name":"hold"},{"type":{"names":["function"]},"description":"Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.","name":"repeat"},{"type":{"names":["function"]},"description":"Time in ms/frames before the repeat will start.","name":"repeatDelay"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenDataGenConfig","scope":"static","___s":true},{"meta":{"filename":"TweenOnActiveCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnActiveCallback","type":{"names":["function"]},"since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onActiveParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnActiveCallback","scope":"static","___s":true},{"meta":{"filename":"TweenOnCompleteCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnCompleteCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["array"]},"description":"The tween targets.","name":"targets"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onCompleteParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnCompleteCallback","scope":"static","___s":true},{"meta":{"filename":"TweenOnLoopCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnLoopCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["array"]},"description":"The tween targets.","name":"targets"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onLoopParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnLoopCallback","scope":"static","___s":true},{"meta":{"filename":"TweenOnRepeatCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnRepeatCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onRepeatParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnRepeatCallback","scope":"static","___s":true},{"meta":{"filename":"TweenOnStartCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnStartCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["array"]},"description":"The tween targets.","name":"targets"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onStartParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnStartCallback","scope":"static","___s":true},{"meta":{"filename":"TweenOnUpdateCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnUpdateCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onUpdateParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnUpdateCallback","scope":"static","___s":true},{"meta":{"filename":"TweenOnYoyoCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnYoyoCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onYoyoParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnYoyoCallback","scope":"static","___s":true},{"meta":{"filename":"TweenPropConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenPropConfig","type":{"names":["object"]},"since":"3.18.0","properties":[{"type":{"names":["number","string","Phaser.Types.Tweens.GetEndCallback","Phaser.Types.Tweens.TweenPropConfig"]},"optional":true,"description":"What the property will be at the END of the Tween.","name":"value"},{"type":{"names":["Phaser.Types.Tweens.GetActiveCallback"]},"optional":true,"description":"What the property will be set to immediately when this tween becomes active.","name":"getActive"},{"type":{"names":["Phaser.Types.Tweens.GetEndCallback"]},"optional":true,"description":"What the property will be at the END of the Tween.","name":"getEnd"},{"type":{"names":["Phaser.Types.Tweens.GetStartCallback"]},"optional":true,"description":"What the property will be at the START of the Tween.","name":"getStart"},{"type":{"names":["string","function"]},"optional":true,"description":"The ease function this tween uses.","name":"ease"},{"type":{"names":["number"]},"optional":true,"description":"Time in ms/frames before tween will start.","name":"delay"},{"type":{"names":["number"]},"optional":true,"description":"Duration of the tween in ms/frames.","name":"duration"},{"type":{"names":["boolean"]},"optional":true,"description":"Determines whether the tween should return back to its start value after hold has expired.","name":"yoyo"},{"type":{"names":["number"]},"optional":true,"description":"Time in ms/frames the tween will pause before repeating or returning to its starting value if yoyo is set to true.","name":"hold"},{"type":{"names":["number"]},"optional":true,"description":"Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.","name":"repeat"},{"type":{"names":["number"]},"optional":true,"description":"Time in ms/frames before the repeat will start.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"description":"Should toggleFlipX be called when yoyo or repeat happens?","name":"flipX"},{"type":{"names":["boolean"]},"optional":true,"description":"Should toggleFlipY be called when yoyo or repeat happens?","name":"flipY"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenPropConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"namespace","name":"Tweens","memberof":"Phaser.Types","longname":"Phaser.Types.Tweens","scope":"static","___s":true},{"meta":{"filename":"Class.js","lineno":69,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils"},"description":"Extends the given `myClass` object's prototype with the properties of `definition`.","kind":"function","name":"extend","params":[{"type":{"names":["Object"]},"description":"The constructor object to mix into.","name":"ctor"},{"type":{"names":["Object"]},"description":"A dictionary of functions for the class.","name":"definition"},{"type":{"names":["boolean"]},"description":"Is the definition a class descriptor?","name":"isClassDescriptor"},{"type":{"names":["Object"]},"optional":true,"description":"The parent constructor object.","name":"extend"}],"longname":"extend","scope":"global","___s":true},{"meta":{"filename":"Class.js","lineno":120,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils"},"description":"Applies the given `mixins` to the prototype of `myClass`.","kind":"function","name":"mixin","params":[{"type":{"names":["Object"]},"description":"The constructor object to mix into.","name":"myClass"},{"type":{"names":["Object","Array."]},"description":"The mixins to apply to the constructor.","name":"mixins"}],"longname":"mixin","scope":"global","___s":true},{"meta":{"range":[4556,6299],"filename":"Class.js","lineno":171,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils"},"description":"Creates a new class with the given descriptor.\nThe constructor, defined by the name `initialize`,\nis an optional function. If unspecified, an anonymous\nfunction will be used which calls the parent class (if\none exists).\n\nYou can also use `Extends` and `Mixins` to provide subclassing\nand inheritance.","kind":"class","classdesc":"Phaser.Class","params":[{"type":{"names":["Object"]},"description":"a dictionary of functions for the class","name":"definition"}],"examples":["var MyClass = new Phaser.Class({\n\n initialize: function() {\n this.foo = 2.0;\n },\n\n bar: function() {\n return this.foo + 5;\n }\n });"],"name":"Class","longname":"Class","scope":"global","___s":true},{"meta":{"filename":"NOOP.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils"},"description":"A NOOP (No Operation) callback function.\n\nUsed internally by Phaser when it's more expensive to determine if a callback exists\nthan it is to just invoke an empty function.","kind":"function","name":"NOOP","since":"3.0.0","memberof":"Phaser.Utils","longname":"Phaser.Utils.NOOP","scope":"static","___s":true},{"meta":{"filename":"Add.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Adds the given item, or array of items, to the array.\n\nEach item must be unique within the array.\n\nThe array is modified in-place and returned.\n\nYou can optionally specify a limit to the maximum size of the array. If the quantity of items being\nadded will take the array length over this limit, it will stop adding once the limit is reached.\n\nYou can optionally specify a callback to be invoked for each item successfully added to the array.","kind":"function","name":"Add","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to be added to.","name":"array"},{"type":{"names":["any","Array."]},"description":"The item, or array of items, to add to the array. Each item must be unique within the array.","name":"item"},{"type":{"names":["integer"]},"optional":true,"description":"Optional limit which caps the size of the array.","name":"limit"},{"type":{"names":["function"]},"optional":true,"description":"A callback to be invoked for each item successfully added to the array.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context in which the callback is invoked.","name":"context"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Add","scope":"static","___s":true},{"meta":{"filename":"AddAt.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Adds the given item, or array of items, to the array starting at the index specified.\n\nEach item must be unique within the array.\n\nExisting elements in the array are shifted up.\n\nThe array is modified in-place and returned.\n\nYou can optionally specify a limit to the maximum size of the array. If the quantity of items being\nadded will take the array length over this limit, it will stop adding once the limit is reached.\n\nYou can optionally specify a callback to be invoked for each item successfully added to the array.","kind":"function","name":"AddAt","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to be added to.","name":"array"},{"type":{"names":["any","Array."]},"description":"The item, or array of items, to add to the array.","name":"item"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The index in the array where the item will be inserted.","name":"index"},{"type":{"names":["integer"]},"optional":true,"description":"Optional limit which caps the size of the array.","name":"limit"},{"type":{"names":["function"]},"optional":true,"description":"A callback to be invoked for each item successfully added to the array.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context in which the callback is invoked.","name":"context"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.AddAt","scope":"static","___s":true},{"meta":{"filename":"BringToTop.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves the given element to the top of the array.\nThe array is modified in-place.","kind":"function","name":"BringToTop","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array.","name":"array"},{"type":{"names":["*"]},"description":"The element to move.","name":"item"}],"returns":[{"type":{"names":["*"]},"description":"The element that was moved."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.BringToTop","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"CountAllMatching.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SafeRange","longname":"SafeRange","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CountAllMatching.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Returns the total number of elements in the array which have a property matching the given value.","kind":"function","name":"CountAllMatching","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search.","name":"array"},{"type":{"names":["string"]},"description":"The property to test on each array element.","name":"property"},{"type":{"names":["*"]},"description":"The value to test the property against. Must pass a strict (`===`) comparison check.","name":"value"},{"type":{"names":["integer"]},"optional":true,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"An optional end index to search to.","name":"endIndex"}],"returns":[{"type":{"names":["integer"]},"description":"The total number of elements with properties matching the given value."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.CountAllMatching","scope":"static","___s":true},{"meta":{"filename":"Each.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Passes each element in the array to the given callback.","kind":"function","name":"Each","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search.","name":"array"},{"type":{"names":["function"]},"description":"A callback to be invoked for each item in the array.","name":"callback"},{"type":{"names":["object"]},"description":"The context in which the callback is invoked.","name":"context"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the current array item.","name":"args"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Each","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"EachInRange.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SafeRange","longname":"SafeRange","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"EachInRange.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Passes each element in the array, between the start and end indexes, to the given callback.","kind":"function","name":"EachInRange","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search.","name":"array"},{"type":{"names":["function"]},"description":"A callback to be invoked for each item in the array.","name":"callback"},{"type":{"names":["object"]},"description":"The context in which the callback is invoked.","name":"context"},{"type":{"names":["integer"]},"description":"The start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"description":"The end index to search to.","name":"endIndex"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.EachInRange","scope":"static","___s":true},{"meta":{"filename":"FindClosestInSorted.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Searches a pre-sorted array for the closet value to the given number.\n\nIf the `key` argument is given it will assume the array contains objects that all have the required `key` property name,\nand will check for the closest value of those to the given number.","kind":"function","name":"FindClosestInSorted","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to search for in the array.","name":"value"},{"type":{"names":["array"]},"description":"The array to search, which must be sorted.","name":"array"},{"type":{"names":["string"]},"optional":true,"description":"An optional property key. If specified the array elements property will be checked against value.","name":"key"}],"returns":[{"type":{"names":["number","any"]},"description":"The nearest value found in the array, or if a `key` was given, the nearest object with the matching property value."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.FindClosestInSorted","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"GetAll.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SafeRange","longname":"SafeRange","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetAll.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Returns all elements in the array.\n\nYou can optionally specify a matching criteria using the `property` and `value` arguments.\n\nFor example: `getAll('visible', true)` would return only elements that have their visible property set.\n\nOptionally you can specify a start and end index. For example if the array had 100 elements,\nand you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\nthe first 50 elements.","kind":"function","name":"GetAll","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search.","name":"array"},{"type":{"names":["string"]},"optional":true,"description":"The property to test on each array element.","name":"property"},{"type":{"names":["*"]},"optional":true,"description":"The value to test the property against. Must pass a strict (`===`) comparison check.","name":"value"},{"type":{"names":["integer"]},"optional":true,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"An optional end index to search to.","name":"endIndex"}],"returns":[{"type":{"names":["array"]},"description":"All matching elements from the array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.GetAll","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"GetFirst.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SafeRange","longname":"SafeRange","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetFirst.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Returns the first element in the array.\n\nYou can optionally specify a matching criteria using the `property` and `value` arguments.\n\nFor example: `getAll('visible', true)` would return the first element that had its `visible` property set.\n\nOptionally you can specify a start and end index. For example if the array had 100 elements,\nand you set `startIndex` to 0 and `endIndex` to 50, it would search only the first 50 elements.","kind":"function","name":"GetFirst","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search.","name":"array"},{"type":{"names":["string"]},"optional":true,"description":"The property to test on each array element.","name":"property"},{"type":{"names":["*"]},"optional":true,"description":"The value to test the property against. Must pass a strict (`===`) comparison check.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"array.length","description":"An optional end index to search up to (but not included)","name":"endIndex"}],"returns":[{"type":{"names":["object"]},"description":"The first matching element from the array, or `null` if no element could be found in the range given."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.GetFirst","scope":"static","___s":true},{"meta":{"filename":"GetRandom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Returns a Random element from the array.","kind":"function","name":"GetRandom","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to select the random entry from.","name":"array"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"array.length","description":"An optional length, the total number of elements (from the startIndex) to choose from.","name":"length"}],"returns":[{"type":{"names":["*"]},"description":"A random element from the array, or `null` if no element could be found in the range given."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.GetRandom","scope":"static","___s":true},{"meta":{"filename":"MoveDown.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves the given array element down one place in the array.\nThe array is modified in-place.","kind":"function","name":"MoveDown","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The input array.","name":"array"},{"type":{"names":["*"]},"description":"The element to move down the array.","name":"item"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.MoveDown","scope":"static","___s":true},{"meta":{"filename":"MoveTo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves an element in an array to a new position within the same array.\nThe array is modified in-place.","kind":"function","name":"MoveTo","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array.","name":"array"},{"type":{"names":["*"]},"description":"The element to move.","name":"item"},{"type":{"names":["integer"]},"description":"The new index that the element will be moved to.","name":"index"}],"returns":[{"type":{"names":["*"]},"description":"The element that was moved."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.MoveTo","scope":"static","___s":true},{"meta":{"filename":"MoveUp.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves the given array element up one place in the array.\nThe array is modified in-place.","kind":"function","name":"MoveUp","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The input array.","name":"array"},{"type":{"names":["*"]},"description":"The element to move up the array.","name":"item"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.MoveUp","scope":"static","___s":true},{"meta":{"filename":"NumberArray.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Create an array representing the range of numbers (usually integers), between, and inclusive of,\nthe given `start` and `end` arguments. For example:\n\n`var array = numberArray(2, 4); // array = [2, 3, 4]`\n`var array = numberArray(0, 9); // array = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]`\n\nThis is equivalent to `numberArrayStep(start, end, 1)`.\n\nYou can optionally provide a prefix and / or suffix string. If given the array will contain\nstrings, not integers. For example:\n\n`var array = numberArray(1, 4, 'Level '); // array = [\"Level 1\", \"Level 2\", \"Level 3\", \"Level 4\"]`\n`var array = numberArray(5, 7, 'HD-', '.png'); // array = [\"HD-5.png\", \"HD-6.png\", \"HD-7.png\"]`","kind":"function","name":"NumberArray","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum value the array starts with.","name":"start"},{"type":{"names":["number"]},"description":"The maximum value the array contains.","name":"end"},{"type":{"names":["string"]},"optional":true,"description":"Optional prefix to place before the number. If provided the array will contain strings, not integers.","name":"prefix"},{"type":{"names":["string"]},"optional":true,"description":"Optional suffix to place after the number. If provided the array will contain strings, not integers.","name":"suffix"}],"returns":[{"type":{"names":["Array.","Array."]},"description":"The array of number values, or strings if a prefix or suffix was provided."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.NumberArray","scope":"static","___s":true},{"meta":{"range":[180,239],"filename":"NumberArrayStep.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"RoundAwayFromZero","longname":"RoundAwayFromZero","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NumberArrayStep.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Create an array of numbers (positive and/or negative) progressing from `start`\nup to but not including `end` by advancing by `step`.\n\nIf `start` is less than `end` a zero-length range is created unless a negative `step` is specified.\n\nCertain values for `start` and `end` (eg. NaN/undefined/null) are currently coerced to 0;\nfor forward compatibility make sure to pass in actual numbers.","examples":["NumberArrayStep(4);\n// => [0, 1, 2, 3]\n\nNumberArrayStep(1, 5);\n// => [1, 2, 3, 4]\n\nNumberArrayStep(0, 20, 5);\n// => [0, 5, 10, 15]\n\nNumberArrayStep(0, -4, -1);\n// => [0, -1, -2, -3]\n\nNumberArrayStep(1, 4, 0);\n// => [1, 1, 1]\n\nNumberArrayStep(0);\n// => []"],"kind":"function","name":"NumberArrayStep","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The start of the range.","name":"start"},{"type":{"names":["number"]},"optional":true,"defaultvalue":null,"description":"The end of the range.","name":"end"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The value to increment or decrement by.","name":"step"}],"returns":[{"type":{"names":["Array."]},"description":"The array of number values."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.NumberArrayStep","scope":"static","___s":true},{"meta":{"range":[195,285],"filename":"QuickSelect.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"ignore":true,"name":"swap","longname":"swap","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[306,379],"filename":"QuickSelect.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"ignore":true,"name":"defaultCompare","longname":"defaultCompare","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuickSelect.js","lineno":25,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"A [Floyd-Rivest](https://en.wikipedia.org/wiki/Floyd%E2%80%93Rivest_algorithm) quick selection algorithm.\n\nRearranges the array items so that all items in the [left, k] range are smaller than all items in [k, right];\nThe k-th element will have the (k - left + 1)th smallest value in [left, right].\n\nThe array is modified in-place.\n\nBased on code by [Vladimir Agafonkin](https://www.npmjs.com/~mourner)","kind":"function","name":"QuickSelect","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to sort.","name":"arr"},{"type":{"names":["integer"]},"description":"The k-th element index.","name":"k"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The index of the left part of the range.","name":"left"},{"type":{"names":["integer"]},"optional":true,"description":"The index of the right part of the range.","name":"right"},{"type":{"names":["function"]},"optional":true,"description":"An optional comparison function. Is passed two elements and should return 0, 1 or -1.","name":"compare"}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.QuickSelect","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"Range.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"GetValue","longname":"GetValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Range.js","lineno":28,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Creates an array populated with a range of values, based on the given arguments and configuration object.\n\nRange ([a,b,c], [1,2,3]) =\na1, a2, a3, b1, b2, b3, c1, c2, c3\n\nRange ([a,b], [1,2,3], qty = 3) =\na1, a1, a1, a2, a2, a2, a3, a3, a3, b1, b1, b1, b2, b2, b2, b3, b3, b3\n\nRange ([a,b,c], [1,2,3], repeat x1) =\na1, a2, a3, b1, b2, b3, c1, c2, c3, a1, a2, a3, b1, b2, b3, c1, c2, c3\n\nRange ([a,b], [1,2], repeat -1 = endless, max = 14) =\nMaybe if max is set then repeat goes to -1 automatically?\na1, a2, b1, b2, a1, a2, b1, b2, a1, a2, b1, b2, a1, a2 (capped at 14 elements)\n\nRange ([a], [1,2,3,4,5], random = true) =\na4, a1, a5, a2, a3\n\nRange ([a, b], [1,2,3], random = true) =\nb3, a2, a1, b1, a3, b2\n\nRange ([a, b, c], [1,2,3], randomB = true) =\na3, a1, a2, b2, b3, b1, c1, c3, c2\n\nRange ([a], [1,2,3,4,5], yoyo = true) =\na1, a2, a3, a4, a5, a5, a4, a3, a2, a1\n\nRange ([a, b], [1,2,3], yoyo = true) =\na1, a2, a3, b1, b2, b3, b3, b2, b1, a3, a2, a1","kind":"function","name":"Range","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The first array of range elements.","name":"a"},{"type":{"names":["array"]},"description":"The second array of range elements.","name":"b"},{"type":{"names":["object"]},"optional":true,"description":"A range configuration object. Can contain: repeat, random, randomB, yoyo, max, qty.","name":"options"}],"returns":[{"type":{"names":["array"]},"description":"An array of arranged elements."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Range","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Remove.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SpliceOne","longname":"SpliceOne","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Remove.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Removes the given item, or array of items, from the array.\n\nThe array is modified in-place.\n\nYou can optionally specify a callback to be invoked for each item successfully removed from the array.","kind":"function","name":"Remove","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to be modified.","name":"array"},{"type":{"names":["*","Array.<*>"]},"description":"The item, or array of items, to be removed from the array.","name":"item"},{"type":{"names":["function"]},"optional":true,"description":"A callback to be invoked for each item successfully removed from the array.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context in which the callback is invoked.","name":"context"}],"returns":[{"type":{"names":["*","Array.<*>"]},"description":"The item, or array of items, that were successfully removed from the array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Remove","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"RemoveAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SpliceOne","longname":"SpliceOne","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RemoveAt.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Removes the item from the given position in the array.\n\nThe array is modified in-place.\n\nYou can optionally specify a callback to be invoked for the item if it is successfully removed from the array.","kind":"function","name":"RemoveAt","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to be modified.","name":"array"},{"type":{"names":["integer"]},"description":"The array index to remove the item from. The index must be in bounds or it will throw an error.","name":"index"},{"type":{"names":["function"]},"optional":true,"description":"A callback to be invoked for the item removed from the array.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context in which the callback is invoked.","name":"context"}],"returns":[{"type":{"names":["*"]},"description":"The item that was removed."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.RemoveAt","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"RemoveBetween.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SafeRange","longname":"SafeRange","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RemoveBetween.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Removes the item within the given range in the array.\n\nThe array is modified in-place.\n\nYou can optionally specify a callback to be invoked for the item/s successfully removed from the array.","kind":"function","name":"RemoveBetween","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to be modified.","name":"array"},{"type":{"names":["integer"]},"description":"The start index to remove from.","name":"startIndex"},{"type":{"names":["integer"]},"description":"The end index to remove to.","name":"endIndex"},{"type":{"names":["function"]},"optional":true,"description":"A callback to be invoked for the item removed from the array.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context in which the callback is invoked.","name":"context"}],"returns":[{"type":{"names":["Array.<*>"]},"description":"An array of items that were removed."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.RemoveBetween","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"RemoveRandomElement.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SpliceOne","longname":"SpliceOne","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RemoveRandomElement.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Removes a random object from the given array and returns it.\nWill return null if there are no array items that fall within the specified range or if there is no item for the randomly chosen index.","kind":"function","name":"RemoveRandomElement","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to removed a random element from.","name":"array"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The array index to start the search from.","name":"start"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"array.length","description":"Optional restriction on the number of elements to randomly select from.","name":"length"}],"returns":[{"type":{"names":["object"]},"description":"The random element that was removed, or `null` if there were no array elements that fell within the given range."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.RemoveRandomElement","scope":"static","___s":true},{"meta":{"filename":"Replace.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Replaces an element of the array with the new element.\nThe new element cannot already be a member of the array.\nThe array is modified in-place.","kind":"function","name":"Replace","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search within.","name":"array"},{"type":{"names":["*"]},"description":"The element in the array that will be replaced.","name":"oldChild"},{"type":{"names":["*"]},"description":"The element to be inserted into the array at the position of `oldChild`.","name":"newChild"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns true if the oldChild was successfully replaced, otherwise returns false."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Replace","scope":"static","___s":true},{"meta":{"filename":"RotateLeft.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves the element at the start of the array to the end, shifting all items in the process.\nThe \"rotation\" happens to the left.","kind":"function","name":"RotateLeft","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to shift to the left. This array is modified in place.","name":"array"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The number of times to shift the array.","name":"total"}],"returns":[{"type":{"names":["*"]},"description":"The most recently shifted element."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.RotateLeft","scope":"static","___s":true},{"meta":{"filename":"RotateRight.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves the element at the end of the array to the start, shifting all items in the process.\nThe \"rotation\" happens to the right.","kind":"function","name":"RotateRight","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to shift to the right. This array is modified in place.","name":"array"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The number of times to shift the array.","name":"total"}],"returns":[{"type":{"names":["*"]},"description":"The most recently shifted element."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.RotateRight","scope":"static","___s":true},{"meta":{"filename":"SafeRange.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Tests if the start and end indexes are a safe range for the given array.","kind":"function","name":"SafeRange","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to check.","name":"array"},{"type":{"names":["integer"]},"description":"The start index.","name":"startIndex"},{"type":{"names":["integer"]},"description":"The end index.","name":"endIndex"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Throw an error if the range is out of bounds.","name":"throwError"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the range is safe, otherwise false."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.SafeRange","scope":"static","___s":true},{"meta":{"filename":"SendToBack.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves the given element to the bottom of the array.\nThe array is modified in-place.","kind":"function","name":"SendToBack","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array.","name":"array"},{"type":{"names":["*"]},"description":"The element to move.","name":"item"}],"returns":[{"type":{"names":["*"]},"description":"The element that was moved."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.SendToBack","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"SetAll.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SafeRange","longname":"SafeRange","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetAll.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Scans the array for elements with the given property. If found, the property is set to the `value`.\n\nFor example: `SetAll('visible', true)` would set all elements that have a `visible` property to `false`.\n\nOptionally you can specify a start and end index. For example if the array had 100 elements,\nand you set `startIndex` to 0 and `endIndex` to 50, it would update only the first 50 elements.","kind":"function","name":"SetAll","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search.","name":"array"},{"type":{"names":["string"]},"description":"The property to test for on each array element.","name":"property"},{"type":{"names":["*"]},"description":"The value to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"An optional end index to search to.","name":"endIndex"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.SetAll","scope":"static","___s":true},{"meta":{"filename":"Shuffle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Shuffles the contents of the given array using the Fisher-Yates implementation.\n\nThe original array is modified directly and returned.","kind":"function","name":"Shuffle","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The array to shuffle. This array is modified in place.","name":"array"}],"returns":[{"type":{"names":["Array."]},"description":"The shuffled array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Shuffle","scope":"static","___s":true},{"meta":{"filename":"SpliceOne.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Removes a single item from an array and returns it without creating gc, like the native splice does.\nBased on code by Mike Reinstein.","kind":"function","name":"SpliceOne","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to splice from.","name":"array"},{"type":{"names":["integer"]},"description":"The index of the item which should be spliced.","name":"index"}],"returns":[{"type":{"names":["*"]},"description":"The item which was spliced (removed)."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.SpliceOne","scope":"static","___s":true},{"meta":{"filename":"StableSort.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"kind":"namespace","name":"StableSortFunctions","memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.StableSortFunctions","scope":"static","___s":true},{"meta":{"filename":"StableSort.js","lineno":16,"columnno":1,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"A stable array sort, because `Array#sort()` is not guaranteed stable.\nThis is an implementation of merge sort, without recursion.","kind":"function","name":"StableSort","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The input array to be sorted.","name":"arr"},{"type":{"names":["function"]},"description":"The comparison handler.","name":"comp"}],"returns":[{"type":{"names":["array"]},"description":"The sorted result."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.StableSort","scope":"static","___s":true},{"meta":{"filename":"StableSort.js","lineno":32,"columnno":1,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Sort the input array and simply copy it back if the result isn't in the original array, which happens on an odd number of passes.","kind":"function","name":"inplace","memberof":"Phaser.Utils.Array.StableSortFunctions","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The input array.","name":"arr"},{"type":{"names":["function"]},"description":"The comparison handler.","name":"comp"}],"returns":[{"type":{"names":["array"]},"description":"The sorted array."}],"longname":"Phaser.Utils.Array.StableSortFunctions.inplace","scope":"static","___s":true},{"meta":{"filename":"Swap.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Swaps the position of two elements in the given array.\nThe elements must exist in the same array.\nThe array is modified in-place.","kind":"function","name":"Swap","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The input array.","name":"array"},{"type":{"names":["*"]},"description":"The first element to swap.","name":"item1"},{"type":{"names":["*"]},"description":"The second element to swap.","name":"item2"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Swap","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"kind":"namespace","name":"Array","memberof":"Phaser.Utils","longname":"Phaser.Utils.Array","scope":"static","___s":true},{"meta":{"filename":"CheckMatrix.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Checks if an array can be used as a matrix.\n\nA matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows) have the same length. There must be at least two rows:\n\n```\n [\n [ 1, 1, 1, 1, 1, 1 ],\n [ 2, 0, 0, 0, 0, 4 ],\n [ 2, 0, 1, 2, 0, 4 ],\n [ 2, 0, 3, 4, 0, 4 ],\n [ 2, 0, 0, 0, 0, 4 ],\n [ 3, 3, 3, 3, 3, 3 ]\n ]\n```","kind":"function","name":"CheckMatrix","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array to check.","name":"matrix"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the given `matrix` array is a valid matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.CheckMatrix","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"MatrixToString.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"name":"Pad","longname":"Pad","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MatrixToString.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Generates a string (which you can pass to console.log) from the given Array Matrix.","kind":"function","name":"MatrixToString","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"A 2-dimensional array.","name":"matrix"}],"returns":[{"type":{"names":["string"]},"description":"A string representing the matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.MatrixToString","scope":"static","___s":true},{"meta":{"filename":"ReverseColumns.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Reverses the columns in the given Array Matrix.","kind":"function","name":"ReverseColumns","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array matrix to reverse the columns for.","name":"matrix"}],"returns":[{"type":{"names":["Array.>"]},"description":"The column reversed matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.ReverseColumns","scope":"static","___s":true},{"meta":{"filename":"ReverseRows.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Reverses the rows in the given Array Matrix.","kind":"function","name":"ReverseRows","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array matrix to reverse the rows for.","name":"matrix"}],"returns":[{"type":{"names":["Array.>"]},"description":"The column reversed matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.ReverseRows","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"Rotate180.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"name":"RotateMatrix","longname":"RotateMatrix","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Rotate180.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Rotates the array matrix 180 degrees.","kind":"function","name":"Rotate180","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array to rotate.","name":"matrix"}],"returns":[{"type":{"names":["Array.>"]},"description":"The rotated matrix array. The source matrix should be discard for the returned matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.Rotate180","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"RotateLeft.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"name":"RotateMatrix","longname":"RotateMatrix","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateLeft.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Rotates the array matrix to the left (or 90 degrees)","kind":"function","name":"RotateLeft","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array to rotate.","name":"matrix"}],"returns":[{"type":{"names":["Array.>"]},"description":"The rotated matrix array. The source matrix should be discard for the returned matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.RotateLeft","scope":"static","___s":true},{"meta":{"range":[180,218],"filename":"RotateMatrix.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"name":"CheckMatrix","longname":"CheckMatrix","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateMatrix.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Rotates the array matrix based on the given rotation value.\n\nThe value can be given in degrees: 90, -90, 270, -270 or 180,\nor a string command: `rotateLeft`, `rotateRight` or `rotate180`.\n\nBased on the routine from {@link http://jsfiddle.net/MrPolywhirl/NH42z/}.","kind":"function","name":"RotateMatrix","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array to rotate.","name":"matrix"},{"type":{"names":["number","string"]},"optional":true,"defaultvalue":90,"description":"The amount to rotate the matrix by.","name":"direction"}],"returns":[{"type":{"names":["Array.>"]},"description":"The rotated matrix array. The source matrix should be discard for the returned matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.RotateMatrix","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"RotateRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"name":"RotateMatrix","longname":"RotateMatrix","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateRight.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Rotates the array matrix to the left (or -90 degrees)","kind":"function","name":"RotateRight","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array to rotate.","name":"matrix"}],"returns":[{"type":{"names":["Array.>"]},"description":"The rotated matrix array. The source matrix should be discard for the returned matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.RotateRight","scope":"static","___s":true},{"meta":{"filename":"TransposeMatrix.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Transposes the elements of the given matrix (array of arrays).\n\nThe transpose of a matrix is a new matrix whose rows are the columns of the original.","kind":"function","name":"TransposeMatrix","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array matrix to transpose.","name":"array"}],"returns":[{"type":{"names":["Array.>"]},"description":"A new array matrix which is a transposed version of the given array."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.TransposeMatrix","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"kind":"namespace","name":"Matrix","memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Matrix","scope":"static","___s":true},{"meta":{"range":[265,339],"filename":"ArrayBufferToBase64.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/base64"},"name":"chars","longname":"chars","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ArrayBufferToBase64.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/base64"},"description":"Converts an ArrayBuffer into a base64 string.\n\nThe resulting string can optionally be a data uri if the `mediaType` argument is provided.\n\nSee https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs for more details.","kind":"function","name":"ArrayBufferToBase64","since":"3.18.0","params":[{"type":{"names":["ArrayBuffer"]},"description":"The Array Buffer to encode.","name":"arrayBuffer"},{"type":{"names":["string"]},"optional":true,"description":"An optional media type, i.e. `audio/ogg` or `image/jpeg`. If included the resulting string will be a data URI.","name":"mediaType"}],"returns":[{"type":{"names":["string"]},"description":"The base64 encoded Array Buffer."}],"memberof":"Phaser.Utils.Base64","longname":"Phaser.Utils.Base64.ArrayBufferToBase64","scope":"static","___s":true},{"meta":{"range":[265,339],"filename":"Base64ToArrayBuffer.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/base64"},"name":"chars","longname":"chars","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Base64ToArrayBuffer.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/base64"},"description":"Converts a base64 string, either with or without a data uri, into an Array Buffer.","kind":"function","name":"Base64ToArrayBuffer","since":"3.18.0","params":[{"type":{"names":["string"]},"description":"The base64 string to be decoded. Can optionally contain a data URI header, which will be stripped out prior to decoding.","name":"base64"}],"returns":[{"type":{"names":["ArrayBuffer"]},"description":"An ArrayBuffer decoded from the base64 data."}],"memberof":"Phaser.Utils.Base64","longname":"Phaser.Utils.Base64.Base64ToArrayBuffer","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/base64"},"kind":"namespace","name":"Base64","memberof":"Phaser.Utils","longname":"Phaser.Utils.Base64","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils"},"kind":"namespace","name":"Utils","memberof":"Phaser","longname":"Phaser.Utils","scope":"static","___s":true},{"meta":{"filename":"Clone.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Shallow Object Clone. Will not clone nested objects.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"the object from which to clone","name":"obj"}],"returns":[{"type":{"names":["object"]},"description":"a new object with the same properties as the input obj"}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.Clone","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"Extend.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"name":"IsPlainObject","longname":"IsPlainObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Extend.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"This is a slightly modified version of http://api.jquery.com/jQuery.extend/","kind":"function","name":"Extend","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"The extended object."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.Extend","scope":"static","___s":true},{"meta":{"range":[180,208],"filename":"GetAdvancedValue.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"name":"MATH","longname":"MATH","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetAdvancedValue.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Retrieves a value from an object. Allows for more advanced selection options, including:\n\nAllowed types:\n\nImplicit\n{\n x: 4\n}\n\nFrom function\n{\n x: function ()\n}\n\nRandomly pick one element from the array\n{\n x: [a, b, c, d, e, f]\n}\n\nRandom integer between min and max:\n{\n x: { randInt: [min, max] }\n}\n\nRandom float between min and max:\n{\n x: { randFloat: [min, max] }\n}","kind":"function","name":"GetAdvancedValue","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to retrieve the value from.","name":"source"},{"type":{"names":["string"]},"description":"The name of the property to retrieve from the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`) - `banner.hideBanner` would return the value of the `hideBanner` property from the object stored in the `banner` property of the `source` object.","name":"key"},{"type":{"names":["*"]},"description":"The value to return if the `key` isn't found in the `source` object.","name":"defaultValue"}],"returns":[{"type":{"names":["*"]},"description":"The value of the requested key."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.GetAdvancedValue","scope":"static","___s":true},{"meta":{"filename":"GetFastValue.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Finds the key within the top level of the {@link source} object, or returns {@link defaultValue}","kind":"function","name":"GetFastValue","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to search","name":"source"},{"type":{"names":["string"]},"description":"The key for the property on source. Must exist at the top level of the source object (no periods)","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The default value to use if the key does not exist.","name":"defaultValue"}],"returns":[{"type":{"names":["*"]},"description":"The value if found; otherwise, defaultValue (null if none provided)"}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.GetFastValue","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"GetMinMaxValue.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"name":"GetValue","longname":"GetValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetMinMaxValue.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Retrieves and clamps a numerical value from an object.","kind":"function","name":"GetMinMaxValue","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to retrieve the value from.","name":"source"},{"type":{"names":["string"]},"description":"The name of the property to retrieve from the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`).","name":"key"},{"type":{"names":["number"]},"description":"The minimum value which can be returned.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value which can be returned.","name":"max"},{"type":{"names":["number"]},"description":"The value to return if the property doesn't exist. It's also constrained to the given bounds.","name":"defaultValue"}],"returns":[{"type":{"names":["number"]},"description":"The clamped value from the `source` object."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.GetMinMaxValue","scope":"static","___s":true},{"meta":{"filename":"GetValue.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Retrieves a value from an object.","kind":"function","name":"GetValue","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to retrieve the value from.","name":"source"},{"type":{"names":["string"]},"description":"The name of the property to retrieve from the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`) - `banner.hideBanner` would return the value of the `hideBanner` property from the object stored in the `banner` property of the `source` object.","name":"key"},{"type":{"names":["*"]},"description":"The value to return if the `key` isn't found in the `source` object.","name":"defaultValue"}],"returns":[{"type":{"names":["*"]},"description":"The value of the requested key."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.GetValue","scope":"static","___s":true},{"meta":{"filename":"HasAll.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Verifies that an object contains all requested keys","kind":"function","name":"HasAll","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"an object on which to check for key existence","name":"source"},{"type":{"names":["Array."]},"description":"an array of keys to ensure the source object contains","name":"keys"}],"returns":[{"type":{"names":["boolean"]},"description":"true if the source object contains all keys, false otherwise."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.HasAll","scope":"static","___s":true},{"meta":{"filename":"HasAny.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Verifies that an object contains at least one of the requested keys","kind":"function","name":"HasAny","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"an object on which to check for key existence","name":"source"},{"type":{"names":["Array."]},"description":"an array of keys to search the object for","name":"keys"}],"returns":[{"type":{"names":["boolean"]},"description":"true if the source object contains at least one of the keys, false otherwise"}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.HasAny","scope":"static","___s":true},{"meta":{"filename":"HasValue.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Determine whether the source object has a property with the specified key.","kind":"function","name":"HasValue","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The source object to be checked.","name":"source"},{"type":{"names":["string"]},"description":"The property to check for within the object","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the provided `key` exists on the `source` object, otherwise `false`."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.HasValue","scope":"static","___s":true},{"meta":{"filename":"IsPlainObject.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"This is a slightly modified version of jQuery.isPlainObject.\nA plain object is an object whose internal class property is [object Object].","kind":"function","name":"IsPlainObject","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to inspect.","name":"obj"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the object is plain, otherwise `false`."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.IsPlainObject","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"Merge.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"name":"Clone","longname":"Clone","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Merge.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Creates a new Object using all values from obj1 and obj2.\nIf a value exists in both obj1 and obj2, the value in obj1 is used.\n\nThis is only a shallow copy. Deeply nested objects are not cloned, so be sure to only use this\nfunction on shallow objects.","kind":"function","name":"Merge","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The first object.","name":"obj1"},{"type":{"names":["object"]},"description":"The second object.","name":"obj2"}],"returns":[{"type":{"names":["object"]},"description":"A new object containing the union of obj1's and obj2's properties."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.Merge","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"MergeRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"name":"Clone","longname":"Clone","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MergeRight.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Creates a new Object using all values from obj1.\n\nThen scans obj2. If a property is found in obj2 that *also* exists in obj1, the value from obj2 is used, otherwise the property is skipped.","kind":"function","name":"MergeRight","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The first object to merge.","name":"obj1"},{"type":{"names":["object"]},"description":"The second object to merge. Keys from this object which also exist in `obj1` will be copied to `obj1`.","name":"obj2"}],"returns":[{"type":{"names":["object"]},"description":"The merged object. `obj1` and `obj2` are not modified."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.MergeRight","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"Pick.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"name":"HasValue","longname":"HasValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Pick.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Returns a new object that only contains the `keys` that were found on the object provided.\nIf no `keys` are found, an empty object is returned.","kind":"function","name":"Pick","since":"3.18.0","params":[{"type":{"names":["object"]},"description":"The object to pick the provided keys from.","name":"object"},{"type":{"names":["array"]},"description":"An array of properties to retrieve from the provided object.","name":"keys"}],"returns":[{"type":{"names":["object"]},"description":"A new object that only contains the `keys` that were found on the provided object. If no `keys` were found, an empty object will be returned."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.Pick","scope":"static","___s":true},{"meta":{"filename":"SetValue.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Sets a value in an object, allowing for dot notation to control the depth of the property.\n\nFor example:\n\n```javascript\nvar data = {\n world: {\n position: {\n x: 200,\n y: 100\n }\n }\n};\n\nSetValue(data, 'world.position.y', 300);\n\nconsole.log(data.world.position.y); // 300\n```","kind":"function","name":"SetValue","since":"3.17.0","params":[{"type":{"names":["object"]},"description":"The object to set the value in.","name":"source"},{"type":{"names":["string"]},"description":"The name of the property in the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`)","name":"key"},{"type":{"names":["any"]},"description":"The value to set into the property, if found in the source object.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the property key was valid and the value was set, otherwise `false`."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.SetValue","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"kind":"namespace","name":"Objects","memberof":"Phaser.Utils","longname":"Phaser.Utils.Objects","scope":"static","___s":true},{"meta":{"filename":"Format.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/string"},"description":"Takes a string and replaces instances of markers with values in the given array.\nThe markers take the form of `%1`, `%2`, etc. I.e.:\n\n`Format(\"The %1 is worth %2 gold\", [ 'Sword', 500 ])`","kind":"function","name":"Format","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string containing the replacement markers.","name":"string"},{"type":{"names":["array"]},"description":"An array containing values that will replace the markers. If no value exists an empty string is inserted instead.","name":"values"}],"returns":[{"type":{"names":["string"]},"description":"The string containing replaced values."}],"memberof":"Phaser.Utils.String","longname":"Phaser.Utils.String.Format","scope":"static","___s":true},{"meta":{"filename":"Pad.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/string"},"description":"Takes the given string and pads it out, to the length required, using the character\nspecified. For example if you need a string to be 6 characters long, you can call:\n\n`pad('bob', 6, '-', 2)`\n\nThis would return: `bob---` as it has padded it out to 6 characters, using the `-` on the right.\n\nYou can also use it to pad numbers (they are always returned as strings):\n\n`pad(512, 6, '0', 1)`\n\nWould return: `000512` with the string padded to the left.\n\nIf you don't specify a direction it'll pad to both sides:\n\n`pad('c64', 7, '*')`\n\nWould return: `**c64**`","kind":"function","name":"Pad","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The target string. `toString()` will be called on the string, which means you can also pass in common data types like numbers.","name":"str"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The number of characters to be added.","name":"len"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"\" \"","description":"The string to pad it out with (defaults to a space).","name":"pad"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":3,"description":"The direction dir = 1 (left), 2 (right), 3 (both).","name":"dir"}],"returns":[{"type":{"names":["string"]},"description":"The padded string."}],"memberof":"Phaser.Utils.String","longname":"Phaser.Utils.String.Pad","scope":"static","___s":true},{"meta":{"filename":"Reverse.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/string"},"description":"Takes the given string and reverses it, returning the reversed string.\nFor example if given the string `Atari 520ST` it would return `TS025 iratA`.","kind":"function","name":"Reverse","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string to be reversed.","name":"string"}],"returns":[{"type":{"names":["string"]},"description":"The reversed string."}],"memberof":"Phaser.Utils.String","longname":"Phaser.Utils.String.Reverse","scope":"static","___s":true},{"meta":{"filename":"UUID.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/string"},"description":"Creates and returns an RFC4122 version 4 compliant UUID.\n\nThe string is in the form: `xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx` where each `x` is replaced with a random\nhexadecimal digit from 0 to f, and `y` is replaced with a random hexadecimal digit from 8 to b.","kind":"function","name":"UUID","since":"3.12.0","returns":[{"type":{"names":["string"]},"description":"The UUID string."}],"memberof":"Phaser.Utils.String","longname":"Phaser.Utils.String.UUID","scope":"static","___s":true},{"meta":{"filename":"UppercaseFirst.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/string"},"description":"Capitalizes the first letter of a string if there is one.","examples":["UppercaseFirst('abc');\n// returns 'Abc'","UppercaseFirst('the happy family');\n// returns 'The happy family'","UppercaseFirst('');\n// returns ''"],"kind":"function","name":"UppercaseFirst","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string to capitalize.","name":"str"}],"returns":[{"type":{"names":["string"]},"description":"A new string, same as the first, but with the first letter capitalized."}],"memberof":"Phaser.Utils.String","longname":"Phaser.Utils.String.UppercaseFirst","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/string"},"kind":"namespace","name":"String","memberof":"Phaser.Utils","longname":"Phaser.Utils.String","scope":"static","___s":true},{"meta":{"filename":"AdInstance.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"kind":"typedef","name":"AdInstance","type":{"names":["object"]},"properties":[{"type":{"names":["any"]},"description":"Represents an instance of an ad.","name":"instance"},{"type":{"names":["string"]},"description":"The Audience Network placement ID of this ad instance.","name":"placementID"},{"type":{"names":["boolean"]},"description":"Has this ad already been shown in-game?","name":"shown"},{"type":{"names":["boolean"]},"description":"Is this a video ad?","name":"video"}],"longname":"AdInstance","scope":"global","___s":true},{"meta":{"range":[234,270],"filename":"FacebookInstantGamesPlugin.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"name":"AdInstance","longname":"AdInstance","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"classdesc":"The Facebook Instant Games Plugin for Phaser 3 provides a seamless bridge between Phaser\nand the Facebook Instant Games API version 6.2.\n\nYou can access this plugin via the `facebook` property in a Scene, i.e:\n\n```javascript\nthis.facebook.getPlatform();\n```\n\nIf this is unavailable please check to make sure you're using a build of Phaser that has\nthis plugin within it. You can quickly check this by looking at the dev tools console\nheader - the Phaser version number will have `-FB` after it if this plugin is loaded.\n\nIf you are building your own version of Phaser then use this Webpack DefinePlugin flag:\n\n`\"typeof PLUGIN_FBINSTANT\": JSON.stringify(true)`\n\nYou will find that every Instant Games API method has a mapping in this plugin.\nFor a full list please consult either the plugin documentation, or the 6.2 SDK documentation\nat https://developers.facebook.com/docs/games/instant-games/sdk/fbinstant6.2\n\nInternally this plugin uses its own Data Manager to handle seamless user data updates and provides\nhandy functions for advertisement displaying, opening share dialogs, logging, leaderboards, purchase API requests,\nloader integration and more.\n\nTo get started with Facebook Instant Games you will need to register on Facebook and create a new Instant\nGame app that has its own unique app ID. Facebook have also provided a dashboard interface for setting up\nvarious features for your game, including leaderboards, ad requests and the payments API. There are lots\nof guides on the Facebook Developers portal to assist with setting these\nvarious systems up: https://developers.facebook.com/docs/games/instant-games/guides\n\nFor more details follow the Quick Start guide here: https://developers.facebook.com/docs/games/instant-games","kind":"class","name":"FacebookInstantGamesPlugin","memberof":"Phaser","augments":["Phaser.Events.EventEmitter"],"since":"3.13.0","params":[{"type":{"names":["Phaser.Game"]},"description":"A reference to the Phaser.Game instance.","name":"game"}],"scope":"static","longname":"Phaser.FacebookInstantGamesPlugin","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A reference to the Phaser.Game instance.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A Data Manager instance.\nIt allows you to store, query and retrieve any key/value data you may need to store.\nIt's also used internally by the plugin to store FBIG API data.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Has the Facebook Instant Games API loaded yet?\nThis is set automatically during the boot process.","name":"hasLoaded","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#hasLoaded","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Is the Data Manager currently locked?","name":"dataLocked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#dataLocked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":113,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A list of the Facebook Instant Games APIs that are available,\nbased on the given platform, context and user privacy settings.\nThis value is populated automatically during boot.","name":"supportedAPIs","type":{"names":["Array."]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#supportedAPIs","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Holds the entry point that the game was launched from.\nThis value is populated automatically during boot.","name":"entryPoint","type":{"names":["string"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#entryPoint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"An object that contains any data associated with the entry point that the game was launched from.\nThe contents of the object are developer-defined, and can occur from entry points on different platforms.\nThis will return null for older mobile clients, as well as when there is no data associated with the particular entry point.\nThis value is populated automatically during boot.","name":"entryPointData","type":{"names":["any"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#entryPointData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":146,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A unique identifier for the current game context. This represents a specific context\nthat the game is being played in (for example, a particular messenger conversation or facebook post).\nThe identifier will be null if game is being played in a solo context.\nThis value is populated automatically during boot.","name":"contextID","type":{"names":["string"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#contextID","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The current context in which your game is running. This can be either `null` or\none of:\n\n`POST` - The game is running inside of a Facebook post.\n`THREAD` - The game is running inside a Facebook Messenger thread.\n`GROUP` - The game is running inside a Facebook Group.\n`SOLO` - This is the default context, the player is the only participant.\n\nThis value is populated automatically during boot.","name":"contextType","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#contextType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":175,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The current locale.\nSee https://origincache.facebook.com/developers/resources/?id=FacebookLocales.xml for a complete list of supported locale values.\nUse this to determine what languages the current game should be localized with.\nThis value is populated automatically during boot.","name":"locale","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#locale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The platform on which the game is currently running, i.e. `IOS`.\nThis value is populated automatically during boot.","name":"platform","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#platform","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":197,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The string representation of the Facebook Instant Games SDK version being used.\nThis value is populated automatically during boot.","name":"version","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#version","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":207,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Holds the id of the player. This is a string based ID, the same as `FBInstant.player.getID()`.\nThis value is populated automatically during boot if the API is supported.","name":"playerID","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#playerID","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":217,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The player's localized display name.\nThis value is populated automatically during boot if the API is supported.","name":"playerName","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#playerName","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":227,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A url to the player's public profile photo. The photo will always be a square, and with dimensions\nof at least 200x200. When rendering it in the game, the exact dimensions should never be assumed to be constant.\nIt's recommended to always scale the image to a desired size before rendering.\nThis value is populated automatically during boot if the API is supported.","name":"playerPhotoURL","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#playerPhotoURL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":239,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Whether a player can subscribe to the game bot or not.","name":"playerCanSubscribeBot","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#playerCanSubscribeBot","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":248,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Does the current platform and context allow for use of the payments API?\nCurrently this is only available on Facebook.com and Android 6+.","name":"paymentsReady","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#paymentsReady","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":258,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The set of products that are registered to the game.","name":"catalog","type":{"names":["Array."]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#catalog","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":267,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Contains all of the player's unconsumed purchases.\nThe game must fetch the current player's purchases as soon as the client indicates that it is ready to perform payments-related operations,\ni.e. at game start. The game can then process and consume any purchases that are waiting to be consumed.","name":"purchases","type":{"names":["Array."]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#purchases","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":278,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Contains all of the leaderboard data, as populated by the `getLeaderboard()` method.","name":"leaderboards","type":{"names":["Array."]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#leaderboards","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":287,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Contains AdInstance objects, as created by the `preloadAds()` method.","name":"ads","type":{"names":["Array."]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#ads","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":357,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Call this method from your `Scene.preload` in order to sync the load progress\nof the Phaser Loader with the Facebook Instant Games loader display, i.e.:\n\n```javascript\nthis.facebook.showLoadProgress(this);\nthis.facebook.once('startgame', this.startGame, this);\n```","kind":"function","name":"showLoadProgress","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene for which you want to show loader progress for.","name":"scene"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#showLoadProgress","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":398,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"This method is called automatically when the game has finished loading,\nif you used the `showLoadProgress` method. If your game doesn't need to\nload any assets, or you're managing the load yourself, then call this\nmethod directly to start the API running.\n\nWhen the API has finished starting this plugin will emit a `startgame` event\nwhich you should listen for.","kind":"function","name":"gameStarted","since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#gameStarted","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Checks to see if a given Facebook Instant Games API is available or not.","kind":"function","name":"checkAPI","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The API to check for, i.e. `player.getID`.","name":"api"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the API is supported, otherwise `false`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#checkAPI","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the unique identifier for the current game context. This represents a specific context\nthat the game is being played in (for example, a particular messenger conversation or facebook post).\nThe identifier will be null if game is being played in a solo context.\n\nIt is only populated if `contextGetID` is in the list of supported APIs.","kind":"function","name":"getID","since":"3.13.0","returns":[{"type":{"names":["string"]},"description":"The context ID."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getID","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":538,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the current context in which your game is running. This can be either `null` or one of:\n\n`POST` - The game is running inside of a Facebook post.\n`THREAD` - The game is running inside a Facebook Messenger thread.\n`GROUP` - The game is running inside a Facebook Group.\n`SOLO` - This is the default context, the player is the only participant.\n\nIt is only populated if `contextGetType` is in the list of supported APIs.","kind":"function","name":"getType","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The context type."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getType","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":563,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the current locale.\nSee https://origincache.facebook.com/developers/resources/?id=FacebookLocales.xml for a complete list of supported locale values.\nUse this to determine what languages the current game should be localized with.\nIt is only populated if `getLocale` is in the list of supported APIs.","kind":"function","name":"getLocale","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The current locale."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getLocale","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":584,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the platform on which the game is currently running, i.e. `IOS`.\nIt is only populated if `getPlatform` is in the list of supported APIs.","kind":"function","name":"getPlatform","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The current platform."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getPlatform","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":603,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the string representation of the Facebook Instant Games SDK version being used.\nIt is only populated if `getSDKVersion` is in the list of supported APIs.","kind":"function","name":"getSDKVersion","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The sdk version."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getSDKVersion","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":622,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the id of the player. This is a string based ID, the same as `FBInstant.player.getID()`.\nIt is only populated if `playerGetID` is in the list of supported APIs.","kind":"function","name":"getPlayerID","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The player ID."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getPlayerID","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":641,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the player's localized display name.\nIt is only populated if `playerGetName` is in the list of supported APIs.","kind":"function","name":"getPlayerName","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The player's localized display name."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getPlayerName","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":660,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the url to the player's public profile photo. The photo will always be a square, and with dimensions\nof at least 200x200. When rendering it in the game, the exact dimensions should never be assumed to be constant.\nIt's recommended to always scale the image to a desired size before rendering.\nIt is only populated if `playerGetPhoto` is in the list of supported APIs.","kind":"function","name":"getPlayerPhotoURL","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The player's photo url."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getPlayerPhotoURL","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":681,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Load the player's photo and store it in the Texture Manager, ready for use in-game.\n\nThis method works by using a Scene Loader instance and then asking the Loader to\nretrieve the image.\n\nWhen complete the plugin will emit a `photocomplete` event, along with the key of the photo.\n\n```javascript\nthis.facebook.loadPlayerPhoto(this, 'player').once('photocomplete', function (key) {\n this.add.image(x, y, 'player');\n}, this);\n```","kind":"function","name":"loadPlayerPhoto","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that will be responsible for loading this photo.","name":"scene"},{"type":{"names":["string"]},"description":"The key to use when storing the photo in the Texture Manager.","name":"key"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#loadPlayerPhoto","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Checks if the current player can subscribe to the game bot.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they can subscribe, the `playerCanSubscribeBot` property is set to `true`\nand this plugin will emit the `cansubscribebot` event.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `cansubscribebotfail` event instead.","kind":"function","name":"canSubscribeBot","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#canSubscribeBot","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":764,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Subscribes the current player to the game bot.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they are successfully subscribed this plugin will emit the `subscribebot` event.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `subscribebotfail` event instead.","kind":"function","name":"subscribeBot","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#subscribeBot","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":802,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Gets the associated data from the player based on the given key, or array of keys.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes the data is set into this plugins Data Manager and the\n`getdata` event will be emitted.","kind":"function","name":"getData","since":"3.13.0","params":[{"type":{"names":["string","Array."]},"description":"The key/s of the data to retrieve.","name":"keys"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getData","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":848,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Set data to be saved to the designated cloud storage of the current player. The game can store up to 1MB of data for each unique player.\n\nThe data save is requested in an async call, so the result isn't available immediately.\n\nData managed via this plugins Data Manager instance is automatically synced with Facebook. However, you can call this\nmethod directly if you need to replace the data object directly.\n\nWhen the APIs `setDataAsync` call resolves it will emit the `savedata` event from this plugin. If the call fails for some\nreason it will emit `savedatafail` instead.\n\nThe call resolving does not necessarily mean that the input has already been persisted. Rather, it means that the data was valid and\nhas been scheduled to be saved. It also guarantees that all values that were set are now available in `getData`.","kind":"function","name":"saveData","since":"3.13.0","params":[{"type":{"names":["object"]},"description":"An object containing a set of key-value pairs that should be persisted to cloud storage.\nThe object must contain only serializable values - any non-serializable values will cause the entire modification to be rejected.","name":"data"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#saveData","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":891,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Immediately flushes any changes to the player data to the designated cloud storage.\nThis function is expensive, and should primarily be used for critical changes where persistence needs to be immediate\nand known by the game. Non-critical changes should rely on the platform to persist them in the background.\nNOTE: Calls to player.setDataAsync will be rejected while this function's result is pending.\n\nData managed via this plugins Data Manager instance is automatically synced with Facebook. However, you can call this\nmethod directly if you need to flush the data directly.\n\nWhen the APIs `flushDataAsync` call resolves it will emit the `flushdata` event from this plugin. If the call fails for some\nreason it will emit `flushdatafail` instead.","kind":"function","name":"flushData","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#flushData","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":929,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Retrieve stats from the designated cloud storage of the current player.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes the `getstats` event will be emitted along with the data object returned.\n\nIf the call fails, i.e. it's not in the list of supported APIs, or the request was rejected,\nit will emit a `getstatsfail` event instead.","kind":"function","name":"getStats","since":"3.13.0","params":[{"type":{"names":["Array."]},"optional":true,"description":"An optional array of unique keys to retrieve stats for. If the function is called without it, it will fetch all stats.","name":"keys"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getStats","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":967,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Save the stats of the current player to the designated cloud storage.\n\nStats in the Facebook Instant Games API are purely numerical values paired with a string-based key. Only numbers can be saved as stats,\nall other data types will be ignored.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes the `savestats` event will be emitted along with the data object returned.\n\nIf the call fails, i.e. it's not in the list of supported APIs, or the request was rejected,\nit will emit a `savestatsfail` event instead.","kind":"function","name":"saveStats","since":"3.13.0","params":[{"type":{"names":["object"]},"description":"An object containing a set of key-value pairs that should be persisted to cloud storage as stats. Note that only numerical values are stored.","name":"data"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#saveStats","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1018,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Increment the stats of the current player and save them to the designated cloud storage.\n\nStats in the Facebook Instant Games API are purely numerical values paired with a string-based key. Only numbers can be saved as stats,\nall other data types will be ignored.\n\nThe data object provided for this call should contain offsets for how much to modify the stats by:\n\n```javascript\nthis.facebook.incStats({\n level: 1,\n zombiesSlain: 17,\n rank: -1\n});\n```\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes the `incstats` event will be emitted along with the data object returned.\n\nIf the call fails, i.e. it's not in the list of supported APIs, or the request was rejected,\nit will emit a `incstatsfail` event instead.","kind":"function","name":"incStats","since":"3.13.0","params":[{"type":{"names":["object"]},"description":"An object containing a set of key-value pairs indicating how much to increment each stat in cloud storage. Note that only numerical values are processed.","name":"data"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#incStats","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1079,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Sets the data associated with the individual gameplay session for the current context.\n\nThis function should be called whenever the game would like to update the current session data.\n\nThis session data may be used to populate a variety of payloads, such as game play webhooks.","kind":"function","name":"saveSession","since":"3.13.0","params":[{"type":{"names":["object"]},"description":"An arbitrary data object, which must be less than or equal to 1000 characters when stringified.","name":"data"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#saveSession","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.\n\nA blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\n\nThis data must be less than or equal to 1000 characters when stringified.\n\nWhen this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\n\nThe user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.","kind":"function","name":"openShare","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"A text message to be shared.","name":"text"},{"type":{"names":["string"]},"description":"The key of the texture to use as the share image.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.","name":"frame"},{"type":{"names":["object"]},"optional":true,"description":"A blob of data to attach to the share.","name":"sessionData"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#openShare","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"This invokes a dialog to let the user invite a friend to play this game, either as a message in Messenger or as a post on the user's timeline.\n\nA blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\n\nThis data must be less than or equal to 1000 characters when stringified.\n\nWhen this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\n\nThe user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.","kind":"function","name":"openInvite","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"A text message to be shared.","name":"text"},{"type":{"names":["string"]},"description":"The key of the texture to use as the share image.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.","name":"frame"},{"type":{"names":["object"]},"optional":true,"description":"A blob of data to attach to the share.","name":"sessionData"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#openInvite","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.\n\nA blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\n\nThis data must be less than or equal to 1000 characters when stringified.\n\nWhen this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\n\nThe user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.","kind":"function","name":"openRequest","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"A text message to be shared.","name":"text"},{"type":{"names":["string"]},"description":"The key of the texture to use as the share image.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.","name":"frame"},{"type":{"names":["object"]},"optional":true,"description":"A blob of data to attach to the share.","name":"sessionData"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#openRequest","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1192,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.\n\nA blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\n\nThis data must be less than or equal to 1000 characters when stringified.\n\nWhen this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\n\nThe user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.","kind":"function","name":"openChallenge","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"A text message to be shared.","name":"text"},{"type":{"names":["string"]},"description":"The key of the texture to use as the share image.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.","name":"frame"},{"type":{"names":["object"]},"optional":true,"description":"A blob of data to attach to the share.","name":"sessionData"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#openChallenge","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"This function determines whether the number of participants in the current game context is between a given minimum and maximum, inclusive.\nIf one of the bounds is null only the other bound will be checked against.\nIt will always return the original result for the first call made in a context in a given game play session.\nSubsequent calls, regardless of arguments, will return the answer to the original query until a context change occurs and the query result is reset.","kind":"function","name":"isSizeBetween","since":"3.13.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The minimum bound of the context size query.","name":"min"},{"type":{"names":["integer"]},"optional":true,"description":"The maximum bound of the context size query.","name":"max"}],"returns":[{"type":{"names":["object"]},"description":"The Context Size Response object in the format: `{answer: boolean, minSize: number?, maxSize: number?}`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#isSizeBetween","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1293,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Request a switch into a specific context. If the player does not have permission to enter that context,\nor if the player does not provide permission for the game to enter that context, this will emit a `switchfail` event.\n\nOtherwise, the plugin will emit the `switch` event when the game has switched into the specified context.","kind":"function","name":"switchContext","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The ID of the desired context.","name":"contextID"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#switchContext","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A filter that may be applied to a Context Choose operation.\n\n'NEW_CONTEXT_ONLY' - Prefer to only surface contexts the game has not been played in before.\n'INCLUDE_EXISTING_CHALLENGES' - Include the \"Existing Challenges\" section, which surfaces actively played-in contexts that the player is a part of.\n'NEW_PLAYERS_ONLY' - In sections containing individuals, prefer people who have not played the game.","kind":"typedef","name":"ContextFilter","type":{"names":["string"]},"longname":"ContextFilter","scope":"global","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1342,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A configuration object that may be applied to a Context Choose operation.","kind":"typedef","name":"ChooseContextConfig","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"optional":true,"description":"The set of filters to apply to the context suggestions: 'NEW_CONTEXT_ONLY', 'INCLUDE_EXISTING_CHALLENGES' or 'NEW_PLAYERS_ONLY'.","name":"filters"},{"type":{"names":["number"]},"optional":true,"description":"The maximum number of participants that a suggested context should ideally have.","name":"maxSize"},{"type":{"names":["number"]},"optional":true,"description":"The minimum number of participants that a suggested context should ideally have.","name":"minSize"}],"longname":"ChooseContextConfig","scope":"global","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Opens a context selection dialog for the player. If the player selects an available context,\nthe client will attempt to switch into that context, and emit the `choose` event if successful.\nOtherwise, if the player exits the menu or the client fails to switch into the new context, the `choosefail` event will be emitted.","kind":"function","name":"chooseContext","since":"3.13.0","params":[{"type":{"names":["ChooseContextConfig"]},"optional":true,"description":"An object specifying conditions on the contexts that should be offered.","name":"options"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#chooseContext","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Attempts to create or switch into a context between a specified player and the current player.\nThis plugin will emit the `create` event once the context switch is completed.\nIf the API call fails, such as if the player listed is not a Connected Player of the current player or if the\nplayer does not provide permission to enter the new context, then the plugin will emit a 'createfail' event.","kind":"function","name":"createContext","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"ID of the player.","name":"playerID"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#createContext","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1420,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Fetches an array of ConnectedPlayer objects containing information about active players\n(people who played the game in the last 90 days) that are connected to the current player.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they are successfully subscribed this plugin will emit the `players` event along\nwith the player data.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `playersfail` event instead.","kind":"function","name":"getPlayers","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getPlayers","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1458,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Fetches the game's product catalog.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they are successfully subscribed this plugin will emit the `getcatalog` event along\nwith the catalog data.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `getcatalogfail` event instead.","kind":"function","name":"getCatalog","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getCatalog","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1503,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Fetches a single Product from the game's product catalog.\n\nThe product catalog must have been populated using `getCatalog` prior to calling this method.\n\nUse this to look-up product details based on a purchase list.","kind":"function","name":"getProduct","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The Product ID of the item to get from the catalog.","name":"productID"}],"returns":[{"type":{"names":["Product"]},"nullable":true,"description":"The Product from the catalog, or `null` if it couldn't be found or the catalog isn't populated."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getProduct","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1530,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Begins the purchase flow for a specific product.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they are successfully subscribed this plugin will emit the `purchase` event along\nwith the purchase data.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `purchasefail` event instead.","kind":"function","name":"purchase","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The identifier of the product to purchase.","name":"productID"},{"type":{"names":["string"]},"optional":true,"description":"An optional developer-specified payload, to be included in the returned purchase's signed request.","name":"developerPayload"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#purchase","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1579,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Fetches all of the player's unconsumed purchases. The game must fetch the current player's purchases\nas soon as the client indicates that it is ready to perform payments-related operations,\ni.e. at game start. The game can then process and consume any purchases that are waiting to be consumed.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they are successfully subscribed this plugin will emit the `getpurchases` event along\nwith the purchase data.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `getpurchasesfail` event instead.","kind":"function","name":"getPurchases","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getPurchases","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Consumes a specific purchase belonging to the current player. Before provisioning a product's effects to the player,\nthe game should request the consumption of the purchased product. Once the purchase is successfully consumed,\nthe game should immediately provide the player with the effects of their purchase.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they are successfully subscribed this plugin will emit the `consumepurchase` event along\nwith the purchase data.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `consumepurchasefail` event instead.","kind":"function","name":"consumePurchase","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The purchase token of the purchase that should be consumed.","name":"purchaseToken"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#consumePurchase","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1667,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Informs Facebook of a custom update that occurred in the game.\nThis will temporarily yield control to Facebook and Facebook will decide what to do based on what the update is.\nOnce Facebook returns control to the game the plugin will emit an `update` or `updatefail` event.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nThe `text` parameter is an update payload with the following structure:\n\n```\ntext: {\n default: 'X just invaded Y\\'s village!',\n localizations: {\n ar_AR: 'X \\u0641\\u0642\\u0637 \\u063A\\u0632\\u062A ' +\n '\\u0642\\u0631\\u064A\\u0629 Y!',\n en_US: 'X just invaded Y\\'s village!',\n es_LA: '\\u00A1X acaba de invadir el pueblo de Y!',\n }\n}\n```","kind":"function","name":"update","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The call to action text.","name":"cta"},{"type":{"names":["object"]},"description":"The text object.","name":"text"},{"type":{"names":["string"]},"description":"The key of the texture to use as the share image.","name":"key"},{"type":{"names":["string","integer"]},"nullable":true,"description":"The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.","name":"frame"},{"type":{"names":["string"]},"description":"The update template key.","name":"template"},{"type":{"names":["object"]},"description":"The update data object payload.","name":"updateData"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#update","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1705,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Informs Facebook of a leaderboard update that occurred in the game.\nThis will temporarily yield control to Facebook and Facebook will decide what to do based on what the update is.\nOnce Facebook returns control to the game the plugin will emit an `update` or `updatefail` event.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nThe `text` parameter is an update payload with the following structure:\n\n```\ntext: {\n default: 'X just invaded Y\\'s village!',\n localizations: {\n ar_AR: 'X \\u0641\\u0642\\u0637 \\u063A\\u0632\\u062A ' +\n '\\u0642\\u0631\\u064A\\u0629 Y!',\n en_US: 'X just invaded Y\\'s village!',\n es_LA: '\\u00A1X acaba de invadir el pueblo de Y!',\n }\n}\n```","kind":"function","name":"updateLeaderboard","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The call to action text.","name":"cta"},{"type":{"names":["object"]},"description":"The text object.","name":"text"},{"type":{"names":["string"]},"description":"The key of the texture to use as the share image.","name":"key"},{"type":{"names":["string","integer"]},"nullable":true,"description":"The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.","name":"frame"},{"type":{"names":["string"]},"description":"The update template key.","name":"template"},{"type":{"names":["object"]},"description":"The update data object payload.","name":"updateData"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#updateLeaderboard","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1806,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Request that the client switch to a different Instant Game.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf the game switches successfully this plugin will emit the `switchgame` event and the client will load the new game.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `switchgamefail` event instead.","kind":"function","name":"switchGame","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The Application ID of the Instant Game to switch to. The application must be an Instant Game, and must belong to the same business as the current game.","name":"appID"},{"type":{"names":["object"]},"optional":true,"description":"An optional data payload. This will be set as the entrypoint data for the game being switched to. Must be less than or equal to 1000 characters when stringified.","name":"data"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#switchGame","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1856,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Prompts the user to create a shortcut to the game if they are eligible to.\nCan only be called once per session.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf the user choose to create a shortcut this plugin will emit the `shortcutcreated` event.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `shortcutcreatedfail` event instead.","kind":"function","name":"createShortcut","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#createShortcut","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1894,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Quits the game.","kind":"function","name":"quit","since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#quit","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1905,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Log an app event with FB Analytics.\n\nSee https://developers.facebook.com/docs/javascript/reference/v2.8#app_events for more details about FB Analytics.","kind":"function","name":"log","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"Name of the event. Must be 2 to 40 characters, and can only contain '_', '-', ' ', and alphanumeric characters.","name":"name"},{"type":{"names":["number"]},"optional":true,"description":"An optional numeric value that FB Analytics can calculate a sum with.","name":"value"},{"type":{"names":["object"]},"optional":true,"description":"An optional object that can contain up to 25 key-value pairs to be logged with the event. Keys must be 2 to 40 characters, and can only contain '_', '-', ' ', and alphanumeric characters. Values must be less than 100 characters in length.","name":"params"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#log","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1936,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Attempt to create an instance of an interstitial ad.\n\nIf the instance is created successfully then the ad is preloaded ready for display in-game via the method `showAd()`.\n\nIf the ad loads it will emit the `adloaded` event, passing the AdInstance as the only parameter.\n\nIf the ad cannot be displayed because there was no inventory to fill it, it will emit the `adsnofill` event.","kind":"function","name":"preloadAds","since":"3.13.0","params":[{"type":{"names":["string","Array."]},"description":"The ad placement ID, or an array of IDs, as created in your Audience Network settings within Facebook.","name":"placementID"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#preloadAds","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":2022,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Attempt to create an instance of an rewarded video ad.\n\nIf the instance is created successfully then the ad is preloaded ready for display in-game via the method `showVideo()`.\n\nIf the ad loads it will emit the `adloaded` event, passing the AdInstance as the only parameter.\n\nIf the ad cannot be displayed because there was no inventory to fill it, it will emit the `adsnofill` event.","kind":"function","name":"preloadVideoAds","since":"3.13.0","params":[{"type":{"names":["string","Array."]},"description":"The ad placement ID, or an array of IDs, as created in your Audience Network settings within Facebook.","name":"placementID"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#preloadVideoAds","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":2108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Displays a previously loaded interstitial ad.\n\nIf the ad is successfully displayed this plugin will emit the `adfinished` event, with the AdInstance object as its parameter.\n\nIf the ad cannot be displayed, it will emit the `adsnotloaded` event.","kind":"function","name":"showAd","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The ad placement ID to display.","name":"placementID"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#showAd","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":2159,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Displays a previously loaded interstitial video ad.\n\nIf the ad is successfully displayed this plugin will emit the `adfinished` event, with the AdInstance object as its parameter.\n\nIf the ad cannot be displayed, it will emit the `adsnotloaded` event.","kind":"function","name":"showVideo","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The ad placement ID to display.","name":"placementID"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#showVideo","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":2210,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Attempts to match the current player with other users looking for people to play with.\nIf successful, a new Messenger group thread will be created containing the matched players and the player will\nbe context switched to that thread. This plugin will also dispatch the `matchplayer` event, containing the new context ID and Type.\n\nThe default minimum and maximum number of players in one matched thread are 2 and 20 respectively,\ndepending on how many players are trying to get matched around the same time.\n\nThe values can be changed in `fbapp-config.json`. See the Bundle Config documentation for documentation about `fbapp-config.json`.","kind":"function","name":"matchPlayer","since":"3.13.0","params":[{"type":{"names":["string"]},"optional":true,"description":"Optional extra information about the player used to group them with similar players. Players will only be grouped with other players with exactly the same tag. The tag must only include letters, numbers, and underscores and be 100 characters or less in length.","name":"matchTag"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optional extra parameter that specifies whether the player should be immediately switched to the new context when a match is found. By default this will be false which will mean the player needs explicitly press play after being matched to switch to the new context.","name":"switchImmediately"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#matchPlayer","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":2251,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Fetch a specific leaderboard belonging to this Instant Game.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes the `getleaderboard` event will be emitted along with a Leaderboard object instance.","kind":"function","name":"getLeaderboard","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the leaderboard. Each leaderboard for an Instant Game must have its own distinct name.","name":"name"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getLeaderboard","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":2290,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Quits the Facebook API and then destroys this plugin.","kind":"function","name":"destroy","since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"range":[206,249],"filename":"Leaderboard.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Leaderboard.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"classdesc":"This class represents one single Leaderboard that belongs to a Facebook Instant Game.\n\nYou do not need to instantiate this class directly, it will be created when you use the\n`getLeaderboard()` method of the main plugin.","kind":"class","name":"FacebookInstantGamesLeaderboard","memberof":"Phaser","augments":["Phaser.Events.EventEmitter"],"since":"3.13.0","params":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"A reference to the Facebook Instant Games Plugin.","name":"plugin"},{"type":{"names":["any"]},"description":"An Instant Game leaderboard instance.","name":"data"}],"scope":"static","longname":"Phaser.FacebookInstantGamesLeaderboard","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":37,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A reference to the Facebook Instant Games Plugin.","name":"plugin","type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#plugin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"An Instant Game leaderboard instance.","name":"ref","type":{"names":["any"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#ref","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The name of the leaderboard.","name":"name","type":{"names":["string"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The ID of the context that the leaderboard is associated with, or null if the leaderboard is not tied to a particular context.","name":"contextID","type":{"names":["string"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#contextID","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The total number of player entries in the leaderboard.\nThis value defaults to zero. Populate it via the `getEntryCount()` method.","name":"entryCount","type":{"names":["integer"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#entryCount","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The players score object.\nThis value defaults to `null`. Populate it via the `getPlayerScore()` method.","name":"playerScore","type":{"names":["LeaderboardScore"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#playerScore","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The scores in the Leaderboard from the currently requested range.\nThis value defaults to an empty array. Populate it via the `getScores()` method.\nThe contents of this array are reset each time `getScores()` is called.","name":"scores","type":{"names":["Array."]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#scores","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Fetches the total number of player entries in the leaderboard.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes this Leaderboard will emit the `getentrycount` event along with the count and name of the Leaderboard.","kind":"function","name":"getEntryCount","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"This Leaderboard instance."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#getEntryCount","scope":"instance","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":137,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Updates the player's score. If the player has an existing score, the old score will only be replaced if the new score is better than it.\nNOTE: If the leaderboard is associated with a specific context, the game must be in that context to set a score for the player.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes this Leaderboard will emit the `setscore` event along with the LeaderboardScore object and the name of the Leaderboard.\n\nIf the save fails the event will send `null` as the score value.","kind":"function","name":"setScore","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The new score for the player. Must be a 64-bit integer number.","name":"score"},{"type":{"names":["string","any"]},"optional":true,"description":"Metadata to associate with the stored score. Must be less than 2KB in size. If an object is given it will be passed to `JSON.stringify`.","name":"data"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"This Leaderboard instance."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#setScore","scope":"instance","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Gets the players leaderboard entry and stores it in the `playerScore` property.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes this Leaderboard will emit the `getplayerscore` event along with the score and the name of the Leaderboard.\n\nIf the player has not yet saved a score, the event will send `null` as the score value, and `playerScore` will be set to `null` as well.","kind":"function","name":"getPlayerScore","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"This Leaderboard instance."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#getPlayerScore","scope":"instance","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":230,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Retrieves a set of leaderboard entries, ordered by score ranking in the leaderboard.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes this Leaderboard will emit the `getscores` event along with an array of LeaderboardScore entries and the name of the Leaderboard.","kind":"function","name":"getScores","since":"3.13.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The number of entries to attempt to fetch from the leaderboard. Currently, up to a maximum of 100 entries may be fetched per query.","name":"count"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The offset from the top of the leaderboard that entries will be fetched from.","name":"offset"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"This Leaderboard instance."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#getScores","scope":"instance","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":271,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Retrieves a set of leaderboard entries, based on the current player's connected players (including the current player), ordered by local rank within the set of connected players.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes this Leaderboard will emit the `getconnectedscores` event along with an array of LeaderboardScore entries and the name of the Leaderboard.","kind":"function","name":"getConnectedScores","since":"3.16.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"This Leaderboard instance."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#getConnectedScores","scope":"instance","___s":true},{"meta":{"filename":"LeaderboardScore.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"kind":"typedef","name":"LeaderboardScore","type":{"names":["object"]},"properties":[{"type":{"names":["integer"]},"description":"An integer score value.","name":"score"},{"type":{"names":["string"]},"description":"The score value, formatted with the score format associated with the leaderboard.","name":"scoreFormatted"},{"type":{"names":["integer"]},"description":"The Unix timestamp of when the leaderboard entry was last updated.","name":"timestamp"},{"type":{"names":["integer"]},"description":"The entry's leaderboard ranking.","name":"rank"},{"type":{"names":["string"]},"description":"The developer-specified payload associated with the score, or null if one was not set.","name":"data"},{"type":{"names":["string"]},"description":"The player's localized display name.","name":"playerName"},{"type":{"names":["string"]},"description":"A url to the player's public profile photo.","name":"playerPhotoURL"},{"type":{"names":["string"]},"description":"The game's unique identifier for the player.","name":"playerID"}],"longname":"LeaderboardScore","scope":"global","___s":true},{"meta":{"range":[206,270],"filename":"Product.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Product.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"kind":"typedef","name":"Product","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"optional":true,"description":"The title of the product.","name":"title"},{"type":{"names":["string"]},"optional":true,"description":"The product's game-specified identifier.","name":"productID"},{"type":{"names":["string"]},"optional":true,"description":"The product description.","name":"description"},{"type":{"names":["string"]},"optional":true,"description":"A link to the product's associated image.","name":"imageURI"},{"type":{"names":["string"]},"optional":true,"description":"The price of the product.","name":"price"},{"type":{"names":["string"]},"optional":true,"description":"The currency code for the product.","name":"priceCurrencyCode"}],"longname":"Product","scope":"global","___s":true},{"meta":{"range":[206,270],"filename":"Purchase.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Purchase.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"kind":"typedef","name":"Purchase","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"optional":true,"description":"A developer-specified string, provided during the purchase of the product.","name":"developerPayload"},{"type":{"names":["string"]},"optional":true,"description":"The identifier for the purchase transaction.","name":"paymentID"},{"type":{"names":["string"]},"optional":true,"description":"The product's game-specified identifier.","name":"productID"},{"type":{"names":["string"]},"optional":true,"description":"Unix timestamp of when the purchase occurred.","name":"purchaseTime"},{"type":{"names":["string"]},"optional":true,"description":"A token representing the purchase that may be used to consume the purchase.","name":"purchaseToken"},{"type":{"names":["string"]},"optional":true,"description":"Server-signed encoding of the purchase request.","name":"signedRequest"}],"longname":"Purchase","scope":"global","___s":true},{"kind":"package","longname":"package:undefined","files":["/home/arian/Documents/Phaser/phaser/src/actions/AlignTo.js","/home/arian/Documents/Phaser/phaser/src/actions/Angle.js","/home/arian/Documents/Phaser/phaser/src/actions/Call.js","/home/arian/Documents/Phaser/phaser/src/actions/GetFirst.js","/home/arian/Documents/Phaser/phaser/src/actions/GetLast.js","/home/arian/Documents/Phaser/phaser/src/actions/GridAlign.js","/home/arian/Documents/Phaser/phaser/src/actions/IncAlpha.js","/home/arian/Documents/Phaser/phaser/src/actions/IncX.js","/home/arian/Documents/Phaser/phaser/src/actions/IncXY.js","/home/arian/Documents/Phaser/phaser/src/actions/IncY.js","/home/arian/Documents/Phaser/phaser/src/actions/PlaceOnCircle.js","/home/arian/Documents/Phaser/phaser/src/actions/PlaceOnEllipse.js","/home/arian/Documents/Phaser/phaser/src/actions/PlaceOnLine.js","/home/arian/Documents/Phaser/phaser/src/actions/PlaceOnRectangle.js","/home/arian/Documents/Phaser/phaser/src/actions/PlaceOnTriangle.js","/home/arian/Documents/Phaser/phaser/src/actions/PlayAnimation.js","/home/arian/Documents/Phaser/phaser/src/actions/PropertyValueInc.js","/home/arian/Documents/Phaser/phaser/src/actions/PropertyValueSet.js","/home/arian/Documents/Phaser/phaser/src/actions/RandomCircle.js","/home/arian/Documents/Phaser/phaser/src/actions/RandomEllipse.js","/home/arian/Documents/Phaser/phaser/src/actions/RandomLine.js","/home/arian/Documents/Phaser/phaser/src/actions/RandomRectangle.js","/home/arian/Documents/Phaser/phaser/src/actions/RandomTriangle.js","/home/arian/Documents/Phaser/phaser/src/actions/Rotate.js","/home/arian/Documents/Phaser/phaser/src/actions/RotateAround.js","/home/arian/Documents/Phaser/phaser/src/actions/RotateAroundDistance.js","/home/arian/Documents/Phaser/phaser/src/actions/ScaleX.js","/home/arian/Documents/Phaser/phaser/src/actions/ScaleXY.js","/home/arian/Documents/Phaser/phaser/src/actions/ScaleY.js","/home/arian/Documents/Phaser/phaser/src/actions/SetAlpha.js","/home/arian/Documents/Phaser/phaser/src/actions/SetBlendMode.js","/home/arian/Documents/Phaser/phaser/src/actions/SetDepth.js","/home/arian/Documents/Phaser/phaser/src/actions/SetHitArea.js","/home/arian/Documents/Phaser/phaser/src/actions/SetOrigin.js","/home/arian/Documents/Phaser/phaser/src/actions/SetRotation.js","/home/arian/Documents/Phaser/phaser/src/actions/SetScale.js","/home/arian/Documents/Phaser/phaser/src/actions/SetScaleX.js","/home/arian/Documents/Phaser/phaser/src/actions/SetScaleY.js","/home/arian/Documents/Phaser/phaser/src/actions/SetScrollFactor.js","/home/arian/Documents/Phaser/phaser/src/actions/SetScrollFactorX.js","/home/arian/Documents/Phaser/phaser/src/actions/SetScrollFactorY.js","/home/arian/Documents/Phaser/phaser/src/actions/SetTint.js","/home/arian/Documents/Phaser/phaser/src/actions/SetVisible.js","/home/arian/Documents/Phaser/phaser/src/actions/SetX.js","/home/arian/Documents/Phaser/phaser/src/actions/SetXY.js","/home/arian/Documents/Phaser/phaser/src/actions/SetY.js","/home/arian/Documents/Phaser/phaser/src/actions/ShiftPosition.js","/home/arian/Documents/Phaser/phaser/src/actions/Shuffle.js","/home/arian/Documents/Phaser/phaser/src/actions/SmoothStep.js","/home/arian/Documents/Phaser/phaser/src/actions/SmootherStep.js","/home/arian/Documents/Phaser/phaser/src/actions/Spread.js","/home/arian/Documents/Phaser/phaser/src/actions/ToggleVisible.js","/home/arian/Documents/Phaser/phaser/src/actions/WrapInRectangle.js","/home/arian/Documents/Phaser/phaser/src/actions/index.js","/home/arian/Documents/Phaser/phaser/src/actions/typedefs/CallCallback.js","/home/arian/Documents/Phaser/phaser/src/actions/typedefs/GridAlignConfig.js","/home/arian/Documents/Phaser/phaser/src/actions/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/animations/Animation.js","/home/arian/Documents/Phaser/phaser/src/animations/AnimationFrame.js","/home/arian/Documents/Phaser/phaser/src/animations/AnimationManager.js","/home/arian/Documents/Phaser/phaser/src/animations/events/ADD_ANIMATION_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/ANIMATION_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/ANIMATION_REPEAT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/ANIMATION_RESTART_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/ANIMATION_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/PAUSE_ALL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/REMOVE_ANIMATION_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/RESUME_ALL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_KEY_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_KEY_REPEAT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_KEY_RESTART_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_KEY_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_KEY_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_REPEAT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_RESTART_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/index.js","/home/arian/Documents/Phaser/phaser/src/animations/index.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/Animation.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/AnimationFrame.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/GenerateFrameNames.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/GenerateFrameNumbers.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/JSONAnimation.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/JSONAnimationFrame.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/JSONAnimations.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/cache/BaseCache.js","/home/arian/Documents/Phaser/phaser/src/cache/CacheManager.js","/home/arian/Documents/Phaser/phaser/src/cache/events/ADD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cache/events/REMOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cache/events/index.js","/home/arian/Documents/Phaser/phaser/src/cache/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/BaseCamera.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/Camera.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/CameraManager.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects/Fade.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects/Flash.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects/Pan.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects/Shake.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects/Zoom.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/DESTROY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/FADE_IN_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/FADE_IN_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/FADE_OUT_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/FADE_OUT_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/FLASH_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/FLASH_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/PAN_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/PAN_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/POST_RENDER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/PRE_RENDER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/SHAKE_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/SHAKE_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/ZOOM_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/ZOOM_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/CameraConfig.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/CameraFadeCallback.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/CameraFlashCallback.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/CameraPanCallback.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/CameraShakeCallback.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/CameraZoomCallback.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/JSONCamera.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/JSONCameraBounds.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/controls/FixedKeyControl.js","/home/arian/Documents/Phaser/phaser/src/cameras/controls/SmoothedKeyControl.js","/home/arian/Documents/Phaser/phaser/src/cameras/controls/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/controls/typedefs/FixedKeyControlConfig.js","/home/arian/Documents/Phaser/phaser/src/cameras/controls/typedefs/SmoothedKeyControlConfig.js","/home/arian/Documents/Phaser/phaser/src/cameras/controls/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/index.js","/home/arian/Documents/Phaser/phaser/src/const.js","/home/arian/Documents/Phaser/phaser/src/core/Config.js","/home/arian/Documents/Phaser/phaser/src/core/CreateRenderer.js","/home/arian/Documents/Phaser/phaser/src/core/DebugHeader.js","/home/arian/Documents/Phaser/phaser/src/core/Game.js","/home/arian/Documents/Phaser/phaser/src/core/TimeStep.js","/home/arian/Documents/Phaser/phaser/src/core/VisibilityHandler.js","/home/arian/Documents/Phaser/phaser/src/core/events/BLUR_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/BOOT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/CONTEXT_LOST_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/CONTEXT_RESTORED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/DESTROY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/FOCUS_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/HIDDEN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/POST_RENDER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/POST_STEP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/PRE_RENDER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/PRE_STEP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/READY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/STEP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/VISIBLE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/index.js","/home/arian/Documents/Phaser/phaser/src/core/index.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/AudioConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/BannerConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/BootCallback.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/CallbacksConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/DOMContainerConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/FPSConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/GameConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/GamepadInputConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/ImagesConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/InputConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/KeyboardInputConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/LoaderConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/MouseInputConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/NOOP.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/PhysicsConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/PluginObject.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/PluginObjectItem.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/RenderConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/ScaleConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/TimeStepCallback.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/TouchInputConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/WidthHeight.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/create/GenerateTexture.js","/home/arian/Documents/Phaser/phaser/src/create/index.js","/home/arian/Documents/Phaser/phaser/src/create/palettes/Arne16.js","/home/arian/Documents/Phaser/phaser/src/create/palettes/C64.js","/home/arian/Documents/Phaser/phaser/src/create/palettes/CGA.js","/home/arian/Documents/Phaser/phaser/src/create/palettes/JMP.js","/home/arian/Documents/Phaser/phaser/src/create/palettes/MSX.js","/home/arian/Documents/Phaser/phaser/src/create/palettes/index.js","/home/arian/Documents/Phaser/phaser/src/create/typedefs/GenerateTextureConfig.js","/home/arian/Documents/Phaser/phaser/src/create/typedefs/Palette.js","/home/arian/Documents/Phaser/phaser/src/create/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/curves/CubicBezierCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/Curve.js","/home/arian/Documents/Phaser/phaser/src/curves/EllipseCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/LineCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/QuadraticBezierCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/SplineCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/index.js","/home/arian/Documents/Phaser/phaser/src/curves/path/MoveTo.js","/home/arian/Documents/Phaser/phaser/src/curves/path/Path.js","/home/arian/Documents/Phaser/phaser/src/curves/typedefs/EllipseCurveConfig.js","/home/arian/Documents/Phaser/phaser/src/curves/typedefs/JSONCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/typedefs/JSONEllipseCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/typedefs/JSONPath.js","/home/arian/Documents/Phaser/phaser/src/curves/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/data/DataManager.js","/home/arian/Documents/Phaser/phaser/src/data/DataManagerPlugin.js","/home/arian/Documents/Phaser/phaser/src/data/events/CHANGE_DATA_EVENT.js","/home/arian/Documents/Phaser/phaser/src/data/events/CHANGE_DATA_KEY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/data/events/REMOVE_DATA_EVENT.js","/home/arian/Documents/Phaser/phaser/src/data/events/SET_DATA_EVENT.js","/home/arian/Documents/Phaser/phaser/src/data/events/index.js","/home/arian/Documents/Phaser/phaser/src/data/index.js","/home/arian/Documents/Phaser/phaser/src/device/Audio.js","/home/arian/Documents/Phaser/phaser/src/device/Browser.js","/home/arian/Documents/Phaser/phaser/src/device/CanvasFeatures.js","/home/arian/Documents/Phaser/phaser/src/device/Features.js","/home/arian/Documents/Phaser/phaser/src/device/Fullscreen.js","/home/arian/Documents/Phaser/phaser/src/device/Input.js","/home/arian/Documents/Phaser/phaser/src/device/OS.js","/home/arian/Documents/Phaser/phaser/src/device/Video.js","/home/arian/Documents/Phaser/phaser/src/device/index.js","/home/arian/Documents/Phaser/phaser/src/display/align/const.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/BottomCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/BottomLeft.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/BottomRight.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/Center.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/LeftCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/QuickSet.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/RightCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/TopCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/TopLeft.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/TopRight.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/index.js","/home/arian/Documents/Phaser/phaser/src/display/align/index.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/BottomCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/BottomLeft.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/BottomRight.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/LeftBottom.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/LeftCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/LeftTop.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/QuickSet.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/RightBottom.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/RightCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/RightTop.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/TopCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/TopLeft.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/TopRight.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/index.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/CenterOn.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetBottom.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetCenterX.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetCenterY.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetLeft.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetOffsetX.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetOffsetY.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetRight.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetTop.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/SetBottom.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/SetCenterX.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/SetCenterY.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/SetLeft.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/SetRight.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/SetTop.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/index.js","/home/arian/Documents/Phaser/phaser/src/display/canvas/CanvasInterpolation.js","/home/arian/Documents/Phaser/phaser/src/display/canvas/CanvasPool.js","/home/arian/Documents/Phaser/phaser/src/display/canvas/Smoothing.js","/home/arian/Documents/Phaser/phaser/src/display/canvas/TouchAction.js","/home/arian/Documents/Phaser/phaser/src/display/canvas/UserSelect.js","/home/arian/Documents/Phaser/phaser/src/display/canvas/index.js","/home/arian/Documents/Phaser/phaser/src/display/color/Color.js","/home/arian/Documents/Phaser/phaser/src/display/color/ColorToRGBA.js","/home/arian/Documents/Phaser/phaser/src/display/color/ComponentToHex.js","/home/arian/Documents/Phaser/phaser/src/display/color/GetColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/GetColor32.js","/home/arian/Documents/Phaser/phaser/src/display/color/HSLToColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/HSVColorWheel.js","/home/arian/Documents/Phaser/phaser/src/display/color/HSVToRGB.js","/home/arian/Documents/Phaser/phaser/src/display/color/HexStringToColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/HueToComponent.js","/home/arian/Documents/Phaser/phaser/src/display/color/IntegerToColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/IntegerToRGB.js","/home/arian/Documents/Phaser/phaser/src/display/color/Interpolate.js","/home/arian/Documents/Phaser/phaser/src/display/color/ObjectToColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/RGBStringToColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/RGBToHSV.js","/home/arian/Documents/Phaser/phaser/src/display/color/RGBToString.js","/home/arian/Documents/Phaser/phaser/src/display/color/RandomRGB.js","/home/arian/Documents/Phaser/phaser/src/display/color/ValueToColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/index.js","/home/arian/Documents/Phaser/phaser/src/display/index.js","/home/arian/Documents/Phaser/phaser/src/display/mask/BitmapMask.js","/home/arian/Documents/Phaser/phaser/src/display/mask/GeometryMask.js","/home/arian/Documents/Phaser/phaser/src/display/mask/index.js","/home/arian/Documents/Phaser/phaser/src/display/shader/BaseShader.js","/home/arian/Documents/Phaser/phaser/src/display/typedefs/ColorObject.js","/home/arian/Documents/Phaser/phaser/src/display/typedefs/HSVColorObject.js","/home/arian/Documents/Phaser/phaser/src/display/typedefs/InputColorObject.js","/home/arian/Documents/Phaser/phaser/src/display/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/dom/AddToDOM.js","/home/arian/Documents/Phaser/phaser/src/dom/CreateDOMContainer.js","/home/arian/Documents/Phaser/phaser/src/dom/DOMContentLoaded.js","/home/arian/Documents/Phaser/phaser/src/dom/GetInnerHeight.js","/home/arian/Documents/Phaser/phaser/src/dom/GetScreenOrientation.js","/home/arian/Documents/Phaser/phaser/src/dom/GetTarget.js","/home/arian/Documents/Phaser/phaser/src/dom/ParseXML.js","/home/arian/Documents/Phaser/phaser/src/dom/RemoveFromDOM.js","/home/arian/Documents/Phaser/phaser/src/dom/RequestAnimationFrame.js","/home/arian/Documents/Phaser/phaser/src/dom/index.js","/home/arian/Documents/Phaser/phaser/src/events/EventEmitter.js","/home/arian/Documents/Phaser/phaser/src/events/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/BuildGameObject.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/BuildGameObjectAnimation.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/DisplayList.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/GameObject.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/GameObjectCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/GameObjectFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/UpdateList.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/GetBitmapTextSize.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/ParseFromAtlas.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/ParseRetroFont.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/ParseXMLBitmapFont.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/RetroFont.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/const.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic/DynamicBitmapText.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static/BitmapText.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static/BitmapTextCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static/BitmapTextCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static/BitmapTextFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static/BitmapTextRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static/BitmapTextWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/BitmapFontCharacterData.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/BitmapFontData.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/BitmapTextConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/BitmapTextSize.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/DisplayCallbackConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/GlobalBitmapTextSize.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/JSONBitmapText.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/LocalBitmapTextSize.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/RetroFontConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/TintConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/Blitter.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/BlitterCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/BlitterCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/BlitterFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/BlitterRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/BlitterWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/Bob.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Alpha.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/AlphaSingle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Animation.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/BlendMode.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/ComputedSize.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Crop.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Depth.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Flip.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/GetBounds.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Mask.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Origin.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/PathFollower.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Pipeline.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/ScrollFactor.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Size.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Texture.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/TextureCrop.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Tint.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/ToJSON.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Transform.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/TransformMatrix.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Visible.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/container/Container.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/container/ContainerCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/container/ContainerCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/container/ContainerFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/container/ContainerRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/container/ContainerWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement/CSSBlendModes.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement/DOMElement.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement/DOMElementCSSRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement/DOMElementFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement/DOMElementRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/DESTROY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_CREATED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_ERROR_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_LOOP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_PLAY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_SEEKED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_SEEKING_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_STOP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_TIMEOUT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_UNLOCKED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/extern/Extern.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/extern/ExternCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/extern/ExternFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/extern/ExternRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/extern/ExternWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/Commands.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/Graphics.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/GraphicsCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/GraphicsCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/GraphicsFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/GraphicsRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/GraphicsWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs/FillStyle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs/LineStyle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs/Options.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs/RoundedRectRadius.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs/Styles.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/Group.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/GroupCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/GroupFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs/GroupCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs/GroupConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs/GroupCreateConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs/GroupMultipleCreateCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/image/Image.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/image/ImageCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/image/ImageCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/image/ImageFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/image/ImageRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/image/ImageWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/lights/Light.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/lights/LightsManager.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/lights/LightsPlugin.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh/Mesh.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh/MeshCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh/MeshCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh/MeshFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh/MeshRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh/MeshWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/EmitterOp.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/GravityWell.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/Particle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleEmitter.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleEmitterManager.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleManagerCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleManagerCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleManagerFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleManagerRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleManagerWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/DeathZoneSource.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/DeathZoneSourceCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EdgeZoneSource.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EdgeZoneSourceCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpCustomEmitConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpCustomUpdateConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpEaseConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpOnEmitCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpOnEmitType.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpOnUpdateCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpOnUpdateType.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpRandomConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpRandomMinMaxConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpRandomStartEndConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpSteppedConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/GravityWellConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleDeathCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterBounds.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterBoundsAlt.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterDeathZoneConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterEdgeZoneConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterFrameConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterRandomZoneConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/RandomZoneSource.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/RandomZoneSourceCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones/DeathZone.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones/EdgeZone.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones/RandomZone.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower/PathFollower.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower/PathFollowerFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower/typedefs/PathConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/quad/Quad.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/quad/QuadCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/quad/QuadFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/RenderTexture.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/RenderTextureCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/RenderTextureCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/RenderTextureFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/RenderTextureRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/RenderTextureWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/typedefs/RenderTextureConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rope/Rope.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rope/RopeCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rope/RopeCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rope/RopeFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rope/RopeRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rope/RopeWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shader/Shader.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shader/ShaderCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shader/ShaderCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shader/ShaderFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shader/ShaderRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shader/ShaderWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/FillPathWebGL.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/FillStyleCanvas.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/LineStyleCanvas.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/Shape.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/StrokePathWebGL.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc/Arc.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc/ArcCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc/ArcFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc/ArcRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc/ArcWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve/Curve.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve/CurveCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve/CurveFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve/CurveRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve/CurveWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse/Ellipse.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse/EllipseCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse/EllipseFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse/EllipseRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse/EllipseWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid/Grid.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid/GridCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid/GridFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid/GridRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid/GridWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox/IsoBox.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox/IsoBoxCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox/IsoBoxFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox/IsoBoxRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox/IsoBoxWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle/IsoTriangle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle/IsoTriangleCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle/IsoTriangleFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle/IsoTriangleRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle/IsoTriangleWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line/Line.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line/LineCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line/LineFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line/LineRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line/LineWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon/Polygon.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon/PolygonCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon/PolygonFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon/PolygonRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon/PolygonWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle/Rectangle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle/RectangleCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle/RectangleFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle/RectangleRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle/RectangleWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star/Star.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star/StarCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star/StarFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star/StarRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star/StarWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle/Triangle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle/TriangleCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle/TriangleFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle/TriangleRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle/TriangleWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/Sprite.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/SpriteCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/SpriteCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/SpriteFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/SpriteRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/SpriteWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/typedefs/SpriteConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/GetTextSize.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/MeasureText.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/TextStyle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static/Text.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static/TextCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static/TextCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static/TextFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static/TextRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static/TextWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs/TextMetrics.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs/TextPadding.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs/TextShadow.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs/TextStyle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs/TextWordWrap.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/TileSprite.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/TileSpriteCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/TileSpriteCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/TileSpriteFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/TileSpriteRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/TileSpriteWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/typedefs/TileSpriteConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/typedefs/GameObjectConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/typedefs/JSONGameObject.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/video/Video.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/video/VideoCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/video/VideoCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/video/VideoFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/video/VideoRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/video/VideoWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/zone/Zone.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/zone/ZoneCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/zone/ZoneFactory.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Area.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Circle.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Circumference.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/CircumferencePoint.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Contains.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/ContainsPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/ContainsRect.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/CopyFrom.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Equals.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/GetBounds.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/GetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/GetPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Offset.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/OffsetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Random.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/index.js","/home/arian/Documents/Phaser/phaser/src/geom/const.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Area.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Circumference.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/CircumferencePoint.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Contains.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/ContainsPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/ContainsRect.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/CopyFrom.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Ellipse.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Equals.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/GetBounds.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/GetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/GetPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Offset.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/OffsetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Random.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/index.js","/home/arian/Documents/Phaser/phaser/src/geom/index.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/CircleToCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/CircleToRectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetCircleToCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetCircleToRectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetLineToCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetLineToRectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetRectangleIntersection.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetRectangleToRectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetRectangleToTriangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetTriangleToCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetTriangleToLine.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetTriangleToTriangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/LineToCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/LineToLine.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/LineToRectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/PointToLine.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/PointToLineSegment.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/RectangleToRectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/RectangleToTriangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/RectangleToValues.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/TriangleToCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/TriangleToLine.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/TriangleToTriangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/index.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Angle.js","/home/arian/Documents/Phaser/phaser/src/geom/line/BresenhamPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/line/CenterOn.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/line/CopyFrom.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Equals.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Extend.js","/home/arian/Documents/Phaser/phaser/src/geom/line/GetMidPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/line/GetNearestPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/line/GetNormal.js","/home/arian/Documents/Phaser/phaser/src/geom/line/GetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/line/GetPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/line/GetShortestDistance.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Height.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Length.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Line.js","/home/arian/Documents/Phaser/phaser/src/geom/line/NormalAngle.js","/home/arian/Documents/Phaser/phaser/src/geom/line/NormalX.js","/home/arian/Documents/Phaser/phaser/src/geom/line/NormalY.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Offset.js","/home/arian/Documents/Phaser/phaser/src/geom/line/PerpSlope.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Random.js","/home/arian/Documents/Phaser/phaser/src/geom/line/ReflectAngle.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Rotate.js","/home/arian/Documents/Phaser/phaser/src/geom/line/RotateAroundPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/line/RotateAroundXY.js","/home/arian/Documents/Phaser/phaser/src/geom/line/SetToAngle.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Slope.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Width.js","/home/arian/Documents/Phaser/phaser/src/geom/line/index.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Ceil.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/point/CopyFrom.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Equals.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Floor.js","/home/arian/Documents/Phaser/phaser/src/geom/point/GetCentroid.js","/home/arian/Documents/Phaser/phaser/src/geom/point/GetMagnitude.js","/home/arian/Documents/Phaser/phaser/src/geom/point/GetMagnitudeSq.js","/home/arian/Documents/Phaser/phaser/src/geom/point/GetRectangleFromPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Interpolate.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Invert.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Negative.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Point.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Project.js","/home/arian/Documents/Phaser/phaser/src/geom/point/ProjectUnit.js","/home/arian/Documents/Phaser/phaser/src/geom/point/SetMagnitude.js","/home/arian/Documents/Phaser/phaser/src/geom/point/index.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Contains.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/ContainsPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Earcut.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/GetAABB.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/GetNumberArray.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/GetPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Perimeter.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Polygon.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Reverse.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Smooth.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/index.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Area.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Ceil.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/CeilAll.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/CenterOn.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Contains.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/ContainsPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/ContainsRect.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/CopyFrom.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Decompose.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Equals.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/FitInside.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/FitOutside.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Floor.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/FloorAll.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/FromPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/GetAspectRatio.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/GetCenter.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/GetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/GetPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/GetSize.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Inflate.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Intersection.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/MarchingAnts.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/MergePoints.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/MergeRect.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/MergeXY.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Offset.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/OffsetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Overlaps.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Perimeter.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/PerimeterPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Random.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/RandomOutside.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Rectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/SameDimensions.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Scale.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Union.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/index.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Area.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/BuildEquilateral.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/BuildFromPolygon.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/BuildRight.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/CenterOn.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Centroid.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/CircumCenter.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/CircumCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Contains.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/ContainsArray.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/ContainsPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/CopyFrom.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Decompose.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Equals.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/GetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/GetPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/InCenter.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Offset.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Perimeter.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Random.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Rotate.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/RotateAroundPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/RotateAroundXY.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Triangle.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/index.js","/home/arian/Documents/Phaser/phaser/src/input/CreateInteractiveObject.js","/home/arian/Documents/Phaser/phaser/src/input/CreatePixelPerfectHandler.js","/home/arian/Documents/Phaser/phaser/src/input/InputManager.js","/home/arian/Documents/Phaser/phaser/src/input/InputPlugin.js","/home/arian/Documents/Phaser/phaser/src/input/InputPluginCache.js","/home/arian/Documents/Phaser/phaser/src/input/Pointer.js","/home/arian/Documents/Phaser/phaser/src/input/const.js","/home/arian/Documents/Phaser/phaser/src/input/events/BOOT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DESTROY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DRAG_END_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DRAG_ENTER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DRAG_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DRAG_LEAVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DRAG_OVER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DRAG_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DROP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DRAG_END_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DRAG_ENTER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DRAG_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DRAG_LEAVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DRAG_OVER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DRAG_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DROP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_MOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_OUT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_OVER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_POINTER_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_POINTER_MOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_POINTER_OUT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_POINTER_OVER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_POINTER_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_POINTER_WHEEL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_WHEEL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAME_OUT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAME_OVER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/MANAGER_BOOT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/MANAGER_PROCESS_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/MANAGER_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTERLOCK_CHANGE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_DOWN_OUTSIDE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_MOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_OUT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_OVER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_UP_OUTSIDE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_WHEEL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/PRE_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/SHUTDOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/index.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/Axis.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/Button.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/Gamepad.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/GamepadPlugin.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs/SNES_USB_Controller.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs/Sony_PlayStation_DualShock_4.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs/XBox360_Controller.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs/index.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/BUTTON_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/BUTTON_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/CONNECTED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/DISCONNECTED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/GAMEPAD_BUTTON_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/GAMEPAD_BUTTON_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/index.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/index.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/typedefs/Pad.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/input/index.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/KeyboardManager.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/KeyboardPlugin.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo/AdvanceKeyCombo.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo/KeyCombo.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo/ProcessKeyCombo.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo/ResetKeyCombo.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/ANY_KEY_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/ANY_KEY_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/COMBO_MATCH_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/KEY_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/KEY_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/index.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/index.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/DownDuration.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/JustDown.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/JustUp.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/Key.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/KeyCodes.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/KeyMap.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/UpDuration.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs/CursorKeys.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs/KeyComboConfig.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs/KeyboardKeydownCallback.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/input/mouse/MouseManager.js","/home/arian/Documents/Phaser/phaser/src/input/mouse/index.js","/home/arian/Documents/Phaser/phaser/src/input/touch/TouchManager.js","/home/arian/Documents/Phaser/phaser/src/input/touch/index.js","/home/arian/Documents/Phaser/phaser/src/input/typedefs/EventData.js","/home/arian/Documents/Phaser/phaser/src/input/typedefs/HitAreaCallback.js","/home/arian/Documents/Phaser/phaser/src/input/typedefs/InputConfiguration.js","/home/arian/Documents/Phaser/phaser/src/input/typedefs/InputPluginContainer.js","/home/arian/Documents/Phaser/phaser/src/input/typedefs/InteractiveObject.js","/home/arian/Documents/Phaser/phaser/src/input/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/loader/File.js","/home/arian/Documents/Phaser/phaser/src/loader/FileTypesManager.js","/home/arian/Documents/Phaser/phaser/src/loader/GetURL.js","/home/arian/Documents/Phaser/phaser/src/loader/LoaderPlugin.js","/home/arian/Documents/Phaser/phaser/src/loader/MergeXHRSettings.js","/home/arian/Documents/Phaser/phaser/src/loader/MultiFile.js","/home/arian/Documents/Phaser/phaser/src/loader/XHRLoader.js","/home/arian/Documents/Phaser/phaser/src/loader/XHRSettings.js","/home/arian/Documents/Phaser/phaser/src/loader/const.js","/home/arian/Documents/Phaser/phaser/src/loader/events/ADD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/FILE_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/FILE_KEY_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/FILE_LOAD_ERROR_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/FILE_LOAD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/FILE_PROGRESS_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/POST_PROCESS_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/PROGRESS_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/index.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/AnimationJSONFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/AtlasJSONFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/AtlasXMLFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/AudioFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/AudioSpriteFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/BinaryFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/BitmapFontFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/CSSFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/GLSLFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/HTML5AudioFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/HTMLFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/HTMLTextureFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/ImageFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/JSONFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/MultiAtlasFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/MultiScriptFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/PackFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/PluginFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/SVGFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/SceneFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/ScenePluginFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/ScriptFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/SpriteSheetFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/TextFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/TilemapCSVFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/TilemapImpactFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/TilemapJSONFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/UnityAtlasFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/VideoFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/XMLFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/index.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/AtlasJSONFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/AtlasXMLFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/AudioFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/AudioSpriteFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/BinaryFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/BitmapFontFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/CSSFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/GLSLFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/HTMLFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/HTMLTextureFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/ImageFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/ImageFrameConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/JSONFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/MultiAtlasFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/MultiScriptFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/PackFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/PluginFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/SVGFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/SVGSizeConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/SceneFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/ScenePluginFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/ScriptFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/SpriteSheetFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/TextFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/TilemapCSVFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/TilemapImpactFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/TilemapJSONFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/UnityAtlasFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/VideoFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/XMLFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/loader/index.js","/home/arian/Documents/Phaser/phaser/src/loader/typedefs/FileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/typedefs/XHRSettingsObject.js","/home/arian/Documents/Phaser/phaser/src/loader/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/math/Average.js","/home/arian/Documents/Phaser/phaser/src/math/Bernstein.js","/home/arian/Documents/Phaser/phaser/src/math/Between.js","/home/arian/Documents/Phaser/phaser/src/math/CatmullRom.js","/home/arian/Documents/Phaser/phaser/src/math/CeilTo.js","/home/arian/Documents/Phaser/phaser/src/math/Clamp.js","/home/arian/Documents/Phaser/phaser/src/math/DegToRad.js","/home/arian/Documents/Phaser/phaser/src/math/Difference.js","/home/arian/Documents/Phaser/phaser/src/math/Factorial.js","/home/arian/Documents/Phaser/phaser/src/math/FloatBetween.js","/home/arian/Documents/Phaser/phaser/src/math/FloorTo.js","/home/arian/Documents/Phaser/phaser/src/math/FromPercent.js","/home/arian/Documents/Phaser/phaser/src/math/GetSpeed.js","/home/arian/Documents/Phaser/phaser/src/math/IsEven.js","/home/arian/Documents/Phaser/phaser/src/math/IsEvenStrict.js","/home/arian/Documents/Phaser/phaser/src/math/Linear.js","/home/arian/Documents/Phaser/phaser/src/math/Matrix3.js","/home/arian/Documents/Phaser/phaser/src/math/Matrix4.js","/home/arian/Documents/Phaser/phaser/src/math/MaxAdd.js","/home/arian/Documents/Phaser/phaser/src/math/MinSub.js","/home/arian/Documents/Phaser/phaser/src/math/Percent.js","/home/arian/Documents/Phaser/phaser/src/math/Quaternion.js","/home/arian/Documents/Phaser/phaser/src/math/RadToDeg.js","/home/arian/Documents/Phaser/phaser/src/math/RandomXY.js","/home/arian/Documents/Phaser/phaser/src/math/RandomXYZ.js","/home/arian/Documents/Phaser/phaser/src/math/RandomXYZW.js","/home/arian/Documents/Phaser/phaser/src/math/Rotate.js","/home/arian/Documents/Phaser/phaser/src/math/RotateAround.js","/home/arian/Documents/Phaser/phaser/src/math/RotateAroundDistance.js","/home/arian/Documents/Phaser/phaser/src/math/RotateVec3.js","/home/arian/Documents/Phaser/phaser/src/math/RoundAwayFromZero.js","/home/arian/Documents/Phaser/phaser/src/math/RoundTo.js","/home/arian/Documents/Phaser/phaser/src/math/SinCosTableGenerator.js","/home/arian/Documents/Phaser/phaser/src/math/SmoothStep.js","/home/arian/Documents/Phaser/phaser/src/math/SmootherStep.js","/home/arian/Documents/Phaser/phaser/src/math/ToXY.js","/home/arian/Documents/Phaser/phaser/src/math/TransformXY.js","/home/arian/Documents/Phaser/phaser/src/math/Vector2.js","/home/arian/Documents/Phaser/phaser/src/math/Vector3.js","/home/arian/Documents/Phaser/phaser/src/math/Vector4.js","/home/arian/Documents/Phaser/phaser/src/math/Within.js","/home/arian/Documents/Phaser/phaser/src/math/Wrap.js","/home/arian/Documents/Phaser/phaser/src/math/angle/Between.js","/home/arian/Documents/Phaser/phaser/src/math/angle/BetweenPoints.js","/home/arian/Documents/Phaser/phaser/src/math/angle/BetweenPointsY.js","/home/arian/Documents/Phaser/phaser/src/math/angle/BetweenY.js","/home/arian/Documents/Phaser/phaser/src/math/angle/CounterClockwise.js","/home/arian/Documents/Phaser/phaser/src/math/angle/Normalize.js","/home/arian/Documents/Phaser/phaser/src/math/angle/Reverse.js","/home/arian/Documents/Phaser/phaser/src/math/angle/RotateTo.js","/home/arian/Documents/Phaser/phaser/src/math/angle/ShortestBetween.js","/home/arian/Documents/Phaser/phaser/src/math/angle/Wrap.js","/home/arian/Documents/Phaser/phaser/src/math/angle/WrapDegrees.js","/home/arian/Documents/Phaser/phaser/src/math/angle/index.js","/home/arian/Documents/Phaser/phaser/src/math/const.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistanceBetween.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistanceBetweenPoints.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistanceBetweenPointsSquared.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistanceChebyshev.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistancePower.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistanceSnake.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistanceSquared.js","/home/arian/Documents/Phaser/phaser/src/math/distance/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/EaseMap.js","/home/arian/Documents/Phaser/phaser/src/math/easing/back/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/back/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/back/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/back/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/bounce/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/bounce/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/bounce/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/bounce/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/circular/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/circular/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/circular/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/circular/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/cubic/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/cubic/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/cubic/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/cubic/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/elastic/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/elastic/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/elastic/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/elastic/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/expo/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/expo/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/expo/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/expo/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/linear/Linear.js","/home/arian/Documents/Phaser/phaser/src/math/easing/linear/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quartic/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quartic/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quartic/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quartic/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quintic/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quintic/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quintic/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quintic/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/sine/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/sine/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/sine/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/sine/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/stepped/Stepped.js","/home/arian/Documents/Phaser/phaser/src/math/easing/stepped/index.js","/home/arian/Documents/Phaser/phaser/src/math/fuzzy/Ceil.js","/home/arian/Documents/Phaser/phaser/src/math/fuzzy/Equal.js","/home/arian/Documents/Phaser/phaser/src/math/fuzzy/Floor.js","/home/arian/Documents/Phaser/phaser/src/math/fuzzy/GreaterThan.js","/home/arian/Documents/Phaser/phaser/src/math/fuzzy/LessThan.js","/home/arian/Documents/Phaser/phaser/src/math/fuzzy/index.js","/home/arian/Documents/Phaser/phaser/src/math/index.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/BezierInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/CatmullRomInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/CubicBezierInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/LinearInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/QuadraticBezierInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/SmoothStepInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/SmootherStepInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/index.js","/home/arian/Documents/Phaser/phaser/src/math/pow2/GetPowerOfTwo.js","/home/arian/Documents/Phaser/phaser/src/math/pow2/IsSizePowerOfTwo.js","/home/arian/Documents/Phaser/phaser/src/math/pow2/IsValuePowerOfTwo.js","/home/arian/Documents/Phaser/phaser/src/math/pow2/index.js","/home/arian/Documents/Phaser/phaser/src/math/random-data-generator/RandomDataGenerator.js","/home/arian/Documents/Phaser/phaser/src/math/snap/SnapCeil.js","/home/arian/Documents/Phaser/phaser/src/math/snap/SnapFloor.js","/home/arian/Documents/Phaser/phaser/src/math/snap/SnapTo.js","/home/arian/Documents/Phaser/phaser/src/math/snap/index.js","/home/arian/Documents/Phaser/phaser/src/math/typedefs/SinCosTable.js","/home/arian/Documents/Phaser/phaser/src/math/typedefs/Vector2Like.js","/home/arian/Documents/Phaser/phaser/src/math/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/phaser.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/ArcadeImage.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/ArcadePhysics.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/ArcadeSprite.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/Body.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/Collider.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/Factory.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/GetOverlapX.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/GetOverlapY.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/PhysicsGroup.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/SeparateX.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/SeparateY.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/StaticBody.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/StaticPhysicsGroup.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/World.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Acceleration.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Angular.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Bounce.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Debug.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Drag.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Enable.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Friction.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Gravity.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Immovable.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Mass.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/OverlapCirc.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/OverlapRect.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Size.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Velocity.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/index.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/const.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/COLLIDE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/OVERLAP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/TILE_COLLIDE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/TILE_OVERLAP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/WORLD_BOUNDS_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/WORLD_STEP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/index.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/index.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/ProcessTileCallbacks.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/ProcessTileSeparationX.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/ProcessTileSeparationY.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/SeparateTile.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/TileCheckX.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/TileCheckY.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/TileIntersectsBody.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/index.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/ArcadeBodyBounds.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/ArcadeBodyCollision.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/ArcadeColliderType.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/ArcadeWorldConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/ArcadeWorldDefaults.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/ArcadeWorldTreeMinMax.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/CheckCollisionObject.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/PhysicsGroupConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/PhysicsGroupDefaults.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/Body.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/COLLIDES.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/CollisionMap.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/DefaultDefs.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/Factory.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/GetVelocity.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/ImpactBody.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/ImpactImage.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/ImpactPhysics.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/ImpactSprite.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/SeparateX.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/SeparateY.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/Solver.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/TYPE.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/UpdateMotion.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/World.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Acceleration.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/BodyScale.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/BodyType.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Bounce.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/CheckAgainst.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Collides.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Debug.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Friction.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Gravity.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Offset.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/SetGameObject.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Velocity.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/index.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/events/COLLIDE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/events/PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/events/RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/events/index.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/index.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs/CollisionOptions.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs/JSONImpactBody.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs/WorldConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs/WorldDefaults.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs/WorldWalls.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/physics/index.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/BodyBounds.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/CustomMain.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/Factory.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/MatterGameObject.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/MatterImage.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/MatterPhysics.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/MatterSprite.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/MatterTileBody.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/PhysicsEditorParser.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/PhysicsJSONParser.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/PointerConstraint.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/World.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Bounce.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Collision.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Force.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Friction.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Gravity.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Mass.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Sensor.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/SetBody.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Sleep.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Static.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Transform.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Velocity.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/index.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/AFTER_ADD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/AFTER_REMOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/AFTER_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/BEFORE_ADD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/BEFORE_REMOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/BEFORE_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/COLLISION_ACTIVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/COLLISION_END_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/COLLISION_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/DRAG_END_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/DRAG_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/DRAG_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/SLEEP_END_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/SLEEP_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/index.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/index.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterBody.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterBodyConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterBodyRenderConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterBodyTileOptions.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterChamferConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterCollisionData.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterCollisionFilter.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterCollisionPair.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterConstraintConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterConstraintRenderConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterDebugConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterRunnerConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterSetBodyConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterTileOptions.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterWorldConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/plugins/BasePlugin.js","/home/arian/Documents/Phaser/phaser/src/plugins/DefaultPlugins.js","/home/arian/Documents/Phaser/phaser/src/plugins/PluginCache.js","/home/arian/Documents/Phaser/phaser/src/plugins/PluginManager.js","/home/arian/Documents/Phaser/phaser/src/plugins/ScenePlugin.js","/home/arian/Documents/Phaser/phaser/src/plugins/index.js","/home/arian/Documents/Phaser/phaser/src/plugins/typedefs/CorePluginContainer.js","/home/arian/Documents/Phaser/phaser/src/plugins/typedefs/CustomPluginContainer.js","/home/arian/Documents/Phaser/phaser/src/plugins/typedefs/GlobalPlugin.js","/home/arian/Documents/Phaser/phaser/src/plugins/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/BlendModes.js","/home/arian/Documents/Phaser/phaser/src/renderer/ScaleModes.js","/home/arian/Documents/Phaser/phaser/src/renderer/canvas/CanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/renderer/canvas/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/canvas/utils/GetBlendModes.js","/home/arian/Documents/Phaser/phaser/src/renderer/canvas/utils/SetTransform.js","/home/arian/Documents/Phaser/phaser/src/renderer/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/CanvasSnapshot.js","/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/WebGLSnapshot.js","/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/typedefs/SnapshotCallback.js","/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/typedefs/SnapshotState.js","/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/Utils.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/WebGLPipeline.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/WebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/BitmapMaskPipeline.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/ForwardDiffuseLightPipeline.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/TextureTintPipeline.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/TextureTintStripPipeline.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components/ModelViewProjection.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/BitmapMask-frag.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/BitmapMask-vert.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/DeferredDiffuse-frag.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/DeferredDiffuse-vert.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/ForwardDiffuse-frag.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/TextureTint-frag.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/TextureTint-vert.js","/home/arian/Documents/Phaser/phaser/src/scale/ScaleManager.js","/home/arian/Documents/Phaser/phaser/src/scale/const/CENTER_CONST.js","/home/arian/Documents/Phaser/phaser/src/scale/const/ORIENTATION_CONST.js","/home/arian/Documents/Phaser/phaser/src/scale/const/SCALE_MODE_CONST.js","/home/arian/Documents/Phaser/phaser/src/scale/const/ZOOM_CONST.js","/home/arian/Documents/Phaser/phaser/src/scale/const/index.js","/home/arian/Documents/Phaser/phaser/src/scale/events/ENTER_FULLSCREEN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scale/events/FULLSCREEN_FAILED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scale/events/FULLSCREEN_UNSUPPORTED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scale/events/LEAVE_FULLSCREEN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scale/events/ORIENTATION_CHANGE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scale/events/RESIZE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scale/events/index.js","/home/arian/Documents/Phaser/phaser/src/scale/index.js","/home/arian/Documents/Phaser/phaser/src/scene/GetPhysicsPlugins.js","/home/arian/Documents/Phaser/phaser/src/scene/GetScenePlugins.js","/home/arian/Documents/Phaser/phaser/src/scene/InjectionMap.js","/home/arian/Documents/Phaser/phaser/src/scene/Scene.js","/home/arian/Documents/Phaser/phaser/src/scene/SceneManager.js","/home/arian/Documents/Phaser/phaser/src/scene/ScenePlugin.js","/home/arian/Documents/Phaser/phaser/src/scene/Settings.js","/home/arian/Documents/Phaser/phaser/src/scene/Systems.js","/home/arian/Documents/Phaser/phaser/src/scene/const.js","/home/arian/Documents/Phaser/phaser/src/scene/events/BOOT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/CREATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/DESTROY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/POST_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/PRE_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/READY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/RENDER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/SHUTDOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/SLEEP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/TRANSITION_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/TRANSITION_INIT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/TRANSITION_OUT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/TRANSITION_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/TRANSITION_WAKE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/WAKE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/index.js","/home/arian/Documents/Phaser/phaser/src/scene/index.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/CreateSceneFromObjectConfig.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/SceneCreateCallback.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/SceneInitCallback.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/ScenePreloadCallback.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/SceneTransitionConfig.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/SettingsConfig.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/SettingsObject.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/sound/BaseSound.js","/home/arian/Documents/Phaser/phaser/src/sound/BaseSoundManager.js","/home/arian/Documents/Phaser/phaser/src/sound/SoundManagerCreator.js","/home/arian/Documents/Phaser/phaser/src/sound/events/COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/DECODED_ALL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/DECODED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/DESTROY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/DETUNE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/GLOBAL_DETUNE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/GLOBAL_MUTE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/GLOBAL_RATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/GLOBAL_VOLUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/LOOPED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/LOOP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/MUTE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/PAUSE_ALL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/PLAY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/RATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/RESUME_ALL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/SEEK_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/STOP_ALL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/STOP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/UNLOCKED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/VOLUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/index.js","/home/arian/Documents/Phaser/phaser/src/sound/html5/HTML5AudioSound.js","/home/arian/Documents/Phaser/phaser/src/sound/html5/HTML5AudioSoundManager.js","/home/arian/Documents/Phaser/phaser/src/sound/index.js","/home/arian/Documents/Phaser/phaser/src/sound/noaudio/NoAudioSound.js","/home/arian/Documents/Phaser/phaser/src/sound/noaudio/NoAudioSoundManager.js","/home/arian/Documents/Phaser/phaser/src/sound/typedefs/AudioSpriteSound.js","/home/arian/Documents/Phaser/phaser/src/sound/typedefs/DecodeAudioConfig.js","/home/arian/Documents/Phaser/phaser/src/sound/typedefs/EachActiveSoundCallback.js","/home/arian/Documents/Phaser/phaser/src/sound/typedefs/SoundConfig.js","/home/arian/Documents/Phaser/phaser/src/sound/typedefs/SoundMarker.js","/home/arian/Documents/Phaser/phaser/src/sound/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/sound/webaudio/WebAudioSound.js","/home/arian/Documents/Phaser/phaser/src/sound/webaudio/WebAudioSoundManager.js","/home/arian/Documents/Phaser/phaser/src/structs/List.js","/home/arian/Documents/Phaser/phaser/src/structs/Map.js","/home/arian/Documents/Phaser/phaser/src/structs/ProcessQueue.js","/home/arian/Documents/Phaser/phaser/src/structs/RTree.js","/home/arian/Documents/Phaser/phaser/src/structs/Set.js","/home/arian/Documents/Phaser/phaser/src/structs/Size.js","/home/arian/Documents/Phaser/phaser/src/structs/events/PROCESS_QUEUE_ADD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/structs/events/PROCESS_QUEUE_REMOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/structs/events/index.js","/home/arian/Documents/Phaser/phaser/src/structs/index.js","/home/arian/Documents/Phaser/phaser/src/textures/CanvasTexture.js","/home/arian/Documents/Phaser/phaser/src/textures/Frame.js","/home/arian/Documents/Phaser/phaser/src/textures/Texture.js","/home/arian/Documents/Phaser/phaser/src/textures/TextureManager.js","/home/arian/Documents/Phaser/phaser/src/textures/TextureSource.js","/home/arian/Documents/Phaser/phaser/src/textures/const.js","/home/arian/Documents/Phaser/phaser/src/textures/events/ADD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/textures/events/ERROR_EVENT.js","/home/arian/Documents/Phaser/phaser/src/textures/events/LOAD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/textures/events/READY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/textures/events/REMOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/textures/events/index.js","/home/arian/Documents/Phaser/phaser/src/textures/index.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/AtlasXML.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/Canvas.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/Image.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/JSONArray.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/JSONHash.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/SpriteSheet.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/SpriteSheetFromAtlas.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/UnityYAML.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/index.js","/home/arian/Documents/Phaser/phaser/src/textures/typedefs/PixelConfig.js","/home/arian/Documents/Phaser/phaser/src/textures/typedefs/SpriteSheetConfig.js","/home/arian/Documents/Phaser/phaser/src/textures/typedefs/SpriteSheetFromAtlasConfig.js","/home/arian/Documents/Phaser/phaser/src/textures/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/Formats.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/ImageCollection.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/ParseToTilemap.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/Tile.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/Tilemap.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/TilemapCreator.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/TilemapFactory.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/Tileset.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/CalculateFacesAt.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/CalculateFacesWithin.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/Copy.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/CreateFromTiles.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/CullTiles.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/Fill.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/FilterTiles.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/FindByIndex.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/FindTile.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/ForEachTile.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/GetTileAt.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/GetTileAtWorldXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/GetTilesWithin.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/GetTilesWithinShape.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/GetTilesWithinWorldXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/HasTileAt.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/HasTileAtWorldXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/IsInLayerBounds.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/PutTileAt.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/PutTileAtWorldXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/PutTilesAt.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/Randomize.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/RemoveTileAt.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/RemoveTileAtWorldXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/RenderDebug.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/ReplaceByIndex.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetCollision.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetCollisionBetween.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetCollisionByExclusion.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetCollisionByProperty.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetCollisionFromCollisionGroup.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetLayerCollisionIndex.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetTileCollision.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetTileIndexCallback.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetTileLocationCallback.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/Shuffle.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SwapByIndex.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/TileToWorldX.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/TileToWorldXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/TileToWorldY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/WeightedRandomize.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/WorldToTileX.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/WorldToTileXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/WorldToTileY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/index.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer/DynamicTilemapLayer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer/DynamicTilemapLayerCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer/DynamicTilemapLayerRender.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer/DynamicTilemapLayerWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/index.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata/LayerData.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata/MapData.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata/ObjectLayer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/Parse.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/Parse2DArray.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/ParseCSV.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact/ParseTileLayers.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact/ParseTilesets.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact/ParseWeltmeister.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact/index.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/index.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/AssignTileProperties.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/Base64Decode.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/BuildTilesetIndex.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/CreateGroupLayer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseGID.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseImageLayers.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseJSONTiled.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseObject.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseObjectLayers.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseTileLayers.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseTilesets.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/index.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer/StaticTilemapLayer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer/StaticTilemapLayerCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer/StaticTilemapLayerRender.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer/StaticTilemapLayerWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/FilteringOptions.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/GetTilesWithinFilteringOptions.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/MapDataConfig.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/ObjectLayerConfig.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/StyleConfig.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/TiledObject.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/TilemapConfig.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/time/Clock.js","/home/arian/Documents/Phaser/phaser/src/time/TimerEvent.js","/home/arian/Documents/Phaser/phaser/src/time/index.js","/home/arian/Documents/Phaser/phaser/src/time/typedefs/TimerEventConfig.js","/home/arian/Documents/Phaser/phaser/src/time/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/tweens/Timeline.js","/home/arian/Documents/Phaser/phaser/src/tweens/TweenManager.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetBoolean.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetEaseFunction.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetNewValue.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetProps.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetTargets.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetTweens.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetValueOp.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/NumberTweenBuilder.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/StaggerBuilder.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/TimelineBuilder.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/TweenBuilder.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/index.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TIMELINE_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TIMELINE_LOOP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TIMELINE_PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TIMELINE_RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TIMELINE_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TIMELINE_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_ACTIVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_LOOP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_REPEAT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_YOYO_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/index.js","/home/arian/Documents/Phaser/phaser/src/tweens/index.js","/home/arian/Documents/Phaser/phaser/src/tweens/tween/Defaults.js","/home/arian/Documents/Phaser/phaser/src/tweens/tween/ReservedProps.js","/home/arian/Documents/Phaser/phaser/src/tweens/tween/Tween.js","/home/arian/Documents/Phaser/phaser/src/tweens/tween/TweenData.js","/home/arian/Documents/Phaser/phaser/src/tweens/tween/const.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/Event.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/GetActiveCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/GetEndCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/GetStartCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/NumberTweenBuilderConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/StaggerConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TimelineBuilderConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TimelineOnCompleteCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TimelineOnLoopCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TimelineOnStartCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TimelineOnUpdateCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TimelineOnYoyoCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenBuilderConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenDataConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenDataGenConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnActiveCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnCompleteCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnLoopCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnRepeatCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnStartCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnUpdateCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnYoyoCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenPropConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/utils/Class.js","/home/arian/Documents/Phaser/phaser/src/utils/NOOP.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Add.js","/home/arian/Documents/Phaser/phaser/src/utils/array/AddAt.js","/home/arian/Documents/Phaser/phaser/src/utils/array/BringToTop.js","/home/arian/Documents/Phaser/phaser/src/utils/array/CountAllMatching.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Each.js","/home/arian/Documents/Phaser/phaser/src/utils/array/EachInRange.js","/home/arian/Documents/Phaser/phaser/src/utils/array/FindClosestInSorted.js","/home/arian/Documents/Phaser/phaser/src/utils/array/GetAll.js","/home/arian/Documents/Phaser/phaser/src/utils/array/GetFirst.js","/home/arian/Documents/Phaser/phaser/src/utils/array/GetRandom.js","/home/arian/Documents/Phaser/phaser/src/utils/array/MoveDown.js","/home/arian/Documents/Phaser/phaser/src/utils/array/MoveTo.js","/home/arian/Documents/Phaser/phaser/src/utils/array/MoveUp.js","/home/arian/Documents/Phaser/phaser/src/utils/array/NumberArray.js","/home/arian/Documents/Phaser/phaser/src/utils/array/NumberArrayStep.js","/home/arian/Documents/Phaser/phaser/src/utils/array/QuickSelect.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Range.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Remove.js","/home/arian/Documents/Phaser/phaser/src/utils/array/RemoveAt.js","/home/arian/Documents/Phaser/phaser/src/utils/array/RemoveBetween.js","/home/arian/Documents/Phaser/phaser/src/utils/array/RemoveRandomElement.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Replace.js","/home/arian/Documents/Phaser/phaser/src/utils/array/RotateLeft.js","/home/arian/Documents/Phaser/phaser/src/utils/array/RotateRight.js","/home/arian/Documents/Phaser/phaser/src/utils/array/SafeRange.js","/home/arian/Documents/Phaser/phaser/src/utils/array/SendToBack.js","/home/arian/Documents/Phaser/phaser/src/utils/array/SetAll.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Shuffle.js","/home/arian/Documents/Phaser/phaser/src/utils/array/SpliceOne.js","/home/arian/Documents/Phaser/phaser/src/utils/array/StableSort.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Swap.js","/home/arian/Documents/Phaser/phaser/src/utils/array/index.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/CheckMatrix.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/MatrixToString.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/ReverseColumns.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/ReverseRows.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/Rotate180.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/RotateLeft.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/RotateMatrix.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/RotateRight.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/TransposeMatrix.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/index.js","/home/arian/Documents/Phaser/phaser/src/utils/base64/ArrayBufferToBase64.js","/home/arian/Documents/Phaser/phaser/src/utils/base64/Base64ToArrayBuffer.js","/home/arian/Documents/Phaser/phaser/src/utils/base64/index.js","/home/arian/Documents/Phaser/phaser/src/utils/index.js","/home/arian/Documents/Phaser/phaser/src/utils/object/Clone.js","/home/arian/Documents/Phaser/phaser/src/utils/object/Extend.js","/home/arian/Documents/Phaser/phaser/src/utils/object/GetAdvancedValue.js","/home/arian/Documents/Phaser/phaser/src/utils/object/GetFastValue.js","/home/arian/Documents/Phaser/phaser/src/utils/object/GetMinMaxValue.js","/home/arian/Documents/Phaser/phaser/src/utils/object/GetValue.js","/home/arian/Documents/Phaser/phaser/src/utils/object/HasAll.js","/home/arian/Documents/Phaser/phaser/src/utils/object/HasAny.js","/home/arian/Documents/Phaser/phaser/src/utils/object/HasValue.js","/home/arian/Documents/Phaser/phaser/src/utils/object/IsPlainObject.js","/home/arian/Documents/Phaser/phaser/src/utils/object/Merge.js","/home/arian/Documents/Phaser/phaser/src/utils/object/MergeRight.js","/home/arian/Documents/Phaser/phaser/src/utils/object/Pick.js","/home/arian/Documents/Phaser/phaser/src/utils/object/SetValue.js","/home/arian/Documents/Phaser/phaser/src/utils/object/index.js","/home/arian/Documents/Phaser/phaser/src/utils/string/Format.js","/home/arian/Documents/Phaser/phaser/src/utils/string/Pad.js","/home/arian/Documents/Phaser/phaser/src/utils/string/Reverse.js","/home/arian/Documents/Phaser/phaser/src/utils/string/UUID.js","/home/arian/Documents/Phaser/phaser/src/utils/string/UppercaseFirst.js","/home/arian/Documents/Phaser/phaser/src/utils/string/index.js","/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src/AdInstance.js","/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src/FacebookInstantGamesPlugin.js","/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src/Leaderboard.js","/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src/LeaderboardScore.js","/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src/Product.js","/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src/Purchase.js"],"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"`this`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"`this`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"`this`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"`this`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"`this`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"`this`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"`this`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"`this`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"`this`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"`this`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"`this`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"`this`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Scene this camera belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#scene","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#scene","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Game Scene Manager.","name":"sceneManager","type":{"names":["Phaser.Scenes.SceneManager"]},"since":"3.12.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#sceneManager","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#sceneManager","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Game Scale Manager.","name":"scaleManager","type":{"names":["Phaser.Scale.ScaleManager"]},"since":"3.16.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#scaleManager","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#scaleManager","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Scene's Camera Manager to which this Camera belongs.","name":"cameraManager","type":{"names":["Phaser.Cameras.Scene2D.CameraManager"]},"since":"3.17.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#cameraManager","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#cameraManager","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera ID. Assigned by the Camera Manager and used to handle camera exclusion.\nThis value is a bitmask.","name":"id","type":{"names":["integer"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#id","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#id","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The name of the Camera. This is left empty for your own use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#name","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#name","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"This property is un-used in v3.16.\n\nThe resolution of the Game, used in most Camera calculations.","name":"resolution","type":{"names":["number"]},"readonly":true,"deprecated":true,"since":"3.12.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#resolution","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#resolution","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":149,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Should this camera round its pixel values to integers?","name":"roundPixels","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#roundPixels","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#roundPixels","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera visible or not?\n\nA visible camera will render and perform input tests.\nAn invisible camera will not render anything and will skip input tests.","name":"visible","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.10.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#visible","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#visible","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":171,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera using a bounds to restrict scrolling movement?\n\nSet this property along with the bounds via `Camera.setBounds`.","name":"useBounds","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#useBounds","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#useBounds","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The World View is a Rectangle that defines the area of the 'world' the Camera is currently looking at.\nThis factors in the Camera viewport size, zoom and scroll position and is updated in the Camera preRender step.\nIf you have enabled Camera bounds the worldview will be clamped to those bounds accordingly.\nYou can use it for culling or intersection checks.","name":"worldView","type":{"names":["Phaser.Geom.Rectangle"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#worldView","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#worldView","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera dirty?\n\nA dirty Camera has had either its viewport size, bounds, scroll, rotation or zoom levels changed since the last frame.\n\nThis flag is cleared during the `postRenderCamera` method of the renderer.","name":"dirty","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#dirty","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#dirty","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":392,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Does this Camera have a transparent background?","name":"transparent","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#transparent","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#transparent","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":402,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The background color of this Camera. Only used if `transparent` is `false`.","name":"backgroundColor","type":{"names":["Phaser.Display.Color"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#backgroundColor","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#backgroundColor","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":411,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera alpha value. Setting this property impacts every single object that this Camera\nrenders. You can either set the property directly, i.e. via a Tween, to fade a Camera in or out,\nor via the chainable `setAlpha` method instead.","name":"alpha","type":{"names":["number"]},"defaultvalue":"1","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#alpha","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#alpha","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":422,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Should the camera cull Game Objects before checking them for input hit tests?\nIn some special cases it may be beneficial to disable this.","name":"disableCull","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#disableCull","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#disableCull","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":444,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The mid-point of the Camera in 'world' coordinates.\n\nUse it to obtain exactly where in the world the center of the camera is currently looking.\n\nThis value is updated in the preRender method, after the scroll values and follower\nhave been processed.","name":"midPoint","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#midPoint","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#midPoint","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":459,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The horizontal origin of rotation for this Camera.\n\nBy default the camera rotates around the center of the viewport.\n\nChanging the origin allows you to adjust the point in the viewport from which rotation happens.\nA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.\n\nSee `setOrigin` to set both origins in a single, chainable call.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#originX","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#originX","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":476,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The vertical origin of rotation for this Camera.\n\nBy default the camera rotates around the center of the viewport.\n\nChanging the origin allows you to adjust the point in the viewport from which rotation happens.\nA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.\n\nSee `setOrigin` to set both origins in a single, chainable call.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#originY","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#originY","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":504,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Mask this Camera is using during render.\nSet the mask using the `setMask` method. Remove the mask using the `clearMask` method.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"nullable":true,"since":"3.17.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#mask","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#mask","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the Alpha level of this Camera. The alpha controls the opacity of the Camera as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.11.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The Camera alpha value.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setAlpha","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the rotation origin of this Camera.\n\nThe values are given in the range 0 to 1 and are only used when calculating Camera rotation.\n\nBy default the camera rotates around the center of the viewport.\n\nChanging the origin allows you to adjust the point in the viewport from which rotation happens.\nA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.","kind":"function","name":"setOrigin","since":"3.11.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setOrigin","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":570,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Calculates what the Camera.scrollX and scrollY values would need to be in order to move\nthe Camera so it is centered on the given x and y coordinates, without actually moving\nthe Camera there. The results are clamped based on the Camera bounds, if set.","kind":"function","name":"getScroll","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the values in. If not given a new Vector2 is created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The scroll coordinates stored in the `x` and `y` properties."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#getScroll","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#getScroll","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":603,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera horizontally so that it is centered on the given x coordinate, bounds allowing.\nCalling this does not change the scrollY value.","kind":"function","name":"centerOnX","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerOnX","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerOnX","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":630,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera vertically so that it is centered on the given y coordinate, bounds allowing.\nCalling this does not change the scrollX value.","kind":"function","name":"centerOnY","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerOnY","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerOnY","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":657,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera so that it is centered on the given coordinates, bounds allowing.","kind":"function","name":"centerOn","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerOn","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerOn","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":676,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera so that it is looking at the center of the Camera Bounds, if enabled.","kind":"function","name":"centerToBounds","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerToBounds","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerToBounds","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":701,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera so that it is re-centered based on its viewport size.","kind":"function","name":"centerToSize","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerToSize","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerToSize","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Takes an array of Game Objects and returns a new array featuring only those objects\nvisible by this camera.","kind":"function","name":"cull","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of Game Objects to cull.","name":"renderableObjects"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Game Objects visible to this Camera."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#cull","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#cull","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":798,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Converts the given `x` and `y` coordinates into World space, based on this Cameras transform.\nYou can optionally provide a Vector2, or similar object, to store the results in.","kind":"function","name":"getWorldPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position to convert to world space.","name":"x"},{"type":{"names":["number"]},"description":"The y position to convert to world space.","name":"y"},{"type":{"names":["object","Phaser.Math.Vector2"]},"optional":true,"description":"An optional object to store the results in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"An object holding the converted values in its `x` and `y` properties."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#getWorldPoint","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#getWorldPoint","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":866,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Given a Game Object, or an array of Game Objects, it will update all of their camera filter settings\nso that they are ignored by this Camera. This means they will not be rendered by this Camera.","kind":"function","name":"ignore","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group"]},"description":"The Game Object, or array of Game Objects, to be ignored by this Camera.","name":"entries"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#ignore","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#ignore","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":970,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Takes an x value and checks it's within the range of the Camera bounds, adjusting if required.\nDo not call this method if you are not using camera bounds.","kind":"function","name":"clampX","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The value to horizontally scroll clamp.","name":"x"}],"returns":[{"type":{"names":["number"]},"description":"The adjusted value to use as scrollX."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#clampX","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#clampX","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1002,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Takes a y value and checks it's within the range of the Camera bounds, adjusting if required.\nDo not call this method if you are not using camera bounds.","kind":"function","name":"clampY","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The value to vertically scroll clamp.","name":"y"}],"returns":[{"type":{"names":["number"]},"description":"The adjusted value to use as scrollY."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#clampY","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#clampY","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1039,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has previously had movement bounds set on it, this will remove them.","kind":"function","name":"removeBounds","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#removeBounds","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#removeBounds","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1058,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the rotation of this Camera. This causes everything it renders to appear rotated.\n\nRotating a camera does not rotate the viewport itself, it is applied during rendering.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The cameras angle of rotation, given in degrees.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setAngle","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setAngle","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1079,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the background color for this Camera.\n\nBy default a Camera has a transparent background but it can be given a solid color, with any level\nof transparency, via this method.\n\nThe color value can be specified using CSS color notation, hex or numbers.","kind":"function","name":"setBackgroundColor","since":"3.0.0","params":[{"type":{"names":["string","number","Phaser.Types.Display.InputColorObject"]},"optional":true,"defaultvalue":"'rgba(0,0,0,0)'","description":"The color value. In CSS, hex or numeric color notation.","name":"color"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setBackgroundColor","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setBackgroundColor","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the bounds of the Camera. The bounds are an axis-aligned rectangle.\n\nThe Camera bounds controls where the Camera can scroll to, stopping it from scrolling off the\nedges and into blank space. It does not limit the placement of Game Objects, or where\nthe Camera viewport can be positioned.\n\nTemporarily disable the bounds by changing the boolean `Camera.useBounds`.\n\nClear the bounds entirely by calling `Camera.removeBounds`.\n\nIf you set bounds that are smaller than the viewport it will stop the Camera from being\nable to scroll. The bounds can be positioned where-ever you wish. By default they are from\n0x0 to the canvas width x height. This means that the coordinate 0x0 is the top left of\nthe Camera bounds. However, you can position them anywhere. So if you wanted a game world\nthat was 2048x2048 in size, with 0x0 being the center of it, you can set the bounds x/y\nto be -1024, -1024, with a width and height of 2048. Depending on your game you may find\nit easier for 0x0 to be the top-left of the bounds, or you may wish 0x0 to be the middle.","kind":"function","name":"setBounds","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The top-left x coordinate of the bounds.","name":"x"},{"type":{"names":["integer"]},"description":"The top-left y coordinate of the bounds.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the bounds, in pixels.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the bounds, in pixels.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the Camera will automatically be centered on the new bounds.","name":"centerOn"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setBounds","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setBounds","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Returns a rectangle containing the bounds of the Camera.\n\nIf the Camera does not have any bounds the rectangle will be empty.\n\nThe rectangle is a copy of the bounds, so is safe to modify.","kind":"function","name":"getBounds","since":"3.16.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"An optional Rectangle to store the bounds in. If not given, a new Rectangle will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A rectangle containing the bounds of this Camera."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#getBounds","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#getBounds","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the name of this Camera.\nThis value is for your own use and isn't used internally.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The name of the Camera.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setName","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setName","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the position of the Camera viewport within the game.\n\nThis does not change where the camera is 'looking'. See `setScroll` to control that.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the Camera viewport.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The top-left y coordinate of the Camera viewport.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setPosition","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setPosition","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the rotation of this Camera. This causes everything it renders to appear rotated.\n\nRotating a camera does not rotate the viewport itself, it is applied during rendering.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of the Camera, in radians.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setRotation","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setRotation","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1246,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Should the Camera round pixel values to whole integers when rendering Game Objects?\n\nIn some types of game, especially with pixel art, this is required to prevent sub-pixel aliasing.","kind":"function","name":"setRoundPixels","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to round Camera pixels, `false` to not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setRoundPixels","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setRoundPixels","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1265,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the Scene the Camera is bound to.\n\nAlso populates the `resolution` property and updates the internal size values.","kind":"function","name":"setScene","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene the camera is bound to.","name":"scene"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setScene","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setScene","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1306,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the position of where the Camera is looking within the game.\nYou can also modify the properties `Camera.scrollX` and `Camera.scrollY` directly.\nUse this method, or the scroll properties, to move your camera around the game world.\n\nThis does not change where the camera viewport is placed. See `setPosition` to control that.","kind":"function","name":"setScroll","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the Camera in the game world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y coordinate of the Camera in the game world.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setScroll","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setScroll","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the size of the Camera viewport.\n\nBy default a Camera is the same size as the game, but can be made smaller via this method,\nallowing you to create mini-cam style effects by creating and positioning a smaller Camera\nviewport within your game.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The width of the Camera viewport.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"width","description":"The height of the Camera viewport.","name":"height"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setSize","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setSize","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1356,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"This method sets the position and size of the Camera viewport in a single call.\n\nIf you're trying to change where the Camera is looking at in your game, then see\nthe method `Camera.setScroll` instead. This method is for changing the viewport\nitself, not what the camera can see.\n\nBy default a Camera is the same size as the game, but can be made smaller via this method,\nallowing you to create mini-cam style effects by creating and positioning a smaller Camera\nviewport within your game.","kind":"function","name":"setViewport","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the Camera viewport.","name":"x"},{"type":{"names":["number"]},"description":"The top-left y coordinate of the Camera viewport.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the Camera viewport.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"width","description":"The height of the Camera viewport.","name":"height"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setViewport","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setViewport","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1387,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the zoom value of the Camera.\n\nChanging to a smaller value, such as 0.5, will cause the camera to 'zoom out'.\nChanging to a larger value, such as 2, will cause the camera to 'zoom in'.\n\nA value of 1 means 'no zoom' and is the default.\n\nChanging the zoom does not impact the Camera viewport in any way, it is only applied during rendering.","kind":"function","name":"setZoom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The zoom value of the Camera. The minimum it can be is 0.001.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setZoom","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setZoom","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1418,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the mask to be applied to this Camera during rendering.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\n\nBitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Camera it will be immediately replaced.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.\n\nNote: You cannot mask a Camera that has `renderToTexture` set.","kind":"function","name":"setMask","since":"3.17.0","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Camera will use when rendering.","name":"mask"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the mask translate along with the Camera, or be fixed in place and not impacted by the Cameras transform?","name":"fixedPosition"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setMask","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setMask","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Clears the mask that this Camera was using.","kind":"function","name":"clearMask","since":"3.17.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#clearMask","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#clearMask","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1475,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the visibility of this Camera.\n\nAn invisible Camera will skip rendering and input tests of everything it can see.","kind":"function","name":"setVisible","since":"3.10.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Camera.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setVisible","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setVisible","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1488,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Returns an Object suitable for JSON storage containing all of the Camera viewport and rendering properties.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Cameras.Scene2D.JSONCamera"]},"description":"A well-formed object suitable for conversion to JSON."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#toJSON","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#toJSON","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1660,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The width of the Camera viewport, in pixels.\n\nThe viewport is the area into which the Camera renders. Setting the viewport does\nnot restrict where the Camera can scroll to.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#width","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#width","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1686,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The height of the Camera viewport, in pixels.\n\nThe viewport is the area into which the Camera renders. Setting the viewport does\nnot restrict where the Camera can scroll to.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#height","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#height","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1712,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The horizontal scroll position of this Camera.\n\nChange this value to cause the Camera to scroll around your Scene.\n\nAlternatively, setting the Camera to follow a Game Object, via the `startFollow` method,\nwill automatically adjust the Camera scroll values accordingly.\n\nYou can set the bounds within which the Camera can scroll via the `setBounds` method.","name":"scrollX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#scrollX","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#scrollX","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The vertical scroll position of this Camera.\n\nChange this value to cause the Camera to scroll around your Scene.\n\nAlternatively, setting the Camera to follow a Game Object, via the `startFollow` method,\nwill automatically adjust the Camera scroll values accordingly.\n\nYou can set the bounds within which the Camera can scroll via the `setBounds` method.","name":"scrollY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#scrollY","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#scrollY","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1772,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera zoom value. Change this value to zoom in, or out of, a Scene.\n\nA value of 0.5 would zoom the Camera out, so you can now see twice as much\nof the Scene as before. A value of 2 would zoom the Camera in, so every pixel\nnow takes up 2 pixels when rendered.\n\nSet to 1 to return to the default zoom level.\n\nBe careful to never set this value to zero.","name":"zoom","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#zoom","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#zoom","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1833,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The horizontal position of the center of the Camera's viewport, relative to the left of the game canvas.","name":"centerX","type":{"names":["number"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerX","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerX","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1850,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The vertical position of the center of the Camera's viewport, relative to the top of the game canvas.","name":"centerY","type":{"names":["number"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerY","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerY","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1867,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The displayed width of the camera viewport, factoring in the camera zoom level.\n\nIf a camera has a viewport width of 800 and a zoom of 0.5 then its display width\nwould be 1600, as it's displaying twice as many pixels as zoom level 1.\n\nEqually, a camera with a width of 800 and zoom of 2 would have a display width\nof 400 pixels.","name":"displayWidth","type":{"names":["number"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1890,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The displayed height of the camera viewport, factoring in the camera zoom level.\n\nIf a camera has a viewport height of 600 and a zoom of 0.5 then its display height\nwould be 1200, as it's displaying twice as many pixels as zoom level 1.\n\nEqually, a camera with a height of 600 and zoom of 2 would have a display height\nof 300 pixels.","name":"displayHeight","type":{"names":["number"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"String based identifier for the type of curve.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#type","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#type","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The default number of divisions within the curve.","name":"defaultDivisions","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#defaultDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#defaultDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The quantity of arc length divisions within the curve.","name":"arcLengthDivisions","type":{"names":["integer"]},"defaultvalue":"100","since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#arcLengthDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#arcLengthDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"An array of cached arc length values.","name":"cacheArcLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#cacheArcLengths","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#cacheArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Does the data of this curve need updating?","name":"needsUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#needsUpdate","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#needsUpdate","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"For a curve on a Path, `false` means the Path will ignore this curve.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#active","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#active","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a Rectangle where the position and dimensions match the bounds of this Curve.\n\nYou can control the accuracy of the bounds. The value given is used to work out how many points\nto plot across the curve. Higher values are more accurate at the cost of calculation speed.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the bounds in. If falsey a new object will be created.","name":"out"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":16,"description":"The accuracy of the bounds calculations.","name":"accuracy"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A Rectangle object holding the bounds of this curve. If `out` was given it will be this object."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getBounds","scope":"instance","inherits":"Phaser.Curves.Curve#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns an array of points, spaced out X distance pixels apart.\nThe smaller the distance, the larger the array will be.","kind":"function","name":"getDistancePoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The distance, in pixels, between each point along the curve.","name":"distance"}],"returns":[{"type":{"names":["Array."]},"description":"An Array of Point objects."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getDistancePoints","scope":"instance","inherits":"Phaser.Curves.Curve#getDistancePoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the end of the curve.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"Optional Vector object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector2 containing the coordinates of the curves end point."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getEndPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getEndPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get total curve arc length","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the curve."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getLength","scope":"instance","inherits":"Phaser.Curves.Curve#getLength","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a list of cumulative segment lengths.\n\nThese lengths are\n\n- [0] 0\n- [1] The first segment\n- [2] The first and second segment\n- ...\n- [divisions] All segments","kind":"function","name":"getLengths","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions or segments.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cumulative lengths."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getLengths","scope":"instance","inherits":"Phaser.Curves.Curve#getLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at a relative position on the curve, by arc length.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getPointAt","scope":"instance","inherits":"Phaser.Curves.Curve#getPointAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of evenly spaced points from the curve.\n\nYou can pass `divisions`, `stepRate`, or neither.\n\nThe number of divisions will be\n\n1. `divisions`, if `divisions` > 0; or\n2. `this.getLength / stepRate`, if `stepRate` > 0; or\n3. `this.defaultDivisions`\n\n`1 + divisions` points will be returned.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"The curve distance between points, implying `divisions`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the curve."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a random point from the curve.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getRandomPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getRandomPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of equally spaced points (by arc distance) from the curve.\n\n`1 + divisions` points will be returned.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.defaultDivisions","description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array of points."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getSpacedPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getSpacedPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve.\nIn case any sub curve does not implement its tangent derivation,\n2 points a small delta apart will be used to find its gradient\nwhich seems to give a reasonable approximation","kind":"function","name":"getTangent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector approximating the tangent line at the point t (delta +/- 0.0001)"}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getTangent","scope":"instance","inherits":"Phaser.Curves.Curve#getTangent","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve, by arc length.","kind":"function","name":"getTangentAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getTangentAt","scope":"instance","inherits":"Phaser.Curves.Curve#getTangentAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getTFromDistance","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getTFromDistance","scope":"instance","inherits":"Phaser.Curves.Curve#getTFromDistance","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getUtoTmapping","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"u"},{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getUtoTmapping","scope":"instance","inherits":"Phaser.Curves.Curve#getUtoTmapping","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Calculate and cache the arc lengths.","kind":"function","name":"updateArcLengths","since":"3.0.0","see":["Phaser.Curves.Curve#getLengths()"],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#updateArcLengths","scope":"instance","inherits":"Phaser.Curves.Curve#updateArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"String based identifier for the type of curve.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#type","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#type","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The default number of divisions within the curve.","name":"defaultDivisions","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#defaultDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#defaultDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The quantity of arc length divisions within the curve.","name":"arcLengthDivisions","type":{"names":["integer"]},"defaultvalue":"100","since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#arcLengthDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#arcLengthDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"An array of cached arc length values.","name":"cacheArcLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#cacheArcLengths","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#cacheArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Does the data of this curve need updating?","name":"needsUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#needsUpdate","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#needsUpdate","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"For a curve on a Path, `false` means the Path will ignore this curve.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#active","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#active","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":111,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Draws this curve on the given Graphics object.\n\nThe curve is drawn using `Graphics.strokePoints` so will be drawn at whatever the present Graphics stroke color is.\nThe Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.","kind":"function","name":"draw","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics instance onto which this curve will be drawn.","name":"graphics"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The resolution of the curve. The higher the value the smoother it will render, at the cost of rendering performance.","name":"pointsTotal"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to which the curve was drawn."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#draw","scope":"instance","inherits":"Phaser.Curves.Curve#draw","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a Rectangle where the position and dimensions match the bounds of this Curve.\n\nYou can control the accuracy of the bounds. The value given is used to work out how many points\nto plot across the curve. Higher values are more accurate at the cost of calculation speed.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the bounds in. If falsey a new object will be created.","name":"out"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":16,"description":"The accuracy of the bounds calculations.","name":"accuracy"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A Rectangle object holding the bounds of this curve. If `out` was given it will be this object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getBounds","scope":"instance","inherits":"Phaser.Curves.Curve#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns an array of points, spaced out X distance pixels apart.\nThe smaller the distance, the larger the array will be.","kind":"function","name":"getDistancePoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The distance, in pixels, between each point along the curve.","name":"distance"}],"returns":[{"type":{"names":["Array."]},"description":"An Array of Point objects."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getDistancePoints","scope":"instance","inherits":"Phaser.Curves.Curve#getDistancePoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the end of the curve.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"Optional Vector object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector2 containing the coordinates of the curves end point."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getEndPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getEndPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get total curve arc length","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the curve."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getLength","scope":"instance","inherits":"Phaser.Curves.Curve#getLength","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a list of cumulative segment lengths.\n\nThese lengths are\n\n- [0] 0\n- [1] The first segment\n- [2] The first and second segment\n- ...\n- [divisions] All segments","kind":"function","name":"getLengths","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions or segments.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cumulative lengths."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getLengths","scope":"instance","inherits":"Phaser.Curves.Curve#getLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at a relative position on the curve, by arc length.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getPointAt","scope":"instance","inherits":"Phaser.Curves.Curve#getPointAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of evenly spaced points from the curve.\n\nYou can pass `divisions`, `stepRate`, or neither.\n\nThe number of divisions will be\n\n1. `divisions`, if `divisions` > 0; or\n2. `this.getLength / stepRate`, if `stepRate` > 0; or\n3. `this.defaultDivisions`\n\n`1 + divisions` points will be returned.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"The curve distance between points, implying `divisions`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the curve."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a random point from the curve.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getRandomPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getRandomPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of equally spaced points (by arc distance) from the curve.\n\n`1 + divisions` points will be returned.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.defaultDivisions","description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array of points."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getSpacedPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getSpacedPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve.\nIn case any sub curve does not implement its tangent derivation,\n2 points a small delta apart will be used to find its gradient\nwhich seems to give a reasonable approximation","kind":"function","name":"getTangent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector approximating the tangent line at the point t (delta +/- 0.0001)"}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getTangent","scope":"instance","inherits":"Phaser.Curves.Curve#getTangent","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve, by arc length.","kind":"function","name":"getTangentAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getTangentAt","scope":"instance","inherits":"Phaser.Curves.Curve#getTangentAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getTFromDistance","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getTFromDistance","scope":"instance","inherits":"Phaser.Curves.Curve#getTFromDistance","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getUtoTmapping","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"u"},{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getUtoTmapping","scope":"instance","inherits":"Phaser.Curves.Curve#getUtoTmapping","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Calculate and cache the arc lengths.","kind":"function","name":"updateArcLengths","since":"3.0.0","see":["Phaser.Curves.Curve#getLengths()"],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#updateArcLengths","scope":"instance","inherits":"Phaser.Curves.Curve#updateArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"String based identifier for the type of curve.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#type","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#type","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The default number of divisions within the curve.","name":"defaultDivisions","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#defaultDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#defaultDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"An array of cached arc length values.","name":"cacheArcLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#cacheArcLengths","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#cacheArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Does the data of this curve need updating?","name":"needsUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#needsUpdate","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#needsUpdate","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"For a curve on a Path, `false` means the Path will ignore this curve.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#active","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#active","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns an array of points, spaced out X distance pixels apart.\nThe smaller the distance, the larger the array will be.","kind":"function","name":"getDistancePoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The distance, in pixels, between each point along the curve.","name":"distance"}],"returns":[{"type":{"names":["Array."]},"description":"An Array of Point objects."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getDistancePoints","scope":"instance","inherits":"Phaser.Curves.Curve#getDistancePoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the end of the curve.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"Optional Vector object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector2 containing the coordinates of the curves end point."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getEndPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getEndPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get total curve arc length","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the curve."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getLength","scope":"instance","inherits":"Phaser.Curves.Curve#getLength","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a list of cumulative segment lengths.\n\nThese lengths are\n\n- [0] 0\n- [1] The first segment\n- [2] The first and second segment\n- ...\n- [divisions] All segments","kind":"function","name":"getLengths","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions or segments.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cumulative lengths."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getLengths","scope":"instance","inherits":"Phaser.Curves.Curve#getLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of evenly spaced points from the curve.\n\nYou can pass `divisions`, `stepRate`, or neither.\n\nThe number of divisions will be\n\n1. `divisions`, if `divisions` > 0; or\n2. `this.getLength / stepRate`, if `stepRate` > 0; or\n3. `this.defaultDivisions`\n\n`1 + divisions` points will be returned.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"The curve distance between points, implying `divisions`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the curve."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a random point from the curve.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getRandomPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getRandomPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of equally spaced points (by arc distance) from the curve.\n\n`1 + divisions` points will be returned.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.defaultDivisions","description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array of points."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getSpacedPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getSpacedPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve, by arc length.","kind":"function","name":"getTangentAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getTangentAt","scope":"instance","inherits":"Phaser.Curves.Curve#getTangentAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getTFromDistance","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getTFromDistance","scope":"instance","inherits":"Phaser.Curves.Curve#getTFromDistance","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Calculate and cache the arc lengths.","kind":"function","name":"updateArcLengths","since":"3.0.0","see":["Phaser.Curves.Curve#getLengths()"],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#updateArcLengths","scope":"instance","inherits":"Phaser.Curves.Curve#updateArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"String based identifier for the type of curve.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#type","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#type","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The default number of divisions within the curve.","name":"defaultDivisions","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#defaultDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#defaultDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The quantity of arc length divisions within the curve.","name":"arcLengthDivisions","type":{"names":["integer"]},"defaultvalue":"100","since":"3.0.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#arcLengthDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#arcLengthDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"An array of cached arc length values.","name":"cacheArcLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#cacheArcLengths","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#cacheArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Does the data of this curve need updating?","name":"needsUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#needsUpdate","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#needsUpdate","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"For a curve on a Path, `false` means the Path will ignore this curve.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#active","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#active","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a Rectangle where the position and dimensions match the bounds of this Curve.\n\nYou can control the accuracy of the bounds. The value given is used to work out how many points\nto plot across the curve. Higher values are more accurate at the cost of calculation speed.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the bounds in. If falsey a new object will be created.","name":"out"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":16,"description":"The accuracy of the bounds calculations.","name":"accuracy"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A Rectangle object holding the bounds of this curve. If `out` was given it will be this object."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getBounds","scope":"instance","inherits":"Phaser.Curves.Curve#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns an array of points, spaced out X distance pixels apart.\nThe smaller the distance, the larger the array will be.","kind":"function","name":"getDistancePoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The distance, in pixels, between each point along the curve.","name":"distance"}],"returns":[{"type":{"names":["Array."]},"description":"An Array of Point objects."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getDistancePoints","scope":"instance","inherits":"Phaser.Curves.Curve#getDistancePoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the end of the curve.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"Optional Vector object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector2 containing the coordinates of the curves end point."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getEndPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getEndPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get total curve arc length","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the curve."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getLength","scope":"instance","inherits":"Phaser.Curves.Curve#getLength","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a list of cumulative segment lengths.\n\nThese lengths are\n\n- [0] 0\n- [1] The first segment\n- [2] The first and second segment\n- ...\n- [divisions] All segments","kind":"function","name":"getLengths","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions or segments.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cumulative lengths."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getLengths","scope":"instance","inherits":"Phaser.Curves.Curve#getLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at a relative position on the curve, by arc length.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getPointAt","scope":"instance","inherits":"Phaser.Curves.Curve#getPointAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of evenly spaced points from the curve.\n\nYou can pass `divisions`, `stepRate`, or neither.\n\nThe number of divisions will be\n\n1. `divisions`, if `divisions` > 0; or\n2. `this.getLength / stepRate`, if `stepRate` > 0; or\n3. `this.defaultDivisions`\n\n`1 + divisions` points will be returned.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"The curve distance between points, implying `divisions`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the curve."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a random point from the curve.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getRandomPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getRandomPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of equally spaced points (by arc distance) from the curve.\n\n`1 + divisions` points will be returned.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.defaultDivisions","description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array of points."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getSpacedPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getSpacedPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve.\nIn case any sub curve does not implement its tangent derivation,\n2 points a small delta apart will be used to find its gradient\nwhich seems to give a reasonable approximation","kind":"function","name":"getTangent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector approximating the tangent line at the point t (delta +/- 0.0001)"}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getTangent","scope":"instance","inherits":"Phaser.Curves.Curve#getTangent","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve, by arc length.","kind":"function","name":"getTangentAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getTangentAt","scope":"instance","inherits":"Phaser.Curves.Curve#getTangentAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getTFromDistance","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getTFromDistance","scope":"instance","inherits":"Phaser.Curves.Curve#getTFromDistance","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getUtoTmapping","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"u"},{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getUtoTmapping","scope":"instance","inherits":"Phaser.Curves.Curve#getUtoTmapping","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Calculate and cache the arc lengths.","kind":"function","name":"updateArcLengths","since":"3.0.0","see":["Phaser.Curves.Curve#getLengths()"],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#updateArcLengths","scope":"instance","inherits":"Phaser.Curves.Curve#updateArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"String based identifier for the type of curve.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#type","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#type","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The default number of divisions within the curve.","name":"defaultDivisions","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#defaultDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#defaultDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The quantity of arc length divisions within the curve.","name":"arcLengthDivisions","type":{"names":["integer"]},"defaultvalue":"100","since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#arcLengthDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#arcLengthDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"An array of cached arc length values.","name":"cacheArcLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#cacheArcLengths","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#cacheArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Does the data of this curve need updating?","name":"needsUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#needsUpdate","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#needsUpdate","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"For a curve on a Path, `false` means the Path will ignore this curve.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#active","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#active","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":111,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Draws this curve on the given Graphics object.\n\nThe curve is drawn using `Graphics.strokePoints` so will be drawn at whatever the present Graphics stroke color is.\nThe Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.","kind":"function","name":"draw","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics instance onto which this curve will be drawn.","name":"graphics"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The resolution of the curve. The higher the value the smoother it will render, at the cost of rendering performance.","name":"pointsTotal"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to which the curve was drawn."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#draw","scope":"instance","inherits":"Phaser.Curves.Curve#draw","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a Rectangle where the position and dimensions match the bounds of this Curve.\n\nYou can control the accuracy of the bounds. The value given is used to work out how many points\nto plot across the curve. Higher values are more accurate at the cost of calculation speed.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the bounds in. If falsey a new object will be created.","name":"out"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":16,"description":"The accuracy of the bounds calculations.","name":"accuracy"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A Rectangle object holding the bounds of this curve. If `out` was given it will be this object."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getBounds","scope":"instance","inherits":"Phaser.Curves.Curve#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns an array of points, spaced out X distance pixels apart.\nThe smaller the distance, the larger the array will be.","kind":"function","name":"getDistancePoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The distance, in pixels, between each point along the curve.","name":"distance"}],"returns":[{"type":{"names":["Array."]},"description":"An Array of Point objects."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getDistancePoints","scope":"instance","inherits":"Phaser.Curves.Curve#getDistancePoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the end of the curve.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"Optional Vector object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector2 containing the coordinates of the curves end point."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getEndPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getEndPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get total curve arc length","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the curve."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getLength","scope":"instance","inherits":"Phaser.Curves.Curve#getLength","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a list of cumulative segment lengths.\n\nThese lengths are\n\n- [0] 0\n- [1] The first segment\n- [2] The first and second segment\n- ...\n- [divisions] All segments","kind":"function","name":"getLengths","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions or segments.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cumulative lengths."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getLengths","scope":"instance","inherits":"Phaser.Curves.Curve#getLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at a relative position on the curve, by arc length.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getPointAt","scope":"instance","inherits":"Phaser.Curves.Curve#getPointAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of evenly spaced points from the curve.\n\nYou can pass `divisions`, `stepRate`, or neither.\n\nThe number of divisions will be\n\n1. `divisions`, if `divisions` > 0; or\n2. `this.getLength / stepRate`, if `stepRate` > 0; or\n3. `this.defaultDivisions`\n\n`1 + divisions` points will be returned.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"The curve distance between points, implying `divisions`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the curve."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a random point from the curve.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getRandomPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getRandomPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of equally spaced points (by arc distance) from the curve.\n\n`1 + divisions` points will be returned.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.defaultDivisions","description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array of points."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getSpacedPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getSpacedPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve.\nIn case any sub curve does not implement its tangent derivation,\n2 points a small delta apart will be used to find its gradient\nwhich seems to give a reasonable approximation","kind":"function","name":"getTangent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector approximating the tangent line at the point t (delta +/- 0.0001)"}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getTangent","scope":"instance","inherits":"Phaser.Curves.Curve#getTangent","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve, by arc length.","kind":"function","name":"getTangentAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getTangentAt","scope":"instance","inherits":"Phaser.Curves.Curve#getTangentAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getTFromDistance","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getTFromDistance","scope":"instance","inherits":"Phaser.Curves.Curve#getTFromDistance","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getUtoTmapping","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"u"},{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getUtoTmapping","scope":"instance","inherits":"Phaser.Curves.Curve#getUtoTmapping","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Calculate and cache the arc lengths.","kind":"function","name":"updateArcLengths","since":"3.0.0","see":["Phaser.Curves.Curve#getLengths()"],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#updateArcLengths","scope":"instance","inherits":"Phaser.Curves.Curve#updateArcLengths","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The object that this DataManager belongs to.","name":"parent","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#parent","scope":"instance","kind":"member","inherits":"Phaser.Data.DataManager#parent","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The DataManager's event emitter.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#events","scope":"instance","kind":"member","inherits":"Phaser.Data.DataManager#events","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The data list.","name":"list","type":{"names":["Object."]},"defaultvalue":"{}","since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#list","scope":"instance","kind":"member","inherits":"Phaser.Data.DataManager#list","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The public values list. You can use this to access anything you have stored\nin this Data Manager. For example, if you set a value called `gold` you can\naccess it via:\n\n```javascript\nthis.data.values.gold;\n```\n\nYou can also modify it directly:\n\n```javascript\nthis.data.values.gold += 1000;\n```\n\nDoing so will emit a `setdata` event from the parent of this Data Manager.\n\nDo not modify this object directly. Adding properties directly to this object will not\nemit any events. Always use `DataManager.set` to create new items the first time around.","name":"values","type":{"names":["Object."]},"defaultvalue":"{}","since":"3.10.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#values","scope":"instance","kind":"member","inherits":"Phaser.Data.DataManager#values","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":116,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Retrieves the value for the given key, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nthis.data.get('gold');\n```\n\nOr access the value directly:\n\n```javascript\nthis.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nthis.data.get([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#get","scope":"instance","inherits":"Phaser.Data.DataManager#get","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Retrieves all data values in a new object.","kind":"function","name":"getAll","since":"3.0.0","returns":[{"type":{"names":["Object."]},"description":"All data values."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#getAll","scope":"instance","inherits":"Phaser.Data.DataManager#getAll","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Queries the DataManager for the values of keys matching the given regular expression.","kind":"function","name":"query","since":"3.0.0","params":[{"type":{"names":["RegExp"]},"description":"A regular expression object. If a non-RegExp object obj is passed, it is implicitly converted to a RegExp by using new RegExp(obj).","name":"search"}],"returns":[{"type":{"names":["Object."]},"description":"The values of the keys matching the search string."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#query","scope":"instance","inherits":"Phaser.Data.DataManager#query","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Sets a value for the given key. If the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\ndata.set('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\ndata.set({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `get`:\n\n```javascript\ndata.get('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\ndata.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"set","fires":["Phaser.Data.Events#event:SET_DATA","Phaser.Data.Events#event:CHANGE_DATA","Phaser.Data.Events#event:CHANGE_DATA_KEY"],"since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object or key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#set","scope":"instance","inherits":"Phaser.Data.DataManager#set","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Passes all data entries to the given callback.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["DataEachCallback"]},"description":"The function to call.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"Value to use as `this` when executing callback.","name":"context"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the game object, key, and data.","name":"args"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#each","scope":"instance","inherits":"Phaser.Data.DataManager#each","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":381,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Merge the given object of key value pairs into this DataManager.\n\nAny newly created values will emit a `setdata` event. Any updated values (see the `overwrite` argument)\nwill emit a `changedata` event.","kind":"function","name":"merge","fires":["Phaser.Data.Events#event:SET_DATA","Phaser.Data.Events#event:CHANGE_DATA","Phaser.Data.Events#event:CHANGE_DATA_KEY"],"since":"3.0.0","params":[{"type":{"names":["Object."]},"description":"The data to merge.","name":"data"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to overwrite existing data. Defaults to true.","name":"overwrite"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#merge","scope":"instance","inherits":"Phaser.Data.DataManager#merge","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":414,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Remove the value for the given key.\n\nIf the key is found in this Data Manager it is removed from the internal lists and a\n`removedata` event is emitted.\n\nYou can also pass in an array of keys, in which case all keys in the array will be removed:\n\n```javascript\nthis.data.remove([ 'gold', 'armor', 'health' ]);\n```","kind":"function","name":"remove","fires":["Phaser.Data.Events#event:REMOVE_DATA"],"since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key to remove, or an array of keys to remove.","name":"key"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#remove","scope":"instance","inherits":"Phaser.Data.DataManager#remove","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Retrieves the data associated with the given 'key', deletes it from this Data Manager, then returns it.","kind":"function","name":"pop","fires":["Phaser.Data.Events#event:REMOVE_DATA"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the value to retrieve and delete.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value of the given key."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#pop","scope":"instance","inherits":"Phaser.Data.DataManager#pop","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":511,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Determines whether the given key is set in this Data Manager.\n\nPlease note that the keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if the key exists, otherwise `false`."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#has","scope":"instance","inherits":"Phaser.Data.DataManager#has","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Freeze or unfreeze this Data Manager. A frozen Data Manager will block all attempts\nto create new values or update existing ones.","kind":"function","name":"setFreeze","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether to freeze or unfreeze the Data Manager.","name":"value"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#setFreeze","scope":"instance","inherits":"Phaser.Data.DataManager#setFreeze","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":547,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Delete all data in this Data Manager and unfreeze it.","kind":"function","name":"reset","since":"3.0.0","returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#reset","scope":"instance","inherits":"Phaser.Data.DataManager#reset","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":585,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Gets or sets the frozen state of this Data Manager.\nA frozen Data Manager will block all attempts to create new values or update existing ones.","name":"freeze","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#freeze","scope":"instance","kind":"member","inherits":"Phaser.Data.DataManager#freeze","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":607,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Return the total number of entries in this Data Manager.","name":"count","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#count","scope":"instance","kind":"member","inherits":"Phaser.Data.DataManager#count","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#texture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#frame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setTexture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The key of the Bitmap Font used by this Bitmap Text.\nTo change the font after creation please use `setFont`.","name":"font","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#font","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#font","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The data of the Bitmap Font used by this Bitmap Text.","name":"fontData","type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapFontData"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#fontData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#fontData","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The character code used to detect for word wrapping.\nDefaults to 32 (a space character).","name":"wordWrapCharCode","type":{"names":["number"]},"since":"3.21.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#wordWrapCharCode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#wordWrapCharCode","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":214,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the lines of text in this BitmapText to be left-aligned.\nThis only has any effect if this BitmapText contains more than one line of text.","kind":"function","name":"setLeftAlign","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setLeftAlign","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setLeftAlign","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":232,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the lines of text in this BitmapText to be center-aligned.\nThis only has any effect if this BitmapText contains more than one line of text.","kind":"function","name":"setCenterAlign","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setCenterAlign","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setCenterAlign","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":250,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the lines of text in this BitmapText to be right-aligned.\nThis only has any effect if this BitmapText contains more than one line of text.","kind":"function","name":"setRightAlign","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setRightAlign","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setRightAlign","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the font size of this Bitmap Text.","kind":"function","name":"setFontSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The font size to set.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setFontSize","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setFontSize","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Sets the letter spacing between each character of this Bitmap Text.\nCan be a positive value to increase the space, or negative to reduce it.\nSpacing is applied after the kerning values have been set.","kind":"function","name":"setLetterSpacing","since":"3.4.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The amount of horizontal space to add between each character.","name":"spacing"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setLetterSpacing","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setLetterSpacing","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the textual content of this BitmapText.\n\nAn array of strings will be converted into multi-line text. Use the align methods to change multi-line alignment.","kind":"function","name":"setText","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The string, or array of strings, to be set as the content of this BitmapText.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setText","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setText","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":346,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Calculate the bounds of this Bitmap Text.\n\nAn object is returned that contains the position, width and height of the Bitmap Text in local and global\ncontexts.\n\nLocal size is based on just the font size and a [0, 0] position.\n\nGlobal size takes into account the Game Object's scale, world position and display origin.\n\nAlso in the object is data regarding the length of each line, should this be a multi-line BitmapText.","kind":"function","name":"getTextBounds","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"description":"Whether to round the results to the nearest integer.","name":"round"}],"returns":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapTextSize"]},"description":"An object that describes the size of this Bitmap Text."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getTextBounds","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#getTextBounds","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Changes the font this BitmapText is using to render.\n\nThe new texture is loaded and applied to the BitmapText. The existing test, size and alignment are preserved,\nunless overridden via the arguments.","kind":"function","name":"setFont","since":"3.11.0","params":[{"type":{"names":["string"]},"description":"The key of the font to use from the Bitmap Font cache.","name":"font"},{"type":{"names":["number"]},"optional":true,"description":"The font size of this Bitmap Text. If not specified the current size will be used.","name":"size"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The alignment of the text in a multi-line BitmapText object. If not specified the current alignment will be used.","name":"align"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setFont","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setFont","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Sets the maximum display width of this BitmapText in pixels.\n\nIf `BitmapText.text` is longer than `maxWidth` then the lines will be automatically wrapped\nbased on the previous whitespace character found in the line.\n\nIf no whitespace was found then no wrapping will take place and consequently the `maxWidth` value will not be honored.\n\nDisable maxWidth by setting the value to 0.\n\nYou can set the whitespace character to be searched for by setting the `wordWrapCharCode` parameter or property.","kind":"function","name":"setMaxWidth","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The maximum display width of this BitmapText in pixels. Set to zero to disable.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"The character code to check for when word wrapping. Defaults to 32 (the space character).","name":"wordWrapCharCode"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setMaxWidth","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setMaxWidth","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":459,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Controls the alignment of each line of text in this BitmapText object.\n\nOnly has any effect when this BitmapText contains multiple lines of text, split with carriage-returns.\nHas no effect with single-lines of text.\n\nSee the methods `setLeftAlign`, `setCenterAlign` and `setRightAlign`.\n\n0 = Left aligned (default)\n1 = Middle aligned\n2 = Right aligned\n\nThe alignment position is based on the longest line of text.","name":"align","type":{"names":["integer"]},"since":"3.11.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#align","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#align","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":492,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The text that this Bitmap Text object displays.\n\nYou can also use the method `setText` if you want a chainable way to change the text content.","name":"text","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#text","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#text","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":515,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The font size of this Bitmap Text.\n\nYou can also use the method `setFontSize` if you want a chainable way to change the font size.","name":"fontSize","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#fontSize","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#fontSize","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":539,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Adds / Removes spacing between characters.\n\nCan be a negative or positive number.\n\nYou can also use the method `setLetterSpacing` if you want a chainable way to change the letter spacing.","name":"letterSpacing","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#letterSpacing","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#letterSpacing","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":565,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The maximum display width of this BitmapText in pixels.\n\nIf BitmapText.text is longer than maxWidth then the lines will be automatically wrapped\nbased on the last whitespace character found in the line.\n\nIf no whitespace was found then no wrapping will take place and consequently the maxWidth value will not be honored.\n\nDisable maxWidth by setting the value to 0.","name":"maxWidth","type":{"names":["number"]},"since":"3.21.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#maxWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#maxWidth","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":594,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The width of this Bitmap Text.","name":"width","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#width","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":613,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The height of this bitmap text.","name":"height","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#height","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Build a JSON representation of this Bitmap Text.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.JSONBitmapText"]},"description":"A JSON representation of this Bitmap Text."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#toJSON","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#texture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#frame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setTexture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#texture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#frame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setTexture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#texture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#frame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setTexture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The pool of Lights.\n\nUsed to recycle removed Lights for a more efficient use of memory.","name":"lightPool","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#lightPool","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.LightsManager#lightPool","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The Lights in the Scene.","name":"lights","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#lights","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.LightsManager#lights","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Lights that have been culled from a Camera's viewport.\n\nLights in this list will not be rendered.","name":"culledLights","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#culledLights","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.LightsManager#culledLights","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The ambient color.","name":"ambientColor","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#ambientColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.LightsManager#ambientColor","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Whether the Lights Manager is enabled.","name":"active","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.LightsManager#active","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The maximum number of lights that a single Camera and the lights shader can process.\nChange this via the `maxLights` property in your game config, as it cannot be changed at runtime.","name":"maxLights","type":{"names":["integer"]},"readonly":true,"since":"3.15.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#maxLights","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.LightsManager#maxLights","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":99,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Enable the Lights Manager.","kind":"function","name":"enable","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#enable","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#enable","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":119,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Disable the Lights Manager.","kind":"function","name":"disable","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#disable","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#disable","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Cull any Lights that aren't visible to the given Camera.\n\nCulling Lights improves performance by ensuring that only Lights within a Camera's viewport are rendered.","kind":"function","name":"cull","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to cull Lights for.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"The culled Lights."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#cull","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#cull","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Iterate over each Light with a callback.","kind":"function","name":"forEachLight","since":"3.0.0","params":[{"type":{"names":["LightForEach"]},"description":"The callback that is called with each Light.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#forEachLight","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#forEachLight","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the ambient light color.","kind":"function","name":"setAmbientColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The integer RGB color of the ambient light.","name":"rgb"}],"returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#setAmbientColor","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#setAmbientColor","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Returns the maximum number of Lights allowed to appear at once.","kind":"function","name":"getMaxVisibleLights","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The maximum number of Lights allowed to appear at once."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#getMaxVisibleLights","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#getMaxVisibleLights","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Get the number of Lights managed by this Lights Manager.","kind":"function","name":"getLightCount","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of Lights managed by this Lights Manager."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#getLightCount","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#getLightCount","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Add a Light.","kind":"function","name":"addLight","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the Light.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the Light.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"The radius of the Light.","name":"radius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xffffff","description":"The integer RGB color of the light.","name":"rgb"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The intensity of the Light.","name":"intensity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"The Light that was added."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#addLight","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#addLight","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Remove a Light.","kind":"function","name":"removeLight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"The Light to remove.","name":"light"}],"returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#removeLight","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#removeLight","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Shut down the Lights Manager.\n\nRecycles all active Lights into the Light pool, resets ambient light color and clears the lists of Lights and\nculled Lights.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#shutdown","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#shutdown","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#texture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#frame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setTexture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"The Animation Controller of this Sprite.","name":"anims","type":{"names":["Phaser.GameObjects.Components.Animation"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#anims","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Sprite#anims","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Start playing the given animation.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If an animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#play","scope":"instance","inherits":"Phaser.GameObjects.Sprite#play","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Build a JSON representation of this Sprite.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#toJSON","scope":"instance","inherits":"Phaser.GameObjects.Sprite#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":23,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Path this PathFollower is following. It can only follow one Path at a time.","name":"path","type":{"names":["Phaser.Curves.Path"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#path","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.PathFollower#path","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Should the PathFollower automatically rotate to point in the direction of the Path?","name":"rotateToPath","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#rotateToPath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.PathFollower#rotateToPath","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":102,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Path that this PathFollower should follow.\n\nOptionally accepts {@link Phaser.Types.GameObjects.PathFollower.PathConfig} settings.","kind":"function","name":"setPath","since":"3.0.0","params":[{"type":{"names":["Phaser.Curves.Path"]},"description":"The Path this PathFollower is following. It can only follow one Path at a time.","name":"path"},{"type":{"names":["number","Phaser.Types.GameObjects.PathFollower.PathConfig","Phaser.Types.Tweens.NumberTweenBuilderConfig"]},"optional":true,"description":"Settings for the PathFollower.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setPath","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#setPath","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set whether the PathFollower should automatically rotate to point in the direction of the Path.","kind":"function","name":"setRotateToPath","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether the PathFollower should automatically rotate to point in the direction of the Path.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Rotation offset in degrees.","name":"offset"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setRotateToPath","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#setRotateToPath","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Is this PathFollower actively following a Path or not?\n\nTo be considered as `isFollowing` it must be currently moving on a Path, and not paused.","kind":"function","name":"isFollowing","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` is this PathFollower is actively following a Path, otherwise `false`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#isFollowing","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#isFollowing","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Starts this PathFollower following its given Path.","kind":"function","name":"startFollow","since":"3.3.0","params":[{"type":{"names":["number","Phaser.Types.GameObjects.PathFollower.PathConfig","Phaser.Types.Tweens.NumberTweenBuilderConfig"]},"optional":true,"defaultvalue":"{}","description":"The duration of the follow, or a PathFollower config object.","name":"config"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional start position of the follow, between 0 and 1.","name":"startAt"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#startFollow","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#startFollow","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":267,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Pauses this PathFollower. It will still continue to render, but it will remain motionless at the\npoint on the Path at which you paused it.","kind":"function","name":"pauseFollow","since":"3.3.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pauseFollow","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#pauseFollow","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":288,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resumes a previously paused PathFollower.\n\nIf the PathFollower was not paused this has no effect.","kind":"function","name":"resumeFollow","since":"3.3.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#resumeFollow","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#resumeFollow","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Stops this PathFollower from following the path any longer.\n\nThis will invoke any 'stop' conditions that may exist on the Path, or for the follower.","kind":"function","name":"stopFollow","since":"3.3.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#stopFollow","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#stopFollow","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Internal update handler that advances this PathFollower along the path.\n\nCalled automatically by the Scene step, should not typically be called directly.","kind":"function","name":"pathUpdate","since":"3.17.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pathUpdate","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#pathUpdate","inherited":true,"___s":true},{"meta":{"filename":"Mesh.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the vertices data for this Mesh.","name":"vertices","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#vertices","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Mesh#vertices","inherited":true,"___s":true},{"meta":{"filename":"Mesh.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the uv data for this Mesh.","name":"uv","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#uv","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Mesh#uv","inherited":true,"___s":true},{"meta":{"filename":"Mesh.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the color data for this Mesh.","name":"colors","type":{"names":["Uint32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#colors","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Mesh#colors","inherited":true,"___s":true},{"meta":{"filename":"Mesh.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the alpha data for this Mesh.","name":"alphas","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#alphas","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Mesh#alphas","inherited":true,"___s":true},{"meta":{"filename":"Mesh.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"Fill or additive mode used when blending the color values?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Mesh#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Mesh.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"This method is left intentionally empty and does not do anything.\nIt is retained to allow a Mesh or Quad to be added to a Container.","kind":"function","name":"setAlpha","since":"3.17.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Mesh#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#texture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#frame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setTexture","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Crop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.Crop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#texture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#frame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setTexture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rope"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rope","longname":"Phaser.GameObjects.Rope#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Crop#texture","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":25,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Crop#frame","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Crop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.Crop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Crop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.Crop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"`this`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"`this`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"`this`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"`this`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"`this`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"`this`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#onFileComplete","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileComplete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#onFileComplete","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileComplete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#onFileComplete","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileComplete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Usually overridden by the FileTypes and is called by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data, for example a JSON file will parse itself during this stage.","kind":"function","name":"onProcess","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#onProcess","scope":"instance","inherits":"Phaser.Loader.File#onProcess","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#onFileComplete","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileComplete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Usually overridden by the FileTypes and is called by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data, for example a JSON file will parse itself during this stage.","kind":"function","name":"onProcess","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#onProcess","scope":"instance","inherits":"Phaser.Loader.File#onProcess","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Usually overridden by the FileTypes and is called by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data, for example a JSON file will parse itself during this stage.","kind":"function","name":"onProcess","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#onProcess","scope":"instance","inherits":"Phaser.Loader.File#onProcess","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Usually overridden by the FileTypes and is called by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data, for example a JSON file will parse itself during this stage.","kind":"function","name":"onProcess","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#onProcess","scope":"instance","inherits":"Phaser.Loader.File#onProcess","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#onFileComplete","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileComplete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#clearAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopRight","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#setBlendMode","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#depth","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#setDepth","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipX","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlip","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#resetFlip","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getRightCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBounds","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originX","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originY","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginX","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginY","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#pipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#initPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#setPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#resetPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#getPipelineName","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#width","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#height","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayWidth","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayHeight","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSizeToFrame","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSize","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setDisplaySize","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#texture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#frame","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#isCropped","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setTexture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setFrame","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#clearTint","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTint","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopRight","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomRight","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tint","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#isTinted","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#x","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#y","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#z","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#w","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scale","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleX","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleY","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#angle","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#rotation","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRandomPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRotation","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setAngle","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setScale","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setX","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setY","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setZ","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setW","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getParentRotation","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"Acceleration.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal and vertical acceleration. If the vertical acceleration value is not provided, the vertical acceleration is set to the same value as the horizontal acceleration.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal acceleration","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical acceleration","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAcceleration","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Acceleration#setAcceleration","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal acceleration.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal acceleration","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAccelerationX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Acceleration#setAccelerationX","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's vertical acceleration.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical acceleration","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAccelerationY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Acceleration#setAccelerationY","inherited":true,"___s":true},{"meta":{"filename":"Angular.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular velocity of the body.\n\nIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\nHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\ncausing them to visually rotate, even though the body remains axis-aligned.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAngularVelocity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Angular#setAngularVelocity","inherited":true,"___s":true},{"meta":{"filename":"Angular.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular acceleration of the body.\n\nIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\nHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\ncausing them to visually rotate, even though the body remains axis-aligned.","kind":"function","name":"setAngularAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of angular acceleration.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAngularAcceleration","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Angular#setAngularAcceleration","inherited":true,"___s":true},{"meta":{"filename":"Angular.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular drag of the body. Drag is applied to the current velocity, providing a form of deceleration.","kind":"function","name":"setAngularDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of drag.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAngularDrag","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Angular#setAngularDrag","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the bounce values of this body.\n\nBounce is the amount of restitution, or elasticity, the body has when it collides with another object.\nA value of 1 means that it will retain its full velocity after the rebound. A value of 0 means it will not rebound at all.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setBounce","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the horizontal bounce value for this body.","kind":"function","name":"setBounceX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setBounceX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setBounceX","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the vertical bounce value for this body.","kind":"function","name":"setBounceY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setBounceY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setBounceY","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets whether this Body collides with the world boundary.\n\nOptionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.","kind":"function","name":"setCollideWorldBounds","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if this body should collide with the world bounds, otherwise `false`.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.x` value.","name":"bounceX"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.y` value.","name":"bounceY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setCollideWorldBounds","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setCollideWorldBounds","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the debug values of this body.\n\nBodies will only draw their debug if debug has been enabled for Arcade Physics as a whole.\nNote that there is a performance cost in drawing debug displays. It should never be used in production.","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` to have this body render its outline to the debug display.","name":"showBody"},{"type":{"names":["boolean"]},"description":"Set to `true` to have this body render a velocity marker to the debug display.","name":"showVelocity"},{"type":{"names":["number"]},"description":"The color of the body outline when rendered to the debug display.","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDebug","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Debug#setDebug","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the color of the body outline when it renders to the debug display.","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The color of the body outline when rendered to the debug display.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDebugBodyColor","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Debug#setDebugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set to `true` to have this body render its outline to the debug display.","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#debugShowBody","scope":"instance","kind":"member","inherits":"Phaser.Physics.Arcade.Components.Debug#debugShowBody","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set to `true` to have this body render a velocity marker to the debug display.","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#debugShowVelocity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Arcade.Components.Debug#debugShowVelocity","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"The color of the body outline when it renders to the debug display.","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#debugBodyColor","scope":"instance","kind":"member","inherits":"Phaser.Physics.Arcade.Components.Debug#debugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal and vertical drag. If the vertical drag value is not provided, the vertical drag is set to the same value as the horizontal drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal drag to apply.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical drag to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDrag","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDrag","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDragX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal drag to apply.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDragX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDragX","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's vertical drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDragY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of vertical drag to apply.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDragY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDragY","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"If this Body is using `drag` for deceleration this function controls how the drag is applied.\nIf set to `true` drag will use a damping effect rather than a linear approach. If you are\ncreating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\nthe game Asteroids) then you will get a far smoother and more visually correct deceleration\nby using damping, avoiding the axis-drift that is prone with linear deceleration.\n\nIf you enable this property then you should use far smaller `drag` values than with linear, as\nthey are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\ndeceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.","kind":"function","name":"setDamping","since":"3.10.0","params":[{"type":{"names":["boolean"]},"description":"`true` to use damping for deceleration, or `false` to use linear deceleration.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDamping","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDamping","inherited":true,"___s":true},{"meta":{"filename":"Enable.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Enables this Game Object's Body.","kind":"function","name":"enableBody","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Also reset the Body and place it at (x, y).","name":"reset"},{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"x"},{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"y"},{"type":{"names":["boolean"]},"description":"Also activate this Game Object.","name":"enableGameObject"},{"type":{"names":["boolean"]},"description":"Also show this Game Object.","name":"showGameObject"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.Body#enable","Phaser.Physics.Arcade.StaticBody#enable","Phaser.Physics.Arcade.Body#reset","Phaser.Physics.Arcade.StaticBody#reset","Phaser.GameObjects.GameObject#active","Phaser.GameObjects.GameObject#visible"],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#enableBody","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Enable#enableBody","inherited":true,"___s":true},{"meta":{"filename":"Enable.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Stops and disables this Game Object's Body.","kind":"function","name":"disableBody","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also deactivate this Game Object.","name":"disableGameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also hide this Game Object.","name":"hideGameObject"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.Body#enable","Phaser.Physics.Arcade.StaticBody#enable","Phaser.GameObjects.GameObject#active","Phaser.GameObjects.GameObject#visible"],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#disableBody","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Enable#disableBody","inherited":true,"___s":true},{"meta":{"filename":"Enable.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Syncs the Body's position and size with its parent Game Object.\nYou don't need to call this for Dynamic Bodies, as it happens automatically.\nBut for Static bodies it's a useful way of modifying the position of a Static Body\nin the Physics World, based on its Game Object.","kind":"function","name":"refreshBody","since":"3.1.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.StaticBody#updateFromGameObject"],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#refreshBody","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Enable#refreshBody","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal friction to apply.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical friction to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFriction","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving horizontally in the X axis.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of friction to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFrictionX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Friction#setFrictionX","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving vertically in the Y axis.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of friction to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFrictionY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Friction#setFrictionY","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the X and Y values of the gravitational pull to act upon this Arcade Physics Game Object. Values can be positive or negative. Larger values result in a stronger effect.\n\nIf only one value is provided, this value will be used for both the X and Y axis.","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the X-axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The gravitational force to be applied to the Y-axis. If this is not specified, the X value will be used.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setGravity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Gravity#setGravity","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the gravitational force to be applied to the X axis. Value can be positive or negative. Larger values result in a stronger effect.","kind":"function","name":"setGravityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the X-axis.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setGravityX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Gravity#setGravityX","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the gravitational force to be applied to the Y axis. Value can be positive or negative. Larger values result in a stronger effect.","kind":"function","name":"setGravityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the Y-axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setGravityY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Gravity#setGravityY","inherited":true,"___s":true},{"meta":{"filename":"Immovable.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets Whether this Body can be moved by collisions with another Body.","kind":"function","name":"setImmovable","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets if this body can be moved by collisions with another Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setImmovable","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Immovable#setImmovable","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the mass of the physics body","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"New value for the mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setMass","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Mass#setMass","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body offset. This allows you to adjust the difference between the center of the body\nand the x and y coordinates of the parent Game Object.","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to offset the body from the parent Game Object along the x-axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setOffset","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Size#setOffset","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":55,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets this physics body to use a circle for collision instead of a rectangle.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the physics body, in pixels.","name":"radius"},{"type":{"names":["number"]},"optional":true,"description":"The amount to offset the body from the parent Game Object along the x-axis.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to offset the body from the parent Game Object along the y-axis.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setCircle","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Size#setCircle","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the velocity of the Body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity of the body. Positive values move the body to the right, while negative values move it to the left.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity of the body. Positive values move the body down, while negative values move it up.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setVelocity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the horizontal component of the body's velocity.\n\nPositive values move the body to the right, while negative values move it to the left.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new horizontal velocity.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the vertical component of the body's velocity.\n\nPositive values move the body down, while negative values move it up.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new vertical velocity of the body.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the maximum velocity of the body.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new maximum horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The new maximum vertical velocity.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setMaxVelocity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setMaxVelocity","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"The Animation Controller of this Sprite.","name":"anims","type":{"names":["Phaser.GameObjects.Components.Animation"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#anims","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Sprite#anims","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Start playing the given animation.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If an animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#play","scope":"instance","inherits":"Phaser.GameObjects.Sprite#play","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Build a JSON representation of this Sprite.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#toJSON","scope":"instance","inherits":"Phaser.GameObjects.Sprite#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#clearAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopRight","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#setBlendMode","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#depth","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#setDepth","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipX","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlip","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#resetFlip","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getRightCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBounds","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originX","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originY","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginX","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginY","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#pipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#initPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#setPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#resetPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#getPipelineName","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#width","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#height","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayWidth","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayHeight","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSizeToFrame","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSize","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setDisplaySize","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#texture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#frame","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#isCropped","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setTexture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setFrame","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#clearTint","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTint","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopRight","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomRight","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tint","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#isTinted","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#x","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#y","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#z","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#w","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scale","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleX","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleY","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#angle","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#rotation","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRandomPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRotation","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setAngle","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setScale","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setX","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setY","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setZ","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setW","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getParentRotation","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"Acceleration.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal and vertical acceleration. If the vertical acceleration value is not provided, the vertical acceleration is set to the same value as the horizontal acceleration.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal acceleration","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical acceleration","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAcceleration","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Acceleration#setAcceleration","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal acceleration.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal acceleration","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAccelerationX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Acceleration#setAccelerationX","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's vertical acceleration.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical acceleration","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAccelerationY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Acceleration#setAccelerationY","inherited":true,"___s":true},{"meta":{"filename":"Angular.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular velocity of the body.\n\nIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\nHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\ncausing them to visually rotate, even though the body remains axis-aligned.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAngularVelocity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Angular#setAngularVelocity","inherited":true,"___s":true},{"meta":{"filename":"Angular.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular acceleration of the body.\n\nIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\nHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\ncausing them to visually rotate, even though the body remains axis-aligned.","kind":"function","name":"setAngularAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of angular acceleration.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAngularAcceleration","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Angular#setAngularAcceleration","inherited":true,"___s":true},{"meta":{"filename":"Angular.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular drag of the body. Drag is applied to the current velocity, providing a form of deceleration.","kind":"function","name":"setAngularDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of drag.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAngularDrag","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Angular#setAngularDrag","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the bounce values of this body.\n\nBounce is the amount of restitution, or elasticity, the body has when it collides with another object.\nA value of 1 means that it will retain its full velocity after the rebound. A value of 0 means it will not rebound at all.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setBounce","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the horizontal bounce value for this body.","kind":"function","name":"setBounceX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setBounceX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setBounceX","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the vertical bounce value for this body.","kind":"function","name":"setBounceY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setBounceY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setBounceY","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets whether this Body collides with the world boundary.\n\nOptionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.","kind":"function","name":"setCollideWorldBounds","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if this body should collide with the world bounds, otherwise `false`.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.x` value.","name":"bounceX"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.y` value.","name":"bounceY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setCollideWorldBounds","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setCollideWorldBounds","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the debug values of this body.\n\nBodies will only draw their debug if debug has been enabled for Arcade Physics as a whole.\nNote that there is a performance cost in drawing debug displays. It should never be used in production.","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` to have this body render its outline to the debug display.","name":"showBody"},{"type":{"names":["boolean"]},"description":"Set to `true` to have this body render a velocity marker to the debug display.","name":"showVelocity"},{"type":{"names":["number"]},"description":"The color of the body outline when rendered to the debug display.","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDebug","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Debug#setDebug","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the color of the body outline when it renders to the debug display.","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The color of the body outline when rendered to the debug display.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDebugBodyColor","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Debug#setDebugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set to `true` to have this body render its outline to the debug display.","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#debugShowBody","scope":"instance","kind":"member","inherits":"Phaser.Physics.Arcade.Components.Debug#debugShowBody","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set to `true` to have this body render a velocity marker to the debug display.","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#debugShowVelocity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Arcade.Components.Debug#debugShowVelocity","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"The color of the body outline when it renders to the debug display.","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#debugBodyColor","scope":"instance","kind":"member","inherits":"Phaser.Physics.Arcade.Components.Debug#debugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal and vertical drag. If the vertical drag value is not provided, the vertical drag is set to the same value as the horizontal drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal drag to apply.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical drag to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDrag","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDrag","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDragX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal drag to apply.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDragX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDragX","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's vertical drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDragY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of vertical drag to apply.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDragY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDragY","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"If this Body is using `drag` for deceleration this function controls how the drag is applied.\nIf set to `true` drag will use a damping effect rather than a linear approach. If you are\ncreating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\nthe game Asteroids) then you will get a far smoother and more visually correct deceleration\nby using damping, avoiding the axis-drift that is prone with linear deceleration.\n\nIf you enable this property then you should use far smaller `drag` values than with linear, as\nthey are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\ndeceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.","kind":"function","name":"setDamping","since":"3.10.0","params":[{"type":{"names":["boolean"]},"description":"`true` to use damping for deceleration, or `false` to use linear deceleration.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDamping","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDamping","inherited":true,"___s":true},{"meta":{"filename":"Enable.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Enables this Game Object's Body.","kind":"function","name":"enableBody","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Also reset the Body and place it at (x, y).","name":"reset"},{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"x"},{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"y"},{"type":{"names":["boolean"]},"description":"Also activate this Game Object.","name":"enableGameObject"},{"type":{"names":["boolean"]},"description":"Also show this Game Object.","name":"showGameObject"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.Body#enable","Phaser.Physics.Arcade.StaticBody#enable","Phaser.Physics.Arcade.Body#reset","Phaser.Physics.Arcade.StaticBody#reset","Phaser.GameObjects.GameObject#active","Phaser.GameObjects.GameObject#visible"],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#enableBody","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Enable#enableBody","inherited":true,"___s":true},{"meta":{"filename":"Enable.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Stops and disables this Game Object's Body.","kind":"function","name":"disableBody","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also deactivate this Game Object.","name":"disableGameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also hide this Game Object.","name":"hideGameObject"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.Body#enable","Phaser.Physics.Arcade.StaticBody#enable","Phaser.GameObjects.GameObject#active","Phaser.GameObjects.GameObject#visible"],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#disableBody","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Enable#disableBody","inherited":true,"___s":true},{"meta":{"filename":"Enable.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Syncs the Body's position and size with its parent Game Object.\nYou don't need to call this for Dynamic Bodies, as it happens automatically.\nBut for Static bodies it's a useful way of modifying the position of a Static Body\nin the Physics World, based on its Game Object.","kind":"function","name":"refreshBody","since":"3.1.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.StaticBody#updateFromGameObject"],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#refreshBody","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Enable#refreshBody","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal friction to apply.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical friction to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFriction","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving horizontally in the X axis.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of friction to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFrictionX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Friction#setFrictionX","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving vertically in the Y axis.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of friction to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFrictionY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Friction#setFrictionY","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the X and Y values of the gravitational pull to act upon this Arcade Physics Game Object. Values can be positive or negative. Larger values result in a stronger effect.\n\nIf only one value is provided, this value will be used for both the X and Y axis.","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the X-axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The gravitational force to be applied to the Y-axis. If this is not specified, the X value will be used.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setGravity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Gravity#setGravity","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the gravitational force to be applied to the X axis. Value can be positive or negative. Larger values result in a stronger effect.","kind":"function","name":"setGravityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the X-axis.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setGravityX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Gravity#setGravityX","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the gravitational force to be applied to the Y axis. Value can be positive or negative. Larger values result in a stronger effect.","kind":"function","name":"setGravityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the Y-axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setGravityY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Gravity#setGravityY","inherited":true,"___s":true},{"meta":{"filename":"Immovable.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets Whether this Body can be moved by collisions with another Body.","kind":"function","name":"setImmovable","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets if this body can be moved by collisions with another Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setImmovable","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Immovable#setImmovable","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the mass of the physics body","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"New value for the mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setMass","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Mass#setMass","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body offset. This allows you to adjust the difference between the center of the body\nand the x and y coordinates of the parent Game Object.","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to offset the body from the parent Game Object along the x-axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setOffset","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Size#setOffset","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":55,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets this physics body to use a circle for collision instead of a rectangle.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the physics body, in pixels.","name":"radius"},{"type":{"names":["number"]},"optional":true,"description":"The amount to offset the body from the parent Game Object along the x-axis.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to offset the body from the parent Game Object along the y-axis.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setCircle","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Size#setCircle","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the velocity of the Body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity of the body. Positive values move the body to the right, while negative values move it to the left.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity of the body. Positive values move the body down, while negative values move it up.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setVelocity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the horizontal component of the body's velocity.\n\nPositive values move the body to the right, while negative values move it to the left.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new horizontal velocity.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the vertical component of the body's velocity.\n\nPositive values move the body down, while negative values move it up.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new vertical velocity of the body.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the maximum velocity of the body.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new maximum horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The new maximum vertical velocity.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setMaxVelocity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setMaxVelocity","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"This scene this group belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#scene","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#scene","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Members of this group.","name":"children","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#children","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#children","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A flag identifying this object as a group.","name":"isParent","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#isParent","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#isParent","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The name of this group.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.18.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#name","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether this group runs its {@link Phaser.GameObjects.Group#preUpdate} method\n(which may update any members).","name":"active","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#active","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The maximum size of this group, if used as a pool. -1 is no limit.","name":"maxSize","type":{"names":["integer"]},"since":"3.0.0","defaultvalue":"-1","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#maxSize","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#maxSize","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A default texture key to use when creating new group members.\n\nThis is used in {@link Phaser.GameObjects.Group#create}\nbut not in {@link Phaser.GameObjects.Group#createMultiple}.","name":"defaultKey","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#defaultKey","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#defaultKey","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":170,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A default texture frame to use when creating new group members.","name":"defaultFrame","type":{"names":["string","integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#defaultFrame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#defaultFrame","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":179,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether to call the update method of any members.","name":"runChildUpdate","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.GameObjects.Group#preUpdate"],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#runChildUpdate","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#runChildUpdate","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":190,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when adding or creating group members.","name":"createCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#createCallback","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#createCallback","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":199,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when removing group members.","name":"removeCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#removeCallback","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#removeCallback","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":208,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when creating several group members at once.","name":"createMultipleCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#createMultipleCallback","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#createMultipleCallback","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates a new Game Object and adds it to this group, unless the group {@link Phaser.GameObjects.Group#isFull is full}.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the new Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the new Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key of the new Game Object.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"The texture frame of the new Game Object.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of the new Game Object.","name":"visible"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.GameObject#active} state of the new Game Object.","name":"active"}],"returns":[{"type":{"names":["any"]},"description":"The new Game Object (usually a Sprite, etc.)."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#create","scope":"instance","inherits":"Phaser.GameObjects.Group#create","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":294,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates several Game Objects and adds them to this group.\n\nIf the group becomes {@link Phaser.GameObjects.Group#isFull}, no further Game Objects are created.\n\nCalls {@link Phaser.GameObjects.Group#createMultipleCallback} and {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"createMultiple","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCreateConfig","Array."]},"description":"Creation settings. This can be a single configuration object or an array of such objects, which will be applied in turn.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"The newly created Game Objects."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#createMultiple","scope":"instance","inherits":"Phaser.GameObjects.Group#createMultiple","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":335,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A helper for {@link Phaser.GameObjects.Group#createMultiple}.","kind":"function","name":"createFromConfig","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"description":"Creation settings.","name":"options"}],"returns":[{"type":{"names":["Array."]},"description":"The newly created Game Objects."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#createFromConfig","scope":"instance","inherits":"Phaser.GameObjects.Group#createFromConfig","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Updates any group members, if {@link Phaser.GameObjects.Group#runChildUpdate} is enabled.","kind":"function","name":"preUpdate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current timestamp.","name":"time"},{"type":{"names":["number"]},"description":"The delta time elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#preUpdate","scope":"instance","inherits":"Phaser.GameObjects.Group#preUpdate","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds a Game Object to this group.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to add.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also add the Game Object to the scene.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#add","scope":"instance","inherits":"Phaser.GameObjects.Group#add","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":562,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds several Game Objects to this group.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"addMultiple","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The Game Objects to add.","name":"children"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also add the Game Objects to the scene.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This group."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#addMultiple","scope":"instance","inherits":"Phaser.GameObjects.Group#addMultiple","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Removes a member of this Group and optionally removes it from the Scene and / or destroys it.\n\nCalls {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to remove.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally remove the Group member from the Scene it belongs to.","name":"removeFromScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call destroy on the removed Group member.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#remove","scope":"instance","inherits":"Phaser.GameObjects.Group#remove","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":645,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Removes all members of this Group and optionally removes them from the Scene and / or destroys them.\n\nDoes not call {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"clear","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally remove each Group member from the Scene.","name":"removeFromScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call destroy on the removed Group members.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This group."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#clear","scope":"instance","inherits":"Phaser.GameObjects.Group#clear","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":691,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Tests if a Game Object is a member of this group.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A Game Object.","name":"child"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object is a member of this group."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#contains","scope":"instance","inherits":"Phaser.GameObjects.Group#contains","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":706,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"All members of the group.","kind":"function","name":"getChildren","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"The group members."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getChildren","scope":"instance","inherits":"Phaser.GameObjects.Group#getChildren","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":719,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The number of members of the group.","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["integer"]}}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getLength","scope":"instance","inherits":"Phaser.GameObjects.Group#getLength","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":732,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group, from top to bottom, for the first member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirst","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getFirst","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirst","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":757,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group, from top to bottom, for the nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstNth","since":"3.6.0","params":[{"type":{"names":["integer"]},"description":"The nth matching Group member to search for.","name":"nth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getFirstNth","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirstNth","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":783,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group for the last member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getLast","since":"3.6.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getLast","scope":"instance","inherits":"Phaser.GameObjects.Group#getLast","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":808,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group for the last nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getLastNth","since":"3.6.0","params":[{"type":{"names":["integer"]},"description":"The nth matching Group member to search for.","name":"nth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getLastNth","scope":"instance","inherits":"Phaser.GameObjects.Group#getLastNth","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":937,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\nassigns `x` and `y`, and returns the member.\n\nIf no inactive member is found and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nThe new Game Object will have its active state set to `true`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first inactive group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#get","scope":"instance","inherits":"Phaser.GameObjects.Group#get","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":961,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `true`,\nassigns `x` and `y`, and returns the member.\n\nIf no active member is found and `createIfNull` is `true` and the group isn't full then it will create a new one using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstAlive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"description":"The first active group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getFirstAlive","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirstAlive","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":985,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\nassigns `x` and `y`, and returns the member.\n\nIf no inactive member is found and `createIfNull` is `true` and the group isn't full then it will create a new one using `x`, `y`, `key`, `frame`, and `visible`.\nThe new Game Object will have an active state set to `true`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstDead","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"description":"The first inactive group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getFirstDead","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirstDead","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1010,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"{@link Phaser.GameObjects.Components.Animation#play Plays} an animation for all members of this group.","kind":"function","name":"playAnimation","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["string"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#playAnimation","scope":"instance","inherits":"Phaser.GameObjects.Group#playAnimation","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1028,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether this group's size at its {@link Phaser.GameObjects.Group#maxSize maximum}.","kind":"function","name":"isFull","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if the number of members equals {@link Phaser.GameObjects.Group#maxSize}."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#isFull","scope":"instance","inherits":"Phaser.GameObjects.Group#isFull","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1048,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Counts the number of active (or inactive) group members.","kind":"function","name":"countActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Count active (true) or inactive (false) group members.","name":"value"}],"returns":[{"type":{"names":["integer"]},"description":"The number of group members with an active state matching the `active` argument."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#countActive","scope":"instance","inherits":"Phaser.GameObjects.Group#countActive","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1075,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Counts the number of in-use (active) group members.","kind":"function","name":"getTotalUsed","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of group members with an active state of true."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getTotalUsed","scope":"instance","inherits":"Phaser.GameObjects.Group#getTotalUsed","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The difference of {@link Phaser.GameObjects.Group#maxSize} and the number of active group members.\n\nThis represents the number of group members that could be created or reactivated before reaching the size limit.","kind":"function","name":"getTotalFree","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"maxSize minus the number of active group numbers; or a large number (if maxSize is -1)."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getTotalFree","scope":"instance","inherits":"Phaser.GameObjects.Group#getTotalFree","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the property as defined in `key` of each group member to the given value.","kind":"function","name":"propertyValueSet","since":"3.21.0","params":[{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#propertyValueSet","scope":"instance","inherits":"Phaser.GameObjects.Group#propertyValueSet","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the property as defined in `key` of each group member.","kind":"function","name":"propertyValueInc","since":"3.21.0","params":[{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#propertyValueInc","scope":"instance","inherits":"Phaser.GameObjects.Group#propertyValueInc","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1148,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the x of each group member.","kind":"function","name":"setX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setX","scope":"instance","inherits":"Phaser.GameObjects.Group#setX","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the y of each group member.","kind":"function","name":"setY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setY","scope":"instance","inherits":"Phaser.GameObjects.Group#setY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the x, y of each group member.","kind":"function","name":"setXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the `x` property to.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to set the `y` property to. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setXY","scope":"instance","inherits":"Phaser.GameObjects.Group#setXY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the x of each group member.","kind":"function","name":"incX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#incX","scope":"instance","inherits":"Phaser.GameObjects.Group#incX","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the y of each group member.","kind":"function","name":"incY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `y` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#incY","scope":"instance","inherits":"Phaser.GameObjects.Group#incY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1240,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the x, y of each group member.","kind":"function","name":"incXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to be added to the `y` property. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#incXY","scope":"instance","inherits":"Phaser.GameObjects.Group#incXY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Iterate through the group members changing the position of each element to be that of the element that came before\nit in the array (or after it if direction = 1)\n\nThe first group member position is set to x/y.","kind":"function","name":"shiftPosition","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to place the first item in the array at.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to place the first item in the array at.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The iteration direction. 0 = first to last and 1 = last to first.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#shiftPosition","scope":"instance","inherits":"Phaser.GameObjects.Group#shiftPosition","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1282,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the angle of each group member.","kind":"function","name":"angle","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the angle to, in degrees.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#angle","scope":"instance","inherits":"Phaser.GameObjects.Group#angle","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the rotation of each group member.","kind":"function","name":"rotate","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the rotation to, in radians.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#rotate","scope":"instance","inherits":"Phaser.GameObjects.Group#rotate","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Rotates each group member around the given point by the given angle.","kind":"function","name":"rotateAround","since":"3.21.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#rotateAround","scope":"instance","inherits":"Phaser.GameObjects.Group#rotateAround","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1336,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Rotates each group member around the given point by the given angle and distance.","kind":"function","name":"rotateAroundDistance","since":"3.21.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"},{"type":{"names":["number"]},"description":"The distance from the point of rotation in pixels.","name":"distance"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#rotateAroundDistance","scope":"instance","inherits":"Phaser.GameObjects.Group#rotateAroundDistance","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the alpha of each group member.","kind":"function","name":"setAlpha","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the alpha to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Group#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the tint of each group member.","kind":"function","name":"setTint","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The tint being applied to top-left corner of item. If other parameters are given no value, this tint will be applied to whole item.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to top-right corner of item.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-left corner of item.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-right corner of item.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setTint","scope":"instance","inherits":"Phaser.GameObjects.Group#setTint","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1393,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the originX, originY of each group member.","kind":"function","name":"setOrigin","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the `originX` property to.","name":"originX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to set the `originY` property to. If `undefined` or `null` it uses the `originX` value.","name":"originY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originY` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Group#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1413,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleX of each group member.","kind":"function","name":"scaleX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#scaleX","scope":"instance","inherits":"Phaser.GameObjects.Group#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleY of each group member.","kind":"function","name":"scaleY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#scaleY","scope":"instance","inherits":"Phaser.GameObjects.Group#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleX, scaleY of each group member.","kind":"function","name":"scaleXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `scaleX` property.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to be added to the `scaleY` property. If `undefined` or `null` it uses the `scaleX` value.","name":"scaleY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleY` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#scaleXY","scope":"instance","inherits":"Phaser.GameObjects.Group#scaleXY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1469,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the depth of each group member.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Group#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1487,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the blendMode of each group member.","kind":"function","name":"setBlendMode","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Group#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1504,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Passes all group members to the Input Manager to enable them for input with identical areas and callbacks.","kind":"function","name":"setHitArea","since":"3.21.0","params":[{"type":{"names":["*"]},"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"hitAreaCallback"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setHitArea","scope":"instance","inherits":"Phaser.GameObjects.Group#setHitArea","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1522,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Shuffles the group members in place.","kind":"function","name":"shuffle","since":"3.21.0","returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#shuffle","scope":"instance","inherits":"Phaser.GameObjects.Group#shuffle","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Deactivates a member of this group.","kind":"function","name":"kill","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A member of this group.","name":"gameObject"}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#kill","scope":"instance","inherits":"Phaser.GameObjects.Group#kill","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1553,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Deactivates and hides a member of this group.","kind":"function","name":"killAndHide","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A member of this group.","name":"gameObject"}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#killAndHide","scope":"instance","inherits":"Phaser.GameObjects.Group#killAndHide","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1570,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the visible of each group member.","kind":"function","name":"setVisible","since":"3.21.0","params":[{"type":{"names":["boolean"]},"description":"The value to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Group#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1589,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Toggles (flips) the visible state of each member of this group.","kind":"function","name":"toggleVisible","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#toggleVisible","scope":"instance","inherits":"Phaser.GameObjects.Group#toggleVisible","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1604,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Empties this group and removes it from the Scene.\n\nDoes not call {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"destroy","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also {@link Phaser.GameObjects.GameObject#destroy} each group member.","name":"destroyChildren"}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#destroy","scope":"instance","inherits":"Phaser.GameObjects.Group#destroy","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"This scene this group belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#scene","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#scene","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Members of this group.","name":"children","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#children","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#children","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A flag identifying this object as a group.","name":"isParent","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#isParent","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#isParent","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The class to create new group members from.","name":"classType","type":{"names":["function"]},"since":"3.0.0","defaultvalue":"Phaser.GameObjects.Sprite","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#classType","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#classType","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The name of this group.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.18.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#name","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether this group runs its {@link Phaser.GameObjects.Group#preUpdate} method\n(which may update any members).","name":"active","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#active","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The maximum size of this group, if used as a pool. -1 is no limit.","name":"maxSize","type":{"names":["integer"]},"since":"3.0.0","defaultvalue":"-1","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#maxSize","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#maxSize","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A default texture key to use when creating new group members.\n\nThis is used in {@link Phaser.GameObjects.Group#create}\nbut not in {@link Phaser.GameObjects.Group#createMultiple}.","name":"defaultKey","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#defaultKey","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#defaultKey","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":170,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A default texture frame to use when creating new group members.","name":"defaultFrame","type":{"names":["string","integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#defaultFrame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#defaultFrame","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":179,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether to call the update method of any members.","name":"runChildUpdate","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.GameObjects.Group#preUpdate"],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#runChildUpdate","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#runChildUpdate","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":190,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when adding or creating group members.","name":"createCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#createCallback","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#createCallback","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":199,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when removing group members.","name":"removeCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#removeCallback","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#removeCallback","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":208,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when creating several group members at once.","name":"createMultipleCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#createMultipleCallback","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#createMultipleCallback","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates a new Game Object and adds it to this group, unless the group {@link Phaser.GameObjects.Group#isFull is full}.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the new Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the new Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key of the new Game Object.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"The texture frame of the new Game Object.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of the new Game Object.","name":"visible"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.GameObject#active} state of the new Game Object.","name":"active"}],"returns":[{"type":{"names":["any"]},"description":"The new Game Object (usually a Sprite, etc.)."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#create","scope":"instance","inherits":"Phaser.GameObjects.Group#create","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":294,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates several Game Objects and adds them to this group.\n\nIf the group becomes {@link Phaser.GameObjects.Group#isFull}, no further Game Objects are created.\n\nCalls {@link Phaser.GameObjects.Group#createMultipleCallback} and {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"createMultiple","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCreateConfig","Array."]},"description":"Creation settings. This can be a single configuration object or an array of such objects, which will be applied in turn.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"The newly created Game Objects."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#createMultiple","scope":"instance","inherits":"Phaser.GameObjects.Group#createMultiple","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":335,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A helper for {@link Phaser.GameObjects.Group#createMultiple}.","kind":"function","name":"createFromConfig","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"description":"Creation settings.","name":"options"}],"returns":[{"type":{"names":["Array."]},"description":"The newly created Game Objects."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#createFromConfig","scope":"instance","inherits":"Phaser.GameObjects.Group#createFromConfig","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Updates any group members, if {@link Phaser.GameObjects.Group#runChildUpdate} is enabled.","kind":"function","name":"preUpdate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current timestamp.","name":"time"},{"type":{"names":["number"]},"description":"The delta time elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#preUpdate","scope":"instance","inherits":"Phaser.GameObjects.Group#preUpdate","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds a Game Object to this group.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to add.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also add the Game Object to the scene.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#add","scope":"instance","inherits":"Phaser.GameObjects.Group#add","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":562,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds several Game Objects to this group.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"addMultiple","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The Game Objects to add.","name":"children"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also add the Game Objects to the scene.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This group."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#addMultiple","scope":"instance","inherits":"Phaser.GameObjects.Group#addMultiple","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Removes a member of this Group and optionally removes it from the Scene and / or destroys it.\n\nCalls {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to remove.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally remove the Group member from the Scene it belongs to.","name":"removeFromScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call destroy on the removed Group member.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#remove","scope":"instance","inherits":"Phaser.GameObjects.Group#remove","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":645,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Removes all members of this Group and optionally removes them from the Scene and / or destroys them.\n\nDoes not call {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"clear","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally remove each Group member from the Scene.","name":"removeFromScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call destroy on the removed Group members.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This group."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#clear","scope":"instance","inherits":"Phaser.GameObjects.Group#clear","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":691,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Tests if a Game Object is a member of this group.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A Game Object.","name":"child"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object is a member of this group."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#contains","scope":"instance","inherits":"Phaser.GameObjects.Group#contains","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":706,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"All members of the group.","kind":"function","name":"getChildren","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"The group members."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getChildren","scope":"instance","inherits":"Phaser.GameObjects.Group#getChildren","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":719,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The number of members of the group.","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["integer"]}}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getLength","scope":"instance","inherits":"Phaser.GameObjects.Group#getLength","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":732,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group, from top to bottom, for the first member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirst","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getFirst","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirst","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":757,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group, from top to bottom, for the nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstNth","since":"3.6.0","params":[{"type":{"names":["integer"]},"description":"The nth matching Group member to search for.","name":"nth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getFirstNth","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirstNth","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":783,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group for the last member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getLast","since":"3.6.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getLast","scope":"instance","inherits":"Phaser.GameObjects.Group#getLast","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":808,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group for the last nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getLastNth","since":"3.6.0","params":[{"type":{"names":["integer"]},"description":"The nth matching Group member to search for.","name":"nth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getLastNth","scope":"instance","inherits":"Phaser.GameObjects.Group#getLastNth","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":937,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\nassigns `x` and `y`, and returns the member.\n\nIf no inactive member is found and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nThe new Game Object will have its active state set to `true`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first inactive group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#get","scope":"instance","inherits":"Phaser.GameObjects.Group#get","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":961,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `true`,\nassigns `x` and `y`, and returns the member.\n\nIf no active member is found and `createIfNull` is `true` and the group isn't full then it will create a new one using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstAlive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"description":"The first active group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getFirstAlive","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirstAlive","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":985,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\nassigns `x` and `y`, and returns the member.\n\nIf no inactive member is found and `createIfNull` is `true` and the group isn't full then it will create a new one using `x`, `y`, `key`, `frame`, and `visible`.\nThe new Game Object will have an active state set to `true`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstDead","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"description":"The first inactive group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getFirstDead","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirstDead","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1010,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"{@link Phaser.GameObjects.Components.Animation#play Plays} an animation for all members of this group.","kind":"function","name":"playAnimation","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["string"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#playAnimation","scope":"instance","inherits":"Phaser.GameObjects.Group#playAnimation","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1028,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether this group's size at its {@link Phaser.GameObjects.Group#maxSize maximum}.","kind":"function","name":"isFull","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if the number of members equals {@link Phaser.GameObjects.Group#maxSize}."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#isFull","scope":"instance","inherits":"Phaser.GameObjects.Group#isFull","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1048,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Counts the number of active (or inactive) group members.","kind":"function","name":"countActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Count active (true) or inactive (false) group members.","name":"value"}],"returns":[{"type":{"names":["integer"]},"description":"The number of group members with an active state matching the `active` argument."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#countActive","scope":"instance","inherits":"Phaser.GameObjects.Group#countActive","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1075,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Counts the number of in-use (active) group members.","kind":"function","name":"getTotalUsed","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of group members with an active state of true."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getTotalUsed","scope":"instance","inherits":"Phaser.GameObjects.Group#getTotalUsed","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The difference of {@link Phaser.GameObjects.Group#maxSize} and the number of active group members.\n\nThis represents the number of group members that could be created or reactivated before reaching the size limit.","kind":"function","name":"getTotalFree","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"maxSize minus the number of active group numbers; or a large number (if maxSize is -1)."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getTotalFree","scope":"instance","inherits":"Phaser.GameObjects.Group#getTotalFree","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the property as defined in `key` of each group member to the given value.","kind":"function","name":"propertyValueSet","since":"3.21.0","params":[{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#propertyValueSet","scope":"instance","inherits":"Phaser.GameObjects.Group#propertyValueSet","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the property as defined in `key` of each group member.","kind":"function","name":"propertyValueInc","since":"3.21.0","params":[{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#propertyValueInc","scope":"instance","inherits":"Phaser.GameObjects.Group#propertyValueInc","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1148,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the x of each group member.","kind":"function","name":"setX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setX","scope":"instance","inherits":"Phaser.GameObjects.Group#setX","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the y of each group member.","kind":"function","name":"setY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setY","scope":"instance","inherits":"Phaser.GameObjects.Group#setY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the x, y of each group member.","kind":"function","name":"setXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the `x` property to.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to set the `y` property to. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setXY","scope":"instance","inherits":"Phaser.GameObjects.Group#setXY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the x of each group member.","kind":"function","name":"incX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#incX","scope":"instance","inherits":"Phaser.GameObjects.Group#incX","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the y of each group member.","kind":"function","name":"incY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `y` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#incY","scope":"instance","inherits":"Phaser.GameObjects.Group#incY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1240,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the x, y of each group member.","kind":"function","name":"incXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to be added to the `y` property. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#incXY","scope":"instance","inherits":"Phaser.GameObjects.Group#incXY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Iterate through the group members changing the position of each element to be that of the element that came before\nit in the array (or after it if direction = 1)\n\nThe first group member position is set to x/y.","kind":"function","name":"shiftPosition","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to place the first item in the array at.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to place the first item in the array at.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The iteration direction. 0 = first to last and 1 = last to first.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#shiftPosition","scope":"instance","inherits":"Phaser.GameObjects.Group#shiftPosition","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1282,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the angle of each group member.","kind":"function","name":"angle","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the angle to, in degrees.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#angle","scope":"instance","inherits":"Phaser.GameObjects.Group#angle","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the rotation of each group member.","kind":"function","name":"rotate","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the rotation to, in radians.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#rotate","scope":"instance","inherits":"Phaser.GameObjects.Group#rotate","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Rotates each group member around the given point by the given angle.","kind":"function","name":"rotateAround","since":"3.21.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#rotateAround","scope":"instance","inherits":"Phaser.GameObjects.Group#rotateAround","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1336,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Rotates each group member around the given point by the given angle and distance.","kind":"function","name":"rotateAroundDistance","since":"3.21.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"},{"type":{"names":["number"]},"description":"The distance from the point of rotation in pixels.","name":"distance"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#rotateAroundDistance","scope":"instance","inherits":"Phaser.GameObjects.Group#rotateAroundDistance","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the alpha of each group member.","kind":"function","name":"setAlpha","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the alpha to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Group#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the tint of each group member.","kind":"function","name":"setTint","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The tint being applied to top-left corner of item. If other parameters are given no value, this tint will be applied to whole item.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to top-right corner of item.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-left corner of item.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-right corner of item.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setTint","scope":"instance","inherits":"Phaser.GameObjects.Group#setTint","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1393,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the originX, originY of each group member.","kind":"function","name":"setOrigin","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the `originX` property to.","name":"originX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to set the `originY` property to. If `undefined` or `null` it uses the `originX` value.","name":"originY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originY` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Group#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1413,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleX of each group member.","kind":"function","name":"scaleX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#scaleX","scope":"instance","inherits":"Phaser.GameObjects.Group#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleY of each group member.","kind":"function","name":"scaleY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#scaleY","scope":"instance","inherits":"Phaser.GameObjects.Group#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleX, scaleY of each group member.","kind":"function","name":"scaleXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `scaleX` property.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to be added to the `scaleY` property. If `undefined` or `null` it uses the `scaleX` value.","name":"scaleY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleY` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#scaleXY","scope":"instance","inherits":"Phaser.GameObjects.Group#scaleXY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1469,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the depth of each group member.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Group#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1487,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the blendMode of each group member.","kind":"function","name":"setBlendMode","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Group#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1504,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Passes all group members to the Input Manager to enable them for input with identical areas and callbacks.","kind":"function","name":"setHitArea","since":"3.21.0","params":[{"type":{"names":["*"]},"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"hitAreaCallback"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setHitArea","scope":"instance","inherits":"Phaser.GameObjects.Group#setHitArea","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1522,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Shuffles the group members in place.","kind":"function","name":"shuffle","since":"3.21.0","returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#shuffle","scope":"instance","inherits":"Phaser.GameObjects.Group#shuffle","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Deactivates a member of this group.","kind":"function","name":"kill","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A member of this group.","name":"gameObject"}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#kill","scope":"instance","inherits":"Phaser.GameObjects.Group#kill","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1553,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Deactivates and hides a member of this group.","kind":"function","name":"killAndHide","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A member of this group.","name":"gameObject"}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#killAndHide","scope":"instance","inherits":"Phaser.GameObjects.Group#killAndHide","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1570,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the visible of each group member.","kind":"function","name":"setVisible","since":"3.21.0","params":[{"type":{"names":["boolean"]},"description":"The value to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Group#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1589,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Toggles (flips) the visible state of each member of this group.","kind":"function","name":"toggleVisible","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#toggleVisible","scope":"instance","inherits":"Phaser.GameObjects.Group#toggleVisible","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1604,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Empties this group and removes it from the Scene.\n\nDoes not call {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"destroy","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also {@link Phaser.GameObjects.GameObject#destroy} each group member.","name":"destroyChildren"}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#destroy","scope":"instance","inherits":"Phaser.GameObjects.Group#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal acceleration of this body.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setAccelerationX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationX","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical acceleration of this body.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setAccelerationY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationY","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical acceleration of this body.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal acceleration to apply.","name":"x"},{"type":{"names":["number"]},"description":"The amount of vertical acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setAcceleration","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAcceleration","inherited":true,"___s":true},{"meta":{"filename":"BodyScale.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the size of the physics body.","kind":"function","name":"setBodySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the body in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height of the body in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setBodySize","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyScale#setBodySize","inherited":true,"___s":true},{"meta":{"filename":"BodyScale.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the scale of the physics body.","kind":"function","name":"setBodyScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of the body.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The vertical scale of the body. If not given, will use the horizontal scale value.","name":"scaleY"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setBodyScale","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyScale#setBodyScale","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"getBodyType","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#getBodyType","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#getBodyType","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setTypeNone","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeNone","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":46,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setTypeA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeA","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setTypeB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeB","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the impact physics bounce, or restitution, value.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 (no rebound) and 1 (full rebound)","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setBounce","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the minimum velocity the body is allowed to be moving to be considered for rebound.","kind":"function","name":"setMinBounceVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum allowed velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setMinBounceVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Bounce#setMinBounceVelocity","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The bounce, or restitution, value of this body.\nA value between 0 (no rebound) and 1 (full rebound)","name":"bounce","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#bounce","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Bounce#bounce","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setAvsB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setAvsB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setAvsB","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setBvsA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setBvsA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setBvsA","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setCheckAgainstNone","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstNone","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setCheckAgainstA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstA","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setCheckAgainstB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstB","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"checkAgainst","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#checkAgainst","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#checkAgainst","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":29,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollideCallback","since":"3.0.0","params":[{"type":{"names":["CollideCallback"]},"description":"[description]","name":"callback"},{"type":{"names":["*"]},"description":"[description]","name":"scope"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setCollideCallback","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setCollideCallback","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollidesNever","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setCollidesNever","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setCollidesNever","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setLiteCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setLiteCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setLiteCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setPassiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setPassiveCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setPassiveCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setActiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setActiveCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setActiveCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":112,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFixedCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setFixedCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setFixedCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"collides","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#collides","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Collides#collides","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"[description]","name":"showBody"},{"type":{"names":["boolean"]},"description":"[description]","name":"showVelocity"},{"type":{"names":["number"]},"description":"[description]","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setDebug","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Debug#setDebug","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setDebugBodyColor","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Debug#setDebugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#debugShowBody","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugShowBody","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":75,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#debugShowVelocity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugShowVelocity","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#debugBodyColor","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setFrictionX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFrictionX","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setFrictionY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFrictionY","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setFriction","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setGravity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Gravity#setGravity","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"gravity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#gravity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Gravity#gravity","inherited":true,"___s":true},{"meta":{"filename":"Offset.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setOffset","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Offset#setOffset","inherited":true,"___s":true},{"meta":{"filename":"SetGameObject.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGameObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"[description]","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"[description]","name":"sync"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setGameObject","scope":"instance","inherits":"Phaser.Physics.Impact.Components.SetGameObject#setGameObject","inherited":true,"___s":true},{"meta":{"filename":"SetGameObject.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"syncGameObject","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#syncGameObject","scope":"instance","inherits":"Phaser.Physics.Impact.Components.SetGameObject#syncGameObject","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical velocities of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the maximum velocity this body can travel at.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The maximum allowed horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The maximum allowed vertical velocity. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setMaxVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setMaxVelocity","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#clearAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopRight","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#setBlendMode","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#depth","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#setDepth","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipX","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlip","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#resetFlip","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getRightCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBounds","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originX","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originY","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginX","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginY","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#pipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#initPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#setPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#resetPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#getPipelineName","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#width","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#height","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayWidth","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayHeight","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSizeToFrame","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSize","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setDisplaySize","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#texture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#frame","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#isCropped","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setTexture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setFrame","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#clearTint","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTint","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopRight","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomRight","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tint","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#isTinted","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#x","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#y","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#z","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#w","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scale","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleX","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleY","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#angle","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#rotation","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRandomPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRotation","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setAngle","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setScale","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setX","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setY","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setZ","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setW","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getParentRotation","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"Acceleration.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal acceleration of this body.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setAccelerationX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationX","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical acceleration of this body.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setAccelerationY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationY","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical acceleration of this body.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal acceleration to apply.","name":"x"},{"type":{"names":["number"]},"description":"The amount of vertical acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setAcceleration","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAcceleration","inherited":true,"___s":true},{"meta":{"filename":"BodyScale.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the size of the physics body.","kind":"function","name":"setBodySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the body in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height of the body in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setBodySize","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyScale#setBodySize","inherited":true,"___s":true},{"meta":{"filename":"BodyScale.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the scale of the physics body.","kind":"function","name":"setBodyScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of the body.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The vertical scale of the body. If not given, will use the horizontal scale value.","name":"scaleY"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setBodyScale","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyScale#setBodyScale","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"getBodyType","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getBodyType","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#getBodyType","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setTypeNone","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeNone","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":46,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setTypeA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeA","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setTypeB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeB","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the impact physics bounce, or restitution, value.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 (no rebound) and 1 (full rebound)","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setBounce","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the minimum velocity the body is allowed to be moving to be considered for rebound.","kind":"function","name":"setMinBounceVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum allowed velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setMinBounceVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Bounce#setMinBounceVelocity","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The bounce, or restitution, value of this body.\nA value between 0 (no rebound) and 1 (full rebound)","name":"bounce","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#bounce","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Bounce#bounce","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setAvsB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setAvsB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setAvsB","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setBvsA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setBvsA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setBvsA","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setCheckAgainstNone","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstNone","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setCheckAgainstA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstA","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setCheckAgainstB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstB","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"checkAgainst","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#checkAgainst","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#checkAgainst","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":29,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollideCallback","since":"3.0.0","params":[{"type":{"names":["CollideCallback"]},"description":"[description]","name":"callback"},{"type":{"names":["*"]},"description":"[description]","name":"scope"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setCollideCallback","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setCollideCallback","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollidesNever","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setCollidesNever","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setCollidesNever","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setLiteCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setLiteCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setLiteCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setPassiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setPassiveCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setPassiveCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setActiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setActiveCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setActiveCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":112,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFixedCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFixedCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setFixedCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"collides","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#collides","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Collides#collides","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"[description]","name":"showBody"},{"type":{"names":["boolean"]},"description":"[description]","name":"showVelocity"},{"type":{"names":["number"]},"description":"[description]","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setDebug","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Debug#setDebug","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setDebugBodyColor","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Debug#setDebugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#debugShowBody","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugShowBody","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":75,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#debugShowVelocity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugShowVelocity","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#debugBodyColor","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFrictionX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFrictionX","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFrictionY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFrictionY","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFriction","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setGravity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Gravity#setGravity","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"gravity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#gravity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Gravity#gravity","inherited":true,"___s":true},{"meta":{"filename":"Offset.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setOffset","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Offset#setOffset","inherited":true,"___s":true},{"meta":{"filename":"SetGameObject.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGameObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"[description]","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"[description]","name":"sync"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setGameObject","scope":"instance","inherits":"Phaser.Physics.Impact.Components.SetGameObject#setGameObject","inherited":true,"___s":true},{"meta":{"filename":"SetGameObject.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"syncGameObject","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#syncGameObject","scope":"instance","inherits":"Phaser.Physics.Impact.Components.SetGameObject#syncGameObject","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical velocities of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the maximum velocity this body can travel at.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The maximum allowed horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The maximum allowed vertical velocity. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setMaxVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setMaxVelocity","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"The Animation Controller of this Sprite.","name":"anims","type":{"names":["Phaser.GameObjects.Components.Animation"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#anims","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Sprite#anims","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Start playing the given animation.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If an animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#play","scope":"instance","inherits":"Phaser.GameObjects.Sprite#play","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Build a JSON representation of this Sprite.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#toJSON","scope":"instance","inherits":"Phaser.GameObjects.Sprite#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#clearAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopRight","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#setBlendMode","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#depth","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#setDepth","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipX","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlip","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#resetFlip","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getRightCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBounds","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originX","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originY","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginX","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginY","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#pipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#initPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#setPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#resetPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#getPipelineName","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#width","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#height","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayWidth","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayHeight","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSizeToFrame","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSize","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setDisplaySize","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#texture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#frame","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#isCropped","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setTexture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setFrame","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#clearTint","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTint","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopRight","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomRight","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tint","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#isTinted","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#x","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#y","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#z","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#w","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scale","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleX","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleY","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#angle","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#rotation","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRandomPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRotation","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setAngle","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setScale","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setX","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setY","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setZ","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setW","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getParentRotation","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"Acceleration.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal acceleration of this body.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setAccelerationX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationX","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical acceleration of this body.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setAccelerationY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationY","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical acceleration of this body.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal acceleration to apply.","name":"x"},{"type":{"names":["number"]},"description":"The amount of vertical acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setAcceleration","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAcceleration","inherited":true,"___s":true},{"meta":{"filename":"BodyScale.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the size of the physics body.","kind":"function","name":"setBodySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the body in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height of the body in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setBodySize","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyScale#setBodySize","inherited":true,"___s":true},{"meta":{"filename":"BodyScale.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the scale of the physics body.","kind":"function","name":"setBodyScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of the body.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The vertical scale of the body. If not given, will use the horizontal scale value.","name":"scaleY"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setBodyScale","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyScale#setBodyScale","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"getBodyType","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getBodyType","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#getBodyType","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setTypeNone","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeNone","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":46,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setTypeA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeA","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setTypeB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeB","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the impact physics bounce, or restitution, value.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 (no rebound) and 1 (full rebound)","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setBounce","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the minimum velocity the body is allowed to be moving to be considered for rebound.","kind":"function","name":"setMinBounceVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum allowed velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setMinBounceVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Bounce#setMinBounceVelocity","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The bounce, or restitution, value of this body.\nA value between 0 (no rebound) and 1 (full rebound)","name":"bounce","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#bounce","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Bounce#bounce","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setAvsB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setAvsB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setAvsB","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setBvsA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setBvsA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setBvsA","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setCheckAgainstNone","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstNone","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setCheckAgainstA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstA","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setCheckAgainstB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstB","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"checkAgainst","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#checkAgainst","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#checkAgainst","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":29,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollideCallback","since":"3.0.0","params":[{"type":{"names":["CollideCallback"]},"description":"[description]","name":"callback"},{"type":{"names":["*"]},"description":"[description]","name":"scope"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setCollideCallback","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setCollideCallback","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollidesNever","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setCollidesNever","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setCollidesNever","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setLiteCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setLiteCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setLiteCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setPassiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setPassiveCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setPassiveCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setActiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setActiveCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setActiveCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":112,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFixedCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFixedCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setFixedCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"collides","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#collides","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Collides#collides","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"[description]","name":"showBody"},{"type":{"names":["boolean"]},"description":"[description]","name":"showVelocity"},{"type":{"names":["number"]},"description":"[description]","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setDebug","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Debug#setDebug","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setDebugBodyColor","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Debug#setDebugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#debugShowBody","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugShowBody","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":75,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#debugShowVelocity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugShowVelocity","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#debugBodyColor","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFrictionX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFrictionX","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFrictionY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFrictionY","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFriction","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setGravity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Gravity#setGravity","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"gravity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#gravity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Gravity#gravity","inherited":true,"___s":true},{"meta":{"filename":"Offset.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setOffset","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Offset#setOffset","inherited":true,"___s":true},{"meta":{"filename":"SetGameObject.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGameObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"[description]","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"[description]","name":"sync"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setGameObject","scope":"instance","inherits":"Phaser.Physics.Impact.Components.SetGameObject#setGameObject","inherited":true,"___s":true},{"meta":{"filename":"SetGameObject.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"syncGameObject","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#syncGameObject","scope":"instance","inherits":"Phaser.Physics.Impact.Components.SetGameObject#syncGameObject","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical velocities of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the maximum velocity this body can travel at.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The maximum allowed horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The maximum allowed vertical velocity. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setMaxVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setMaxVelocity","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#clearAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopRight","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#setBlendMode","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#depth","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#setDepth","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipX","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlip","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#resetFlip","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getRightCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBounds","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originX","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originY","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginX","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginY","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#pipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#initPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#setPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#resetPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#getPipelineName","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#width","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#height","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayWidth","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayHeight","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSizeToFrame","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSize","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setDisplaySize","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#texture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#frame","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#isCropped","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setTexture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setFrame","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#clearTint","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTint","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopRight","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomRight","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tint","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#isTinted","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#x","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#y","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#z","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#w","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scale","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleX","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleY","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#angle","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#rotation","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRandomPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRotation","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setAngle","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setScale","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setX","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setY","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setZ","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setW","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getParentRotation","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the restitution on the physics object.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setBounce","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\nTwo bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\ncategories are included in their collision masks (see {@link #setCollidesWith}).","kind":"function","name":"setCollisionCategory","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique category bitfield.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setCollisionCategory","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollisionCategory","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\nthey will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\nIf two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\nthey will never collide.","kind":"function","name":"setCollisionGroup","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique group index.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setCollisionGroup","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollisionGroup","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\ncollide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\nand `(categoryB & maskA) !== 0` are both true.","kind":"function","name":"setCollidesWith","since":"3.0.0","params":[{"type":{"names":["number","Array."]},"description":"A unique category bitfield, or an array of them.","name":"categories"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setCollidesWith","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollidesWith","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollide","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body starts colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setOnCollide","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollide","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideEnd","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body stops colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setOnCollideEnd","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideEnd","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideActive","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke for the duration of this body colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setOnCollideActive","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideActive","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideWith","since":"3.22.0","params":[{"type":{"names":["MatterJS.Body","Array."]},"description":"The body, or an array of bodies, to test for collisions with.","name":"body"},{"type":{"names":["function"]},"description":"The callback to invoke when this body collides with the given body or bodies.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setOnCollideWith","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideWith","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Applies a force to a body.","kind":"function","name":"applyForce","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#applyForce","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#applyForce","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":38,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Applies a force to a body from a given position.","kind":"function","name":"applyForceFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The position in which the force comes from.","name":"position"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#applyForceFrom","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#applyForceFrom","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the forward position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrust","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#thrust","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrust","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the left position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustLeft","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#thrustLeft","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrustLeft","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":102,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the right position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustRight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#thrustRight","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrustRight","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the back position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustBack","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#thrustBack","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrustBack","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets new friction values for this Game Object's Matter Body.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.","name":"air"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.","name":"fstatic"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFriction","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new air resistance for this Game Object's Matter Body.\nA value of 0 means the Body will never slow as it moves through space.\nThe higher the value, the faster a Body slows when moving through space.","kind":"function","name":"setFrictionAir","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new air resistance for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFrictionAir","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFrictionAir","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new static friction for this Game Object's Matter Body.\nA value of 0 means the Body will never \"stick\" when it is nearly stationary.\nThe higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.","kind":"function","name":"setFrictionStatic","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new static friction for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFrictionStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFrictionStatic","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A togglable function for ignoring world gravity in real-time on the current body.","kind":"function","name":"setIgnoreGravity","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to true to ignore the effect of world gravity, or false to not ignore it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setIgnoreGravity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the mass of the Game Object's Matter Body.","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setMass","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Mass#setMass","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets density of the body.","kind":"function","name":"setDensity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new density of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setDensity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Mass#setDensity","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The body's center of mass.\n\nCalling this creates a new `Vector2 each time to avoid mutation.\n\nIf you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.","name":"centerOfMass","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.10.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The center of mass."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#centerOfMass","scope":"instance","kind":"member","inherits":"Phaser.Physics.Matter.Components.Mass#centerOfMass","inherited":true,"___s":true},{"meta":{"filename":"Sensor.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body belonging to this Game Object to be a sensor.\nSensors trigger collision events, but don't react with colliding body physically.","kind":"function","name":"setSensor","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as a sensor, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSensor","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sensor#setSensor","inherited":true,"___s":true},{"meta":{"filename":"Sensor.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Is the body belonging to this Game Object a sensor or not?","kind":"function","name":"isSensor","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is a sensor, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#isSensor","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sensor#isSensor","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":23,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on a Game Object to a rectangle.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setRectangle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setRectangle","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setRectangle","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on a Game Object to a circle.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setCircle","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setCircle","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":62,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on the Game Object to a polygon shape.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setPolygon","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number of sides the polygon will have.","name":"sides"},{"type":{"names":["number"]},"description":"The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setPolygon","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setPolygon","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on the Game Object to a trapezoid shape.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setTrapezoid","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the trapezoid Body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the trapezoid Body.","name":"height"},{"type":{"names":["number"]},"description":"The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.","name":"slope"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setTrapezoid","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setTrapezoid","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set this Game Object to use the given existing Matter Body.\n\nThe body is first removed from the world before being added to this Game Object.","kind":"function","name":"setExistingBody","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Body this Game Object should use.","name":"body"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setExistingBody","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setExistingBody","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set this Game Object to create and use a new Body based on the configuration object given.\n\nCalling this method resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setBody","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Physics.Matter.MatterSetBodyConfig"]},"description":"Either a string, such as `circle`, or a Matter Set Body Configuration object.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setBody","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setBody","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets this Body to sleep.","kind":"function","name":"setToSleep","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setToSleep","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setToSleep","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Wakes this Body if asleep.","kind":"function","name":"setAwake","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setAwake","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setAwake","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).","kind":"function","name":"setSleepThreshold","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSleepThreshold","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepThreshold","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enable sleep and wake events for this body.\n\nBy default when a body goes to sleep, or wakes up, it will not emit any events.\n\nThe events are emitted by the Matter World instance and can be listened to via\nthe `SLEEP_START` and `SLEEP_END` events.","kind":"function","name":"setSleepEvents","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` if you want the sleep start event to be emitted for this body.","name":"start"},{"type":{"names":["boolean"]},"description":"`true` if you want the sleep end event to be emitted for this body.","name":"end"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSleepEvents","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepEvents","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":88,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep Start event for this body.","kind":"function","name":"setSleepStartEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSleepStartEvent","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep End event for this body.","kind":"function","name":"setSleepEndEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSleepEndEvent","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent","inherited":true,"___s":true},{"meta":{"filename":"Static.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Changes the physics body to be either static `true` or dynamic `false`.","kind":"function","name":"setStatic","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as being static, or `false` to make it dynamic.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Static#setStatic","inherited":true,"___s":true},{"meta":{"filename":"Static.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Returns `true` if the body is static, otherwise `false` for a dynamic body.","kind":"function","name":"isStatic","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is static, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#isStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Static#isStatic","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":239,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Setting fixed rotation sets the Body inertia to Infinity, which stops it\nfrom being able to rotate when forces are applied to it.","kind":"function","name":"setFixedRotation","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFixedRotation","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Transform#setFixedRotation","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the angular velocity of the body instantly.\nPosition, angle, force etc. are unchanged.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setAngularVelocity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setAngularVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets both the horizontal and vertical velocity of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value, it can be either positive or negative. If not given, it will be the same as the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setVelocity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"The Animation Controller of this Sprite.","name":"anims","type":{"names":["Phaser.GameObjects.Components.Animation"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#anims","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Sprite#anims","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Start playing the given animation.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If an animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#play","scope":"instance","inherits":"Phaser.GameObjects.Sprite#play","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Build a JSON representation of this Sprite.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#toJSON","scope":"instance","inherits":"Phaser.GameObjects.Sprite#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#clearAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopRight","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#setBlendMode","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#depth","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#setDepth","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipX","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlip","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#resetFlip","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getRightCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBounds","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originX","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originY","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginX","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginY","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#pipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#initPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#setPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#resetPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#getPipelineName","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#width","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#height","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayWidth","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayHeight","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSizeToFrame","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSize","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setDisplaySize","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#texture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#frame","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#isCropped","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setTexture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setFrame","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#clearTint","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTint","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopRight","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomRight","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tint","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#isTinted","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#x","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#y","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#z","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#w","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scale","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleX","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleY","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#angle","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#rotation","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRandomPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRotation","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setAngle","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setScale","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setX","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setY","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setZ","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setW","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getParentRotation","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the restitution on the physics object.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setBounce","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\nTwo bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\ncategories are included in their collision masks (see {@link #setCollidesWith}).","kind":"function","name":"setCollisionCategory","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique category bitfield.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setCollisionCategory","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollisionCategory","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\nthey will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\nIf two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\nthey will never collide.","kind":"function","name":"setCollisionGroup","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique group index.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setCollisionGroup","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollisionGroup","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\ncollide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\nand `(categoryB & maskA) !== 0` are both true.","kind":"function","name":"setCollidesWith","since":"3.0.0","params":[{"type":{"names":["number","Array."]},"description":"A unique category bitfield, or an array of them.","name":"categories"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setCollidesWith","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollidesWith","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollide","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body starts colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setOnCollide","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollide","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideEnd","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body stops colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setOnCollideEnd","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideEnd","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideActive","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke for the duration of this body colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setOnCollideActive","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideActive","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideWith","since":"3.22.0","params":[{"type":{"names":["MatterJS.Body","Array."]},"description":"The body, or an array of bodies, to test for collisions with.","name":"body"},{"type":{"names":["function"]},"description":"The callback to invoke when this body collides with the given body or bodies.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setOnCollideWith","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideWith","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Applies a force to a body.","kind":"function","name":"applyForce","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#applyForce","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#applyForce","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":38,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Applies a force to a body from a given position.","kind":"function","name":"applyForceFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The position in which the force comes from.","name":"position"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#applyForceFrom","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#applyForceFrom","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the forward position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrust","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#thrust","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrust","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the left position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustLeft","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#thrustLeft","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrustLeft","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":102,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the right position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustRight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#thrustRight","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrustRight","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the back position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustBack","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#thrustBack","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrustBack","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets new friction values for this Game Object's Matter Body.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.","name":"air"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.","name":"fstatic"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFriction","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new air resistance for this Game Object's Matter Body.\nA value of 0 means the Body will never slow as it moves through space.\nThe higher the value, the faster a Body slows when moving through space.","kind":"function","name":"setFrictionAir","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new air resistance for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFrictionAir","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFrictionAir","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new static friction for this Game Object's Matter Body.\nA value of 0 means the Body will never \"stick\" when it is nearly stationary.\nThe higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.","kind":"function","name":"setFrictionStatic","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new static friction for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFrictionStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFrictionStatic","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A togglable function for ignoring world gravity in real-time on the current body.","kind":"function","name":"setIgnoreGravity","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to true to ignore the effect of world gravity, or false to not ignore it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setIgnoreGravity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the mass of the Game Object's Matter Body.","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setMass","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Mass#setMass","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets density of the body.","kind":"function","name":"setDensity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new density of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setDensity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Mass#setDensity","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The body's center of mass.\n\nCalling this creates a new `Vector2 each time to avoid mutation.\n\nIf you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.","name":"centerOfMass","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.10.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The center of mass."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#centerOfMass","scope":"instance","kind":"member","inherits":"Phaser.Physics.Matter.Components.Mass#centerOfMass","inherited":true,"___s":true},{"meta":{"filename":"Sensor.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body belonging to this Game Object to be a sensor.\nSensors trigger collision events, but don't react with colliding body physically.","kind":"function","name":"setSensor","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as a sensor, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSensor","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sensor#setSensor","inherited":true,"___s":true},{"meta":{"filename":"Sensor.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Is the body belonging to this Game Object a sensor or not?","kind":"function","name":"isSensor","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is a sensor, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#isSensor","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sensor#isSensor","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":23,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on a Game Object to a rectangle.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setRectangle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setRectangle","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setRectangle","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on a Game Object to a circle.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setCircle","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setCircle","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":62,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on the Game Object to a polygon shape.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setPolygon","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number of sides the polygon will have.","name":"sides"},{"type":{"names":["number"]},"description":"The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setPolygon","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setPolygon","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on the Game Object to a trapezoid shape.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setTrapezoid","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the trapezoid Body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the trapezoid Body.","name":"height"},{"type":{"names":["number"]},"description":"The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.","name":"slope"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setTrapezoid","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setTrapezoid","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set this Game Object to use the given existing Matter Body.\n\nThe body is first removed from the world before being added to this Game Object.","kind":"function","name":"setExistingBody","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Body this Game Object should use.","name":"body"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setExistingBody","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setExistingBody","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set this Game Object to create and use a new Body based on the configuration object given.\n\nCalling this method resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setBody","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Physics.Matter.MatterSetBodyConfig"]},"description":"Either a string, such as `circle`, or a Matter Set Body Configuration object.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setBody","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setBody","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets this Body to sleep.","kind":"function","name":"setToSleep","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setToSleep","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setToSleep","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Wakes this Body if asleep.","kind":"function","name":"setAwake","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setAwake","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setAwake","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).","kind":"function","name":"setSleepThreshold","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSleepThreshold","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepThreshold","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enable sleep and wake events for this body.\n\nBy default when a body goes to sleep, or wakes up, it will not emit any events.\n\nThe events are emitted by the Matter World instance and can be listened to via\nthe `SLEEP_START` and `SLEEP_END` events.","kind":"function","name":"setSleepEvents","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` if you want the sleep start event to be emitted for this body.","name":"start"},{"type":{"names":["boolean"]},"description":"`true` if you want the sleep end event to be emitted for this body.","name":"end"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSleepEvents","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepEvents","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":88,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep Start event for this body.","kind":"function","name":"setSleepStartEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSleepStartEvent","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep End event for this body.","kind":"function","name":"setSleepEndEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSleepEndEvent","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent","inherited":true,"___s":true},{"meta":{"filename":"Static.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Changes the physics body to be either static `true` or dynamic `false`.","kind":"function","name":"setStatic","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as being static, or `false` to make it dynamic.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Static#setStatic","inherited":true,"___s":true},{"meta":{"filename":"Static.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Returns `true` if the body is static, otherwise `false` for a dynamic body.","kind":"function","name":"isStatic","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is static, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#isStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Static#isStatic","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":239,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Setting fixed rotation sets the Body inertia to Infinity, which stops it\nfrom being able to rotate when forces are applied to it.","kind":"function","name":"setFixedRotation","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFixedRotation","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Transform#setFixedRotation","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the angular velocity of the body instantly.\nPosition, angle, force etc. are unchanged.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setAngularVelocity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setAngularVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets both the horizontal and vertical velocity of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value, it can be either positive or negative. If not given, it will be the same as the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setVelocity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the restitution on the physics object.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setBounce","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\nTwo bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\ncategories are included in their collision masks (see {@link #setCollidesWith}).","kind":"function","name":"setCollisionCategory","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique category bitfield.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setCollisionCategory","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollisionCategory","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\nthey will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\nIf two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\nthey will never collide.","kind":"function","name":"setCollisionGroup","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique group index.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setCollisionGroup","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollisionGroup","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\ncollide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\nand `(categoryB & maskA) !== 0` are both true.","kind":"function","name":"setCollidesWith","since":"3.0.0","params":[{"type":{"names":["number","Array."]},"description":"A unique category bitfield, or an array of them.","name":"categories"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setCollidesWith","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollidesWith","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollide","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body starts colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setOnCollide","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollide","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideEnd","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body stops colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setOnCollideEnd","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideEnd","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideActive","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke for the duration of this body colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setOnCollideActive","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideActive","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideWith","since":"3.22.0","params":[{"type":{"names":["MatterJS.Body","Array."]},"description":"The body, or an array of bodies, to test for collisions with.","name":"body"},{"type":{"names":["function"]},"description":"The callback to invoke when this body collides with the given body or bodies.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setOnCollideWith","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideWith","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets new friction values for this Game Object's Matter Body.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.","name":"air"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.","name":"fstatic"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setFriction","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new air resistance for this Game Object's Matter Body.\nA value of 0 means the Body will never slow as it moves through space.\nThe higher the value, the faster a Body slows when moving through space.","kind":"function","name":"setFrictionAir","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new air resistance for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setFrictionAir","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFrictionAir","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new static friction for this Game Object's Matter Body.\nA value of 0 means the Body will never \"stick\" when it is nearly stationary.\nThe higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.","kind":"function","name":"setFrictionStatic","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new static friction for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setFrictionStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFrictionStatic","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A togglable function for ignoring world gravity in real-time on the current body.","kind":"function","name":"setIgnoreGravity","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to true to ignore the effect of world gravity, or false to not ignore it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setIgnoreGravity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the mass of the Game Object's Matter Body.","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setMass","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Mass#setMass","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets density of the body.","kind":"function","name":"setDensity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new density of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setDensity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Mass#setDensity","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The body's center of mass.\n\nCalling this creates a new `Vector2 each time to avoid mutation.\n\nIf you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.","name":"centerOfMass","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.10.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The center of mass."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#centerOfMass","scope":"instance","kind":"member","inherits":"Phaser.Physics.Matter.Components.Mass#centerOfMass","inherited":true,"___s":true},{"meta":{"filename":"Sensor.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body belonging to this Game Object to be a sensor.\nSensors trigger collision events, but don't react with colliding body physically.","kind":"function","name":"setSensor","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as a sensor, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setSensor","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sensor#setSensor","inherited":true,"___s":true},{"meta":{"filename":"Sensor.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Is the body belonging to this Game Object a sensor or not?","kind":"function","name":"isSensor","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is a sensor, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#isSensor","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sensor#isSensor","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets this Body to sleep.","kind":"function","name":"setToSleep","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setToSleep","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setToSleep","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Wakes this Body if asleep.","kind":"function","name":"setAwake","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setAwake","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setAwake","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).","kind":"function","name":"setSleepThreshold","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setSleepThreshold","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepThreshold","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enable sleep and wake events for this body.\n\nBy default when a body goes to sleep, or wakes up, it will not emit any events.\n\nThe events are emitted by the Matter World instance and can be listened to via\nthe `SLEEP_START` and `SLEEP_END` events.","kind":"function","name":"setSleepEvents","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` if you want the sleep start event to be emitted for this body.","name":"start"},{"type":{"names":["boolean"]},"description":"`true` if you want the sleep end event to be emitted for this body.","name":"end"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setSleepEvents","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepEvents","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":88,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep Start event for this body.","kind":"function","name":"setSleepStartEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setSleepStartEvent","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep End event for this body.","kind":"function","name":"setSleepEndEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setSleepEndEvent","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent","inherited":true,"___s":true},{"meta":{"filename":"Static.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Changes the physics body to be either static `true` or dynamic `false`.","kind":"function","name":"setStatic","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as being static, or `false` to make it dynamic.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Static#setStatic","inherited":true,"___s":true},{"meta":{"filename":"Static.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Returns `true` if the body is static, otherwise `false` for a dynamic body.","kind":"function","name":"isStatic","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is static, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#isStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Static#isStatic","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BasePlugin.js","lineno":49,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The PluginManager calls this method on a Global Plugin when the plugin is first instantiated.\nIt will never be called again on this instance.\nIn here you can set-up whatever you need for this plugin to run.\nIf a plugin is set to automatically start then `BasePlugin.start` will be called immediately after this.\nOn a Scene Plugin, this method is never called. Use {@link Phaser.Plugins.ScenePlugin#boot} instead.","kind":"function","name":"init","since":"3.8.0","params":[{"type":{"names":["any"]},"optional":true,"nullable":true,"description":"A value specified by the user, if any, from the `data` property of the plugin's configuration object (if started at game boot) or passed in the PluginManager's `install` method (if started manually).","name":"data"}],"memberof":"Phaser.Plugins.ScenePlugin","longname":"Phaser.Plugins.ScenePlugin#init","scope":"instance","inherits":"Phaser.Plugins.BasePlugin#init","inherited":true,"___s":true},{"meta":{"filename":"BasePlugin.js","lineno":65,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The PluginManager calls this method on a Global Plugin when the plugin is started.\nIf a plugin is stopped, and then started again, this will get called again.\nTypically called immediately after `BasePlugin.init`.\nOn a Scene Plugin, this method is never called.","kind":"function","name":"start","since":"3.8.0","memberof":"Phaser.Plugins.ScenePlugin","longname":"Phaser.Plugins.ScenePlugin#start","scope":"instance","inherits":"Phaser.Plugins.BasePlugin#start","inherited":true,"___s":true},{"meta":{"filename":"BasePlugin.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The PluginManager calls this method on a Global Plugin when the plugin is stopped.\nThe game code has requested that your plugin stop doing whatever it does.\nIt is now considered as 'inactive' by the PluginManager.\nHandle that process here (i.e. stop listening for events, etc)\nIf the plugin is started again then `BasePlugin.start` will be called again.\nOn a Scene Plugin, this method is never called.","kind":"function","name":"stop","since":"3.8.0","memberof":"Phaser.Plugins.ScenePlugin","longname":"Phaser.Plugins.ScenePlugin#stop","scope":"instance","inherits":"Phaser.Plugins.BasePlugin#stop","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Name of the Pipeline. Used for identifying","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#name","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#name","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The Game which owns this WebGL Pipeline.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#game","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#game","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The canvas which this WebGL Pipeline renders to.","name":"view","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#view","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#view","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Used to store the current game resolution","name":"resolution","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#resolution","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#resolution","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Width of the current viewport","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#width","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#width","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Height of the current viewport","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#height","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#height","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL context this WebGL Pipeline uses.","name":"gl","type":{"names":["WebGLRenderingContext"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#gl","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#gl","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"How many vertices have been fed to the current pipeline.","name":"vertexCount","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The limit of vertices that the pipeline can hold","name":"vertexCapacity","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexCapacity","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL Renderer which owns this WebGL Pipeline.","name":"renderer","type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#renderer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#renderer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Raw byte buffer of vertices.","name":"vertexData","type":{"names":["ArrayBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexData","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexData","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL vertex buffer object.","name":"vertexBuffer","type":{"names":["WebGLBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexBuffer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL program","name":"program","type":{"names":["WebGLProgram"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#program","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#program","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Array of objects that describe the vertex attributes","name":"attributes","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#attributes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#attributes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The size in bytes of the vertex","name":"vertexSize","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexSize","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexSize","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The primitive topology which the pipeline will use to submit draw calls","name":"topology","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#topology","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#topology","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":201,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Uint8 view to the vertex raw buffer. Used for uploading vertex buffer resources\nto the GPU.","name":"bytes","type":{"names":["Uint8Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#bytes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bytes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"This will store the amount of components of 32 bit length","name":"vertexComponentCount","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexComponentCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexComponentCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is flushing the contents to the GPU.\nWhen the variable is set the flush function will be locked.","name":"flushLocked","type":{"names":["boolean"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#flushLocked","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#flushLocked","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":230,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is active or not for this frame only.\nReset in the onRender method.","name":"active","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#active","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#active","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called when the Game has fully booted and the Renderer has finished setting up.\n\nBy this stage all Game level systems are now in place and you can perform any final\ntasks that the pipeline may need that relied on game systems such as the Texture Manager.","kind":"function","name":"boot","since":"3.11.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#boot","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#boot","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Adds a description of vertex attribute to the pipeline","kind":"function","name":"addAttribute","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"Name of the vertex attribute","name":"name"},{"type":{"names":["integer"]},"description":"Vertex component size","name":"size"},{"type":{"names":["integer"]},"description":"Type of the attribute","name":"type"},{"type":{"names":["boolean"]},"description":"Is the value normalized to a range","name":"normalized"},{"type":{"names":["integer"]},"description":"Byte offset to the beginning of the first element in the vertex","name":"offset"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#addAttribute","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#addAttribute","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":285,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Check if the current batch of vertices is full.","kind":"function","name":"shouldFlush","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the current batch should be flushed, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#shouldFlush","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds the pipeline resources, including programs, vertex buffers and binds attributes","kind":"function","name":"bind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#bind","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bind","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":374,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before each frame is rendered, but after the canvas has been cleared.","kind":"function","name":"onPreRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onPreRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPreRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":388,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before a Scene's Camera is rendered.","kind":"function","name":"onRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene being rendered.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Scene Camera being rendered with.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":405,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called after each frame has been completely rendered and snapshots have been taken.","kind":"function","name":"onPostRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onPostRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPostRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":419,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Uploads the vertex data and emits a draw call\nfor the current batch of vertices.","kind":"function","name":"flush","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#flush","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#flush","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":454,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes all object references in this WebGL Pipeline and removes its program from the WebGL context.","kind":"function","name":"destroy","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#destroy","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#destroy","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new value of the `float` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec2` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec3` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec3` uniform.","name":"y"},{"type":{"names":["number"]},"description":"The new Z component of the `vec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":533,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["number"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["number"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["number"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat1v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":572,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat2v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat3v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat4v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new value of the `int` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setInt1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":644,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec2` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setInt2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":663,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec3` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec3` uniform.","name":"y"},{"type":{"names":["integer"]},"description":"The new Z component of the `ivec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setInt3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["integer"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["integer"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["integer"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setInt4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":704,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat2` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setMatrix2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat3` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setMatrix3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Should the matrix be transpose","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"Matrix data","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setMatrix4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Name of the Pipeline. Used for identifying","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#name","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#name","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The Game which owns this WebGL Pipeline.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#game","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#game","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The canvas which this WebGL Pipeline renders to.","name":"view","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#view","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#view","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Used to store the current game resolution","name":"resolution","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#resolution","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#resolution","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Width of the current viewport","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#width","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#width","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Height of the current viewport","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#height","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#height","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL context this WebGL Pipeline uses.","name":"gl","type":{"names":["WebGLRenderingContext"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#gl","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#gl","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"How many vertices have been fed to the current pipeline.","name":"vertexCount","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The limit of vertices that the pipeline can hold","name":"vertexCapacity","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexCapacity","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL Renderer which owns this WebGL Pipeline.","name":"renderer","type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#renderer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#renderer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Raw byte buffer of vertices.","name":"vertexData","type":{"names":["ArrayBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexData","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexData","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL vertex buffer object.","name":"vertexBuffer","type":{"names":["WebGLBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexBuffer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL program","name":"program","type":{"names":["WebGLProgram"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#program","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#program","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Array of objects that describe the vertex attributes","name":"attributes","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#attributes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#attributes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The size in bytes of the vertex","name":"vertexSize","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexSize","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexSize","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The primitive topology which the pipeline will use to submit draw calls","name":"topology","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#topology","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#topology","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":201,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Uint8 view to the vertex raw buffer. Used for uploading vertex buffer resources\nto the GPU.","name":"bytes","type":{"names":["Uint8Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#bytes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bytes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"This will store the amount of components of 32 bit length","name":"vertexComponentCount","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexComponentCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexComponentCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is flushing the contents to the GPU.\nWhen the variable is set the flush function will be locked.","name":"flushLocked","type":{"names":["boolean"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#flushLocked","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#flushLocked","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":230,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is active or not for this frame only.\nReset in the onRender method.","name":"active","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#active","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#active","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called when the Game has fully booted and the Renderer has finished setting up.\n\nBy this stage all Game level systems are now in place and you can perform any final\ntasks that the pipeline may need that relied on game systems such as the Texture Manager.","kind":"function","name":"boot","since":"3.11.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#boot","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#boot","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Adds a description of vertex attribute to the pipeline","kind":"function","name":"addAttribute","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"Name of the vertex attribute","name":"name"},{"type":{"names":["integer"]},"description":"Vertex component size","name":"size"},{"type":{"names":["integer"]},"description":"Type of the attribute","name":"type"},{"type":{"names":["boolean"]},"description":"Is the value normalized to a range","name":"normalized"},{"type":{"names":["integer"]},"description":"Byte offset to the beginning of the first element in the vertex","name":"offset"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#addAttribute","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#addAttribute","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":285,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Check if the current batch of vertices is full.","kind":"function","name":"shouldFlush","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the current batch should be flushed, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#shouldFlush","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds the pipeline resources, including programs, vertex buffers and binds attributes","kind":"function","name":"bind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#bind","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bind","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":374,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before each frame is rendered, but after the canvas has been cleared.","kind":"function","name":"onPreRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onPreRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPreRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":388,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before a Scene's Camera is rendered.","kind":"function","name":"onRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene being rendered.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Scene Camera being rendered with.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":405,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called after each frame has been completely rendered and snapshots have been taken.","kind":"function","name":"onPostRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onPostRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPostRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":454,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes all object references in this WebGL Pipeline and removes its program from the WebGL context.","kind":"function","name":"destroy","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#destroy","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#destroy","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new value of the `float` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec2` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec3` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec3` uniform.","name":"y"},{"type":{"names":["number"]},"description":"The new Z component of the `vec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":533,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["number"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["number"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["number"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat1v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":572,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat2v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat3v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat4v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new value of the `int` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setInt1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":644,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec2` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setInt2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":663,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec3` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec3` uniform.","name":"y"},{"type":{"names":["integer"]},"description":"The new Z component of the `ivec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setInt3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["integer"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["integer"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["integer"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setInt4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":704,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat2` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setMatrix2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat3` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setMatrix3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Should the matrix be transpose","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"Matrix data","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setMatrix4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Float32 view of the array buffer containing the pipeline's vertices.","name":"vertexViewF32","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexViewF32","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexViewF32","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Uint32 view of the array buffer containing the pipeline's vertices.","name":"vertexViewU32","type":{"names":["Uint32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexViewU32","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexViewU32","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Size of the batch.","name":"maxQuads","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#maxQuads","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#maxQuads","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Collection of batch information","name":"batches","type":{"names":["array"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batches","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batches","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":266,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Called every time the pipeline needs to be used.\nIt binds all necessary resources.","kind":"function","name":"onBind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#onBind","scope":"instance","overrides":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onBind","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onBind","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":284,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Resizes this pipeline and updates the projection.","kind":"function","name":"resize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new width.","name":"width"},{"type":{"names":["number"]},"description":"The new height.","name":"height"},{"type":{"names":["number"]},"description":"The resolution.","name":"resolution"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#resize","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#resize","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":305,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Assigns a texture to the current batch. If a different texture is already set it creates a new batch object.","kind":"function","name":"setTexture2D","since":"3.1.0","params":[{"type":{"names":["WebGLTexture"]},"optional":true,"description":"WebGLTexture that will be assigned to the current batch. If not given uses blankTexture.","name":"texture"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This pipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setTexture2D","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setTexture2D","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":329,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Checks if the current batch has the same texture and texture unit, or if we need to create a new batch.","kind":"function","name":"requireTextureBatch","since":"3.16.0","params":[{"type":{"names":["WebGLTexture"]},"description":"WebGLTexture that will be assigned to the current batch. If not given uses blankTexture.","name":"texture"},{"type":{"names":["integer"]},"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline needs to create a new batch, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#requireTextureBatch","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#requireTextureBatch","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":356,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Creates a new batch object and pushes it to a batch array.\nThe batch object contains information relevant to the current \nvertex batch like the offset in the vertex buffer, vertex count and \nthe textures used by that batch.","kind":"function","name":"pushBatch","since":"3.1.0","params":[{"type":{"names":["WebGLTexture"]},"description":"Optional WebGLTexture that will be assigned to the created batch.","name":"texture"},{"type":{"names":["integer"]},"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#pushBatch","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#pushBatch","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Uploads the vertex data and emits a draw call for the current batch of vertices.","kind":"function","name":"flush","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#flush","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#flush","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":659,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the vertices data into the batch and flushes if full.\n\nAssumes 6 vertices in the following arrangement:\n\n```\n0----3\n|\\ B|\n| \\ |\n| \\ |\n| A \\|\n| \\\n1----2\n```\n\nWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3","kind":"function","name":"batchQuad","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The top-left x position.","name":"x0"},{"type":{"names":["number"]},"description":"The top-left y position.","name":"y0"},{"type":{"names":["number"]},"description":"The bottom-left x position.","name":"x1"},{"type":{"names":["number"]},"description":"The bottom-left y position.","name":"y1"},{"type":{"names":["number"]},"description":"The bottom-right x position.","name":"x2"},{"type":{"names":["number"]},"description":"The bottom-right y position.","name":"y2"},{"type":{"names":["number"]},"description":"The top-right x position.","name":"x3"},{"type":{"names":["number"]},"description":"The top-right y position.","name":"y3"},{"type":{"names":["number"]},"description":"UV u0 value.","name":"u0"},{"type":{"names":["number"]},"description":"UV v0 value.","name":"v0"},{"type":{"names":["number"]},"description":"UV u1 value.","name":"u1"},{"type":{"names":["number"]},"description":"UV v1 value.","name":"v1"},{"type":{"names":["number"]},"description":"The top-left tint color value.","name":"tintTL"},{"type":{"names":["number"]},"description":"The top-right tint color value.","name":"tintTR"},{"type":{"names":["number"]},"description":"The bottom-left tint color value.","name":"tintBL"},{"type":{"names":["number"]},"description":"The bottom-right tint color value.","name":"tintBR"},{"type":{"names":["number","boolean"]},"description":"The tint effect for the shader to use.","name":"tintEffect"},{"type":{"names":["WebGLTexture"]},"optional":true,"description":"WebGLTexture that will be assigned to the current batch if a flush occurs.","name":"texture"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if this method caused the batch to flush, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchQuad","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchQuad","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":766,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the vertices data into the batch and flushes if full.\n\nAssumes 3 vertices in the following arrangement:\n\n```\n0\n|\\\n| \\\n| \\\n| \\\n| \\\n1-----2\n```","kind":"function","name":"batchTri","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The bottom-left x position.","name":"x1"},{"type":{"names":["number"]},"description":"The bottom-left y position.","name":"y1"},{"type":{"names":["number"]},"description":"The bottom-right x position.","name":"x2"},{"type":{"names":["number"]},"description":"The bottom-right y position.","name":"y2"},{"type":{"names":["number"]},"description":"The top-right x position.","name":"x3"},{"type":{"names":["number"]},"description":"The top-right y position.","name":"y3"},{"type":{"names":["number"]},"description":"UV u0 value.","name":"u0"},{"type":{"names":["number"]},"description":"UV v0 value.","name":"v0"},{"type":{"names":["number"]},"description":"UV u1 value.","name":"u1"},{"type":{"names":["number"]},"description":"UV v1 value.","name":"v1"},{"type":{"names":["number"]},"description":"The top-left tint color value.","name":"tintTL"},{"type":{"names":["number"]},"description":"The top-right tint color value.","name":"tintTR"},{"type":{"names":["number"]},"description":"The bottom-left tint color value.","name":"tintBL"},{"type":{"names":["number","boolean"]},"description":"The tint effect for the shader to use.","name":"tintEffect"},{"type":{"names":["WebGLTexture"]},"optional":true,"description":"WebGLTexture that will be assigned to the current batch if a flush occurs.","name":"texture"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if this method caused the batch to flush, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchTri","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTri","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1030,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds a Texture Frame into the batch for rendering.","kind":"function","name":"batchTextureFrame","since":"3.12.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The Texture Frame to be rendered.","name":"frame"},{"type":{"names":["number"]},"description":"The horizontal position to render the texture at.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position to render the texture at.","name":"y"},{"type":{"names":["number"]},"description":"The tint color.","name":"tint"},{"type":{"names":["number"]},"description":"The alpha value.","name":"alpha"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The Transform Matrix to use for the texture.","name":"transformMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A parent Transform Matrix.","name":"parentTransformMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchTextureFrame","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTextureFrame","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a filled rectangle into the vertex batch.\nRectangle has no transform values and isn't transformed into the local space.\nUsed for directly batching untransformed rectangles, such as Camera background colors.","kind":"function","name":"drawFillRect","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Horizontal top left coordinate of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"Vertical top left coordinate of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["number"]},"description":"Color of the rectangle to draw.","name":"color"},{"type":{"names":["number"]},"description":"Alpha value of the rectangle to draw.","name":"alpha"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#drawFillRect","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#drawFillRect","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1115,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a filled rectangle into the vertex batch.\nRectangle factors in the given transform matrices before adding to the batch.","kind":"function","name":"batchFillRect","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Horizontal top left coordinate of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"Vertical top left coordinate of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchFillRect","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchFillRect","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a filled triangle into the vertex batch.\nTriangle factors in the given transform matrices before adding to the batch.","kind":"function","name":"batchFillTriangle","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Point 0 x coordinate.","name":"x0"},{"type":{"names":["number"]},"description":"Point 0 y coordinate.","name":"y0"},{"type":{"names":["number"]},"description":"Point 1 x coordinate.","name":"x1"},{"type":{"names":["number"]},"description":"Point 1 y coordinate.","name":"y1"},{"type":{"names":["number"]},"description":"Point 2 x coordinate.","name":"x2"},{"type":{"names":["number"]},"description":"Point 2 y coordinate.","name":"y2"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchFillTriangle","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchFillTriangle","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a stroked triangle into the vertex batch.\nTriangle factors in the given transform matrices before adding to the batch.\nThe triangle is created from 3 lines and drawn using the `batchStrokePath` method.","kind":"function","name":"batchStrokeTriangle","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Point 0 x coordinate.","name":"x0"},{"type":{"names":["number"]},"description":"Point 0 y coordinate.","name":"y0"},{"type":{"names":["number"]},"description":"Point 1 x coordinate.","name":"x1"},{"type":{"names":["number"]},"description":"Point 1 y coordinate.","name":"y1"},{"type":{"names":["number"]},"description":"Point 2 x coordinate.","name":"x2"},{"type":{"names":["number"]},"description":"Point 2 y coordinate.","name":"y2"},{"type":{"names":["number"]},"description":"The width of the line in pixels.","name":"lineWidth"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchStrokeTriangle","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchStrokeTriangle","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the given path to the vertex batch for rendering.\n\nIt works by taking the array of path data and then passing it through Earcut, which\ncreates a list of polygons. Each polygon is then added to the batch.\n\nThe path is always automatically closed because it's filled.","kind":"function","name":"batchFillPath","since":"3.12.0","params":[{"type":{"names":["array"]},"description":"Collection of points that represent the path.","name":"path"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchFillPath","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchFillPath","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1335,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the given path to the vertex batch for rendering.\n\nIt works by taking the array of path data and calling `batchLine` for each section\nof the path.\n\nThe path is optionally closed at the end.","kind":"function","name":"batchStrokePath","since":"3.12.0","params":[{"type":{"names":["array"]},"description":"Collection of points that represent the path.","name":"path"},{"type":{"names":["number"]},"description":"The width of the line segments in pixels.","name":"lineWidth"},{"type":{"names":["boolean"]},"description":"Indicates if the path should be closed or left open.","name":"pathOpen"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchStrokePath","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchStrokePath","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1383,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Creates a quad and adds it to the vertex batch based on the given line values.","kind":"function","name":"batchLine","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"X coordinate to the start of the line","name":"ax"},{"type":{"names":["number"]},"description":"Y coordinate to the start of the line","name":"ay"},{"type":{"names":["number"]},"description":"X coordinate to the end of the line","name":"bx"},{"type":{"names":["number"]},"description":"Y coordinate to the end of the line","name":"by"},{"type":{"names":["number"]},"description":"Width of the start of the line","name":"aLineWidth"},{"type":{"names":["number"]},"description":"Width of the end of the line","name":"bLineWidth"},{"type":{"names":["Float32Array"]},"description":"Parent matrix, generally used by containers","name":"currentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchLine","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchLine","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Name of the Pipeline. Used for identifying","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#name","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#name","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The Game which owns this WebGL Pipeline.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#game","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#game","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The canvas which this WebGL Pipeline renders to.","name":"view","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#view","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#view","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Used to store the current game resolution","name":"resolution","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#resolution","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#resolution","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Width of the current viewport","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#width","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#width","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Height of the current viewport","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#height","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#height","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL context this WebGL Pipeline uses.","name":"gl","type":{"names":["WebGLRenderingContext"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#gl","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#gl","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"How many vertices have been fed to the current pipeline.","name":"vertexCount","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The limit of vertices that the pipeline can hold","name":"vertexCapacity","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexCapacity","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL Renderer which owns this WebGL Pipeline.","name":"renderer","type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#renderer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#renderer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Raw byte buffer of vertices.","name":"vertexData","type":{"names":["ArrayBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexData","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexData","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL vertex buffer object.","name":"vertexBuffer","type":{"names":["WebGLBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexBuffer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL program","name":"program","type":{"names":["WebGLProgram"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#program","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#program","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Array of objects that describe the vertex attributes","name":"attributes","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#attributes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#attributes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The size in bytes of the vertex","name":"vertexSize","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexSize","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexSize","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The primitive topology which the pipeline will use to submit draw calls","name":"topology","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#topology","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#topology","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":201,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Uint8 view to the vertex raw buffer. Used for uploading vertex buffer resources\nto the GPU.","name":"bytes","type":{"names":["Uint8Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#bytes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bytes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"This will store the amount of components of 32 bit length","name":"vertexComponentCount","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexComponentCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexComponentCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is flushing the contents to the GPU.\nWhen the variable is set the flush function will be locked.","name":"flushLocked","type":{"names":["boolean"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#flushLocked","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#flushLocked","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":230,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is active or not for this frame only.\nReset in the onRender method.","name":"active","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#active","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#active","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called when the Game has fully booted and the Renderer has finished setting up.\n\nBy this stage all Game level systems are now in place and you can perform any final\ntasks that the pipeline may need that relied on game systems such as the Texture Manager.","kind":"function","name":"boot","since":"3.11.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#boot","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#boot","inherited":true,"overrides":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#boot","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Adds a description of vertex attribute to the pipeline","kind":"function","name":"addAttribute","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"Name of the vertex attribute","name":"name"},{"type":{"names":["integer"]},"description":"Vertex component size","name":"size"},{"type":{"names":["integer"]},"description":"Type of the attribute","name":"type"},{"type":{"names":["boolean"]},"description":"Is the value normalized to a range","name":"normalized"},{"type":{"names":["integer"]},"description":"Byte offset to the beginning of the first element in the vertex","name":"offset"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#addAttribute","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#addAttribute","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":285,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Check if the current batch of vertices is full.","kind":"function","name":"shouldFlush","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the current batch should be flushed, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#shouldFlush","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds the pipeline resources, including programs, vertex buffers and binds attributes","kind":"function","name":"bind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#bind","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bind","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":374,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before each frame is rendered, but after the canvas has been cleared.","kind":"function","name":"onPreRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#onPreRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPreRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":405,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called after each frame has been completely rendered and snapshots have been taken.","kind":"function","name":"onPostRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#onPostRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPostRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":454,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes all object references in this WebGL Pipeline and removes its program from the WebGL context.","kind":"function","name":"destroy","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#destroy","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#destroy","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new value of the `float` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec2` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec3` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec3` uniform.","name":"y"},{"type":{"names":["number"]},"description":"The new Z component of the `vec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":533,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["number"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["number"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["number"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat1v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":572,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat2v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat3v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat4v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new value of the `int` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setInt1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":644,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec2` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setInt2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":663,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec3` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec3` uniform.","name":"y"},{"type":{"names":["integer"]},"description":"The new Z component of the `ivec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setInt3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["integer"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["integer"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["integer"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setInt4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":704,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat2` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setMatrix2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat3` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setMatrix3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Should the matrix be transpose","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"Matrix data","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setMatrix4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Name of the Pipeline. Used for identifying","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#name","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#name","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The Game which owns this WebGL Pipeline.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#game","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#game","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The canvas which this WebGL Pipeline renders to.","name":"view","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#view","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#view","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Used to store the current game resolution","name":"resolution","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#resolution","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#resolution","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Width of the current viewport","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#width","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#width","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Height of the current viewport","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#height","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#height","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL context this WebGL Pipeline uses.","name":"gl","type":{"names":["WebGLRenderingContext"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#gl","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#gl","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"How many vertices have been fed to the current pipeline.","name":"vertexCount","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#vertexCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The limit of vertices that the pipeline can hold","name":"vertexCapacity","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#vertexCapacity","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL Renderer which owns this WebGL Pipeline.","name":"renderer","type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#renderer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#renderer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Raw byte buffer of vertices.","name":"vertexData","type":{"names":["ArrayBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#vertexData","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexData","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL vertex buffer object.","name":"vertexBuffer","type":{"names":["WebGLBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#vertexBuffer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL program","name":"program","type":{"names":["WebGLProgram"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#program","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#program","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Array of objects that describe the vertex attributes","name":"attributes","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#attributes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#attributes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The size in bytes of the vertex","name":"vertexSize","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#vertexSize","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexSize","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The primitive topology which the pipeline will use to submit draw calls","name":"topology","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#topology","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#topology","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":201,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Uint8 view to the vertex raw buffer. Used for uploading vertex buffer resources\nto the GPU.","name":"bytes","type":{"names":["Uint8Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#bytes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bytes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"This will store the amount of components of 32 bit length","name":"vertexComponentCount","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#vertexComponentCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexComponentCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is flushing the contents to the GPU.\nWhen the variable is set the flush function will be locked.","name":"flushLocked","type":{"names":["boolean"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#flushLocked","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#flushLocked","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":230,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is active or not for this frame only.\nReset in the onRender method.","name":"active","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#active","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#active","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called when the Game has fully booted and the Renderer has finished setting up.\n\nBy this stage all Game level systems are now in place and you can perform any final\ntasks that the pipeline may need that relied on game systems such as the Texture Manager.","kind":"function","name":"boot","since":"3.11.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#boot","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#boot","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Adds a description of vertex attribute to the pipeline","kind":"function","name":"addAttribute","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"Name of the vertex attribute","name":"name"},{"type":{"names":["integer"]},"description":"Vertex component size","name":"size"},{"type":{"names":["integer"]},"description":"Type of the attribute","name":"type"},{"type":{"names":["boolean"]},"description":"Is the value normalized to a range","name":"normalized"},{"type":{"names":["integer"]},"description":"Byte offset to the beginning of the first element in the vertex","name":"offset"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#addAttribute","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#addAttribute","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":285,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Check if the current batch of vertices is full.","kind":"function","name":"shouldFlush","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the current batch should be flushed, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#shouldFlush","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds the pipeline resources, including programs, vertex buffers and binds attributes","kind":"function","name":"bind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#bind","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bind","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":374,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before each frame is rendered, but after the canvas has been cleared.","kind":"function","name":"onPreRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#onPreRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPreRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":388,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before a Scene's Camera is rendered.","kind":"function","name":"onRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene being rendered.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Scene Camera being rendered with.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#onRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":405,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called after each frame has been completely rendered and snapshots have been taken.","kind":"function","name":"onPostRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#onPostRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPostRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":454,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes all object references in this WebGL Pipeline and removes its program from the WebGL context.","kind":"function","name":"destroy","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#destroy","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#destroy","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new value of the `float` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setFloat1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec2` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setFloat2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec3` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec3` uniform.","name":"y"},{"type":{"names":["number"]},"description":"The new Z component of the `vec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setFloat3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":533,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["number"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["number"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["number"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setFloat4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setFloat1v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":572,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setFloat2v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setFloat3v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setFloat4v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new value of the `int` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setInt1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":644,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec2` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setInt2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":663,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec3` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec3` uniform.","name":"y"},{"type":{"names":["integer"]},"description":"The new Z component of the `ivec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setInt3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["integer"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["integer"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["integer"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setInt4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":704,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat2` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setMatrix2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat3` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setMatrix3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Should the matrix be transpose","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"Matrix data","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline#setMatrix4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"`this`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"`this`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"`this`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"`this`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"`this`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"`this`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Asset key for the sound.","name":"key","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#key","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#key","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently playing.","name":"isPlaying","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#isPlaying","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#isPlaying","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently paused.","name":"isPaused","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#isPaused","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#isPaused","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A property that holds the value of sound's actual playback rate,\nafter its rate and detune values has been combined with global\nrate and detune values.","name":"totalRate","type":{"names":["number"]},"defaultvalue":"1","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#totalRate","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#totalRate","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A value representing the duration, in seconds.\nIt could be total sound duration or a marker duration.","name":"duration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#duration","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#duration","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"The total duration of the sound in seconds.","name":"totalDuration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#totalDuration","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#totalDuration","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Object containing markers definitions.","name":"markers","type":{"names":["Object."]},"defaultvalue":"{}","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#markers","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#markers","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Currently playing marker.\n'null' if whole sound is playing.","name":"currentMarker","type":{"names":["Phaser.Types.Sound.SoundMarker"]},"defaultvalue":"null","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#currentMarker","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#currentMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\nThis allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.","kind":"function","name":"addMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was added successfully."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#addMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#addMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Updates previously added marker.","kind":"function","name":"updateMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object with updated values.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was updated successfully."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#updateMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#updateMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a marker from the sound.","kind":"function","name":"removeMarker","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the marker to remove.","name":"markerName"}],"returns":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"nullable":true,"description":"Removed marker object or 'null' if there was no marker with provided name."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#removeMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#removeMarker","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to game.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#game","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#game","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to the JSON Cache, as used by Audio Sprites.","name":"jsonCache","type":{"names":["Phaser.Cache.BaseCache"]},"readonly":true,"since":"3.7.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#jsonCache","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#jsonCache","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sounds should be paused when game looses focus,\nfor instance when user switches to another tab/program/app.","name":"pauseOnBlur","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#pauseOnBlur","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#pauseOnBlur","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Mobile devices require sounds to be triggered from an explicit user action,\nsuch as a tap, before any sound can be loaded/played on a web page.\nSet to true if the audio system is currently locked awaiting user interaction.","name":"locked","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#locked","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#locked","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new audio sprite sound into the sound manager.\nAudio Sprites are a combination of audio files and a JSON configuration.\nThe JSON follows the format of that created by https://github.com/tonistiigi/audiosprite","kind":"function","name":"addAudioSprite","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound","Phaser.Sound.WebAudioSound"]},"description":"The new audio sprite sound instance."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#addAudioSprite","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#addAudioSprite","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new sound to the sound manager and plays it.\nThe sound will be automatically removed (destroyed) once playback ends.\nThis lets you play a new sound on the fly without the need to keep a reference to it.","kind":"function","name":"play","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig","Phaser.Types.Sound.SoundMarker"]},"optional":true,"description":"An optional additional object containing settings to be applied to the sound. It could be either config or marker object.","name":"extra"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#play","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#play","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Enables playing audio sprite sound on the fly without the need to keep a reference to it.\nSound will auto destroy once its playback ends.","kind":"function","name":"playAudioSprite","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["string"]},"description":"The name of the sound sprite to play.","name":"spriteName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the audio sprite sound started playing successfully."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#playAudioSprite","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#playAudioSprite","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a sound from the sound manager.\nThe removed sound is destroyed before removal.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The sound object to remove.","name":"sound"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the sound was removed successfully, otherwise false."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#remove","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#remove","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes all sounds from the sound manager that have an asset key matching the given value.\nThe removed sounds are destroyed before removal.","kind":"function","name":"removeByKey","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key to match when removing sound objects.","name":"key"}],"returns":[{"type":{"names":["number"]},"description":"The number of matching sound objects that were removed."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#removeByKey","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#removeByKey","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Pauses all the sounds in the game.","kind":"function","name":"pauseAll","fires":["Phaser.Sound.Events#event:PAUSE_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#pauseAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#pauseAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Resumes all the sounds in the game.","kind":"function","name":"resumeAll","fires":["Phaser.Sound.Events#event:RESUME_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#resumeAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#resumeAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Stops all the sounds in the game.","kind":"function","name":"stopAll","fires":["Phaser.Sound.Events#event:STOP_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#stopAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#stopAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global playback rate at which all the sounds will be played.\n\nFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","kind":"function","name":"setRate","fires":["Phaser.Sound.Events#event:GLOBAL_RATE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"Global playback rate at which all the sounds will be played.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#setRate","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#setRate","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global playback rate at which all the sounds will be played.\nValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audio's playback speed.","name":"rate","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#rate","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#rate","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","kind":"function","name":"setDetune","fires":["Phaser.Sound.Events#event:GLOBAL_DETUNE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#setDetune","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#setDetune","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"detune","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#detune","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#detune","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Asset key for the sound.","name":"key","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#key","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#key","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently playing.","name":"isPlaying","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#isPlaying","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#isPlaying","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently paused.","name":"isPaused","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#isPaused","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#isPaused","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A property that holds the value of sound's actual playback rate,\nafter its rate and detune values has been combined with global\nrate and detune values.","name":"totalRate","type":{"names":["number"]},"defaultvalue":"1","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#totalRate","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#totalRate","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A value representing the duration, in seconds.\nIt could be total sound duration or a marker duration.","name":"duration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#duration","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#duration","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"The total duration of the sound in seconds.","name":"totalDuration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#totalDuration","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#totalDuration","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Object containing markers definitions.","name":"markers","type":{"names":["Object."]},"defaultvalue":"{}","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#markers","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#markers","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Currently playing marker.\n'null' if whole sound is playing.","name":"currentMarker","type":{"names":["Phaser.Types.Sound.SoundMarker"]},"defaultvalue":"null","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#currentMarker","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#currentMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\nThis allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.","kind":"function","name":"addMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was added successfully."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#addMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#addMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Updates previously added marker.","kind":"function","name":"updateMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object with updated values.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was updated successfully."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#updateMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#updateMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a marker from the sound.","kind":"function","name":"removeMarker","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the marker to remove.","name":"markerName"}],"returns":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"nullable":true,"description":"Removed marker object or 'null' if there was no marker with provided name."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#removeMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#removeMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":283,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Play this sound, or a marked section of it.\nIt always plays the sound from the start. If you want to start playback from a specific time\nyou can set 'seek' setting of the config object, provided to this call, to that value.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"''","description":"If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.","name":"markerName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#play","scope":"instance","inherits":"Phaser.Sound.BaseSound#play","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":342,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Pauses the sound.","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was paused successfully."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#pause","scope":"instance","inherits":"Phaser.Sound.BaseSound#pause","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":363,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Resumes the sound.","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was resumed successfully."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#resume","scope":"instance","inherits":"Phaser.Sound.BaseSound#resume","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Stop playing this sound.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was stopped successfully."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#stop","scope":"instance","inherits":"Phaser.Sound.BaseSound#stop","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Destroys this sound and all associated events and marks it for removal from the sound manager.","kind":"function","name":"destroy","fires":["Phaser.Sound.Events#event:DESTROY"],"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#destroy","scope":"instance","inherits":"Phaser.Sound.BaseSound#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to game.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#game","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#game","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to the JSON Cache, as used by Audio Sprites.","name":"jsonCache","type":{"names":["Phaser.Cache.BaseCache"]},"readonly":true,"since":"3.7.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#jsonCache","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#jsonCache","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global mute setting.","name":"mute","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#mute","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#mute","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global volume setting.","name":"volume","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#volume","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#volume","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sounds should be paused when game looses focus,\nfor instance when user switches to another tab/program/app.","name":"pauseOnBlur","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#pauseOnBlur","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#pauseOnBlur","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Mobile devices require sounds to be triggered from an explicit user action,\nsuch as a tap, before any sound can be loaded/played on a web page.\nSet to true if the audio system is currently locked awaiting user interaction.","name":"locked","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#locked","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#locked","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new sound into the sound manager.","kind":"function","name":"add","override":true,"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The new sound instance."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#add","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#add","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new audio sprite sound into the sound manager.\nAudio Sprites are a combination of audio files and a JSON configuration.\nThe JSON follows the format of that created by https://github.com/tonistiigi/audiosprite","kind":"function","name":"addAudioSprite","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound","Phaser.Sound.WebAudioSound"]},"description":"The new audio sprite sound instance."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#addAudioSprite","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#addAudioSprite","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new sound to the sound manager and plays it.\nThe sound will be automatically removed (destroyed) once playback ends.\nThis lets you play a new sound on the fly without the need to keep a reference to it.","kind":"function","name":"play","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig","Phaser.Types.Sound.SoundMarker"]},"optional":true,"description":"An optional additional object containing settings to be applied to the sound. It could be either config or marker object.","name":"extra"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#play","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#play","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Enables playing audio sprite sound on the fly without the need to keep a reference to it.\nSound will auto destroy once its playback ends.","kind":"function","name":"playAudioSprite","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["string"]},"description":"The name of the sound sprite to play.","name":"spriteName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the audio sprite sound started playing successfully."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#playAudioSprite","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#playAudioSprite","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a sound from the sound manager.\nThe removed sound is destroyed before removal.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The sound object to remove.","name":"sound"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the sound was removed successfully, otherwise false."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#remove","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#remove","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes all sounds from the sound manager that have an asset key matching the given value.\nThe removed sounds are destroyed before removal.","kind":"function","name":"removeByKey","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key to match when removing sound objects.","name":"key"}],"returns":[{"type":{"names":["number"]},"description":"The number of matching sound objects that were removed."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#removeByKey","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#removeByKey","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Pauses all the sounds in the game.","kind":"function","name":"pauseAll","fires":["Phaser.Sound.Events#event:PAUSE_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#pauseAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#pauseAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Resumes all the sounds in the game.","kind":"function","name":"resumeAll","fires":["Phaser.Sound.Events#event:RESUME_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#resumeAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#resumeAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Stops all the sounds in the game.","kind":"function","name":"stopAll","fires":["Phaser.Sound.Events#event:STOP_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#stopAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#stopAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Destroys all the sounds in the game and all associated events.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#destroy","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#destroy","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global playback rate at which all the sounds will be played.\n\nFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","kind":"function","name":"setRate","fires":["Phaser.Sound.Events#event:GLOBAL_RATE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"Global playback rate at which all the sounds will be played.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#setRate","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#setRate","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global playback rate at which all the sounds will be played.\nValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audio's playback speed.","name":"rate","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#rate","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#rate","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","kind":"function","name":"setDetune","fires":["Phaser.Sound.Events#event:GLOBAL_DETUNE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#setDetune","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#setDetune","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"detune","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#detune","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#detune","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Asset key for the sound.","name":"key","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#key","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#key","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently playing.","name":"isPlaying","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#isPlaying","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#isPlaying","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently paused.","name":"isPaused","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#isPaused","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#isPaused","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A property that holds the value of sound's actual playback rate,\nafter its rate and detune values has been combined with global\nrate and detune values.","name":"totalRate","type":{"names":["number"]},"defaultvalue":"1","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#totalRate","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#totalRate","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A value representing the duration, in seconds.\nIt could be total sound duration or a marker duration.","name":"duration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#duration","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#duration","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"The total duration of the sound in seconds.","name":"totalDuration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#totalDuration","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#totalDuration","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Object containing markers definitions.","name":"markers","type":{"names":["Object."]},"defaultvalue":"{}","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#markers","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#markers","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Currently playing marker.\n'null' if whole sound is playing.","name":"currentMarker","type":{"names":["Phaser.Types.Sound.SoundMarker"]},"defaultvalue":"null","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#currentMarker","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#currentMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\nThis allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.","kind":"function","name":"addMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was added successfully."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#addMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#addMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Updates previously added marker.","kind":"function","name":"updateMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object with updated values.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was updated successfully."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#updateMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#updateMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a marker from the sound.","kind":"function","name":"removeMarker","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the marker to remove.","name":"markerName"}],"returns":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"nullable":true,"description":"Removed marker object or 'null' if there was no marker with provided name."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#removeMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#removeMarker","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to game.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#game","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#game","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to the JSON Cache, as used by Audio Sprites.","name":"jsonCache","type":{"names":["Phaser.Cache.BaseCache"]},"readonly":true,"since":"3.7.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#jsonCache","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#jsonCache","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sounds should be paused when game looses focus,\nfor instance when user switches to another tab/program/app.","name":"pauseOnBlur","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#pauseOnBlur","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#pauseOnBlur","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Mobile devices require sounds to be triggered from an explicit user action,\nsuch as a tap, before any sound can be loaded/played on a web page.\nSet to true if the audio system is currently locked awaiting user interaction.","name":"locked","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#locked","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#locked","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new audio sprite sound into the sound manager.\nAudio Sprites are a combination of audio files and a JSON configuration.\nThe JSON follows the format of that created by https://github.com/tonistiigi/audiosprite","kind":"function","name":"addAudioSprite","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound","Phaser.Sound.WebAudioSound"]},"description":"The new audio sprite sound instance."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#addAudioSprite","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#addAudioSprite","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new sound to the sound manager and plays it.\nThe sound will be automatically removed (destroyed) once playback ends.\nThis lets you play a new sound on the fly without the need to keep a reference to it.","kind":"function","name":"play","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig","Phaser.Types.Sound.SoundMarker"]},"optional":true,"description":"An optional additional object containing settings to be applied to the sound. It could be either config or marker object.","name":"extra"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#play","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#play","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Enables playing audio sprite sound on the fly without the need to keep a reference to it.\nSound will auto destroy once its playback ends.","kind":"function","name":"playAudioSprite","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["string"]},"description":"The name of the sound sprite to play.","name":"spriteName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the audio sprite sound started playing successfully."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#playAudioSprite","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#playAudioSprite","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a sound from the sound manager.\nThe removed sound is destroyed before removal.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The sound object to remove.","name":"sound"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the sound was removed successfully, otherwise false."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#remove","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#remove","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes all sounds from the sound manager that have an asset key matching the given value.\nThe removed sounds are destroyed before removal.","kind":"function","name":"removeByKey","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key to match when removing sound objects.","name":"key"}],"returns":[{"type":{"names":["number"]},"description":"The number of matching sound objects that were removed."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#removeByKey","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#removeByKey","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Pauses all the sounds in the game.","kind":"function","name":"pauseAll","fires":["Phaser.Sound.Events#event:PAUSE_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#pauseAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#pauseAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Resumes all the sounds in the game.","kind":"function","name":"resumeAll","fires":["Phaser.Sound.Events#event:RESUME_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#resumeAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#resumeAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Stops all the sounds in the game.","kind":"function","name":"stopAll","fires":["Phaser.Sound.Events#event:STOP_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#stopAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#stopAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global playback rate at which all the sounds will be played.\n\nFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","kind":"function","name":"setRate","fires":["Phaser.Sound.Events#event:GLOBAL_RATE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"Global playback rate at which all the sounds will be played.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#setRate","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#setRate","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global playback rate at which all the sounds will be played.\nValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audio's playback speed.","name":"rate","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#rate","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#rate","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","kind":"function","name":"setDetune","fires":["Phaser.Sound.Events#event:GLOBAL_DETUNE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#setDetune","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#setDetune","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"detune","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#detune","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#detune","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"`this`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"`this`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"`this`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"`this`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"`this`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"`this`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"A reference to the Texture Manager this Texture belongs to.","name":"manager","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#manager","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#manager","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The unique string-based key of this Texture.","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#key","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#key","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An array of TextureSource instances.\nThese are unique to this Texture and contain the actual Image (or Canvas) data.","name":"source","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#source","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#source","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An array of TextureSource data instances.\nUsed to store additional data images, such as normal maps or specular maps.","name":"dataSource","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#dataSource","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#dataSource","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"A key-value object pair associating the unique Frame keys with the Frames objects.","name":"frames","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#frames","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#frames","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Any additional data that was set in the source JSON (if any),\nor any extra data you'd like to store relating to this texture","name":"customData","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#customData","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#customData","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The name of the first frame of the Texture.","name":"firstFrame","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#firstFrame","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#firstFrame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The total number of Frames in this Texture, including the `__BASE` frame.\n\nA Texture will always contain at least 1 frame because every Texture contains a `__BASE` frame by default,\nin addition to any extra frames that have been added to it, such as when parsing a Sprite Sheet or Texture Atlas.","name":"frameTotal","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#frameTotal","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#frameTotal","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a new Frame to this Texture.\n\nA Frame is a rectangular region of a TextureSource with a unique index or string-based key.\n\nThe name given must be unique within this Texture. If it already exists, this method will return `null`.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["integer","string"]},"description":"The name of this Frame. The name is unique within the Texture.","name":"name"},{"type":{"names":["integer"]},"description":"The index of the TextureSource that this Frame is a part of.","name":"sourceIndex"},{"type":{"names":["number"]},"description":"The x coordinate of the top-left of this Frame.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of this Frame.","name":"y"},{"type":{"names":["number"]},"description":"The width of this Frame.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Frame.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"nullable":true,"description":"The Frame that was added to this Texture, or `null` if the given name already exists."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#add","scope":"instance","inherits":"Phaser.Textures.Texture#add","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Removes the given Frame from this Texture. The Frame is destroyed immediately.\n\nAny Game Objects using this Frame should stop using it _before_ you remove it,\nas it does not happen automatically.","kind":"function","name":"remove","since":"3.19.0","params":[{"type":{"names":["string"]},"description":"The key of the Frame to remove.","name":"name"}],"returns":[{"type":{"names":["boolean"]},"description":"True if a Frame with the matching key was removed from this Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#remove","scope":"instance","inherits":"Phaser.Textures.Texture#remove","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":209,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Checks to see if a Frame matching the given key exists within this Texture.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Frame to check for.","name":"name"}],"returns":[{"type":{"names":["boolean"]},"description":"True if a Frame with the matching key exists in this Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#has","scope":"instance","inherits":"Phaser.Textures.Texture#has","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":224,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Gets a Frame from this Texture based on either the key or the index of the Frame.\n\nIn a Texture Atlas Frames are typically referenced by a key.\nIn a Sprite Sheet Frames are referenced by an index.\nPassing no value for the name returns the base texture.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from this Texture.","name":"name"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The Texture Frame."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#get","scope":"instance","inherits":"Phaser.Textures.Texture#get","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes the given TextureSource and returns the index of it within this Texture.\nIf it's not in this Texture, it returns -1.\nUnless this Texture has multiple TextureSources, such as with a multi-atlas, this\nmethod will always return zero or -1.","kind":"function","name":"getTextureSourceIndex","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.TextureSource"]},"description":"The TextureSource to check.","name":"source"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the TextureSource within this Texture, or -1 if not in this Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getTextureSourceIndex","scope":"instance","inherits":"Phaser.Textures.Texture#getTextureSourceIndex","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":284,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns an array of all the Frames in the given TextureSource.","kind":"function","name":"getFramesFromTextureSource","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the TextureSource to get the Frames from.","name":"sourceIndex"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Include the `__BASE` Frame in the output array?","name":"includeBase"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Texture Frames."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getFramesFromTextureSource","scope":"instance","inherits":"Phaser.Textures.Texture#getFramesFromTextureSource","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns an array with all of the names of the Frames in this Texture.\n\nUseful if you want to randomly assign a Frame to a Game Object, as you can\npick a random element from the returned array.","kind":"function","name":"getFrameNames","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Include the `__BASE` Frame in the output array?","name":"includeBase"}],"returns":[{"type":{"names":["Array."]},"description":"An array of all Frame names in this Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getFrameNames","scope":"instance","inherits":"Phaser.Textures.Texture#getFrameNames","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Given a Frame name, return the source image it uses to render with.\n\nThis will return the actual DOM Image or Canvas element.","kind":"function","name":"getSourceImage","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from this Texture.","name":"name"}],"returns":[{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Phaser.GameObjects.RenderTexture"]},"description":"The DOM Image, Canvas Element or Render Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getSourceImage","scope":"instance","inherits":"Phaser.Textures.Texture#getSourceImage","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Given a Frame name, return the data source image it uses to render with.\nYou can use this to get the normal map for an image for example.\n\nThis will return the actual DOM Image.","kind":"function","name":"getDataSourceImage","since":"3.7.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from this Texture.","name":"name"}],"returns":[{"type":{"names":["HTMLImageElement","HTMLCanvasElement"]},"description":"The DOM Image or Canvas Element."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getDataSourceImage","scope":"instance","inherits":"Phaser.Textures.Texture#getDataSourceImage","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":421,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a data source image to this Texture.\n\nAn example of a data source image would be a normal map, where all of the Frames for this Texture\nequally apply to the normal map.","kind":"function","name":"setDataSource","since":"3.0.0","params":[{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"description":"The source image.","name":"data"}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#setDataSource","scope":"instance","inherits":"Phaser.Textures.Texture#setDataSource","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":447,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the Filter Mode for this Texture.\n\nThe mode can be either Linear, the default, or Nearest.\n\nFor pixel-art you should use Nearest.\n\nThe mode applies to the entire Texture, not just a specific Frame of it.","kind":"function","name":"setFilter","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.FilterMode"]},"description":"The Filter Mode.","name":"filterMode"}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#setFilter","scope":"instance","inherits":"Phaser.Textures.Texture#setFilter","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"`this`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"`this`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"`this`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"`this`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"`this`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"`this`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":42,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#destroy","scope":"instance","inherits":"Phaser.Events.EventEmitter#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":42,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#destroy","scope":"instance","inherits":"Phaser.Events.EventEmitter#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is not centered within the parent by Phaser.\nYou can still center it yourself via CSS.","name":"NO_CENTER","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.NO_CENTER","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":38,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is centered both horizontally and vertically within the parent.\nTo do this, the parent has to have a bounds that can be calculated and not be empty.\n\nCentering is achieved by setting the margin left and top properties of the\ngame canvas, and does not factor in any other CSS styles you may have applied.","name":"CENTER_BOTH","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.CENTER_BOTH","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is centered horizontally within the parent.\nTo do this, the parent has to have a bounds that can be calculated and not be empty.\n\nCentering is achieved by setting the margin left and top properties of the\ngame canvas, and does not factor in any other CSS styles you may have applied.","name":"CENTER_HORIZONTALLY","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.CENTER_HORIZONTALLY","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is centered both vertically within the parent.\nTo do this, the parent has to have a bounds that can be calculated and not be empty.\n\nCentering is achieved by setting the margin left and top properties of the\ngame canvas, and does not factor in any other CSS styles you may have applied.","name":"CENTER_VERTICALLY","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.CENTER_VERTICALLY","scope":"static","___s":true},{"meta":{"filename":"ORIENTATION_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"A landscape orientation.","name":"LANDSCAPE","type":{"names":["string"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.LANDSCAPE","scope":"static","___s":true},{"meta":{"filename":"ORIENTATION_CONST.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"A portrait orientation.","name":"PORTRAIT","type":{"names":["string"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.PORTRAIT","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"No scaling happens at all. The canvas is set to the size given in the game config and Phaser doesn't change it\nagain from that point on. If you change the canvas size, either via CSS, or directly via code, then you need\nto call the Scale Managers `resize` method to give the new dimensions, or input events will stop working.","name":"NONE","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.NONE","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The height is automatically adjusted based on the width.","name":"WIDTH_CONTROLS_HEIGHT","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.WIDTH_CONTROLS_HEIGHT","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":49,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The width is automatically adjusted based on the height.","name":"HEIGHT_CONTROLS_WIDTH","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.HEIGHT_CONTROLS_WIDTH","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":59,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The width and height are automatically adjusted to fit inside the given target area,\nwhile keeping the aspect ratio. Depending on the aspect ratio there may be some space\ninside the area which is not covered.","name":"FIT","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.FIT","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The width and height are automatically adjusted to make the size cover the entire target\narea while keeping the aspect ratio. This may extend further out than the target size.","name":"ENVELOP","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.ENVELOP","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The Canvas is resized to fit all available _parent_ space, regardless of aspect ratio.","name":"RESIZE","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.RESIZE","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas will not be zoomed by Phaser.","name":"NO_ZOOM","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.NO_ZOOM","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas will be 2x zoomed by Phaser.","name":"ZOOM_2X","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.ZOOM_2X","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas will be 4x zoomed by Phaser.","name":"ZOOM_4X","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.ZOOM_4X","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Calculate the zoom value based on the maximum multiplied game size that will\nfit into the parent, or browser window if no parent is set.","name":"MAX_ZOOM","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.MAX_ZOOM","scope":"static","___s":true}]} \ No newline at end of file +{"docs":[{"meta":{"range":[149,199],"filename":"AlignTo.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"QuickSet","longname":"QuickSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AlignTo.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have public `x` and `y` properties, and aligns them next to each other.\n\nThe first item isn't moved. The second item is aligned next to the first, then the third next to the second, and so on.","kind":"function","name":"AlignTo","since":"3.22.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["integer"]},"description":"The position to align the items with. This is an align constant, such as `Phaser.Display.Align.LEFT_CENTER`.","name":"position"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.AlignTo","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"Angle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Angle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `angle` property,\nand then adds the given value to each of their `angle` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `Angle(group.getChildren(), value, step)`","kind":"function","name":"Angle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `angle` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.Angle","scope":"static","___s":true},{"meta":{"filename":"Call.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of objects and passes each of them to the given callback.","kind":"function","name":"Call","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["Phaser.Types.Actions.CallCallback"]},"description":"The callback to be invoked. It will be passed just one argument: the item from the array.","name":"callback"},{"type":{"names":["*"]},"description":"The scope in which the callback will be invoked.","name":"context"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.Call","scope":"static","___s":true},{"meta":{"filename":"GetFirst.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of objects and returns the first element in the array that has properties which match\nall of those specified in the `compare` object. For example, if the compare object was: `{ scaleX: 0.5, alpha: 1 }`\nthen it would return the first item which had the property `scaleX` set to 0.5 and `alpha` set to 1.\n\nTo use this with a Group: `GetFirst(group.getChildren(), compare, index)`","kind":"function","name":"GetFirst","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be searched by this action.","name":"items"},{"type":{"names":["object"]},"description":"The comparison object. Each property in this object will be checked against the items of the array.","name":"compare"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"}],"returns":[{"type":{"names":["object","Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The first object in the array that matches the comparison object, or `null` if no match was found."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.GetFirst","scope":"static","___s":true},{"meta":{"filename":"GetLast.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of objects and returns the last element in the array that has properties which match\nall of those specified in the `compare` object. For example, if the compare object was: `{ scaleX: 0.5, alpha: 1 }`\nthen it would return the last item which had the property `scaleX` set to 0.5 and `alpha` set to 1.\n\nTo use this with a Group: `GetLast(group.getChildren(), compare, index)`","kind":"function","name":"GetLast","since":"3.3.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be searched by this action.","name":"items"},{"type":{"names":["object"]},"description":"The comparison object. Each property in this object will be checked against the items of the array.","name":"compare"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"}],"returns":[{"type":{"names":["object","Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The last object in the array that matches the comparison object, or `null` if no match was found."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.GetLast","scope":"static","___s":true},{"meta":{"range":[180,229],"filename":"GridAlign.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"AlignIn","longname":"AlignIn","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GridAlign.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have public `x` and `y` properties,\nand then aligns them based on the grid configuration given to this action.","kind":"function","name":"GridAlign","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["Phaser.Types.Actions.GridAlignConfig"]},"description":"The GridAlign Configuration object.","name":"options"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.GridAlign","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"IncAlpha.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IncAlpha.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `alpha` property,\nand then adds the given value to each of their `alpha` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `IncAlpha(group.getChildren(), value, step)`","kind":"function","name":"IncAlpha","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `alpha` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.IncAlpha","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"IncX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IncX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `x` property,\nand then adds the given value to each of their `x` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `IncX(group.getChildren(), value, step)`","kind":"function","name":"IncX","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.IncX","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"IncXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IncXY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have public `x` and `y` properties,\nand then adds the given value to each of them.\n\nThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `IncXY(group.getChildren(), x, y, stepX, stepY)`","kind":"function","name":"IncXY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to be added to the `y` property. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.IncXY","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"IncY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IncY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `y` property,\nand then adds the given value to each of their `y` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `IncY(group.getChildren(), value, step)`","kind":"function","name":"IncY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `y` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.IncY","scope":"static","___s":true},{"meta":{"filename":"PlaceOnCircle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them on evenly spaced points around the perimeter of a Circle.\n\nIf you wish to pass a `Phaser.GameObjects.Circle` Shape to this function, you should pass its `geom` property.","kind":"function","name":"PlaceOnCircle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to position the Game Objects on.","name":"circle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional angle to start position from, in radians.","name":"startAngle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":6.28,"description":"Optional angle to stop position at, in radians.","name":"endAngle"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PlaceOnCircle","scope":"static","___s":true},{"meta":{"filename":"PlaceOnEllipse.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them on evenly spaced points around the perimeter of an Ellipse.\n\nIf you wish to pass a `Phaser.GameObjects.Ellipse` Shape to this function, you should pass its `geom` property.","kind":"function","name":"PlaceOnEllipse","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to position the Game Objects on.","name":"ellipse"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional angle to start position from, in radians.","name":"startAngle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":6.28,"description":"Optional angle to stop position at, in radians.","name":"endAngle"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PlaceOnEllipse","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"PlaceOnLine.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"GetPoints","longname":"GetPoints","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PlaceOnLine.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Positions an array of Game Objects on evenly spaced points of a Line.","kind":"function","name":"PlaceOnLine","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to position the Game Objects on.","name":"line"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PlaceOnLine","scope":"static","___s":true},{"meta":{"range":[180,236],"filename":"PlaceOnRectangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"MarchingAnts","longname":"MarchingAnts","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PlaceOnRectangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them on evenly spaced points around the perimeter of a Rectangle.\n\nPlacement starts from the top-left of the rectangle, and proceeds in a clockwise direction.\nIf the `shift` parameter is given you can offset where placement begins.","kind":"function","name":"PlaceOnRectangle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to position the Game Objects on.","name":"rect"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"An optional positional offset.","name":"shift"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PlaceOnRectangle","scope":"static","___s":true},{"meta":{"range":[180,237],"filename":"PlaceOnTriangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"BresenhamPoints","longname":"BresenhamPoints","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PlaceOnTriangle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them on evenly spaced points around the edges of a Triangle.\n\nIf you wish to pass a `Phaser.GameObjects.Triangle` Shape to this function, you should pass its `geom` property.","kind":"function","name":"PlaceOnTriangle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to position the Game Objects on.","name":"triangle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"An optional step rate, to increase or decrease the packing of the Game Objects on the lines.","name":"stepRate"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PlaceOnTriangle","scope":"static","___s":true},{"meta":{"filename":"PlayAnimation.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Play an animation with the given key, starting at the given startFrame on all Game Objects in items.","kind":"function","name":"PlayAnimation","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["string"]},"description":"The name of the animation to play.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The starting frame of the animation with the given key.","name":"startFrame"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PlayAnimation","scope":"static","___s":true},{"meta":{"filename":"PropertyValueInc.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public property as defined in `key`,\nand then adds the given value to it.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `PropertyValueInc(group.getChildren(), key, value, step)`","kind":"function","name":"PropertyValueInc","since":"3.3.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to be added to the property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PropertyValueInc","scope":"static","___s":true},{"meta":{"filename":"PropertyValueSet.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public property as defined in `key`,\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `PropertyValueSet(group.getChildren(), key, value, step)`","kind":"function","name":"PropertyValueSet","since":"3.3.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.PropertyValueSet","scope":"static","___s":true},{"meta":{"range":[180,221],"filename":"RandomCircle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Random","longname":"Random","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomCircle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them at random locations within the Circle.\n\nIf you wish to pass a `Phaser.GameObjects.Circle` Shape to this function, you should pass its `geom` property.","kind":"function","name":"RandomCircle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to position the Game Objects within.","name":"circle"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RandomCircle","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"RandomEllipse.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Random","longname":"Random","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomEllipse.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them at random locations within the Ellipse.\n\nIf you wish to pass a `Phaser.GameObjects.Ellipse` Shape to this function, you should pass its `geom` property.","kind":"function","name":"RandomEllipse","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to position the Game Objects within.","name":"ellipse"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RandomEllipse","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"RandomLine.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Random","longname":"Random","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomLine.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them at random locations on the Line.\n\nIf you wish to pass a `Phaser.GameObjects.Line` Shape to this function, you should pass its `geom` property.","kind":"function","name":"RandomLine","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to position the Game Objects randomly on.","name":"line"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RandomLine","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"RandomRectangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Random","longname":"Random","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomRectangle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them at random locations within the Rectangle.","kind":"function","name":"RandomRectangle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to position the Game Objects within.","name":"rect"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RandomRectangle","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"RandomTriangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Random","longname":"Random","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomTriangle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and positions them at random locations within the Triangle.\n\nIf you wish to pass a `Phaser.GameObjects.Triangle` Shape to this function, you should pass its `geom` property.","kind":"function","name":"RandomTriangle","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to position the Game Objects within.","name":"triangle"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RandomTriangle","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"Rotate.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Rotate.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `rotation` property,\nand then adds the given value to each of their `rotation` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `Rotate(group.getChildren(), value, step)`","kind":"function","name":"Rotate","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `rotation` property (in radians).","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.Rotate","scope":"static","___s":true},{"meta":{"range":[180,242],"filename":"RotateAround.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"RotateAroundDistance","longname":"RotateAroundDistance","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateAround.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Rotates each item around the given point by the given angle.","kind":"function","name":"RotateAround","since":"3.0.0","see":["Phaser.Math.RotateAroundDistance"],"params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["object"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RotateAround","scope":"static","___s":true},{"meta":{"range":[180,246],"filename":"RotateAroundDistance.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"MathRotateAroundDistance","longname":"MathRotateAroundDistance","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateAroundDistance.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Rotates an array of Game Objects around a point by the given angle and distance.","kind":"function","name":"RotateAroundDistance","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["object"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"},{"type":{"names":["number"]},"description":"The distance from the point of rotation in pixels.","name":"distance"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.RotateAroundDistance","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"ScaleX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScaleX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `scaleX` property,\nand then adds the given value to each of their `scaleX` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `ScaleX(group.getChildren(), value, step)`","kind":"function","name":"ScaleX","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `scaleX` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.ScaleX","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"ScaleXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScaleXY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have public `scaleX` and `scaleY` properties,\nand then adds the given value to each of them.\n\nThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `ScaleXY(group.getChildren(), scaleX, scaleY, stepX, stepY)`","kind":"function","name":"ScaleXY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `scaleX` property.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to be added to the `scaleY` property. If `undefined` or `null` it uses the `scaleX` value.","name":"scaleY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleY` amount, multiplied by the iteration counter.","name":"stepY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.ScaleXY","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"ScaleY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueInc","longname":"PropertyValueInc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScaleY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have a public `scaleY` property,\nand then adds the given value to each of their `scaleY` properties.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `ScaleY(group.getChildren(), value, step)`","kind":"function","name":"ScaleY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to be added to the `scaleY` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.ScaleY","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetAlpha.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetAlpha.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `alpha`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetAlpha(group.getChildren(), value, step)`","kind":"function","name":"SetAlpha","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetAlpha","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetBlendMode.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetBlendMode.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `blendMode`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetBlendMode(group.getChildren(), value)`","kind":"function","name":"SetBlendMode","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetBlendMode","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetDepth.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetDepth.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `depth`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetDepth(group.getChildren(), value, step)`","kind":"function","name":"SetDepth","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetDepth","scope":"static","___s":true},{"meta":{"filename":"SetHitArea.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Passes all provided Game Objects to the Input Manager to enable them for input with identical areas and callbacks.","see":["{@link Phaser.GameObjects.GameObject#setInteractive}"],"kind":"function","name":"SetHitArea","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["*"]},"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"hitAreaCallback"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetHitArea","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetOrigin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetOrigin.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public properties `originX` and `originY`\nand then sets them to the given values.\n\nThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetOrigin(group.getChildren(), originX, originY, stepX, stepY)`","kind":"function","name":"SetOrigin","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the `originX` property to.","name":"originX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to set the `originY` property to. If `undefined` or `null` it uses the `originX` value.","name":"originY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originY` amount, multiplied by the iteration counter.","name":"stepY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetOrigin","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetRotation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetRotation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `rotation`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetRotation(group.getChildren(), value, step)`","kind":"function","name":"SetRotation","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetRotation","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetScale.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetScale.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public properties `scaleX` and `scaleY`\nand then sets them to the given values.\n\nThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetScale(group.getChildren(), scaleX, scaleY, stepX, stepY)`","kind":"function","name":"SetScale","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the `scaleX` property to.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to set the `scaleY` property to. If `undefined` or `null` it uses the `scaleX` value.","name":"scaleY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleY` amount, multiplied by the iteration counter.","name":"stepY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetScale","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetScaleX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetScaleX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `scaleX`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetScaleX(group.getChildren(), value, step)`","kind":"function","name":"SetScaleX","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetScaleX","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetScaleY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetScaleY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `scaleY`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetScaleY(group.getChildren(), value, step)`","kind":"function","name":"SetScaleY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetScaleY","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetScrollFactor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetScrollFactor.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public properties `scrollFactorX` and `scrollFactorY`\nand then sets them to the given values.\n\nThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetScrollFactor(group.getChildren(), scrollFactorX, scrollFactorY, stepX, stepY)`","kind":"function","name":"SetScrollFactor","since":"3.21.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the `scrollFactorX` property to.","name":"scrollFactorX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to set the `scrollFactorY` property to. If `undefined` or `null` it uses the `scrollFactorX` value.","name":"scrollFactorY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scrollFactorX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scrollFactorY` amount, multiplied by the iteration counter.","name":"stepY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetScrollFactor","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetScrollFactorX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetScrollFactorX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `scrollFactorX`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetScrollFactorX(group.getChildren(), value, step)`","kind":"function","name":"SetScrollFactorX","since":"3.21.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetScrollFactorX","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetScrollFactorY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetScrollFactorY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `scrollFactorY`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetScrollFactorY(group.getChildren(), value, step)`","kind":"function","name":"SetScrollFactorY","since":"3.21.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetScrollFactorY","scope":"static","___s":true},{"meta":{"filename":"SetTint.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public method setTint() and then updates it to the given value(s). You can specify tint color per corner or provide only one color value for `topLeft` parameter, in which case whole item will be tinted with that color.","kind":"function","name":"SetTint","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["number"]},"description":"The tint being applied to top-left corner of item. If other parameters are given no value, this tint will be applied to whole item.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to top-right corner of item.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-left corner of item.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-right corner of item.","name":"bottomRight"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetTint","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetVisible.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetVisible.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `visible`\nand then sets it to the given value.\n\nTo use this with a Group: `SetVisible(group.getChildren(), value)`","kind":"function","name":"SetVisible","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["boolean"]},"description":"The value to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetVisible","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `x`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetX(group.getChildren(), value, step)`","kind":"function","name":"SetX","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetX","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetXY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public properties `x` and `y`\nand then sets them to the given values.\n\nThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetXY(group.getChildren(), x, y, stepX, stepY)`","kind":"function","name":"SetXY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the `x` property to.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to set the `y` property to. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetXY","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"SetY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"PropertyValueSet","longname":"PropertyValueSet","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects, or any objects that have the public property `y`\nand then sets it to the given value.\n\nThe optional `step` property is applied incrementally, multiplied by each item in the array.\n\nTo use this with a Group: `SetY(group.getChildren(), value, step)`","kind":"function","name":"SetY","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The array of items to be updated by this action.","name":"items"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SetY","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"ShiftPosition.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Vector2","longname":"Vector2","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ShiftPosition.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Iterate through the items array changing the position of each element to be that of the element that came before\nit in the array (or after it if direction = 1)\n\nThe first items position is set to x/y.\n\nThe final x/y coords are returned","kind":"function","name":"ShiftPosition","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["number"]},"description":"The x coordinate to place the first item in the array at.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to place the first item in the array at.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The iteration direction. 0 = first to last and 1 = last to first.","name":"direction"},{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An optional objec to store the final objects position in.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The output vector."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.ShiftPosition","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"Shuffle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"ArrayShuffle","longname":"ArrayShuffle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Shuffle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Shuffles the array in place. The shuffled array is both modified and returned.","kind":"function","name":"Shuffle","since":"3.0.0","see":["Phaser.Utils.Array.Shuffle"],"params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.Shuffle","scope":"static","___s":true},{"meta":{"range":[180,226],"filename":"SmoothStep.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"MathSmoothStep","longname":"MathSmoothStep","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SmoothStep.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Smoothstep is a sigmoid-like interpolation and clamping function.\n\nThe function depends on three parameters, the input x, the \"left edge\" and the \"right edge\", with the left edge being assumed smaller than the right edge. The function receives a real number x as an argument and returns 0 if x is less than or equal to the left edge, 1 if x is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial, between 0 and 1 otherwise. The slope of the smoothstep function is zero at both edges. This is convenient for creating a sequence of transitions using smoothstep to interpolate each segment as an alternative to using more sophisticated or expensive interpolation techniques.","kind":"function","name":"SmoothStep","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["string"]},"description":"The property of the Game Object to interpolate.","name":"property"},{"type":{"names":["number"]},"description":"The minimum interpolation value.","name":"min"},{"type":{"names":["number"]},"description":"The maximum interpolation value.","name":"max"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the values be incremented? `true` or set (`false`)","name":"inc"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SmoothStep","scope":"static","___s":true},{"meta":{"range":[180,230],"filename":"SmootherStep.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"MathSmootherStep","longname":"MathSmootherStep","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SmootherStep.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Smootherstep is a sigmoid-like interpolation and clamping function.\n\nThe function depends on three parameters, the input x, the \"left edge\" and the \"right edge\", with the left edge being assumed smaller than the right edge. The function receives a real number x as an argument and returns 0 if x is less than or equal to the left edge, 1 if x is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial, between 0 and 1 otherwise. The slope of the smoothstep function is zero at both edges. This is convenient for creating a sequence of transitions using smoothstep to interpolate each segment as an alternative to using more sophisticated or expensive interpolation techniques.","kind":"function","name":"SmootherStep","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["string"]},"description":"The property of the Game Object to interpolate.","name":"property"},{"type":{"names":["number"]},"description":"The minimum interpolation value.","name":"min"},{"type":{"names":["number"]},"description":"The maximum interpolation value.","name":"max"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the values be incremented? `true` or set (`false`)","name":"inc"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.SmootherStep","scope":"static","___s":true},{"meta":{"filename":"Spread.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and then modifies their `property` so the value equals, or is incremented, by the\ncalculated spread value.\n\nThe spread value is derived from the given `min` and `max` values and the total number of items in the array.\n\nFor example, to cause an array of Sprites to change in alpha from 0 to 1 you could call:\n\n```javascript\nPhaser.Actions.Spread(itemsArray, 'alpha', 0, 1);\n```","kind":"function","name":"Spread","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["string"]},"description":"The property of the Game Object to spread.","name":"property"},{"type":{"names":["number"]},"description":"The minimum value.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value.","name":"max"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the values be incremented? `true` or set (`false`)","name":"inc"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that were passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.Spread","scope":"static","___s":true},{"meta":{"filename":"ToggleVisible.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Takes an array of Game Objects and toggles the visibility of each one.\nThose previously `visible = false` will become `visible = true`, and vice versa.","kind":"function","name":"ToggleVisible","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.ToggleVisible","scope":"static","___s":true},{"meta":{"range":[225,255],"filename":"WrapInRectangle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"name":"Wrap","longname":"Wrap","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WrapInRectangle.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"description":"Wrap each item's coordinates within a rectangle's area.","kind":"function","name":"WrapInRectangle","since":"3.0.0","see":["Phaser.Math.Wrap"],"params":[{"type":{"names":["array","Array."]},"description":"An array of Game Objects. The contents of this array are updated by this Action.","name":"items"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle.","name":"rect"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"An amount added to each side of the rectangle during the operation.","name":"padding"}],"returns":[{"type":{"names":["array","Array."]},"description":"The array of Game Objects that was passed to this Action."}],"memberof":"Phaser.Actions","longname":"Phaser.Actions.WrapInRectangle","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions"},"kind":"namespace","name":"Actions","memberof":"Phaser","longname":"Phaser.Actions","scope":"static","___s":true},{"meta":{"filename":"CallCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions/typedefs"},"kind":"typedef","name":"CallCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to run the callback on.","name":"item"}],"memberof":"Phaser.Types.Actions","longname":"Phaser.Types.Actions.CallCallback","scope":"static","___s":true},{"meta":{"filename":"GridAlignConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions/typedefs"},"kind":"typedef","name":"GridAlignConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":-1,"description":"The width of the grid in items (not pixels). -1 means lay all items out horizontally, regardless of quantity.\n If both this value and height are set to -1 then this value overrides it and the `height` value is ignored.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":-1,"description":"The height of the grid in items (not pixels). -1 means lay all items out vertically, regardless of quantity.\n If both this value and `width` are set to -1 then `width` overrides it and this value is ignored.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The width of the cell, in pixels, in which the item is positioned.","name":"cellWidth"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The height of the cell, in pixels, in which the item is positioned.","name":"cellHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The alignment position. One of the Phaser.Display.Align consts such as `TOP_LEFT` or `RIGHT_CENTER`.","name":"position"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optionally place the top-left of the final grid at this coordinate.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optionally place the top-left of the final grid at this coordinate.","name":"y"}],"memberof":"Phaser.Types.Actions","longname":"Phaser.Types.Actions.GridAlignConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/actions/typedefs"},"kind":"namespace","name":"Actions","memberof":"Phaser.Types","longname":"Phaser.Types.Actions","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"Animation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Animation.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"classdesc":"A Frame based Animation.\n\nThis consists of a key, some default values (like the frame rate) and a bunch of Frame objects.\n\nThe Animation Manager creates these. Game Objects don't own an instance of these directly.\nGame Objects have the Animation Component, which are like playheads to global Animations (these objects)\nSo multiple Game Objects can have playheads all pointing to this one Animation instance.","kind":"class","name":"Animation","memberof":"Phaser.Animations","augments":["Phaser.Events.EventEmitter"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"A reference to the global Animation Manager","name":"manager"},{"type":{"names":["string"]},"description":"The unique identifying string for this animation.","name":"key"},{"type":{"names":["Phaser.Types.Animations.Animation"]},"description":"The Animation configuration.","name":"config"}],"scope":"static","longname":"Phaser.Animations.Animation","___s":true},{"meta":{"filename":"Animation.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"A reference to the global Animation Manager.","name":"manager","type":{"names":["Phaser.Animations.AnimationManager"]},"since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The unique identifying string for this animation.","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":63,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"A frame based animation (as opposed to a bone based animation)","name":"type","type":{"names":["string"]},"defaultvalue":"frame","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Extract all the frame data into the frames array.","name":"frames","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#frames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The frame rate of playback in frames per second (default 24 if duration is null)","name":"frameRate","type":{"names":["integer"]},"defaultvalue":"24","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#frameRate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"How long the animation should play for, in milliseconds.\nIf the `frameRate` property has been set then it overrides this value,\notherwise the `frameRate` is derived from `duration`.","name":"duration","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"How many ms per frame, not including frame specific modifiers.","name":"msPerFrame","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#msPerFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Skip frames if the time lags, or always advanced anyway?","name":"skipMissedFrames","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#skipMissedFrames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The delay in ms before the playback will begin.","name":"delay","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#delay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Number of times to repeat the animation. Set to -1 to repeat forever.","name":"repeat","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#repeat","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The delay in ms before the a repeat play starts.","name":"repeatDelay","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#repeatDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Should the animation yoyo (reverse back down to the start) before repeating?","name":"yoyo","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#yoyo","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Should the GameObject's `visible` property be set to `true` when the animation starts to play?","name":"showOnStart","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#showOnStart","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":197,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Should the GameObject's `visible` property be set to `false` when the animation finishes?","name":"hideOnComplete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#hideOnComplete","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":207,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Global pause. All Game Objects using this Animation instance are impacted by this property.","name":"paused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#paused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Add frames to the end of the animation.","kind":"function","name":"addFrame","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"[description]","name":"config"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#addFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":236,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Add frame/s into the animation.","kind":"function","name":"addFrameAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index to insert the frame at within the animation.","name":"index"},{"type":{"names":["string","Array."]},"description":"[description]","name":"config"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#addFrameAt","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":275,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Check if the given frame index is valid.","kind":"function","name":"checkFrame","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index to be checked.","name":"index"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the index is valid, otherwise `false`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#checkFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"getFrames","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"[description]","name":"textureManager"},{"type":{"names":["string","Array."]},"description":"[description]","name":"frames"},{"type":{"names":["string"]},"optional":true,"description":"[description]","name":"defaultTextureKey"}],"returns":[{"type":{"names":["Array."]},"description":"[description]"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#getFrames","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"getNextTick","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Components.Animation"]},"description":"[description]","name":"component"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#getNextTick","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":512,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Returns the frame closest to the given progress value between 0 and 1.","kind":"function","name":"getFrameByProgress","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The frame closest to the given progress value."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#getFrameByProgress","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Advance the animation frame.","kind":"function","name":"nextFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Components.Animation"]},"description":"The Animation Component to advance.","name":"component"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#nextFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":613,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Returns the animation last frame.","kind":"function","name":"getLastFrame","since":"3.12.0","returns":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"component - The Animation Last Frame."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#getLastFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"previousFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Components.Animation"]},"description":"[description]","name":"component"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#previousFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":689,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"removeFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"[description]","name":"frame"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#removeFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":711,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Removes a frame from the AnimationFrame array at the provided index\nand updates the animation accordingly.","kind":"function","name":"removeFrameAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index in the AnimationFrame array","name":"index"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#removeFrameAt","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":731,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"repeatAnimation","fires":["Phaser.Animations.Events#event:ANIMATION_REPEAT","Phaser.Animations.Events#event:SPRITE_ANIMATION_REPEAT","Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_REPEAT"],"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Components.Animation"]},"description":"[description]","name":"component"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#repeatAnimation","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":779,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Sets the texture frame the animation uses for rendering.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Components.Animation"]},"description":"[description]","name":"component"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#setFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":800,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Converts the animation data to JSON.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Animations.JSONAnimation"]},"description":"[description]"}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#toJSON","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":833,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"updateFrameSequence","since":"3.0.0","returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#updateFrameSequence","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":890,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#pause","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":905,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"This Animation object."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#resume","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":920,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"range":[180,213],"filename":"AnimationFrame.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"classdesc":"A single frame in an Animation sequence.\n\nAn AnimationFrame consists of a reference to the Texture it uses for rendering, references to other\nframes in the animation, and index data. It also has the ability to modify the animation timing.\n\nAnimationFrames are generated automatically by the Animation class.","kind":"class","name":"AnimationFrame","memberof":"Phaser.Animations","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture this AnimationFrame uses.","name":"textureKey"},{"type":{"names":["string","integer"]},"description":"The key of the Frame within the Texture that this AnimationFrame uses.","name":"textureFrame"},{"type":{"names":["integer"]},"description":"The index of this AnimationFrame within the Animation sequence.","name":"index"},{"type":{"names":["Phaser.Textures.Frame"]},"description":"A reference to the Texture Frame this AnimationFrame uses for rendering.","name":"frame"}],"scope":"static","longname":"Phaser.Animations.AnimationFrame","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The key of the Texture this AnimationFrame uses.","name":"textureKey","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#textureKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The key of the Frame within the Texture that this AnimationFrame uses.","name":"textureFrame","type":{"names":["string","integer"]},"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#textureFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The index of this AnimationFrame within the Animation sequence.","name":"index","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#index","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"A reference to the Texture Frame this AnimationFrame uses for rendering.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Is this the first frame in an animation sequence?","name":"isFirst","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#isFirst","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Is this the last frame in an animation sequence?","name":"isLast","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#isLast","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"A reference to the AnimationFrame that comes before this one in the animation, if any.","name":"prevFrame","type":{"names":["Phaser.Animations.AnimationFrame"]},"nullable":true,"defaultvalue":"null","readonly":true,"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#prevFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"A reference to the AnimationFrame that comes after this one in the animation, if any.","name":"nextFrame","type":{"names":["Phaser.Animations.AnimationFrame"]},"nullable":true,"defaultvalue":"null","readonly":true,"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#nextFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Additional time (in ms) that this frame should appear for during playback.\nThe value is added onto the msPerFrame set by the animation.","name":"duration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":125,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"What % through the animation does this frame come?\nThis value is generated when the animation is created and cached here.","name":"progress","type":{"names":["number"]},"defaultvalue":"0","readonly":true,"since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":138,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Generates a JavaScript object suitable for converting to JSON.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Animations.JSONAnimationFrame"]},"description":"The AnimationFrame data."}],"memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#toJSON","scope":"instance","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Destroys this object by removing references to external resources and callbacks.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Animations.AnimationFrame","longname":"Phaser.Animations.AnimationFrame#destroy","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"AnimationManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"name":"Animation","longname":"Animation","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AnimationManager.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"classdesc":"The Animation Manager.\n\nAnimations are managed by the global Animation Manager. This is a singleton class that is\nresponsible for creating and delivering animations and their corresponding data to all Game Objects.\nUnlike plugins it is owned by the Game instance, not the Scene.\n\nSprites and other Game Objects get the data they need from the AnimationManager.","kind":"class","name":"AnimationManager","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Animations","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"A reference to the Phaser.Game instance.","name":"game"}],"scope":"static","longname":"Phaser.Animations.AnimationManager","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The global time scale of the Animation Manager.\n\nThis scales the time delta between two frames, thus influencing the speed of time for the Animation Manager.","name":"globalTimeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#globalTimeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Whether the Animation Manager is paused along with all of its Animations.","name":"paused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#paused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"The name of this Animation Manager.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Registers event listeners after the Game boots.","kind":"function","name":"boot","listens":["Phaser.Core.Events#event:DESTROY"],"since":"3.0.0","memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#boot","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":124,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Adds an existing Animation to the Animation Manager.","kind":"function","name":"add","fires":["Phaser.Animations.Events#event:ADD_ANIMATION"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key under which the Animation should be added. The Animation will be updated with it. Must be unique.","name":"key"},{"type":{"names":["Phaser.Animations.Animation"]},"description":"The Animation which should be added to the Animation Manager.","name":"animation"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"This Animation Manager."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#add","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Checks to see if the given key is already in use within the Animation Manager or not.\n\nAnimations are global. Keys created in one scene can be used from any other Scene in your game. They are not Scene specific.","kind":"function","name":"exists","since":"3.16.0","params":[{"type":{"names":["string"]},"description":"The key of the Animation to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Animation already exists in the Animation Manager, or `false` if the key is available."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#exists","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":171,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Creates a new Animation and adds it to the Animation Manager.\n\nAnimations are global. Once created, you can use them in any Scene in your game. They are not Scene specific.\n\nIf an invalid key is given this method will return `false`.\n\nIf you pass the key of an animation that already exists in the Animation Manager, that animation will be returned.\n\nA brand new animation is only created if the key is valid and not already in use.\n\nIf you wish to re-use an existing key, call `AnimationManager.remove` first, then this method.","kind":"function","name":"create","fires":["Phaser.Animations.Events#event:ADD_ANIMATION"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Animations.Animation"]},"description":"The configuration settings for the Animation.","name":"config"}],"returns":[{"type":{"names":["Phaser.Animations.Animation","false"]},"description":"The Animation that was created, or `false` is the key is already in use."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#create","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Loads this Animation Manager's Animations and settings from a JSON object.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Animations.JSONAnimations","Phaser.Types.Animations.JSONAnimation"]},"description":"The JSON object to parse.","name":"data"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If set to `true`, the current animations will be removed (`anims.clear()`). If set to `false` (default), the animations in `data` will be added.","name":"clearCurrentAnimations"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing all of the Animation objects that were created as a result of this call."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#fromJSON","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":264,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"[description]","kind":"function","name":"generateFrameNames","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key for the texture containing the animation frames.","name":"key"},{"type":{"names":["Phaser.Types.Animations.GenerateFrameNames"]},"optional":true,"description":"The configuration object for the animation frame names.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"The array of {@link Phaser.Types.Animations.AnimationFrame} objects."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#generateFrameNames","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":339,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Generate an array of {@link Phaser.Types.Animations.AnimationFrame} objects from a texture key and configuration object.\n\nGenerates objects with numbered frame names, as configured by the given {@link Phaser.Types.Animations.GenerateFrameNumbers}.","kind":"function","name":"generateFrameNumbers","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key for the texture containing the animation frames.","name":"key"},{"type":{"names":["Phaser.Types.Animations.GenerateFrameNumbers"]},"description":"The configuration object for the animation frames.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"The array of {@link Phaser.Types.Animations.AnimationFrame} objects."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#generateFrameNumbers","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Get an Animation.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Animation to retrieve.","name":"key"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"The Animation."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#get","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Load an Animation into a Game Object's Animation Component.","kind":"function","name":"load","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to load the animation into.","name":"child"},{"type":{"names":["string"]},"description":"The key of the animation to load.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name of a start frame to set on the loaded animation.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object with the animation loaded into it."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#load","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":453,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Pause all animations.","kind":"function","name":"pauseAll","fires":["Phaser.Animations.Events#event:PAUSE_ALL"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"This Animation Manager."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#pauseAll","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":474,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Play an animation on the given Game Objects that have an Animation Component.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the animation to play on the Game Object.","name":"key"},{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"The Game Objects to play the animation on.","name":"child"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"This Animation Manager."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#play","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":507,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Remove an animation.","kind":"function","name":"remove","fires":["Phaser.Animations.Events#event:REMOVE_ANIMATION"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the animation to remove.","name":"key"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"[description]"}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#remove","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":532,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Resume all paused animations.","kind":"function","name":"resumeAll","fires":["Phaser.Animations.Events#event:RESUME_ALL"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"This Animation Manager."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#resumeAll","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":553,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Takes an array of Game Objects that have an Animation Component and then\nstarts the given animation playing on them, each one offset by the\n`stagger` amount given to this method.","kind":"function","name":"staggerPlay","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the animation to play on the Game Objects.","name":"key"},{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to play the animation on. They must have an Animation Component.","name":"children"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The amount of time, in milliseconds, to offset each play time by.","name":"stagger"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"This Animation Manager."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#staggerPlay","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":593,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Get the animation data as javascript object by giving key, or get the data of all animations as array of objects, if key wasn't provided.","kind":"function","name":"toJSON","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"[description]","name":"key"}],"returns":[{"type":{"names":["Phaser.Types.Animations.JSONAnimations"]},"description":"[description]"}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#toJSON","scope":"instance","___s":true},{"meta":{"filename":"AnimationManager.js","lineno":625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"description":"Destroy this Animation Manager and clean up animation definitions and references to other objects.\nThis method should not be called directly. It will be called automatically as a response to a `destroy` event from the Phaser.Game instance.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"ADD_ANIMATION_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Add Animation Event.\n\nThis event is dispatched when a new animation is added to the global Animation Manager.\n\nThis can happen either as a result of an animation instance being added to the Animation Manager,\nor the Animation Manager creating a new animation directly.","kind":"event","name":"ADD_ANIMATION","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Animation that was added to the global Animation Manager.","name":"key"},{"type":{"names":["Phaser.Animations.Animation"]},"description":"An instance of the newly created Animation.","name":"animation"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:ADD_ANIMATION","scope":"instance","___s":true},{"meta":{"filename":"ANIMATION_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Animation Complete Event.\n\nThis event is dispatched by an Animation instance when it completes, i.e. finishes playing or is manually stopped.\n\nBe careful with the volume of events this could generate. If a group of Sprites all complete the same\nanimation at the same time, this event will invoke its handler for each one of them.","kind":"event","name":"ANIMATION_COMPLETE","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that completed.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation completed on.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation completed.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:ANIMATION_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"ANIMATION_REPEAT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Animation Repeat Event.\n\nThis event is dispatched when a currently playing animation repeats.\n\nThe event is dispatched directly from the Animation object itself. Which means that listeners\nbound to this event will be invoked every time the Animation repeats, for every Game Object that may have it.","kind":"event","name":"ANIMATION_REPEAT","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that repeated.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation was on when it repeated.","name":"frame"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:ANIMATION_REPEAT","scope":"instance","___s":true},{"meta":{"filename":"ANIMATION_RESTART_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Animation Restart Event.\n\nThis event is dispatched by an Animation instance when it restarts.\n\nBe careful with the volume of events this could generate. If a group of Sprites all restart the same\nanimation at the same time, this event will invoke its handler for each one of them.","kind":"event","name":"ANIMATION_RESTART","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that restarted playing.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation restarted with.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation restarted playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:ANIMATION_RESTART","scope":"instance","___s":true},{"meta":{"filename":"ANIMATION_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Animation Start Event.\n\nThis event is dispatched by an Animation instance when it starts playing.\n\nBe careful with the volume of events this could generate. If a group of Sprites all play the same\nanimation at the same time, this event will invoke its handler for each one of them.","kind":"event","name":"ANIMATION_START","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that started playing.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation started with.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation started playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:ANIMATION_START","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_ALL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Pause All Animations Event.\n\nThis event is dispatched when the global Animation Manager is told to pause.\n\nWhen this happens all current animations will stop updating, although it doesn't necessarily mean\nthat the game has paused as well.","kind":"event","name":"PAUSE_ALL","since":"3.0.0","memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:PAUSE_ALL","scope":"instance","___s":true},{"meta":{"filename":"REMOVE_ANIMATION_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Remove Animation Event.\n\nThis event is dispatched when an animation is removed from the global Animation Manager.","kind":"event","name":"REMOVE_ANIMATION","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Animation that was removed from the global Animation Manager.","name":"key"},{"type":{"names":["Phaser.Animations.Animation"]},"description":"An instance of the removed Animation.","name":"animation"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:REMOVE_ANIMATION","scope":"instance","___s":true},{"meta":{"filename":"RESUME_ALL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Resume All Animations Event.\n\nThis event is dispatched when the global Animation Manager resumes, having been previously paused.\n\nWhen this happens all current animations will continue updating again.","kind":"event","name":"RESUME_ALL","since":"3.0.0","memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:RESUME_ALL","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Complete Event.\n\nThis event is dispatched by a Sprite when an animation finishes playing on it.\n\nListen for it on the Sprite using `sprite.on('animationcomplete', listener)`\n\nThis same event is dispatched for all animations. To listen for a specific animation, use the `SPRITE_ANIMATION_KEY_COMPLETE` event.","kind":"event","name":"SPRITE_ANIMATION_COMPLETE","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that completed.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation completed on.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation completed.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_KEY_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Key Complete Event.\n\nThis event is dispatched by a Sprite when a specific animation finishes playing on it.\n\nListen for it on the Sprite using `sprite.on('animationcomplete-key', listener)` where `key` is the key of\nthe animation. For example, if you had an animation with the key 'explode' you should listen for `animationcomplete-explode`.","kind":"event","name":"SPRITE_ANIMATION_KEY_COMPLETE","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that completed.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation completed on.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation completed.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_KEY_REPEAT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Key Repeat Event.\n\nThis event is dispatched by a Sprite when a specific animation repeats playing on it.\n\nListen for it on the Sprite using `sprite.on('animationrepeat-key', listener)` where `key` is the key of\nthe animation. For example, if you had an animation with the key 'explode' you should listen for `animationrepeat-explode`.","kind":"event","name":"SPRITE_ANIMATION_KEY_REPEAT","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that is repeating on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation started with.","name":"frame"},{"type":{"names":["integer"]},"description":"The number of times the Animation has repeated so far.","name":"repeatCount"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation repeated playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_REPEAT","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_KEY_RESTART_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Key Restart Event.\n\nThis event is dispatched by a Sprite when a specific animation restarts playing on it.\n\nListen for it on the Sprite using `sprite.on('animationrestart-key', listener)` where `key` is the key of\nthe animation. For example, if you had an animation with the key 'explode' you should listen for `animationrestart-explode`.","kind":"event","name":"SPRITE_ANIMATION_KEY_RESTART","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that was restarted on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation restarted with.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation restarted playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_RESTART","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_KEY_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Key Start Event.\n\nThis event is dispatched by a Sprite when a specific animation starts playing on it.\n\nListen for it on the Sprite using `sprite.on('animationstart-key', listener)` where `key` is the key of\nthe animation. For example, if you had an animation with the key 'explode' you should listen for `animationstart-explode`.","kind":"event","name":"SPRITE_ANIMATION_KEY_START","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that was started on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation started with.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation started playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_START","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_KEY_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Key Update Event.\n\nThis event is dispatched by a Sprite when a specific animation playing on it updates. This happens when the animation changes frame,\nbased on the animation frame rate and other factors like `timeScale` and `delay`.\n\nListen for it on the Sprite using `sprite.on('animationupdate-key', listener)` where `key` is the key of\nthe animation. For example, if you had an animation with the key 'explode' you should listen for `animationupdate-explode`.","kind":"event","name":"SPRITE_ANIMATION_KEY_UPDATE","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that has updated on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame of the Animation.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation updated.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_REPEAT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Repeat Event.\n\nThis event is dispatched by a Sprite when an animation repeats playing on it.\n\nListen for it on the Sprite using `sprite.on('animationrepeat', listener)`\n\nThis same event is dispatched for all animations. To listen for a specific animation, use the `SPRITE_ANIMATION_KEY_REPEAT` event.","kind":"event","name":"SPRITE_ANIMATION_REPEAT","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that is repeating on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation started with.","name":"frame"},{"type":{"names":["integer"]},"description":"The number of times the Animation has repeated so far.","name":"repeatCount"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation repeated playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_REPEAT","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_RESTART_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Restart Event.\n\nThis event is dispatched by a Sprite when an animation restarts playing on it.\n\nListen for it on the Sprite using `sprite.on('animationrestart', listener)`\n\nThis same event is dispatched for all animations. To listen for a specific animation, use the `SPRITE_ANIMATION_KEY_RESTART` event.","kind":"event","name":"SPRITE_ANIMATION_RESTART","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that was restarted on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation restarted with.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation restarted playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_RESTART","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Start Event.\n\nThis event is dispatched by a Sprite when an animation starts playing on it.\n\nListen for it on the Sprite using `sprite.on('animationstart', listener)`\n\nThis same event is dispatched for all animations. To listen for a specific animation, use the `SPRITE_ANIMATION_KEY_START` event.","kind":"event","name":"SPRITE_ANIMATION_START","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that was started on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame that the Animation started with.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation started playing.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_START","scope":"instance","___s":true},{"meta":{"filename":"SPRITE_ANIMATION_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"description":"The Sprite Animation Update Event.\n\nThis event is dispatched by a Sprite when an animation playing on it updates. This happens when the animation changes frame,\nbased on the animation frame rate and other factors like `timeScale` and `delay`.\n\nListen for it on the Sprite using `sprite.on('animationupdate', listener)`\n\nThis same event is dispatched for all animations. To listen for a specific animation, use the `SPRITE_ANIMATION_KEY_UPDATE` event.","kind":"event","name":"SPRITE_ANIMATION_UPDATE","since":"3.16.1","params":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"A reference to the Animation that has updated on the Sprite.","name":"animation"},{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The current Animation Frame of the Animation.","name":"frame"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"A reference to the Game Object on which the animation updated.","name":"gameObject"}],"memberof":"Phaser.Animations.Events","longname":"Phaser.Animations.Events#event:SPRITE_ANIMATION_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Animations","longname":"Phaser.Animations.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations"},"kind":"namespace","name":"Animations","memberof":"Phaser","longname":"Phaser.Animations","scope":"static","___s":true},{"meta":{"filename":"Animation.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"Animation","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"The key that the animation will be associated with. i.e. sprite.animations.play(key)","name":"key"},{"type":{"names":["Array."]},"optional":true,"description":"An object containing data used to generate the frames for the animation","name":"frames"},{"type":{"names":["string"]},"optional":true,"defaultvalue":null,"description":"The key of the texture all frames of the animation will use. Can be overridden on a per frame basis.","name":"defaultTextureKey"},{"type":{"names":["integer"]},"optional":true,"description":"The frame rate of playback in frames per second (default 24 if duration is null)","name":"frameRate"},{"type":{"names":["integer"]},"optional":true,"description":"How long the animation should play for in milliseconds. If not given its derived from frameRate.","name":"duration"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Skip frames if the time lags, or always advanced anyway?","name":"skipMissedFrames"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Delay before starting playback. Value given in milliseconds.","name":"delay"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Number of times to repeat the animation (-1 for infinity)","name":"repeat"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Delay before the animation repeats. Value given in milliseconds.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the animation yoyo? (reverse back down to the start) before repeating?","name":"yoyo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should sprite.visible = true when the animation starts to play?","name":"showOnStart"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should sprite.visible = false when the animation finishes?","name":"hideOnComplete"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.Animation","scope":"static","___s":true},{"meta":{"filename":"AnimationFrame.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"AnimationFrame","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The key that the animation will be associated with. i.e. sprite.animations.play(key)","name":"key"},{"type":{"names":["string","number"]},"description":"[description]","name":"frame"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"[description]","name":"duration"},{"type":{"names":["boolean"]},"optional":true,"description":"[description]","name":"visible"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.AnimationFrame","scope":"static","___s":true},{"meta":{"filename":"GenerateFrameNames.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"GenerateFrameNames","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The string to append to every resulting frame name if using a range or an array of `frames`.","name":"prefix"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If `frames` is not provided, the number of the first frame to return.","name":"start"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If `frames` is not provided, the number of the last frame to return.","name":"end"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The string to append to every resulting frame name if using a range or an array of `frames`.","name":"suffix"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The minimum expected lengths of each resulting frame's number. Numbers will be left-padded with zeroes until they are this long, then prepended and appended to create the resulting frame name.","name":"zeroPad"},{"type":{"names":["Array."]},"optional":true,"defaultvalue":"[]","description":"The array to append the created configuration objects to.","name":"outputArray"},{"type":{"names":["boolean","Array."]},"optional":true,"defaultvalue":false,"description":"If provided as an array, the range defined by `start` and `end` will be ignored and these frame numbers will be used.","name":"frames"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.GenerateFrameNames","scope":"static","___s":true},{"meta":{"filename":"GenerateFrameNumbers.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"GenerateFrameNumbers","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The starting frame of the animation.","name":"start"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":-1,"description":"The ending frame of the animation.","name":"end"},{"type":{"names":["boolean","integer"]},"optional":true,"defaultvalue":false,"description":"A frame to put at the beginning of the animation, before `start` or `outputArray` or `frames`.","name":"first"},{"type":{"names":["Array."]},"optional":true,"defaultvalue":"[]","description":"An array to concatenate the output onto.","name":"outputArray"},{"type":{"names":["boolean","Array."]},"optional":true,"defaultvalue":false,"description":"A custom sequence of frames.","name":"frames"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.GenerateFrameNumbers","scope":"static","___s":true},{"meta":{"filename":"JSONAnimation.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"JSONAnimation","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The key that the animation will be associated with. i.e. sprite.animations.play(key)","name":"key"},{"type":{"names":["string"]},"description":"A frame based animation (as opposed to a bone based animation)","name":"type"},{"type":{"names":["Array."]},"description":"[description]","name":"frames"},{"type":{"names":["integer"]},"description":"The frame rate of playback in frames per second (default 24 if duration is null)","name":"frameRate"},{"type":{"names":["integer"]},"description":"How long the animation should play for in milliseconds. If not given its derived from frameRate.","name":"duration"},{"type":{"names":["boolean"]},"description":"Skip frames if the time lags, or always advanced anyway?","name":"skipMissedFrames"},{"type":{"names":["integer"]},"description":"Delay before starting playback. Value given in milliseconds.","name":"delay"},{"type":{"names":["integer"]},"description":"Number of times to repeat the animation (-1 for infinity)","name":"repeat"},{"type":{"names":["integer"]},"description":"Delay before the animation repeats. Value given in milliseconds.","name":"repeatDelay"},{"type":{"names":["boolean"]},"description":"Should the animation yoyo? (reverse back down to the start) before repeating?","name":"yoyo"},{"type":{"names":["boolean"]},"description":"Should sprite.visible = true when the animation starts to play?","name":"showOnStart"},{"type":{"names":["boolean"]},"description":"Should sprite.visible = false when the animation finishes?","name":"hideOnComplete"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.JSONAnimation","scope":"static","___s":true},{"meta":{"filename":"JSONAnimationFrame.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"JSONAnimationFrame","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The key of the Texture this AnimationFrame uses.","name":"key"},{"type":{"names":["string","integer"]},"description":"The key of the Frame within the Texture that this AnimationFrame uses.","name":"frame"},{"type":{"names":["number"]},"description":"Additional time (in ms) that this frame should appear for during playback.","name":"duration"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.JSONAnimationFrame","scope":"static","___s":true},{"meta":{"filename":"JSONAnimations.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"typedef","name":"JSONAnimations","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Array."]},"description":"An array of all Animations added to the Animation Manager.","name":"anims"},{"type":{"names":["number"]},"description":"The global time scale of the Animation Manager.","name":"globalTimeScale"}],"memberof":"Phaser.Types.Animations","longname":"Phaser.Types.Animations.JSONAnimations","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/animations/typedefs"},"kind":"namespace","name":"Animations","memberof":"Phaser.Types","longname":"Phaser.Types.Animations","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"BaseCache.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BaseCache.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"classdesc":"The BaseCache is a base Cache class that can be used for storing references to any kind of data.\n\nData can be added, retrieved and removed based on the given keys.\n\nKeys are string-based.","kind":"class","name":"BaseCache","memberof":"Phaser.Cache","since":"3.0.0","scope":"static","longname":"Phaser.Cache.BaseCache","___s":true},{"meta":{"filename":"BaseCache.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"The Map in which the cache objects are stored.\n\nYou can query the Map directly or use the BaseCache methods.","name":"entries","type":{"names":["Phaser.Structs.Map."]},"since":"3.0.0","memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#entries","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCache.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"An instance of EventEmitter used by the cache to emit related events.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCache.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Adds an item to this cache. The item is referenced by a unique string, which you are responsible\nfor setting and keeping track of. The item can only be retrieved by using this string.","kind":"function","name":"add","fires":["Phaser.Cache.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique key by which the data added to the cache will be referenced.","name":"key"},{"type":{"names":["*"]},"description":"The data to be stored in the cache.","name":"data"}],"returns":[{"type":{"names":["Phaser.Cache.BaseCache"]},"description":"This BaseCache object."}],"memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#add","scope":"instance","___s":true},{"meta":{"filename":"BaseCache.js","lineno":74,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Checks if this cache contains an item matching the given key.\nThis performs the same action as `BaseCache.exists`.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique key of the item to be checked in this cache.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if the cache contains an item matching the given key, otherwise `false`."}],"memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#has","scope":"instance","___s":true},{"meta":{"filename":"BaseCache.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Checks if this cache contains an item matching the given key.\nThis performs the same action as `BaseCache.has` and is called directly by the Loader.","kind":"function","name":"exists","since":"3.7.0","params":[{"type":{"names":["string"]},"description":"The unique key of the item to be checked in this cache.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if the cache contains an item matching the given key, otherwise `false`."}],"memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#exists","scope":"instance","___s":true},{"meta":{"filename":"BaseCache.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Gets an item from this cache based on the given key.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique key of the item to be retrieved from this cache.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The item in the cache, or `null` if no item matching the given key was found."}],"memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#get","scope":"instance","___s":true},{"meta":{"filename":"BaseCache.js","lineno":121,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Removes and item from this cache based on the given key.\n\nIf an entry matching the key is found it is removed from the cache and a `remove` event emitted.\nNo additional checks are done on the item removed. If other systems or parts of your game code\nare relying on this item, it is up to you to sever those relationships prior to removing the item.","kind":"function","name":"remove","fires":["Phaser.Cache.Events#event:REMOVE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique key of the item to remove from the cache.","name":"key"}],"returns":[{"type":{"names":["Phaser.Cache.BaseCache"]},"description":"This BaseCache object."}],"memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#remove","scope":"instance","___s":true},{"meta":{"filename":"BaseCache.js","lineno":150,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Returns all keys in use in this cache.","kind":"function","name":"getKeys","since":"3.17.0","returns":[{"type":{"names":["Array."]},"description":"Array containing all the keys."}],"memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#getKeys","scope":"instance","___s":true},{"meta":{"filename":"BaseCache.js","lineno":163,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Destroys this cache and all items within it.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Cache.BaseCache","longname":"Phaser.Cache.BaseCache#destroy","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"CacheManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"name":"BaseCache","longname":"BaseCache","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CacheManager.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"classdesc":"The Cache Manager is the global cache owned and maintained by the Game instance.\n\nVarious systems, such as the file Loader, rely on this cache in order to store the files\nit has loaded. The manager itself doesn't store any files, but instead owns multiple BaseCache\ninstances, one per type of file. You can also add your own custom caches.","kind":"class","name":"CacheManager","memberof":"Phaser.Cache","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"A reference to the Phaser.Game instance that owns this CacheManager.","name":"game"}],"scope":"static","longname":"Phaser.Cache.CacheManager","___s":true},{"meta":{"filename":"CacheManager.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all binary files, typically added via the Loader.","name":"binary","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#binary","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all bitmap font data files, typically added via the Loader.\nOnly the font data is stored in this cache, the textures are part of the Texture Manager.","name":"bitmapFont","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#bitmapFont","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all JSON data files, typically added via the Loader.","name":"json","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#json","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all physics data files, typically added via the Loader.","name":"physics","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#physics","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all shader source files, typically added via the Loader.","name":"shader","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#shader","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all non-streaming audio files, typically added via the Loader.","name":"audio","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#audio","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all non-streaming video files, typically added via the Loader.","name":"video","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.20.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#video","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all text files, typically added via the Loader.","name":"text","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#text","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all html files, typically added via the Loader.","name":"html","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.12.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#html","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all WaveFront OBJ files, typically added via the Loader.","name":"obj","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#obj","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all tilemap data files, typically added via the Loader.\nOnly the data is stored in this cache, the textures are part of the Texture Manager.","name":"tilemap","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#tilemap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":143,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"A Cache storing all xml data files, typically added via the Loader.","name":"xml","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#xml","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"An object that contains your own custom BaseCache entries.\nAdd to this via the `addCustom` method.","name":"custom","type":{"names":["Object."]},"since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#custom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CacheManager.js","lineno":165,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Add your own custom Cache for storing your own files.\nThe cache will be available under `Cache.custom.key`.\nThe cache will only be created if the key is not already in use.","kind":"function","name":"addCustom","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique key of your custom cache.","name":"key"}],"returns":[{"type":{"names":["Phaser.Cache.BaseCache"]},"description":"A reference to the BaseCache that was created. If the key was already in use, a reference to the existing cache is returned instead."}],"memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#addCustom","scope":"instance","___s":true},{"meta":{"filename":"CacheManager.js","lineno":187,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"description":"Removes all entries from all BaseCaches and destroys all custom caches.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Cache.CacheManager","longname":"Phaser.Cache.CacheManager#destroy","scope":"instance","___s":true},{"meta":{"filename":"ADD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cache/events"},"description":"The Cache Add Event.\n\nThis event is dispatched by any Cache that extends the BaseCache each time a new object is added to it.","kind":"event","name":"ADD","since":"3.0.0","params":[{"type":{"names":["Phaser.Cache.BaseCache"]},"description":"The cache to which the object was added.","name":"cache"},{"type":{"names":["string"]},"description":"The key of the object added to the cache.","name":"key"},{"type":{"names":["*"]},"description":"A reference to the object that was added to the cache.","name":"object"}],"memberof":"Phaser.Cache.Events","longname":"Phaser.Cache.Events#event:ADD","scope":"instance","___s":true},{"meta":{"filename":"REMOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cache/events"},"description":"The Cache Remove Event.\n\nThis event is dispatched by any Cache that extends the BaseCache each time an object is removed from it.","kind":"event","name":"REMOVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Cache.BaseCache"]},"description":"The cache from which the object was removed.","name":"cache"},{"type":{"names":["string"]},"description":"The key of the object removed from the cache.","name":"key"},{"type":{"names":["*"]},"description":"A reference to the object that was removed from the cache.","name":"object"}],"memberof":"Phaser.Cache.Events","longname":"Phaser.Cache.Events#event:REMOVE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cache/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Cache","longname":"Phaser.Cache.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cache"},"kind":"namespace","name":"Cache","memberof":"Phaser","longname":"Phaser.Cache","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"BaseCamera.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"classdesc":"A Base Camera class.\n\nThe Camera is the way in which all games are rendered in Phaser. They provide a view into your game world,\nand can be positioned, rotated, zoomed and scrolled accordingly.\n\nA Camera consists of two elements: The viewport and the scroll values.\n\nThe viewport is the physical position and size of the Camera within your game. Cameras, by default, are\ncreated the same size as your game, but their position and size can be set to anything. This means if you\nwanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game,\nyou'd adjust the viewport to do that (using methods like `setViewport` and `setSize`).\n\nIf you wish to change where the Camera is looking in your game, then you scroll it. You can do this\nvia the properties `scrollX` and `scrollY` or the method `setScroll`. Scrolling has no impact on the\nviewport, and changing the viewport has no impact on the scrolling.\n\nBy default a Camera will render all Game Objects it can see. You can change this using the `ignore` method,\nallowing you to filter Game Objects out on a per-Camera basis.\n\nThe Base Camera is extended by the Camera class, which adds in special effects including Fade,\nFlash and Camera Shake, as well as the ability to follow Game Objects.\n\nThe Base Camera was introduced in Phaser 3.12. It was split off from the Camera class, to allow\nyou to isolate special effects as needed. Therefore the 'since' values for properties of this class relate\nto when they were added to the Camera class.","kind":"class","name":"BaseCamera","memberof":"Phaser.Cameras.Scene2D","since":"3.12.0","augments":["Phaser.Events.EventEmitter","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.Visible"],"params":[{"type":{"names":["number"]},"description":"The x position of the Camera, relative to the top-left of the game canvas.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Camera, relative to the top-left of the game canvas.","name":"y"},{"type":{"names":["number"]},"description":"The width of the Camera, in pixels.","name":"width"},{"type":{"names":["number"]},"description":"The height of the Camera, in pixels.","name":"height"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.BaseCamera","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Scene this camera belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Game Scene Manager.","name":"sceneManager","type":{"names":["Phaser.Scenes.SceneManager"]},"since":"3.12.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#sceneManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Game Scale Manager.","name":"scaleManager","type":{"names":["Phaser.Scale.ScaleManager"]},"since":"3.16.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#scaleManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Scene's Camera Manager to which this Camera belongs.","name":"cameraManager","type":{"names":["Phaser.Cameras.Scene2D.CameraManager"]},"since":"3.17.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#cameraManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera ID. Assigned by the Camera Manager and used to handle camera exclusion.\nThis value is a bitmask.","name":"id","type":{"names":["integer"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#id","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The name of the Camera. This is left empty for your own use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"This property is un-used in v3.16.\n\nThe resolution of the Game, used in most Camera calculations.","name":"resolution","type":{"names":["number"]},"readonly":true,"deprecated":true,"since":"3.12.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#resolution","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":149,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Should this camera round its pixel values to integers?","name":"roundPixels","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#roundPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera visible or not?\n\nA visible camera will render and perform input tests.\nAn invisible camera will not render anything and will skip input tests.","name":"visible","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.10.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#visible","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":171,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera using a bounds to restrict scrolling movement?\n\nSet this property along with the bounds via `Camera.setBounds`.","name":"useBounds","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#useBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The World View is a Rectangle that defines the area of the 'world' the Camera is currently looking at.\nThis factors in the Camera viewport size, zoom and scroll position and is updated in the Camera preRender step.\nIf you have enabled Camera bounds the worldview will be clamped to those bounds accordingly.\nYou can use it for culling or intersection checks.","name":"worldView","type":{"names":["Phaser.Geom.Rectangle"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#worldView","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera dirty?\n\nA dirty Camera has had either its viewport size, bounds, scroll, rotation or zoom levels changed since the last frame.\n\nThis flag is cleared during the `postRenderCamera` method of the renderer.","name":"dirty","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":392,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Does this Camera have a transparent background?","name":"transparent","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#transparent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":402,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The background color of this Camera. Only used if `transparent` is `false`.","name":"backgroundColor","type":{"names":["Phaser.Display.Color"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#backgroundColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":411,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera alpha value. Setting this property impacts every single object that this Camera\nrenders. You can either set the property directly, i.e. via a Tween, to fade a Camera in or out,\nor via the chainable `setAlpha` method instead.","name":"alpha","type":{"names":["number"]},"defaultvalue":"1","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#alpha","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":422,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Should the camera cull Game Objects before checking them for input hit tests?\nIn some special cases it may be beneficial to disable this.","name":"disableCull","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#disableCull","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":444,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The mid-point of the Camera in 'world' coordinates.\n\nUse it to obtain exactly where in the world the center of the camera is currently looking.\n\nThis value is updated in the preRender method, after the scroll values and follower\nhave been processed.","name":"midPoint","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#midPoint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":459,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The horizontal origin of rotation for this Camera.\n\nBy default the camera rotates around the center of the viewport.\n\nChanging the origin allows you to adjust the point in the viewport from which rotation happens.\nA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.\n\nSee `setOrigin` to set both origins in a single, chainable call.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#originX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":476,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The vertical origin of rotation for this Camera.\n\nBy default the camera rotates around the center of the viewport.\n\nChanging the origin allows you to adjust the point in the viewport from which rotation happens.\nA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.\n\nSee `setOrigin` to set both origins in a single, chainable call.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#originY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":504,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Mask this Camera is using during render.\nSet the mask using the `setMask` method. Remove the mask using the `clearMask` method.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"nullable":true,"since":"3.17.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#mask","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the Alpha level of this Camera. The alpha controls the opacity of the Camera as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.11.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The Camera alpha value.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setAlpha","scope":"instance","overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the rotation origin of this Camera.\n\nThe values are given in the range 0 to 1 and are only used when calculating Camera rotation.\n\nBy default the camera rotates around the center of the viewport.\n\nChanging the origin allows you to adjust the point in the viewport from which rotation happens.\nA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.","kind":"function","name":"setOrigin","since":"3.11.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setOrigin","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":570,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Calculates what the Camera.scrollX and scrollY values would need to be in order to move\nthe Camera so it is centered on the given x and y coordinates, without actually moving\nthe Camera there. The results are clamped based on the Camera bounds, if set.","kind":"function","name":"getScroll","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the values in. If not given a new Vector2 is created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The scroll coordinates stored in the `x` and `y` properties."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#getScroll","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":603,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera horizontally so that it is centered on the given x coordinate, bounds allowing.\nCalling this does not change the scrollY value.","kind":"function","name":"centerOnX","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerOnX","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":630,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera vertically so that it is centered on the given y coordinate, bounds allowing.\nCalling this does not change the scrollX value.","kind":"function","name":"centerOnY","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerOnY","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":657,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera so that it is centered on the given coordinates, bounds allowing.","kind":"function","name":"centerOn","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerOn","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":676,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera so that it is looking at the center of the Camera Bounds, if enabled.","kind":"function","name":"centerToBounds","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerToBounds","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":701,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera so that it is re-centered based on its viewport size.","kind":"function","name":"centerToSize","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerToSize","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Takes an array of Game Objects and returns a new array featuring only those objects\nvisible by this camera.","kind":"function","name":"cull","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of Game Objects to cull.","name":"renderableObjects"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Game Objects visible to this Camera."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#cull","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":798,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Converts the given `x` and `y` coordinates into World space, based on this Cameras transform.\nYou can optionally provide a Vector2, or similar object, to store the results in.","kind":"function","name":"getWorldPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position to convert to world space.","name":"x"},{"type":{"names":["number"]},"description":"The y position to convert to world space.","name":"y"},{"type":{"names":["object","Phaser.Math.Vector2"]},"optional":true,"description":"An optional object to store the results in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"An object holding the converted values in its `x` and `y` properties."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#getWorldPoint","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":866,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Given a Game Object, or an array of Game Objects, it will update all of their camera filter settings\nso that they are ignored by this Camera. This means they will not be rendered by this Camera.","kind":"function","name":"ignore","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group"]},"description":"The Game Object, or array of Game Objects, to be ignored by this Camera.","name":"entries"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#ignore","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":970,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Takes an x value and checks it's within the range of the Camera bounds, adjusting if required.\nDo not call this method if you are not using camera bounds.","kind":"function","name":"clampX","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The value to horizontally scroll clamp.","name":"x"}],"returns":[{"type":{"names":["number"]},"description":"The adjusted value to use as scrollX."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#clampX","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1002,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Takes a y value and checks it's within the range of the Camera bounds, adjusting if required.\nDo not call this method if you are not using camera bounds.","kind":"function","name":"clampY","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The value to vertically scroll clamp.","name":"y"}],"returns":[{"type":{"names":["number"]},"description":"The adjusted value to use as scrollY."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#clampY","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1039,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has previously had movement bounds set on it, this will remove them.","kind":"function","name":"removeBounds","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#removeBounds","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1058,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the rotation of this Camera. This causes everything it renders to appear rotated.\n\nRotating a camera does not rotate the viewport itself, it is applied during rendering.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The cameras angle of rotation, given in degrees.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setAngle","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1079,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the background color for this Camera.\n\nBy default a Camera has a transparent background but it can be given a solid color, with any level\nof transparency, via this method.\n\nThe color value can be specified using CSS color notation, hex or numbers.","kind":"function","name":"setBackgroundColor","since":"3.0.0","params":[{"type":{"names":["string","number","Phaser.Types.Display.InputColorObject"]},"optional":true,"defaultvalue":"'rgba(0,0,0,0)'","description":"The color value. In CSS, hex or numeric color notation.","name":"color"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setBackgroundColor","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the bounds of the Camera. The bounds are an axis-aligned rectangle.\n\nThe Camera bounds controls where the Camera can scroll to, stopping it from scrolling off the\nedges and into blank space. It does not limit the placement of Game Objects, or where\nthe Camera viewport can be positioned.\n\nTemporarily disable the bounds by changing the boolean `Camera.useBounds`.\n\nClear the bounds entirely by calling `Camera.removeBounds`.\n\nIf you set bounds that are smaller than the viewport it will stop the Camera from being\nable to scroll. The bounds can be positioned where-ever you wish. By default they are from\n0x0 to the canvas width x height. This means that the coordinate 0x0 is the top left of\nthe Camera bounds. However, you can position them anywhere. So if you wanted a game world\nthat was 2048x2048 in size, with 0x0 being the center of it, you can set the bounds x/y\nto be -1024, -1024, with a width and height of 2048. Depending on your game you may find\nit easier for 0x0 to be the top-left of the bounds, or you may wish 0x0 to be the middle.","kind":"function","name":"setBounds","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The top-left x coordinate of the bounds.","name":"x"},{"type":{"names":["integer"]},"description":"The top-left y coordinate of the bounds.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the bounds, in pixels.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the bounds, in pixels.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the Camera will automatically be centered on the new bounds.","name":"centerOn"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setBounds","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Returns a rectangle containing the bounds of the Camera.\n\nIf the Camera does not have any bounds the rectangle will be empty.\n\nThe rectangle is a copy of the bounds, so is safe to modify.","kind":"function","name":"getBounds","since":"3.16.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"An optional Rectangle to store the bounds in. If not given, a new Rectangle will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A rectangle containing the bounds of this Camera."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#getBounds","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the name of this Camera.\nThis value is for your own use and isn't used internally.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The name of the Camera.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setName","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the position of the Camera viewport within the game.\n\nThis does not change where the camera is 'looking'. See `setScroll` to control that.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the Camera viewport.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The top-left y coordinate of the Camera viewport.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setPosition","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the rotation of this Camera. This causes everything it renders to appear rotated.\n\nRotating a camera does not rotate the viewport itself, it is applied during rendering.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of the Camera, in radians.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setRotation","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1246,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Should the Camera round pixel values to whole integers when rendering Game Objects?\n\nIn some types of game, especially with pixel art, this is required to prevent sub-pixel aliasing.","kind":"function","name":"setRoundPixels","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to round Camera pixels, `false` to not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setRoundPixels","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1265,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the Scene the Camera is bound to.\n\nAlso populates the `resolution` property and updates the internal size values.","kind":"function","name":"setScene","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene the camera is bound to.","name":"scene"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setScene","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1306,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the position of where the Camera is looking within the game.\nYou can also modify the properties `Camera.scrollX` and `Camera.scrollY` directly.\nUse this method, or the scroll properties, to move your camera around the game world.\n\nThis does not change where the camera viewport is placed. See `setPosition` to control that.","kind":"function","name":"setScroll","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the Camera in the game world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y coordinate of the Camera in the game world.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setScroll","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the size of the Camera viewport.\n\nBy default a Camera is the same size as the game, but can be made smaller via this method,\nallowing you to create mini-cam style effects by creating and positioning a smaller Camera\nviewport within your game.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The width of the Camera viewport.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"width","description":"The height of the Camera viewport.","name":"height"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setSize","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1356,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"This method sets the position and size of the Camera viewport in a single call.\n\nIf you're trying to change where the Camera is looking at in your game, then see\nthe method `Camera.setScroll` instead. This method is for changing the viewport\nitself, not what the camera can see.\n\nBy default a Camera is the same size as the game, but can be made smaller via this method,\nallowing you to create mini-cam style effects by creating and positioning a smaller Camera\nviewport within your game.","kind":"function","name":"setViewport","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the Camera viewport.","name":"x"},{"type":{"names":["number"]},"description":"The top-left y coordinate of the Camera viewport.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the Camera viewport.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"width","description":"The height of the Camera viewport.","name":"height"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setViewport","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1387,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the zoom value of the Camera.\n\nChanging to a smaller value, such as 0.5, will cause the camera to 'zoom out'.\nChanging to a larger value, such as 2, will cause the camera to 'zoom in'.\n\nA value of 1 means 'no zoom' and is the default.\n\nChanging the zoom does not impact the Camera viewport in any way, it is only applied during rendering.","kind":"function","name":"setZoom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The zoom value of the Camera. The minimum it can be is 0.001.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setZoom","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1418,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the mask to be applied to this Camera during rendering.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\n\nBitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Camera it will be immediately replaced.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.\n\nNote: You cannot mask a Camera that has `renderToTexture` set.","kind":"function","name":"setMask","since":"3.17.0","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Camera will use when rendering.","name":"mask"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the mask translate along with the Camera, or be fixed in place and not impacted by the Cameras transform?","name":"fixedPosition"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setMask","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Clears the mask that this Camera was using.","kind":"function","name":"clearMask","since":"3.17.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#clearMask","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1475,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the visibility of this Camera.\n\nAn invisible Camera will skip rendering and input tests of everything it can see.","kind":"function","name":"setVisible","since":"3.10.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Camera.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#setVisible","scope":"instance","overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1488,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Returns an Object suitable for JSON storage containing all of the Camera viewport and rendering properties.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Cameras.Scene2D.JSONCamera"]},"description":"A well-formed object suitable for conversion to JSON."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#toJSON","scope":"instance","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1573,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Destroys this Camera instance and its internal properties and references.\nOnce destroyed you cannot use this Camera again, even if re-added to a Camera Manager.\n\nThis method is called automatically by `CameraManager.remove` if that methods `runDestroy` argument is `true`, which is the default.\n\nUnless you have a specific reason otherwise, always use `CameraManager.remove` and allow it to handle the camera destruction,\nrather than calling this method directly.","kind":"function","name":"destroy","fires":["Phaser.Cameras.Scene2D.Events#event:DESTROY"],"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1610,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The x position of the Camera viewport, relative to the top-left of the game canvas.\nThe viewport is the area into which the camera renders.\nTo adjust the position the camera is looking at in the game world, see the `scrollX` value.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1635,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The y position of the Camera viewport, relative to the top-left of the game canvas.\nThe viewport is the area into which the camera renders.\nTo adjust the position the camera is looking at in the game world, see the `scrollY` value.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1660,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The width of the Camera viewport, in pixels.\n\nThe viewport is the area into which the Camera renders. Setting the viewport does\nnot restrict where the Camera can scroll to.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1686,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The height of the Camera viewport, in pixels.\n\nThe viewport is the area into which the Camera renders. Setting the viewport does\nnot restrict where the Camera can scroll to.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1712,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The horizontal scroll position of this Camera.\n\nChange this value to cause the Camera to scroll around your Scene.\n\nAlternatively, setting the Camera to follow a Game Object, via the `startFollow` method,\nwill automatically adjust the Camera scroll values accordingly.\n\nYou can set the bounds within which the Camera can scroll via the `setBounds` method.","name":"scrollX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#scrollX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The vertical scroll position of this Camera.\n\nChange this value to cause the Camera to scroll around your Scene.\n\nAlternatively, setting the Camera to follow a Game Object, via the `startFollow` method,\nwill automatically adjust the Camera scroll values accordingly.\n\nYou can set the bounds within which the Camera can scroll via the `setBounds` method.","name":"scrollY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#scrollY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1772,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera zoom value. Change this value to zoom in, or out of, a Scene.\n\nA value of 0.5 would zoom the Camera out, so you can now see twice as much\nof the Scene as before. A value of 2 would zoom the Camera in, so every pixel\nnow takes up 2 pixels when rendered.\n\nSet to 1 to return to the default zoom level.\n\nBe careful to never set this value to zero.","name":"zoom","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#zoom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1833,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The horizontal position of the center of the Camera's viewport, relative to the left of the game canvas.","name":"centerX","type":{"names":["number"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1850,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The vertical position of the center of the Camera's viewport, relative to the top of the game canvas.","name":"centerY","type":{"names":["number"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#centerY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1867,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The displayed width of the camera viewport, factoring in the camera zoom level.\n\nIf a camera has a viewport width of 800 and a zoom of 0.5 then its display width\nwould be 1600, as it's displaying twice as many pixels as zoom level 1.\n\nEqually, a camera with a width of 800 and zoom of 2 would have a display width\nof 400 pixels.","name":"displayWidth","type":{"names":["number"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#displayWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1890,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The displayed height of the camera viewport, factoring in the camera zoom level.\n\nIf a camera has a viewport height of 600 and a zoom of 0.5 then its display height\nwould be 1200, as it's displaying twice as many pixels as zoom level 1.\n\nEqually, a camera with a height of 600 and zoom of 2 would have a display height\nof 300 pixels.","name":"displayHeight","type":{"names":["number"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#displayHeight","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"Camera.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"name":"BaseCamera","longname":"BaseCamera","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Camera.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"classdesc":"A Camera.\n\nThe Camera is the way in which all games are rendered in Phaser. They provide a view into your game world,\nand can be positioned, rotated, zoomed and scrolled accordingly.\n\nA Camera consists of two elements: The viewport and the scroll values.\n\nThe viewport is the physical position and size of the Camera within your game. Cameras, by default, are\ncreated the same size as your game, but their position and size can be set to anything. This means if you\nwanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game,\nyou'd adjust the viewport to do that (using methods like `setViewport` and `setSize`).\n\nIf you wish to change where the Camera is looking in your game, then you scroll it. You can do this\nvia the properties `scrollX` and `scrollY` or the method `setScroll`. Scrolling has no impact on the\nviewport, and changing the viewport has no impact on the scrolling.\n\nBy default a Camera will render all Game Objects it can see. You can change this using the `ignore` method,\nallowing you to filter Game Objects out on a per-Camera basis.\n\nA Camera also has built-in special effects including Fade, Flash and Camera Shake.","kind":"class","name":"Camera","memberof":"Phaser.Cameras.Scene2D","since":"3.0.0","augments":["Phaser.Cameras.Scene2D.BaseCamera","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.Tint"],"params":[{"type":{"names":["number"]},"description":"The x position of the Camera, relative to the top-left of the game canvas.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Camera, relative to the top-left of the game canvas.","name":"y"},{"type":{"names":["number"]},"description":"The width of the Camera, in pixels.","name":"width"},{"type":{"names":["number"]},"description":"The height of the Camera, in pixels.","name":"height"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.Camera","___s":true},{"meta":{"filename":"Camera.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Does this Camera allow the Game Objects it renders to receive input events?","name":"inputEnabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#inputEnabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera Fade effect handler.\nTo fade this camera see the `Camera.fade` methods.","name":"fadeEffect","type":{"names":["Phaser.Cameras.Scene2D.Effects.Fade"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#fadeEffect","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":90,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera Flash effect handler.\nTo flash this camera see the `Camera.flash` method.","name":"flashEffect","type":{"names":["Phaser.Cameras.Scene2D.Effects.Flash"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#flashEffect","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":100,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera Shake effect handler.\nTo shake this camera see the `Camera.shake` method.","name":"shakeEffect","type":{"names":["Phaser.Cameras.Scene2D.Effects.Shake"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#shakeEffect","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera Pan effect handler.\nTo pan this camera see the `Camera.pan` method.","name":"panEffect","type":{"names":["Phaser.Cameras.Scene2D.Effects.Pan"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#panEffect","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera Zoom effect handler.\nTo zoom this camera see the `Camera.zoom` method.","name":"zoomEffect","type":{"names":["Phaser.Cameras.Scene2D.Effects.Zoom"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#zoomEffect","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The linear interpolation value to use when following a target.\n\nCan also be set via `setLerp` or as part of the `startFollow` call.\n\nThe default values of 1 means the camera will instantly snap to the target coordinates.\nA lower value, such as 0.1 means the camera will more slowly track the target, giving\na smooth transition. You can set the horizontal and vertical values independently, and also\nadjust this value in real-time during your game.\n\nBe sure to keep the value between 0 and 1. A value of zero will disable tracking on that axis.","name":"lerp","type":{"names":["Phaser.Math.Vector2"]},"since":"3.9.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#lerp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The values stored in this property are subtracted from the Camera targets position, allowing you to\noffset the camera from the actual target x/y coordinates by this amount.\nCan also be set via `setFollowOffset` or as part of the `startFollow` call.","name":"followOffset","type":{"names":["Phaser.Math.Vector2"]},"since":"3.9.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#followOffset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera dead zone.\n\nThe deadzone is only used when the camera is following a target.\n\nIt defines a rectangular region within which if the target is present, the camera will not scroll.\nIf the target moves outside of this area, the camera will begin scrolling in order to follow it.\n\nThe `lerp` values that you can set for a follower target also apply when using a deadzone.\n\nYou can directly set this property to be an instance of a Rectangle. Or, you can use the\n`setDeadzone` method for a chainable approach.\n\nThe rectangle you provide can have its dimensions adjusted dynamically, however, please\nnote that its position is updated every frame, as it is constantly re-centered on the cameras mid point.\n\nCalling `setDeadzone` with no arguments will reset an active deadzone, as will setting this property\nto `null`.","name":"deadzone","type":{"names":["Phaser.Geom.Rectangle"]},"nullable":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#deadzone","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":195,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera rendering directly to the canvas or to a texture?\n\nEnable rendering to texture with the method `setRenderToTexture` (just enabling this boolean won't be enough)\n\nOnce enabled you can toggle it by switching this property.\n\nTo properly remove a render texture you should call the `clearRenderToTexture()` method.","name":"renderToTexture","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.13.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#renderToTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has been set to render to a texture then this holds a reference\nto the HTML Canvas Element that the Camera is drawing to.\n\nEnable texture rendering using the method `setRenderToTexture`.\n\nThis is only populated if Phaser is running with the Canvas Renderer.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.13.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":225,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has been set to render to a texture then this holds a reference\nto the Rendering Context belonging to the Canvas element the Camera is drawing to.\n\nEnable texture rendering using the method `setRenderToTexture`.\n\nThis is only populated if Phaser is running with the Canvas Renderer.","name":"context","type":{"names":["CanvasRenderingContext2D"]},"since":"3.13.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":239,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has been set to render to a texture then this holds a reference\nto the GL Texture belonging the Camera is drawing to.\n\nEnable texture rendering using the method `setRenderToTexture`.\n\nThis is only set if Phaser is running with the WebGL Renderer.","name":"glTexture","type":{"names":["WebGLTexture"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#glTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":253,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has been set to render to a texture then this holds a reference\nto the GL Frame Buffer belonging the Camera is drawing to.\n\nEnable texture rendering using the method `setRenderToTexture`.\n\nThis is only set if Phaser is running with the WebGL Renderer.","name":"framebuffer","type":{"names":["WebGLFramebuffer"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#framebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":267,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has been set to render to a texture and to use a custom pipeline,\nthen this holds a reference to the pipeline the Camera is drawing with.\n\nEnable texture rendering using the method `setRenderToTexture`.\n\nThis is only set if Phaser is running with the WebGL Renderer.","name":"pipeline","type":{"names":["any"]},"since":"3.13.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#pipeline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Camera.js","lineno":282,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the Camera to render to a texture instead of to the main canvas.\n\nThe Camera will redirect all Game Objects it's asked to render to this texture.\n\nDuring the render sequence, the texture itself will then be rendered to the main canvas.\n\nDoing this gives you the ability to modify the texture before this happens,\nallowing for special effects such as Camera specific shaders, or post-processing\non the texture.\n\nIf running under Canvas the Camera will render to its `canvas` property.\n\nIf running under WebGL the Camera will create a frame buffer, which is stored in its `framebuffer` and `glTexture` properties.\n\nIf you set a camera to render to a texture then it will emit 2 events during the render loop:\n\nFirst, it will emit the event `prerender`. This happens right before any Game Object's are drawn to the Camera texture.\n\nThen, it will emit the event `postrender`. This happens after all Game Object's have been drawn, but right before the\nCamera texture is rendered to the main game canvas. It's the final point at which you can manipulate the texture before\nit appears in-game.\n\nYou should not enable this unless you plan on actually using the texture it creates\nsomehow, otherwise you're just doubling the work required to render your game.\n\nTo temporarily disable rendering to a texture, toggle the `renderToTexture` boolean.\n\nIf you no longer require the Camera to render to a texture, call the `clearRenderToTexture` method,\nwhich will delete the respective textures and free-up resources.","kind":"function","name":"setRenderToTexture","since":"3.13.0","params":[{"type":{"names":["string","Phaser.Renderer.WebGL.WebGLPipeline"]},"optional":true,"description":"An optional WebGL Pipeline to render with, can be either a string which is the name of the pipeline, or a pipeline reference.","name":"pipeline"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setRenderToTexture","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":345,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the WebGL pipeline this Camera is using when rendering to a texture.\n\nYou can pass either the string-based name of the pipeline, or a reference to the pipeline itself.\n\nCall this method with no arguments to clear any previously set pipeline.","kind":"function","name":"setPipeline","since":"3.13.0","params":[{"type":{"names":["string","Phaser.Renderer.WebGL.WebGLPipeline"]},"optional":true,"description":"The WebGL Pipeline to render with, can be either a string which is the name of the pipeline, or a pipeline reference. Or if left empty it will clear the pipeline.","name":"pipeline"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setPipeline","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":378,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera was set to render to a texture, this will clear the resources it was using and\nredirect it to render back to the primary Canvas again.\n\nIf you only wish to temporarily disable rendering to a texture then you can toggle the\nproperty `renderToTexture` instead.","kind":"function","name":"clearRenderToTexture","since":"3.13.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#clearRenderToTexture","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":433,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the Camera dead zone.\n\nThe deadzone is only used when the camera is following a target.\n\nIt defines a rectangular region within which if the target is present, the camera will not scroll.\nIf the target moves outside of this area, the camera will begin scrolling in order to follow it.\n\nThe deadzone rectangle is re-positioned every frame so that it is centered on the mid-point\nof the camera. This allows you to use the object for additional game related checks, such as\ntesting if an object is within it or not via a Rectangle.contains call.\n\nThe `lerp` values that you can set for a follower target also apply when using a deadzone.\n\nCalling this method with no arguments will reset an active deadzone.","kind":"function","name":"setDeadzone","since":"3.11.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of the deadzone rectangle in pixels. If not specified the deadzone is removed.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the deadzone rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setDeadzone","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":495,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Fades the Camera in from the given color over the duration specified.","kind":"function","name":"fadeIn","fires":["Phaser.Cameras.Scene2D.Events#event:FADE_IN_START","Phaser.Cameras.Scene2D.Events#event:FADE_IN_COMPLETE"],"since":"3.3.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["function"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#fadeIn","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":518,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Fades the Camera out to the given color over the duration specified.\nThis is an alias for Camera.fade that forces the fade to start, regardless of existing fades.","kind":"function","name":"fadeOut","fires":["Phaser.Cameras.Scene2D.Events#event:FADE_OUT_START","Phaser.Cameras.Scene2D.Events#event:FADE_OUT_COMPLETE"],"since":"3.3.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["function"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#fadeOut","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":542,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Fades the Camera from the given color to transparent over the duration specified.","kind":"function","name":"fadeFrom","fires":["Phaser.Cameras.Scene2D.Events#event:FADE_IN_START","Phaser.Cameras.Scene2D.Events#event:FADE_IN_COMPLETE"],"since":"3.5.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the effect to start immediately, even if already running.","name":"force"},{"type":{"names":["function"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#fadeFrom","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":566,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Fades the Camera from transparent to the given color over the duration specified.","kind":"function","name":"fade","fires":["Phaser.Cameras.Scene2D.Events#event:FADE_OUT_START","Phaser.Cameras.Scene2D.Events#event:FADE_OUT_COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the effect to start immediately, even if already running.","name":"force"},{"type":{"names":["function"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#fade","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Flashes the Camera by setting it to the given color immediately and then fading it away again quickly over the duration specified.","kind":"function","name":"flash","fires":["Phaser.Cameras.Scene2D.Events#event:FLASH_START","Phaser.Cameras.Scene2D.Events#event:FLASH_COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":250,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the effect to start immediately, even if already running.","name":"force"},{"type":{"names":["function"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#flash","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":614,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Shakes the Camera by the given intensity over the duration specified.","kind":"function","name":"shake","fires":["Phaser.Cameras.Scene2D.Events#event:SHAKE_START","Phaser.Cameras.Scene2D.Events#event:SHAKE_COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":100,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["number","Phaser.Math.Vector2"]},"optional":true,"defaultvalue":0.05,"description":"The intensity of the shake.","name":"intensity"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the shake effect to start immediately, even if already running.","name":"force"},{"type":{"names":["function"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#shake","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":636,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"This effect will scroll the Camera so that the center of its viewport finishes at the given destination,\nover the duration and with the ease specified.","kind":"function","name":"pan","fires":["Phaser.Cameras.Scene2D.Events#event:PAN_START","Phaser.Cameras.Scene2D.Events#event:PAN_COMPLETE"],"since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The destination x coordinate to scroll the center of the Camera viewport to.","name":"x"},{"type":{"names":["number"]},"description":"The destination y coordinate to scroll the center of the Camera viewport to.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Linear'","description":"The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function.","name":"ease"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the pan effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraPanCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\nthe current camera scroll x coordinate and the current camera scroll y coordinate.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#pan","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":662,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"This effect will zoom the Camera to the given scale, over the duration and with the ease specified.","kind":"function","name":"zoomTo","fires":["Phaser.Cameras.Scene2D.Events#event:ZOOM_START","Phaser.Cameras.Scene2D.Events#event:ZOOM_COMPLETE"],"since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The target Camera zoom value.","name":"zoom"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Linear'","description":"The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function.","name":"ease"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the pan effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraPanCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\nthe current camera scroll x coordinate and the current camera scroll y coordinate.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#zoomTo","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":791,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the linear interpolation value to use when following a target.\n\nThe default values of 1 means the camera will instantly snap to the target coordinates.\nA lower value, such as 0.1 means the camera will more slowly track the target, giving\na smooth transition. You can set the horizontal and vertical values independently, and also\nadjust this value in real-time during your game.\n\nBe sure to keep the value between 0 and 1. A value of zero will disable tracking on that axis.","kind":"function","name":"setLerp","since":"3.9.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The amount added to the horizontal linear interpolation of the follow target.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The amount added to the vertical linear interpolation of the follow target.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setLerp","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":819,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the horizontal and vertical offset of the camera from its follow target.\nThe values are subtracted from the targets position during the Cameras update step.","kind":"function","name":"setFollowOffset","since":"3.9.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal offset from the camera follow target.x position.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical offset from the camera follow target.y position.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setFollowOffset","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":841,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the Camera to follow a Game Object.\n\nWhen enabled the Camera will automatically adjust its scroll position to keep the target Game Object\nin its center.\n\nYou can set the linear interpolation value used in the follow code.\nUse low lerp values (such as 0.1) to automatically smooth the camera motion.\n\nIf you find you're getting a slight \"jitter\" effect when following an object it's probably to do with sub-pixel\nrendering of the targets position. This can be rounded by setting the `roundPixels` argument to `true` to\nforce full pixel rounding rendering. Note that this can still be broken if you have specified a non-integer zoom\nvalue on the camera. So be sure to keep the camera zoom to integers.","kind":"function","name":"startFollow","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","object"]},"description":"The target for the Camera to follow.","name":"target"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Round the camera position to whole integers to avoid sub-pixel rendering?","name":"roundPixels"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A value between 0 and 1. This value specifies the amount of linear interpolation to use when horizontally tracking the target. The closer the value to 1, the faster the camera will track.","name":"lerpX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A value between 0 and 1. This value specifies the amount of linear interpolation to use when vertically tracking the target. The closer the value to 1, the faster the camera will track.","name":"lerpY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal offset from the camera follow target.x position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical offset from the camera follow target.y position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#startFollow","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":906,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Stops a Camera from following a Game Object, if previously set via `Camera.startFollow`.","kind":"function","name":"stopFollow","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#stopFollow","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":921,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Resets any active FX, such as a fade, flash or shake. Useful to call after a fade in order to\nremove the fade.","kind":"function","name":"resetFX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#resetFX","scope":"instance","___s":true},{"meta":{"filename":"Camera.js","lineno":962,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Destroys this Camera instance. You rarely need to call this directly.\n\nCalled by the Camera Manager. If you wish to destroy a Camera please use `CameraManager.remove` as\ncameras are stored in a pool, ready for recycling later, and calling this directly will prevent that.","kind":"function","name":"destroy","fires":["Phaser.Cameras.Scene2D.Events#event:DESTROY"],"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#destroy","scope":"instance","overrides":"Phaser.Cameras.Scene2D.BaseCamera#destroy","___s":true},{"meta":{"range":[180,208],"filename":"CameraManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"name":"Camera","longname":"Camera","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CameraManager.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"classdesc":"The Camera Manager is a plugin that belongs to a Scene and is responsible for managing all of the Scene Cameras.\n\nBy default you can access the Camera Manager from within a Scene using `this.cameras`, although this can be changed\nin your game config.\n\nCreate new Cameras using the `add` method. Or extend the Camera class with your own addition code and then add\nthe new Camera in using the `addExisting` method.\n\nCameras provide a view into your game world, and can be positioned, rotated, zoomed and scrolled accordingly.\n\nA Camera consists of two elements: The viewport and the scroll values.\n\nThe viewport is the physical position and size of the Camera within your game. Cameras, by default, are\ncreated the same size as your game, but their position and size can be set to anything. This means if you\nwanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game,\nyou'd adjust the viewport to do that (using methods like `setViewport` and `setSize`).\n\nIf you wish to change where the Camera is looking in your game, then you scroll it. You can do this\nvia the properties `scrollX` and `scrollY` or the method `setScroll`. Scrolling has no impact on the\nviewport, and changing the viewport has no impact on the scrolling.\n\nBy default a Camera will render all Game Objects it can see. You can change this using the `ignore` method,\nallowing you to filter Game Objects out on a per-Camera basis. The Camera Manager can manage up to 31 unique \n'Game Object ignore capable' Cameras. Any Cameras beyond 31 that you create will all be given a Camera ID of\nzero, meaning that they cannot be used for Game Object exclusion. This means if you need your Camera to ignore\nGame Objects, make sure it's one of the first 31 created.\n\nA Camera also has built-in special effects including Fade, Flash, Camera Shake, Pan and Zoom.","kind":"class","name":"CameraManager","memberof":"Phaser.Cameras.Scene2D","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that owns the Camera Manager plugin.","name":"scene"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.CameraManager","___s":true},{"meta":{"filename":"CameraManager.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Scene that owns the Camera Manager plugin.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CameraManager.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Scene.Systems handler for the Scene that owns the Camera Manager.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CameraManager.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"All Cameras created by, or added to, this Camera Manager, will have their `roundPixels`\nproperty set to match this value. By default it is set to match the value set in the\ngame configuration, but can be changed at any point. Equally, individual cameras can\nalso be changed as needed.","name":"roundPixels","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#roundPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CameraManager.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"An Array of the Camera objects being managed by this Camera Manager.\nThe Cameras are updated and rendered in the same order in which they appear in this array.\nDo not directly add or remove entries to this array. However, you can move the contents\naround the array should you wish to adjust the display order.","name":"cameras","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#cameras","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CameraManager.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A handy reference to the 'main' camera. By default this is the first Camera the\nCamera Manager creates. You can also set it directly, or use the `makeMain` argument\nin the `add` and `addExisting` methods. It allows you to access it from your game:\n\n```javascript\nvar cam = this.cameras.main;\n```\n\nAlso see the properties `camera1`, `camera2` and so on.","name":"main","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#main","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CameraManager.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A default un-transformed Camera that doesn't exist on the camera list and doesn't\ncount towards the total number of cameras being managed. It exists for other\nsystems, as well as your own code, should they require a basic un-transformed\ncamera instance from which to calculate a view matrix.","name":"default","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"since":"3.17.0","memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#default","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CameraManager.js","lineno":205,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Adds a new Camera into the Camera Manager. The Camera Manager can support up to 31 different Cameras.\n\nEach Camera has its own viewport, which controls the size of the Camera and its position within the canvas.\n\nUse the `Camera.scrollX` and `Camera.scrollY` properties to change where the Camera is looking, or the\nCamera methods such as `centerOn`. Cameras also have built in special effects, such as fade, flash, shake,\npan and zoom.\n\nBy default Cameras are transparent and will render anything that they can see based on their `scrollX`\nand `scrollY` values. Game Objects can be set to be ignored by a Camera by using the `Camera.ignore` method.\n\nThe Camera will have its `roundPixels` property set to whatever `CameraManager.roundPixels` is. You can change\nit after creation if required.\n\nSee the Camera class documentation for more details.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the Camera viewport.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the Camera viewport.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the Camera viewport. If not given it'll be the game config size.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the Camera viewport. If not given it'll be the game config size.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Set this Camera as being the 'main' camera. This just makes the property `main` a reference to it.","name":"makeMain"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The name of the Camera.","name":"name"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The newly created Camera."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#add","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":261,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Adds an existing Camera into the Camera Manager.\n\nThe Camera should either be a `Phaser.Cameras.Scene2D.Camera` instance, or a class that extends from it.\n\nThe Camera will have its `roundPixels` property set to whatever `CameraManager.roundPixels` is. You can change\nit after addition if required.\n\nThe Camera will be assigned an ID, which is used for Game Object exclusion and then added to the\nmanager. As long as it doesn't already exist in the manager it will be added then returned.\n\nIf this method returns `null` then the Camera already exists in this Camera Manager.","kind":"function","name":"addExisting","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to be added to the Camera Manager.","name":"camera"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Set this Camera as being the 'main' camera. This just makes the property `main` a reference to it.","name":"makeMain"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"nullable":true,"description":"The Camera that was added to the Camera Manager, or `null` if it couldn't be added."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#addExisting","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Gets the total number of Cameras in this Camera Manager.\n\nIf the optional `isVisible` argument is set it will only count Cameras that are currently visible.","kind":"function","name":"getTotal","since":"3.11.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Set the `true` to only include visible Cameras in the total.","name":"isVisible"}],"returns":[{"type":{"names":["integer"]},"description":"The total number of Cameras in this Camera Manager."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#getTotal","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":388,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Populates this Camera Manager based on the given configuration object, or an array of config objects.\n\nSee the `Phaser.Types.Cameras.Scene2D.CameraConfig` documentation for details of the object structure.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraConfig","Array."]},"description":"A Camera configuration object, or an array of them, to be added to this Camera Manager.","name":"config"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.CameraManager"]},"description":"This Camera Manager instance."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#fromJSON","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":457,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Gets a Camera based on its name.\n\nCamera names are optional and don't have to be set, so this method is only of any use if you\nhave given your Cameras unique names.","kind":"function","name":"getCamera","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the Camera.","name":"name"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"nullable":true,"description":"The first Camera with a name matching the given string, otherwise `null`."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#getCamera","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Returns an array of all cameras below the given Pointer.\n\nThe first camera in the array is the top-most camera in the camera list.","kind":"function","name":"getCamerasBelowPointer","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer to check against.","name":"pointer"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cameras below the Pointer."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#getCamerasBelowPointer","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":520,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Removes the given Camera, or an array of Cameras, from this Camera Manager.\n\nIf found in the Camera Manager it will be immediately removed from the local cameras array.\nIf also currently the 'main' camera, 'main' will be reset to be camera 0.\n\nThe removed Cameras are automatically destroyed if the `runDestroy` argument is `true`, which is the default.\nIf you wish to re-use the cameras then set this to `false`, but know that they will retain their references\nand internal data until destroyed or re-added to a Camera Manager.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera","Array."]},"description":"The Camera, or an array of Cameras, to be removed from this Camera Manager.","name":"camera"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Automatically call `Camera.destroy` on each Camera removed from this Camera Manager.","name":"runDestroy"}],"returns":[{"type":{"names":["integer"]},"description":"The total number of Cameras removed."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#remove","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Resets this Camera Manager.\n\nThis will iterate through all current Cameras, destroying them all, then it will reset the\ncameras array, reset the ID counter and create 1 new single camera using the default values.","kind":"function","name":"resetAll","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The freshly created main Camera."}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#resetAll","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":651,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The event handler that manages the `resize` event dispatched by the Scale Manager.","kind":"function","name":"onResize","since":"3.18.0","params":[{"type":{"names":["Phaser.Structs.Size"]},"description":"The default Game Size object. This is the un-modified game dimensions.","name":"gameSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"The base Size object. The game dimensions multiplied by the resolution. The canvas width / height values match this.","name":"baseSize"}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#onResize","scope":"instance","___s":true},{"meta":{"filename":"CameraManager.js","lineno":676,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Resizes all cameras to the given dimensions.","kind":"function","name":"resize","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The new width of the camera.","name":"width"},{"type":{"names":["number"]},"description":"The new height of the camera.","name":"height"}],"memberof":"Phaser.Cameras.Scene2D.CameraManager","longname":"Phaser.Cameras.Scene2D.CameraManager#resize","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"Fade.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Fade.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"classdesc":"A Camera Fade effect.\n\nThis effect will fade the camera viewport to the given color, over the duration specified.\n\nOnly the camera viewport is faded. None of the objects it is displaying are impacted, i.e. their colors do\nnot change.\n\nThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\nwhich is invoked each frame for the duration of the effect, if required.","kind":"class","name":"Fade","memberof":"Phaser.Cameras.Scene2D.Effects","since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera this effect is acting upon.","name":"camera"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.Effects.Fade","___s":true},{"meta":{"filename":"Fade.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The Camera this effect belongs to.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"readonly":true,"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Fade.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Is this effect actively running?","name":"isRunning","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Fade.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Has this effect finished running?\n\nThis is different from `isRunning` because it remains set to `true` when the effect is over,\nuntil the effect is either reset or started again.","name":"isComplete","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#isComplete","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Fade.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The direction of the fade.\n`true` = fade out (transparent to color), `false` = fade in (color to transparent)","name":"direction","type":{"names":["boolean"]},"readonly":true,"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#direction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Fade.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The duration of the effect, in milliseconds.","name":"duration","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Fade.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"If this effect is running this holds the current percentage of the progress, a value between 0 and 1.","name":"progress","type":{"names":["number"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Fade.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Fades the Camera to or from the given color over the duration specified.","kind":"function","name":"start","fires":["Phaser.Cameras.Scene2D.Events#event:FADE_IN_START","Phaser.Cameras.Scene2D.Events#event:FADE_OUT_START"],"since":"3.5.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The direction of the fade. `true` = fade out (transparent to color), `false` = fade in (color to transparent)","name":"direction"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraFadeCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera on which the effect was started."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#start","scope":"instance","___s":true},{"meta":{"filename":"Fade.js","lineno":237,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The main update loop for this effect. Called automatically by the Camera.","kind":"function","name":"update","since":"3.5.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#update","scope":"instance","___s":true},{"meta":{"filename":"Fade.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally by the Canvas Renderer.","kind":"function","name":"postRenderCanvas","since":"3.5.0","params":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas context to render to.","name":"ctx"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the effect drew to the renderer, otherwise `false`."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#postRenderCanvas","scope":"instance","___s":true},{"meta":{"filename":"Fade.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally by the WebGL Renderer.","kind":"function","name":"postRenderWebGL","since":"3.5.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"The WebGL Pipeline to render to.","name":"pipeline"},{"type":{"names":["function"]},"description":"A function that will return the gl safe tint colors.","name":"getTintFunction"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the effect drew to the renderer, otherwise `false`."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#postRenderWebGL","scope":"instance","___s":true},{"meta":{"filename":"Fade.js","lineno":330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally when the effect completes.","kind":"function","name":"effectComplete","fires":["Phaser.Cameras.Scene2D.Events#event:FADE_IN_COMPLETE","Phaser.Cameras.Scene2D.Events#event:FADE_OUT_COMPLETE"],"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#effectComplete","scope":"instance","___s":true},{"meta":{"filename":"Fade.js","lineno":351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Resets this camera effect.\nIf it was previously running, it stops instantly without calling its onComplete callback or emitting an event.","kind":"function","name":"reset","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#reset","scope":"instance","___s":true},{"meta":{"filename":"Fade.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Destroys this effect, releasing it from the Camera.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Fade","longname":"Phaser.Cameras.Scene2D.Effects.Fade#destroy","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"Flash.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Flash.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"classdesc":"A Camera Flash effect.\n\nThis effect will flash the camera viewport to the given color, over the duration specified.\n\nOnly the camera viewport is flashed. None of the objects it is displaying are impacted, i.e. their colors do\nnot change.\n\nThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\nwhich is invoked each frame for the duration of the effect, if required.","kind":"class","name":"Flash","memberof":"Phaser.Cameras.Scene2D.Effects","since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera this effect is acting upon.","name":"camera"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.Effects.Flash","___s":true},{"meta":{"filename":"Flash.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The Camera this effect belongs to.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"readonly":true,"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Flash.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Is this effect actively running?","name":"isRunning","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Flash.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The duration of the effect, in milliseconds.","name":"duration","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Flash.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"If this effect is running this holds the current percentage of the progress, a value between 0 and 1.","name":"progress","type":{"names":["number"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Flash.js","lineno":153,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Flashes the Camera to or from the given color over the duration specified.","kind":"function","name":"start","fires":["Phaser.Cameras.Scene2D.Events#event:FLASH_START","Phaser.Cameras.Scene2D.Events#event:FLASH_COMPLETE"],"since":"3.5.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":250,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The amount to fade the red channel towards. A value between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The amount to fade the green channel towards. A value between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The amount to fade the blue channel towards. A value between 0 and 255.","name":"blue"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraFlashCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera on which the effect was started."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#start","scope":"instance","___s":true},{"meta":{"filename":"Flash.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The main update loop for this effect. Called automatically by the Camera.","kind":"function","name":"update","since":"3.5.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#update","scope":"instance","___s":true},{"meta":{"filename":"Flash.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally by the Canvas Renderer.","kind":"function","name":"postRenderCanvas","since":"3.5.0","params":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas context to render to.","name":"ctx"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the effect drew to the renderer, otherwise `false`."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#postRenderCanvas","scope":"instance","___s":true},{"meta":{"filename":"Flash.js","lineno":266,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally by the WebGL Renderer.","kind":"function","name":"postRenderWebGL","since":"3.5.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"The WebGL Pipeline to render to.","name":"pipeline"},{"type":{"names":["function"]},"description":"A function that will return the gl safe tint colors.","name":"getTintFunction"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the effect drew to the renderer, otherwise `false`."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#postRenderWebGL","scope":"instance","___s":true},{"meta":{"filename":"Flash.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally when the effect completes.","kind":"function","name":"effectComplete","fires":["Phaser.Cameras.Scene2D.Events#event:FLASH_COMPLETE"],"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#effectComplete","scope":"instance","___s":true},{"meta":{"filename":"Flash.js","lineno":315,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Resets this camera effect.\nIf it was previously running, it stops instantly without calling its onComplete callback or emitting an event.","kind":"function","name":"reset","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#reset","scope":"instance","___s":true},{"meta":{"filename":"Flash.js","lineno":330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Destroys this effect, releasing it from the Camera.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Flash","longname":"Phaser.Cameras.Scene2D.Effects.Flash#destroy","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"Pan.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Pan.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"classdesc":"A Camera Pan effect.\n\nThis effect will scroll the Camera so that the center of its viewport finishes at the given destination,\nover the duration and with the ease specified.\n\nOnly the camera scroll is moved. None of the objects it is displaying are impacted, i.e. their positions do\nnot change.\n\nThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\nwhich is invoked each frame for the duration of the effect if required.","kind":"class","name":"Pan","memberof":"Phaser.Cameras.Scene2D.Effects","since":"3.11.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera this effect is acting upon.","name":"camera"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.Effects.Pan","___s":true},{"meta":{"filename":"Pan.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The Camera this effect belongs to.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Is this effect actively running?","name":"isRunning","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The duration of the effect, in milliseconds.","name":"duration","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The starting scroll coordinates to pan the camera from.","name":"source","type":{"names":["Phaser.Math.Vector2"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The constantly updated value based on zoom.","name":"current","type":{"names":["Phaser.Math.Vector2"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#current","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The destination scroll coordinates to pan the camera to.","name":"destination","type":{"names":["Phaser.Math.Vector2"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#destination","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The ease function to use during the pan.","name":"ease","type":{"names":["function"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#ease","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"If this effect is running this holds the current percentage of the progress, a value between 0 and 1.","name":"progress","type":{"names":["number"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pan.js","lineno":148,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"This effect will scroll the Camera so that the center of its viewport finishes at the given destination,\nover the duration and with the ease specified.","kind":"function","name":"start","fires":["Phaser.Cameras.Scene2D.Events#event:PAN_START","Phaser.Cameras.Scene2D.Events#event:PAN_COMPLETE"],"since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The destination x coordinate to scroll the center of the Camera viewport to.","name":"x"},{"type":{"names":["number"]},"description":"The destination y coordinate to scroll the center of the Camera viewport to.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Linear'","description":"The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function.","name":"ease"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the pan effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraPanCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\nthe current camera scroll x coordinate and the current camera scroll y coordinate.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera on which the effect was started."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#start","scope":"instance","___s":true},{"meta":{"filename":"Pan.js","lineno":217,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The main update loop for this effect. Called automatically by the Camera.","kind":"function","name":"update","since":"3.11.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#update","scope":"instance","___s":true},{"meta":{"filename":"Pan.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally when the effect completes.","kind":"function","name":"effectComplete","fires":["Phaser.Cameras.Scene2D.Events#event:PAN_COMPLETE"],"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#effectComplete","scope":"instance","___s":true},{"meta":{"filename":"Pan.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Resets this camera effect.\nIf it was previously running, it stops instantly without calling its onComplete callback or emitting an event.","kind":"function","name":"reset","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#reset","scope":"instance","___s":true},{"meta":{"filename":"Pan.js","lineno":302,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Destroys this effect, releasing it from the Camera.","kind":"function","name":"destroy","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Pan","longname":"Phaser.Cameras.Scene2D.Effects.Pan#destroy","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"Shake.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Shake.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"classdesc":"A Camera Shake effect.\n\nThis effect will shake the camera viewport by a random amount, bounded by the specified intensity, each frame.\n\nOnly the camera viewport is moved. None of the objects it is displaying are impacted, i.e. their positions do\nnot change.\n\nThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\nwhich is invoked each frame for the duration of the effect if required.","kind":"class","name":"Shake","memberof":"Phaser.Cameras.Scene2D.Effects","since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera this effect is acting upon.","name":"camera"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.Effects.Shake","___s":true},{"meta":{"filename":"Shake.js","lineno":37,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The Camera this effect belongs to.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"readonly":true,"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shake.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Is this effect actively running?","name":"isRunning","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shake.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The duration of the effect, in milliseconds.","name":"duration","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shake.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The intensity of the effect. Use small float values. The default when the effect starts is 0.05.\nThis is a Vector2 object, allowing you to control the shake intensity independently across x and y.\nYou can modify this value while the effect is active to create more varied shake effects.","name":"intensity","type":{"names":["Phaser.Math.Vector2"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#intensity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shake.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"If this effect is running this holds the current percentage of the progress, a value between 0 and 1.","name":"progress","type":{"names":["number"]},"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shake.js","lineno":143,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Shakes the Camera by the given intensity over the duration specified.","kind":"function","name":"start","fires":["Phaser.Cameras.Scene2D.Events#event:SHAKE_START","Phaser.Cameras.Scene2D.Events#event:SHAKE_COMPLETE"],"since":"3.5.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":100,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["number","Phaser.Math.Vector2"]},"optional":true,"defaultvalue":0.05,"description":"The intensity of the shake.","name":"intensity"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the shake effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraShakeCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera on which the effect was started."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#start","scope":"instance","___s":true},{"meta":{"filename":"Shake.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The pre-render step for this effect. Called automatically by the Camera.","kind":"function","name":"preRender","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#preRender","scope":"instance","___s":true},{"meta":{"filename":"Shake.js","lineno":212,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The main update loop for this effect. Called automatically by the Camera.","kind":"function","name":"update","since":"3.5.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#update","scope":"instance","___s":true},{"meta":{"filename":"Shake.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally when the effect completes.","kind":"function","name":"effectComplete","fires":["Phaser.Cameras.Scene2D.Events#event:SHAKE_COMPLETE"],"since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#effectComplete","scope":"instance","___s":true},{"meta":{"filename":"Shake.js","lineno":279,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Resets this camera effect.\nIf it was previously running, it stops instantly without calling its onComplete callback or emitting an event.","kind":"function","name":"reset","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#reset","scope":"instance","___s":true},{"meta":{"filename":"Shake.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Destroys this effect, releasing it from the Camera.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Cameras.Scene2D.Effects.Shake","longname":"Phaser.Cameras.Scene2D.Effects.Shake#destroy","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"Zoom.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Zoom.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"classdesc":"A Camera Zoom effect.\n\nThis effect will zoom the Camera to the given scale, over the duration and with the ease specified.\n\nThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\nwhich is invoked each frame for the duration of the effect if required.","kind":"class","name":"Zoom","memberof":"Phaser.Cameras.Scene2D.Effects","since":"3.11.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera this effect is acting upon.","name":"camera"}],"scope":"static","longname":"Phaser.Cameras.Scene2D.Effects.Zoom","___s":true},{"meta":{"filename":"Zoom.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The Camera this effect belongs to.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Is this effect actively running?","name":"isRunning","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The duration of the effect, in milliseconds.","name":"duration","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The starting zoom value;","name":"source","type":{"names":["number"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The destination zoom value.","name":"destination","type":{"names":["number"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#destination","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The ease function to use during the zoom.","name":"ease","type":{"names":["function"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#ease","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"If this effect is running this holds the current percentage of the progress, a value between 0 and 1.","name":"progress","type":{"names":["number"]},"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zoom.js","lineno":134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"This effect will zoom the Camera to the given scale, over the duration and with the ease specified.","kind":"function","name":"start","fires":["Phaser.Cameras.Scene2D.Events#event:ZOOM_START","Phaser.Cameras.Scene2D.Events#event:ZOOM_COMPLETE"],"since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The target Camera zoom value.","name":"zoom"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration of the effect in milliseconds.","name":"duration"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Linear'","description":"The ease to use for the Zoom. Can be any of the Phaser Easing constants or a custom function.","name":"ease"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the zoom effect to start immediately, even if already running.","name":"force"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.CameraZoomCallback"]},"optional":true,"description":"This callback will be invoked every frame for the duration of the effect.\nIt is sent three arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\nand the current camera zoom value.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera on which the effect was started."}],"memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#start","scope":"instance","___s":true},{"meta":{"filename":"Zoom.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"The main update loop for this effect. Called automatically by the Camera.","kind":"function","name":"update","since":"3.11.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#update","scope":"instance","___s":true},{"meta":{"filename":"Zoom.js","lineno":240,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Called internally when the effect completes.","kind":"function","name":"effectComplete","fires":["Phaser.Cameras.Scene2D.Events#event:ZOOM_COMPLETE"],"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#effectComplete","scope":"instance","___s":true},{"meta":{"filename":"Zoom.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Resets this camera effect.\nIf it was previously running, it stops instantly without calling its onComplete callback or emitting an event.","kind":"function","name":"reset","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#reset","scope":"instance","___s":true},{"meta":{"filename":"Zoom.js","lineno":272,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"description":"Destroys this effect, releasing it from the Camera.","kind":"function","name":"destroy","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Effects.Zoom","longname":"Phaser.Cameras.Scene2D.Effects.Zoom#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects"},"kind":"namespace","name":"Effects","memberof":"Phaser.Cameras.Scene2D","longname":"Phaser.Cameras.Scene2D.Effects","scope":"static","___s":true},{"meta":{"filename":"DESTROY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Destroy Camera Event.\n\nThis event is dispatched by a Camera instance when it is destroyed by the Camera Manager.","kind":"event","name":"DESTROY","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"The camera that was destroyed.","name":"camera"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:DESTROY","scope":"instance","___s":true},{"meta":{"filename":"FADE_IN_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Fade In Complete Event.\n\nThis event is dispatched by a Camera instance when the Fade In Effect completes.\n\nListen to it from a Camera instance using `Camera.on('camerafadeincomplete', listener)`.","kind":"event","name":"FADE_IN_COMPLETE","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Fade"]},"description":"A reference to the effect instance.","name":"effect"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:FADE_IN_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"FADE_IN_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Fade In Start Event.\n\nThis event is dispatched by a Camera instance when the Fade In Effect starts.\n\nListen to it from a Camera instance using `Camera.on('camerafadeinstart', listener)`.","kind":"event","name":"FADE_IN_START","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Fade"]},"description":"A reference to the effect instance.","name":"effect"},{"type":{"names":["integer"]},"description":"The duration of the effect.","name":"duration"},{"type":{"names":["integer"]},"description":"The red color channel value.","name":"red"},{"type":{"names":["integer"]},"description":"The green color channel value.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color channel value.","name":"blue"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:FADE_IN_START","scope":"instance","___s":true},{"meta":{"filename":"FADE_OUT_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Fade Out Complete Event.\n\nThis event is dispatched by a Camera instance when the Fade Out Effect completes.\n\nListen to it from a Camera instance using `Camera.on('camerafadeoutcomplete', listener)`.","kind":"event","name":"FADE_OUT_COMPLETE","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Fade"]},"description":"A reference to the effect instance.","name":"effect"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:FADE_OUT_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"FADE_OUT_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Fade Out Start Event.\n\nThis event is dispatched by a Camera instance when the Fade Out Effect starts.\n\nListen to it from a Camera instance using `Camera.on('camerafadeoutstart', listener)`.","kind":"event","name":"FADE_OUT_START","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Fade"]},"description":"A reference to the effect instance.","name":"effect"},{"type":{"names":["integer"]},"description":"The duration of the effect.","name":"duration"},{"type":{"names":["integer"]},"description":"The red color channel value.","name":"red"},{"type":{"names":["integer"]},"description":"The green color channel value.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color channel value.","name":"blue"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:FADE_OUT_START","scope":"instance","___s":true},{"meta":{"filename":"FLASH_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Flash Complete Event.\n\nThis event is dispatched by a Camera instance when the Flash Effect completes.","kind":"event","name":"FLASH_COMPLETE","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Flash"]},"description":"A reference to the effect instance.","name":"effect"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:FLASH_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"FLASH_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Flash Start Event.\n\nThis event is dispatched by a Camera instance when the Flash Effect starts.","kind":"event","name":"FLASH_START","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Flash"]},"description":"A reference to the effect instance.","name":"effect"},{"type":{"names":["integer"]},"description":"The duration of the effect.","name":"duration"},{"type":{"names":["integer"]},"description":"The red color channel value.","name":"red"},{"type":{"names":["integer"]},"description":"The green color channel value.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color channel value.","name":"blue"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:FLASH_START","scope":"instance","___s":true},{"meta":{"filename":"PAN_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Pan Complete Event.\n\nThis event is dispatched by a Camera instance when the Pan Effect completes.","kind":"event","name":"PAN_COMPLETE","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Pan"]},"description":"A reference to the effect instance.","name":"effect"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:PAN_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"PAN_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Pan Start Event.\n\nThis event is dispatched by a Camera instance when the Pan Effect starts.","kind":"event","name":"PAN_START","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Pan"]},"description":"A reference to the effect instance.","name":"effect"},{"type":{"names":["integer"]},"description":"The duration of the effect.","name":"duration"},{"type":{"names":["number"]},"description":"The destination scroll x coordinate.","name":"x"},{"type":{"names":["number"]},"description":"The destination scroll y coordinate.","name":"y"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:PAN_START","scope":"instance","___s":true},{"meta":{"filename":"POST_RENDER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Post-Render Event.\n\nThis event is dispatched by a Camera instance after is has finished rendering.\nIt is only dispatched if the Camera is rendering to a texture.\n\nListen to it from a Camera instance using: `camera.on('postrender', listener)`.","kind":"event","name":"POST_RENDER","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"The camera that has finished rendering to a texture.","name":"camera"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:POST_RENDER","scope":"instance","___s":true},{"meta":{"filename":"PRE_RENDER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Pre-Render Event.\n\nThis event is dispatched by a Camera instance when it is about to render.\nIt is only dispatched if the Camera is rendering to a texture.\n\nListen to it from a Camera instance using: `camera.on('prerender', listener)`.","kind":"event","name":"PRE_RENDER","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"The camera that is about to render to a texture.","name":"camera"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:PRE_RENDER","scope":"instance","___s":true},{"meta":{"filename":"SHAKE_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Shake Complete Event.\n\nThis event is dispatched by a Camera instance when the Shake Effect completes.","kind":"event","name":"SHAKE_COMPLETE","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Shake"]},"description":"A reference to the effect instance.","name":"effect"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:SHAKE_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"SHAKE_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Shake Start Event.\n\nThis event is dispatched by a Camera instance when the Shake Effect starts.","kind":"event","name":"SHAKE_START","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Shake"]},"description":"A reference to the effect instance.","name":"effect"},{"type":{"names":["integer"]},"description":"The duration of the effect.","name":"duration"},{"type":{"names":["number"]},"description":"The intensity of the effect.","name":"intensity"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:SHAKE_START","scope":"instance","___s":true},{"meta":{"filename":"ZOOM_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Zoom Complete Event.\n\nThis event is dispatched by a Camera instance when the Zoom Effect completes.","kind":"event","name":"ZOOM_COMPLETE","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Zoom"]},"description":"A reference to the effect instance.","name":"effect"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:ZOOM_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"ZOOM_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"description":"The Camera Zoom Start Event.\n\nThis event is dispatched by a Camera instance when the Zoom Effect starts.","kind":"event","name":"ZOOM_START","since":"3.3.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera that the effect began on.","name":"camera"},{"type":{"names":["Phaser.Cameras.Scene2D.Effects.Zoom"]},"description":"A reference to the effect instance.","name":"effect"},{"type":{"names":["integer"]},"description":"The duration of the effect.","name":"duration"},{"type":{"names":["number"]},"description":"The destination zoom value.","name":"zoom"}],"memberof":"Phaser.Cameras.Scene2D.Events","longname":"Phaser.Cameras.Scene2D.Events#event:ZOOM_START","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Cameras.Scene2D","longname":"Phaser.Cameras.Scene2D.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"kind":"namespace","name":"Scene2D","memberof":"Phaser.Cameras","longname":"Phaser.Cameras.Scene2D","scope":"static","___s":true},{"meta":{"filename":"CameraConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"CameraConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The name of the Camera.","name":"name"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the Camera viewport.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the Camera viewport.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the Camera viewport.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the Camera viewport.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The default zoom level of the Camera.","name":"zoom"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of the Camera, in radians.","name":"rotation"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the Camera round pixels before rendering?","name":"roundPixels"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal scroll position of the Camera.","name":"scrollX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical scroll position of the Camera.","name":"scrollY"},{"type":{"names":["false","string"]},"optional":true,"defaultvalue":false,"description":"A CSS color string controlling the Camera background color.","name":"backgroundColor"},{"type":{"names":["object"]},"optional":true,"nullable":true,"description":"Defines the Camera bounds.","name":"bounds"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The top-left extent of the Camera bounds.","name":"bounds.x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The top-left extent of the Camera bounds.","name":"bounds.y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the Camera bounds.","name":"bounds.width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the Camera bounds.","name":"bounds.height"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.CameraConfig","scope":"static","___s":true},{"meta":{"filename":"CameraFadeCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"CameraFadeCallback","type":{"names":["function"]},"since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera on which the effect is running.","name":"camera"},{"type":{"names":["number"]},"description":"The progress of the effect. A value between 0 and 1.","name":"progress"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.CameraFadeCallback","scope":"static","___s":true},{"meta":{"filename":"CameraFlashCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"CameraFlashCallback","type":{"names":["function"]},"since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera on which the effect is running.","name":"camera"},{"type":{"names":["number"]},"description":"The progress of the effect. A value between 0 and 1.","name":"progress"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.CameraFlashCallback","scope":"static","___s":true},{"meta":{"filename":"CameraPanCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"CameraPanCallback","type":{"names":["function"]},"since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera on which the effect is running.","name":"camera"},{"type":{"names":["number"]},"description":"The progress of the effect. A value between 0 and 1.","name":"progress"},{"type":{"names":["number"]},"description":"The Camera's new scrollX coordinate.","name":"x"},{"type":{"names":["number"]},"description":"The Camera's new scrollY coordinate.","name":"y"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.CameraPanCallback","scope":"static","___s":true},{"meta":{"filename":"CameraShakeCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"CameraShakeCallback","type":{"names":["function"]},"since":"3.5.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera on which the effect is running.","name":"camera"},{"type":{"names":["number"]},"description":"The progress of the effect. A value between 0 and 1.","name":"progress"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.CameraShakeCallback","scope":"static","___s":true},{"meta":{"filename":"CameraZoomCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"CameraZoomCallback","type":{"names":["function"]},"since":"3.11.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera on which the effect is running.","name":"camera"},{"type":{"names":["number"]},"description":"The progress of the effect. A value between 0 and 1.","name":"progress"},{"type":{"names":["number"]},"description":"The Camera's new zoom value.","name":"zoom"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.CameraZoomCallback","scope":"static","___s":true},{"meta":{"filename":"JSONCamera.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"JSONCamera","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The name of the camera","name":"name"},{"type":{"names":["number"]},"description":"The horizontal position of camera","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of camera","name":"y"},{"type":{"names":["number"]},"description":"The width size of camera","name":"width"},{"type":{"names":["number"]},"description":"The height size of camera","name":"height"},{"type":{"names":["number"]},"description":"The zoom of camera","name":"zoom"},{"type":{"names":["number"]},"description":"The rotation of camera","name":"rotation"},{"type":{"names":["boolean"]},"description":"The round pixels st status of camera","name":"roundPixels"},{"type":{"names":["number"]},"description":"The horizontal scroll of camera","name":"scrollX"},{"type":{"names":["number"]},"description":"The vertical scroll of camera","name":"scrollY"},{"type":{"names":["string"]},"description":"The background color of camera","name":"backgroundColor"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.JSONCameraBounds","undefined"]},"optional":true,"description":"The bounds of camera","name":"bounds"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.JSONCamera","scope":"static","___s":true},{"meta":{"filename":"JSONCameraBounds.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"typedef","name":"JSONCameraBounds","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The horizontal position of camera","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of camera","name":"y"},{"type":{"names":["number"]},"description":"The width size of camera","name":"width"},{"type":{"names":["number"]},"description":"The height size of camera","name":"height"}],"memberof":"Phaser.Types.Cameras.Scene2D","longname":"Phaser.Types.Cameras.Scene2D.JSONCameraBounds","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs"},"kind":"namespace","name":"Scene2D","memberof":"Phaser.Types.Cameras","longname":"Phaser.Types.Cameras.Scene2D","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"FixedKeyControl.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"classdesc":"A Fixed Key Camera Control.\n\nThis allows you to control the movement and zoom of a camera using the defined keys.\n\n```javascript\nvar camControl = new FixedKeyControl({\n camera: this.cameras.main,\n left: cursors.left,\n right: cursors.right,\n speed: float OR { x: 0, y: 0 }\n});\n```\n\nMovement is precise and has no 'smoothing' applied to it.\n\nYou must call the `update` method of this controller every frame.","kind":"class","name":"FixedKeyControl","memberof":"Phaser.Cameras.Controls","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Cameras.Controls.FixedKeyControlConfig"]},"description":"The Fixed Key Control configuration object.","name":"config"}],"scope":"static","longname":"Phaser.Cameras.Controls.FixedKeyControl","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Camera that this Control will update.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera left.","name":"left","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera right.","name":"right","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera up.","name":"up","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#up","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera down.","name":"down","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#down","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will zoom the Camera in.","name":"zoomIn","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#zoomIn","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will zoom the Camera out.","name":"zoomOut","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#zoomOut","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.","name":"zoomSpeed","type":{"names":["number"]},"defaultvalue":"0.01","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#zoomSpeed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The horizontal speed the camera will move.","name":"speedX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#speedX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The vertical speed the camera will move.","name":"speedY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#speedY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"A flag controlling if the Controls will update the Camera or not.","name":"active","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":176,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Starts the Key Control running, providing it has been linked to a camera.","kind":"function","name":"start","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Controls.FixedKeyControl"]},"description":"This Key Control instance."}],"memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#start","scope":"instance","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Stops this Key Control from running. Call `start` to start it again.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Controls.FixedKeyControl"]},"description":"This Key Control instance."}],"memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#stop","scope":"instance","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Binds this Key Control to a camera.","kind":"function","name":"setCamera","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera to bind this Key Control to.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Cameras.Controls.FixedKeyControl"]},"description":"This Key Control instance."}],"memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#setCamera","scope":"instance","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Applies the results of pressing the control keys to the Camera.\n\nYou must call this every step, it is not called automatically.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#update","scope":"instance","___s":true},{"meta":{"filename":"FixedKeyControl.js","lineno":279,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Destroys this Key Control.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Cameras.Controls.FixedKeyControl","longname":"Phaser.Cameras.Controls.FixedKeyControl#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"SmoothedKeyControl.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"classdesc":"A Smoothed Key Camera Control.\n\nThis allows you to control the movement and zoom of a camera using the defined keys.\nUnlike the Fixed Camera Control you can also provide physics values for acceleration, drag and maxSpeed for smoothing effects.\n\n```javascript\nvar controlConfig = {\n camera: this.cameras.main,\n left: cursors.left,\n right: cursors.right,\n up: cursors.up,\n down: cursors.down,\n zoomIn: this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.Q),\n zoomOut: this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.E),\n zoomSpeed: 0.02,\n acceleration: 0.06,\n drag: 0.0005,\n maxSpeed: 1.0\n};\n```\n\nYou must call the `update` method of this controller every frame.","kind":"class","name":"SmoothedKeyControl","memberof":"Phaser.Cameras.Controls","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Cameras.Controls.SmoothedKeyControlConfig"]},"description":"The Smoothed Key Control configuration object.","name":"config"}],"scope":"static","longname":"Phaser.Cameras.Controls.SmoothedKeyControl","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Camera that this Control will update.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera left.","name":"left","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera right.","name":"right","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera up.","name":"up","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#up","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will move the Camera down.","name":"down","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#down","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will zoom the Camera in.","name":"zoomIn","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#zoomIn","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The Key to be pressed that will zoom the Camera out.","name":"zoomOut","type":{"names":["Phaser.Input.Keyboard.Key"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#zoomOut","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.","name":"zoomSpeed","type":{"names":["number"]},"defaultvalue":"0.01","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#zoomSpeed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The horizontal acceleration the camera will move.","name":"accelX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#accelX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The vertical acceleration the camera will move.","name":"accelY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#accelY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The horizontal drag applied to the camera when it is moving.","name":"dragX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#dragX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":171,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The vertical drag applied to the camera when it is moving.","name":"dragY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#dragY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":194,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The maximum horizontal speed the camera will move.","name":"maxSpeedX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#maxSpeedX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":204,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"The maximum vertical speed the camera will move.","name":"maxSpeedY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#maxSpeedY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":260,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"A flag controlling if the Controls will update the Camera or not.","name":"active","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Starts the Key Control running, providing it has been linked to a camera.","kind":"function","name":"start","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Controls.SmoothedKeyControl"]},"description":"This Key Control instance."}],"memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#start","scope":"instance","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":285,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Stops this Key Control from running. Call `start` to start it again.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Controls.SmoothedKeyControl"]},"description":"This Key Control instance."}],"memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#stop","scope":"instance","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Binds this Key Control to a camera.","kind":"function","name":"setCamera","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera to bind this Key Control to.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Cameras.Controls.SmoothedKeyControl"]},"description":"This Key Control instance."}],"memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#setCamera","scope":"instance","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":317,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Applies the results of pressing the control keys to the Camera.\n\nYou must call this every step, it is not called automatically.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#update","scope":"instance","___s":true},{"meta":{"filename":"SmoothedKeyControl.js","lineno":456,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"description":"Destroys this Key Control.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Cameras.Controls.SmoothedKeyControl","longname":"Phaser.Cameras.Controls.SmoothedKeyControl#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls"},"kind":"namespace","name":"Controls","memberof":"Phaser.Cameras","longname":"Phaser.Cameras.Controls","scope":"static","___s":true},{"meta":{"filename":"FixedKeyControlConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls/typedefs"},"kind":"typedef","name":"FixedKeyControlConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera that this Control will update.","name":"camera"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera left.","name":"left"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera right.","name":"right"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera up.","name":"up"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera down.","name":"down"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will zoom the Camera in.","name":"zoomIn"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will zoom the Camera out.","name":"zoomOut"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.01,"description":"The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.","name":"zoomSpeed"},{"type":{"names":["number","Object"]},"optional":true,"defaultvalue":0,"description":"The horizontal and vertical speed the camera will move.","name":"speed"}],"memberof":"Phaser.Types.Cameras.Controls","longname":"Phaser.Types.Cameras.Controls.FixedKeyControlConfig","scope":"static","___s":true},{"meta":{"filename":"SmoothedKeyControlConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls/typedefs"},"kind":"typedef","name":"SmoothedKeyControlConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera that this Control will update.","name":"camera"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera left.","name":"left"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera right.","name":"right"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will move the Camera up.","name":"up"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will zoom the Camera in.","name":"zoomIn"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"The Key to be pressed that will zoom the Camera out.","name":"zoomOut"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.01,"description":"The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.","name":"zoomSpeed"},{"type":{"names":["number","Object"]},"optional":true,"defaultvalue":0,"description":"The horizontal and vertical acceleration the camera will move.","name":"acceleration"},{"type":{"names":["number","Object"]},"optional":true,"defaultvalue":0,"description":"The horizontal and vertical drag applied to the camera when it is moving.","name":"drag"},{"type":{"names":["number","Object"]},"optional":true,"defaultvalue":0,"description":"The maximum horizontal and vertical speed the camera will move.","name":"maxSpeed"}],"memberof":"Phaser.Types.Cameras.Controls","longname":"Phaser.Types.Cameras.Controls.SmoothedKeyControlConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/controls/typedefs"},"kind":"namespace","name":"Controls","memberof":"Phaser.Types.Cameras","longname":"Phaser.Types.Cameras.Controls","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras"},"kind":"namespace","name":"Cameras","memberof":"Phaser","longname":"Phaser.Cameras","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/cameras"},"kind":"namespace","name":"Cameras","memberof":"Phaser.Types","longname":"Phaser.Types.Cameras","scope":"static","___s":true},{"meta":{"range":[225,2126],"filename":"const.js","lineno":13,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Global constants.","ignore":true,"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Phaser Release Version","name":"VERSION","kind":"constant","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.VERSION","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":29,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"AUTO Detect Renderer.","name":"AUTO","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.AUTO","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Canvas Renderer.","name":"CANVAS","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.CANVAS","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":49,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"WebGL Renderer.","name":"WEBGL","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.WEBGL","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":59,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Headless Renderer.","name":"HEADLESS","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.HEADLESS","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":69,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"In Phaser the value -1 means 'forever' in lots of cases, this const allows you to use it instead\nto help you remember what the value is doing in your code.","name":"FOREVER","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.FOREVER","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Direction constant.","name":"NONE","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.NONE","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Direction constant.","name":"UP","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.UP","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Direction constant.","name":"DOWN","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.DOWN","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Direction constant.","name":"LEFT","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.LEFT","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"Direction constant.","name":"RIGHT","kind":"constant","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser","longname":"Phaser.RIGHT","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Config.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Config.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"classdesc":"The active game configuration settings, parsed from a {@link Phaser.Types.Core.GameConfig} object.","kind":"class","name":"Config","memberof":"Phaser.Core","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Core.GameConfig"]},"optional":true,"description":"The configuration object for your Phaser Game instance.","name":"GameConfig"}],"see":["Phaser.Game#config"],"scope":"static","longname":"Phaser.Core.Config","___s":true},{"meta":{"filename":"Config.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"width","type":{"names":["integer","string"]},"description":"The width of the underlying canvas, in pixels.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#width","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"height","type":{"names":["integer","string"]},"description":"The height of the underlying canvas, in pixels.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#height","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"zoom","type":{"names":["Phaser.Scale.ZoomType","integer"]},"description":"The zoom factor, as used by the Scale Manager.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#zoom","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"resolution","type":{"names":["number"]},"description":"The canvas device pixel resolution. Currently un-used.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#resolution","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"parent","type":{"names":["*"]},"nullable":true,"description":"A parent DOM element into which the canvas created by the renderer will be injected.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#parent","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"scaleMode","type":{"names":["Phaser.Scale.ScaleModeType"]},"description":"The scale mode as used by the Scale Manager. The default is zero, which is no scaling.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#scaleMode","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"expandParent","type":{"names":["boolean"]},"description":"Is the Scale Manager allowed to adjust the CSS height property of the parent to be 100%?","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#expandParent","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"autoRound","type":{"names":["integer"]},"description":"Automatically round the display and style sizes of the canvas. This can help with performance in lower-powered devices.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#autoRound","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"autoCenter","type":{"names":["Phaser.Scale.CenterType"]},"description":"Automatically center the canvas within the parent?","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#autoCenter","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"resizeInterval","type":{"names":["integer"]},"description":"How many ms should elapse before checking if the browser size has changed?","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#resizeInterval","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"fullscreenTarget","type":{"names":["HTMLElement","string"]},"nullable":true,"description":"The DOM element that will be sent into full screen mode, or its `id`. If undefined Phaser will create its own div and insert the canvas into it when entering fullscreen mode.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#fullscreenTarget","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"minWidth","type":{"names":["integer"]},"description":"The minimum width, in pixels, the canvas will scale down to. A value of zero means no minimum.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#minWidth","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":109,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"maxWidth","type":{"names":["integer"]},"description":"The maximum width, in pixels, the canvas will scale up to. A value of zero means no maximum.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#maxWidth","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"minHeight","type":{"names":["integer"]},"description":"The minimum height, in pixels, the canvas will scale down to. A value of zero means no minimum.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#minHeight","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"maxHeight","type":{"names":["integer"]},"description":"The maximum height, in pixels, the canvas will scale up to. A value of zero means no maximum.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#maxHeight","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"renderType","type":{"names":["number"]},"description":"Force Phaser to use a specific renderer. Can be `CONST.CANVAS`, `CONST.WEBGL`, `CONST.HEADLESS` or `CONST.AUTO` (default)","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#renderType","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"canvas","type":{"names":["HTMLCanvasElement"]},"nullable":true,"description":"Force Phaser to use your own Canvas element instead of creating one.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#canvas","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"context","type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"nullable":true,"description":"Force Phaser to use your own Canvas context instead of creating one.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#context","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":162,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"canvasStyle","type":{"names":["string"]},"nullable":true,"description":"Optional CSS attributes to be set on the canvas object created by the renderer.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#canvasStyle","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"customEnvironment","type":{"names":["boolean"]},"description":"Is Phaser running under a custom (non-native web) environment? If so, set this to `true` to skip internal Feature detection. If `true` the `renderType` cannot be left as `AUTO`.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#customEnvironment","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":172,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"sceneConfig","type":{"names":["object"]},"nullable":true,"description":"The default Scene configuration object.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#sceneConfig","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"seed","type":{"names":["Array."]},"description":"A seed which the Random Data Generator will use. If not given, a dynamic seed based on the time is used.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#seed","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":184,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"gameTitle","type":{"names":["string"]},"description":"The title of the game.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#gameTitle","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":189,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"gameURL","type":{"names":["string"]},"description":"The URL of the game.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#gameURL","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":194,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"gameVersion","type":{"names":["string"]},"description":"The version of the game.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#gameVersion","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":199,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"autoFocus","type":{"names":["boolean"]},"description":"If `true` the window will automatically be given focus immediately and on any future mousedown event.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#autoFocus","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":206,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"domCreateContainer","type":{"names":["boolean"]},"nullable":true,"description":"Should the game create a div element to act as a DOM Container? Only enable if you're using DOM Element objects. You must provide a parent object if you use this feature.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#domCreateContainer","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"domBehindCanvas","type":{"names":["boolean"]},"nullable":true,"description":"Should the DOM Container that is created (if `dom.createContainer` is true) be positioned behind (true) or over the top (false, the default) of the game canvas?","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#domBehindCanvas","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":218,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputKeyboard","type":{"names":["boolean"]},"description":"Enable the Keyboard Plugin. This can be disabled in games that don't need keyboard input.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputKeyboard","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":223,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputKeyboardEventTarget","type":{"names":["*"]},"description":"The DOM Target to listen for keyboard events on. Defaults to `window` if not specified.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputKeyboardEventTarget","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":228,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputKeyboardCapture","type":{"names":["Array."]},"nullable":true,"description":"`preventDefault` will be called on every non-modified key which has a key code in this array. By default, it is empty.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputKeyboardCapture","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":233,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputMouse","type":{"names":["boolean","object"]},"description":"Enable the Mouse Plugin. This can be disabled in games that don't need mouse input.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputMouse","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":238,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputMouseEventTarget","type":{"names":["*"]},"nullable":true,"description":"The DOM Target to listen for mouse events on. Defaults to the game canvas if not specified.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputMouseEventTarget","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":243,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputMouseCapture","type":{"names":["boolean"]},"description":"Should mouse events be captured? I.e. have prevent default called on them.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputMouseCapture","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":248,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputTouch","type":{"names":["boolean"]},"description":"Enable the Touch Plugin. This can be disabled in games that don't need touch input.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputTouch","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":253,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputTouchEventTarget","type":{"names":["*"]},"nullable":true,"description":"The DOM Target to listen for touch events on. Defaults to the game canvas if not specified.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputTouchEventTarget","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":258,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputTouchCapture","type":{"names":["boolean"]},"description":"Should touch events be captured? I.e. have prevent default called on them.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputTouchCapture","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":263,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputActivePointers","type":{"names":["integer"]},"description":"The number of Pointer objects created by default. In a mouse-only, or non-multi touch game, you can leave this as 1.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputActivePointers","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":268,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputSmoothFactor","type":{"names":["integer"]},"description":"The smoothing factor to apply during Pointer movement. See {@link Phaser.Input.Pointer#smoothFactor}.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputSmoothFactor","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputWindowEvents","type":{"names":["boolean"]},"description":"Should Phaser listen for input events on the Window? If you disable this, events like 'POINTER_UP_OUTSIDE' will no longer fire.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputWindowEvents","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":278,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputGamepad","type":{"names":["boolean"]},"description":"Enable the Gamepad Plugin. This can be disabled in games that don't need gamepad input.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputGamepad","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":283,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"inputGamepadEventTarget","type":{"names":["*"]},"description":"The DOM Target to listen for gamepad events on. Defaults to `window` if not specified.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#inputGamepadEventTarget","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":288,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"disableContextMenu","type":{"names":["boolean"]},"description":"Set to `true` to disable the right-click context menu.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#disableContextMenu","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":293,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"audio","type":{"names":["Phaser.Types.Core.AudioConfig"]},"description":"The Audio Configuration object.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#audio","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":300,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"hideBanner","type":{"names":["boolean"]},"description":"Don't write the banner line to the console.log.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#hideBanner","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":305,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"hidePhaser","type":{"names":["boolean"]},"description":"Omit Phaser's name and version from the banner.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#hidePhaser","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":310,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"bannerTextColor","type":{"names":["string"]},"description":"The color of the banner text.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#bannerTextColor","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":315,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"bannerBackgroundColor","type":{"names":["Array."]},"description":"The background colors of the banner.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#bannerBackgroundColor","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":325,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"fps","type":{"names":["Phaser.Types.Core.FPSConfig"]},"nullable":true,"description":"The Frame Rate Configuration object, as parsed by the Timestep class.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#fps","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":335,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"antialias","type":{"names":["boolean"]},"description":"When set to `true`, WebGL uses linear interpolation to draw scaled or rotated textures, giving a smooth appearance. When set to `false`, WebGL uses nearest-neighbor interpolation, giving a crisper appearance. `false` also disables antialiasing of the game canvas itself, if the browser supports it, when the game canvas is scaled.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#antialias","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":340,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"antialiasGL","type":{"names":["boolean"]},"description":"Sets the `antialias` property when the WebGL context is created. Setting this value does not impact any subsequent textures that are created, or the canvas style attributes.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#antialiasGL","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":345,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"mipmapFilter","type":{"names":["string"]},"description":"Sets the `mipmapFilter` property when the WebGL renderer is created.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#mipmapFilter","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":350,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"desynchronized","type":{"names":["boolean"]},"description":"When set to `true` it will create a desynchronized context for both 2D and WebGL. See https://developers.google.com/web/updates/2019/05/desynchronized for details.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#desynchronized","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":355,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"roundPixels","type":{"names":["boolean"]},"description":"Draw texture-based Game Objects at only whole-integer positions. Game Objects without textures, like Graphics, ignore this property.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#roundPixels","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":360,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"pixelArt","type":{"names":["boolean"]},"description":"Prevent pixel art from becoming blurred when scaled. It will remain crisp (tells the WebGL renderer to automatically create textures using a linear filter mode).","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#pixelArt","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":371,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"transparent","type":{"names":["boolean"]},"description":"Whether the game canvas will have a transparent background.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#transparent","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":376,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"clearBeforeRender","type":{"names":["boolean"]},"description":"Whether the game canvas will be cleared between each rendering frame. You can disable this if you have a full-screen background image or game object.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#clearBeforeRender","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":381,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"premultipliedAlpha","type":{"names":["boolean"]},"description":"In WebGL mode, sets the drawing buffer to contain colors with pre-multiplied alpha.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#premultipliedAlpha","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":386,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"failIfMajorPerformanceCaveat","type":{"names":["boolean"]},"description":"Let the browser abort creating a WebGL context if it judges performance would be unacceptable.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#failIfMajorPerformanceCaveat","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":391,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"powerPreference","type":{"names":["string"]},"description":"\"high-performance\", \"low-power\" or \"default\". A hint to the browser on how much device power the game might use.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#powerPreference","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":396,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"batchSize","type":{"names":["integer"]},"description":"The default WebGL Batch size.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#batchSize","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":401,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"maxLights","type":{"names":["integer"]},"description":"The maximum number of lights allowed to be visible within range of a single Camera in the LightManager.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#maxLights","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":408,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"backgroundColor","type":{"names":["Phaser.Display.Color"]},"description":"The background color of the game canvas. The default is black. This value is ignored if `transparent` is set to `true`.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#backgroundColor","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":418,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"preBoot","type":{"names":["Phaser.Types.Core.BootCallback"]},"description":"Called before Phaser boots. Useful for initializing anything not related to Phaser that Phaser may require while booting.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#preBoot","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":423,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"postBoot","type":{"names":["Phaser.Types.Core.BootCallback"]},"description":"A function to run at the end of the boot sequence. At this point, all the game systems have started and plugins have been loaded.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#postBoot","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":428,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"physics","type":{"names":["Phaser.Types.Core.PhysicsConfig"]},"description":"The Physics Configuration object.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#physics","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":433,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"defaultPhysicsSystem","type":{"names":["boolean","string"]},"description":"The default physics system. It will be started for each scene. Either 'arcade', 'impact' or 'matter'.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#defaultPhysicsSystem","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":438,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderBaseURL","type":{"names":["string"]},"description":"A URL used to resolve paths given to the loader. Example: 'http://labs.phaser.io/assets/'.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderBaseURL","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":443,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderPath","type":{"names":["string"]},"description":"A URL path used to resolve relative paths given to the loader. Example: 'images/sprites/'.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderPath","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":448,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderMaxParallelDownloads","type":{"names":["integer"]},"description":"Maximum parallel downloads allowed for resources (Default to 32).","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderMaxParallelDownloads","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":453,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderCrossOrigin","type":{"names":["string","undefined"]},"description":"'anonymous', 'use-credentials', or `undefined`. If you're not making cross-origin requests, leave this as `undefined`. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes}.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderCrossOrigin","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":458,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderResponseType","type":{"names":["string"]},"description":"The response type of the XHR request, e.g. `blob`, `text`, etc.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderResponseType","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":463,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderAsync","type":{"names":["boolean"]},"description":"Should the XHR request use async or not?","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderAsync","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":468,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderUser","type":{"names":["string"]},"description":"Optional username for all XHR requests.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderUser","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":473,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderPassword","type":{"names":["string"]},"description":"Optional password for all XHR requests.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderPassword","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":478,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"loaderTimeout","type":{"names":["integer"]},"description":"Optional XHR timeout value, in ms.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#loaderTimeout","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":501,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"installGlobalPlugins","type":{"names":["any"]},"description":"An array of global plugins to be installed.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#installGlobalPlugins","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":506,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"installScenePlugins","type":{"names":["any"]},"description":"An array of Scene level plugins to be installed.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#installScenePlugins","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":537,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"defaultPlugins","type":{"names":["any"]},"description":"The plugins installed into every Scene (in addition to CoreScene and Global).","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#defaultPlugins","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":545,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"defaultImage","type":{"names":["string"]},"description":"A base64 encoded PNG that will be used as the default blank texture.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#defaultImage","scope":"instance","___s":true},{"meta":{"filename":"Config.js","lineno":550,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"constant","name":"missingImage","type":{"names":["string"]},"description":"A base64 encoded PNG that will be used as the default texture when a texture is assigned that is missing or not loaded.","memberof":"Phaser.Core.Config","longname":"Phaser.Core.Config#missingImage","scope":"instance","___s":true},{"meta":{"range":[180,250],"filename":"CreateRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"name":"CanvasInterpolation","longname":"CanvasInterpolation","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CreateRenderer.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Called automatically by Phaser.Game and responsible for creating the renderer it will use.\n\nRelies upon two webpack global flags to be defined: `WEBGL_RENDERER` and `CANVAS_RENDERER` during build time, but not at run-time.","kind":"function","name":"CreateRenderer","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Phaser.Game instance on which the renderer will be set.","name":"game"}],"memberof":"Phaser.Core","longname":"Phaser.Core.CreateRenderer","scope":"static","___s":true},{"meta":{"range":[180,207],"filename":"DebugHeader.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DebugHeader.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Called automatically by Phaser.Game and responsible for creating the console.log debug header.\n\nYou can customize or disable the header via the Game Config object.","kind":"function","name":"DebugHeader","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Phaser.Game instance which will output this debug header.","name":"game"}],"memberof":"Phaser.Core","longname":"Phaser.Core.DebugHeader","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"Game.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"name":"AddToDOM","longname":"AddToDOM","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Game.js","lineno":41,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"classdesc":"The Phaser.Game instance is the main controller for the entire Phaser game. It is responsible\nfor handling the boot process, parsing the configuration values, creating the renderer,\nand setting-up all of the global Phaser systems, such as sound and input.\nOnce that is complete it will start the Scene Manager and then begin the main game loop.\n\nYou should generally avoid accessing any of the systems created by Game, and instead use those\nmade available to you via the Phaser.Scene Systems class instead.","kind":"class","name":"Game","memberof":"Phaser","fires":["Phaser.Core.Events#event:BLUR","Phaser.Core.Events#event:FOCUS","Phaser.Core.Events#event:HIDDEN","Phaser.Core.Events#event:VISIBLE"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Core.GameConfig"]},"optional":true,"description":"The configuration object for your Phaser Game instance.","name":"GameConfig"}],"scope":"static","longname":"Phaser.Game","___s":true},{"meta":{"filename":"Game.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The parsed Game Configuration object.\n\nThe values stored within this object are read-only and should not be changed at run-time.","name":"config","type":{"names":["Phaser.Core.Config"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A reference to either the Canvas or WebGL Renderer that this Game is using.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A reference to an HTML Div Element used as the DOM Element Container.\n\nOnly set if `createDOMContainer` is `true` in the game config (by default it is `false`) and\nif you provide a parent element to insert the Phaser Game inside.\n\nSee the DOM Element Game Object for more details.","name":"domContainer","type":{"names":["HTMLDivElement"]},"since":"3.17.0","memberof":"Phaser.Game","longname":"Phaser.Game#domContainer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A reference to the HTML Canvas Element that Phaser uses to render the game.\nThis is created automatically by Phaser unless you provide a `canvas` property\nin your Game Config.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A reference to the Rendering Context belonging to the Canvas Element this game is rendering to.\nIf the game is running under Canvas it will be a 2d Canvas Rendering Context.\nIf the game is running under WebGL it will be a WebGL Rendering Context.\nThis context is created automatically by Phaser unless you provide a `context` property\nin your Game Config.","name":"context","type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A flag indicating when this Game instance has finished its boot process.","name":"isBooted","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#isBooted","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A flag indicating if this Game is currently running its game step or not.","name":"isRunning","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An Event Emitter which is used to broadcast game-level events from the global systems.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Animation Manager.\n\nThe Animation Manager is a global system responsible for managing all animations used within your game.","name":"anims","type":{"names":["Phaser.Animations.AnimationManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#anims","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Texture Manager.\n\nThe Texture Manager is a global system responsible for managing all textures being used by your game.","name":"textures","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#textures","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Cache Manager.\n\nThe Cache Manager is a global system responsible for caching, accessing and releasing external game assets.","name":"cache","type":{"names":["Phaser.Cache.CacheManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#cache","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":189,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Data Manager","name":"registry","type":{"names":["Phaser.Data.DataManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#registry","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":198,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Input Manager.\n\nThe Input Manager is a global system responsible for the capture of browser-level input events.","name":"input","type":{"names":["Phaser.Input.InputManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#input","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":209,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Scene Manager.\n\nThe Scene Manager is a global system responsible for creating, modifying and updating the Scenes in your game.","name":"scene","type":{"names":["Phaser.Scenes.SceneManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A reference to the Device inspector.\n\nContains information about the device running this game, such as OS, browser vendor and feature support.\nUsed by various systems to determine capabilities and code paths.","name":"device","type":{"names":["Phaser.DeviceConf"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#device","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":232,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Scale Manager.\n\nThe Scale Manager is a global system responsible for handling scaling of the game canvas.","name":"scale","type":{"names":["Phaser.Scale.ScaleManager"]},"since":"3.16.0","memberof":"Phaser.Game","longname":"Phaser.Game#scale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":243,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the base Sound Manager.\n\nThe Sound Manager is a global system responsible for the playback and updating of all audio in your game.\n\nYou can disable the inclusion of the Sound Manager in your build by toggling the webpack `FEATURE_SOUND` flag.","name":"sound","type":{"names":["Phaser.Sound.NoAudioSoundManager","Phaser.Sound.HTML5AudioSoundManager","Phaser.Sound.WebAudioSoundManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#sound","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":261,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Time Step.\n\nThe Time Step is a global system responsible for setting-up and responding to the browser frame events, processing\nthem and calculating delta values. It then automatically calls the game step.","name":"loop","type":{"names":["Phaser.Core.TimeStep"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#loop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Plugin Manager.\n\nThe Plugin Manager is a global system that allows plugins to register themselves with it, and can then install\nthose plugins into Scenes as required.","name":"plugins","type":{"names":["Phaser.Plugins.PluginManager"]},"since":"3.0.0","memberof":"Phaser.Game","longname":"Phaser.Game#plugins","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":287,"columnno":12,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An instance of the Facebook Instant Games Plugin.\n\nThis will only be available if the plugin has been built into Phaser,\nor you're using the special Facebook Instant Games custom build.","name":"facebook","type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"since":"3.13.0","memberof":"Phaser.Game","longname":"Phaser.Game#facebook","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":331,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Does the window the game is running in currently have focus or not?\nThis is modified by the VisibilityHandler.","name":"hasFocus","type":{"names":["boolean"]},"readonly":true,"since":"3.9.0","memberof":"Phaser.Game","longname":"Phaser.Game#hasFocus","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Game.js","lineno":437,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The main Game Step. Called automatically by the Time Step, once per browser frame (typically as a result of\nRequest Animation Frame, or Set Timeout on very old browsers.)\n\nThe step will update the global managers first, then proceed to update each Scene in turn, via the Scene Manager.\n\nIt will then render each Scene in turn, via the Renderer. This process emits `prerender` and `postrender` events.","kind":"function","name":"step","fires":["Phaser.Core.Events#event:PRE_STEP_EVENT","Phaser.Core.Events#event:STEP_EVENT","Phaser.Core.Events#event:POST_STEP_EVENT","Phaser.Core.Events#event:PRE_RENDER_EVENT","Phaser.Core.Events#event:POST_RENDER_EVENT"],"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Game","longname":"Phaser.Game#step","scope":"instance","___s":true},{"meta":{"filename":"Game.js","lineno":502,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A special version of the Game Step for the HEADLESS renderer only.\n\nThe main Game Step. Called automatically by the Time Step, once per browser frame (typically as a result of\nRequest Animation Frame, or Set Timeout on very old browsers.)\n\nThe step will update the global managers first, then proceed to update each Scene in turn, via the Scene Manager.\n\nThis process emits `prerender` and `postrender` events, even though nothing actually displays.","kind":"function","name":"headlessStep","fires":["Phaser.Game#event:prerenderEvent","Phaser.Game#event:postrenderEvent"],"since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Game","longname":"Phaser.Game#headlessStep","scope":"instance","___s":true},{"meta":{"filename":"Game.js","lineno":610,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Returns the current game frame.\n\nWhen the game starts running, the frame is incremented every time Request Animation Frame, or Set Timeout, fires.","kind":"function","name":"getFrame","since":"3.16.0","returns":[{"type":{"names":["number"]},"description":"The current game frame."}],"memberof":"Phaser.Game","longname":"Phaser.Game#getFrame","scope":"instance","___s":true},{"meta":{"filename":"Game.js","lineno":625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Returns the time that the current game step started at, as based on `performance.now`.","kind":"function","name":"getTime","since":"3.16.0","returns":[{"type":{"names":["number"]},"description":"The current game timestamp."}],"memberof":"Phaser.Game","longname":"Phaser.Game#getTime","scope":"instance","___s":true},{"meta":{"filename":"Game.js","lineno":638,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Flags this Game instance as needing to be destroyed on the _next frame_, making this an asynchronous operation.\n\nIt will wait until the current frame has completed and then call `runDestroy` internally.\n\nIf you need to react to the games eventual destruction, listen for the `DESTROY` event.\n\nIf you **do not** need to run Phaser again on the same web page you can set the `noReturn` argument to `true` and it will free-up\nmemory being held by the core Phaser plugins. If you do need to create another game instance on the same page, leave this as `false`.","kind":"function","name":"destroy","fires":["Phaser.Core.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if you would like the parent canvas element removed from the DOM, or `false` to leave it in place.","name":"removeCanvas"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` all the core Phaser plugins are destroyed. You cannot create another instance of Phaser on the same web page if you do this.","name":"noReturn"}],"memberof":"Phaser.Game","longname":"Phaser.Game#destroy","scope":"instance","___s":true},{"meta":{"range":[180,213],"filename":"TimeStep.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TimeStep.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"classdesc":"The core runner class that Phaser uses to handle the game loop. It can use either Request Animation Frame,\nor SetTimeout, based on browser support and config settings, to create a continuous loop within the browser.\n\nEach time the loop fires, `TimeStep.step` is called and this is then passed onto the core Game update loop,\nit is the core heartbeat of your game. It will fire as often as Request Animation Frame is capable of handling\non the target device.\n\nNote that there are lots of situations where a browser will stop updating your game. Such as if the player\nswitches tabs, or covers up the browser window with another application. In these cases, the 'heartbeat'\nof your game will pause, and only resume when focus is returned to it by the player. There is no way to avoid\nthis situation, all you can do is use the visibility events the browser, and Phaser, provide to detect when\nit has happened and then gracefully recover.","kind":"class","name":"TimeStep","memberof":"Phaser.Core","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"A reference to the Phaser.Game instance that owns this Time Step.","name":"game"},{"type":{"names":["Phaser.Types.Core.FPSConfig"]},"name":"config"}],"scope":"static","longname":"Phaser.Core.TimeStep","___s":true},{"meta":{"filename":"TimeStep.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A reference to the Phaser.Game instance.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The Request Animation Frame DOM Event handler.","name":"raf","type":{"names":["Phaser.DOM.RequestAnimationFrame"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#raf","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":63,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A flag that is set once the TimeStep has started running and toggled when it stops.","name":"started","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#started","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A flag that is set once the TimeStep has started running and toggled when it stops.\nThe difference between this value and `started` is that `running` is toggled when\nthe TimeStep is sent to sleep, where-as `started` remains `true`, only changing if\nthe TimeStep is actually stopped, not just paused.","name":"running","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#running","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The minimum fps rate you want the Time Step to run at.","name":"minFps","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#minFps","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The target fps rate for the Time Step to run at.\n\nSetting this value will not actually change the speed at which the browser runs, that is beyond\nthe control of Phaser. Instead, it allows you to determine performance issues and if the Time Step\nis spiraling out of control.","name":"targetFps","type":{"names":["integer"]},"defaultvalue":"60","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#targetFps","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"An exponential moving average of the frames per second.","name":"actualFps","type":{"names":["integer"]},"readonly":true,"defaultvalue":"60","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#actualFps","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":145,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The time at which the next fps rate update will take place.\nWhen an fps update happens, the `framesThisSecond` value is reset.","name":"nextFpsUpdate","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#nextFpsUpdate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The number of frames processed this second.","name":"framesThisSecond","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#framesThisSecond","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"A callback to be invoked each time the Time Step steps.","name":"callback","type":{"names":["Phaser.Types.Core.TimeStepCallback"]},"defaultvalue":"NOOP","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#callback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"You can force the Time Step to use Set Timeout instead of Request Animation Frame by setting\nthe `forceSetTimeOut` property to `true` in the Game Configuration object. It cannot be changed at run-time.","name":"forceSetTimeOut","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#forceSetTimeOut","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":190,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The time, calculated at the start of the current step, as smoothed by the delta value.","name":"time","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#time","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":200,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The time at which the game started running. This value is adjusted if the game is then\npaused and resumes.","name":"startTime","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#startTime","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The time, as returned by `performance.now` of the previous step.","name":"lastTime","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#lastTime","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":221,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The current frame the game is on. This counter is incremented once every game step, regardless of how much\ntime has passed and is unaffected by delta smoothing.","name":"frame","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":233,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Is the browser currently considered in focus by the Page Visibility API?\nThis value is set in the `blur` method, which is called automatically by the Game instance.","name":"inFocus","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#inFocus","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":267,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The delta time, in ms, since the last game step. This is a clamped and smoothed average value.","name":"delta","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#delta","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":277,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Internal index of the delta history position.","name":"deltaIndex","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#deltaIndex","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":287,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Internal array holding the previous delta values, used for delta smoothing.","name":"deltaHistory","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#deltaHistory","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":296,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The maximum number of delta values that are retained in order to calculate a smoothed moving average.\n\nThis can be changed in the Game Config via the `fps.deltaHistory` property. The default is 10.","name":"deltaSmoothingMax","type":{"names":["integer"]},"defaultvalue":"10","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#deltaSmoothingMax","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":308,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The number of frames that the cooldown is set to after the browser panics over the FPS rate, usually\nas a result of switching tabs and regaining focus.\n\nThis can be changed in the Game Config via the `fps.panicMax` property. The default is 120.","name":"panicMax","type":{"names":["integer"]},"defaultvalue":"120","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#panicMax","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":321,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The actual elapsed time in ms between one update and the next.\n\nUnlike with `delta`, no smoothing, capping, or averaging is applied to this value.\nSo please be careful when using this value in math calculations.","name":"rawDelta","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#rawDelta","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":334,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The time, as returned by `performance.now` at the very start of the current step.\nThis can differ from the `time` value in that it isn't calculated based on the delta value.","name":"now","type":{"names":["number"]},"defaultvalue":"0","since":"3.18.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#now","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":345,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Apply smoothing to the delta value used within Phasers internal calculations?\n\nThis can be changed in the Game Config via the `fps.smoothStep` property. The default is `true`.\n\nSmoothing helps settle down the delta values after browser tab switches, or other situations\nwhich could cause significant delta spikes or dips. By default it has been enabled in Phaser 3\nsince the first version, but is now exposed under this property (and the corresponding game config\n`smoothStep` value), to allow you to easily disable it, should you require.","name":"smoothStep","type":{"names":["boolean"]},"since":"3.22.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#smoothStep","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimeStep.js","lineno":362,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Called by the Game instance when the DOM window.onBlur event triggers.","kind":"function","name":"blur","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#blur","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Called by the Game instance when the DOM window.onFocus event triggers.","kind":"function","name":"focus","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#focus","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":386,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Called when the visibility API says the game is 'hidden' (tab switch out of view, etc)","kind":"function","name":"pause","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#pause","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":397,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Called when the visibility API says the game is 'visible' again (tab switch back into view, etc)","kind":"function","name":"resume","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#resume","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Resets the time, lastTime, fps averages and delta history.\nCalled automatically when a browser sleeps them resumes.","kind":"function","name":"resetDelta","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#resetDelta","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":439,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Starts the Time Step running, if it is not already doing so.\nCalled automatically by the Game Boot process.","kind":"function","name":"start","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Core.TimeStepCallback"]},"description":"The callback to be invoked each time the Time Step steps.","name":"callback"}],"memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#start","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The main step method. This is called each time the browser updates, either by Request Animation Frame,\nor by Set Timeout. It is responsible for calculating the delta values, frame totals, cool down history and more.\nYou generally should never call this method directly.","kind":"function","name":"step","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#step","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":607,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Manually calls `TimeStep.step`.","kind":"function","name":"tick","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#tick","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":618,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Sends the TimeStep to sleep, stopping Request Animation Frame (or SetTimeout) and toggling the `running` flag to false.","kind":"function","name":"sleep","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#sleep","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":634,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Wakes-up the TimeStep, restarting Request Animation Frame (or SetTimeout) and toggling the `running` flag to true.\nThe `seamless` argument controls if the wake-up should adjust the start time or not.","kind":"function","name":"wake","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Adjust the startTime based on the lastTime values.","name":"seamless"}],"memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#wake","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":661,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Gets the duration which the game has been running, in seconds.","kind":"function","name":"getDuration","since":"3.17.0","returns":[{"type":{"names":["number"]},"description":"The duration in seconds."}],"memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#getDuration","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":674,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Gets the duration which the game has been running, in ms.","kind":"function","name":"getDurationMS","since":"3.17.0","returns":[{"type":{"names":["number"]},"description":"The duration in ms."}],"memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#getDurationMS","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":687,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Stops the TimeStep running.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["Phaser.Core.TimeStep"]},"description":"The TimeStep object."}],"memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#stop","scope":"instance","___s":true},{"meta":{"filename":"TimeStep.js","lineno":705,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"Destroys the TimeStep. This will stop Request Animation Frame, stop the step, clear the callbacks and null\nany objects.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Core.TimeStep","longname":"Phaser.Core.TimeStep#destroy","scope":"instance","___s":true},{"meta":{"range":[180,208],"filename":"VisibilityHandler.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"name":"Events","longname":"Events","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"VisibilityHandler.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"description":"The Visibility Handler is responsible for listening out for document level visibility change events.\nThis includes `visibilitychange` if the browser supports it, and blur and focus events. It then uses\nthe provided Event Emitter and fires the related events.","kind":"function","name":"VisibilityHandler","fires":["Phaser.Core.Events#event:BLUR","Phaser.Core.Events#event:FOCUS","Phaser.Core.Events#event:HIDDEN","Phaser.Core.Events#event:VISIBLE"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Game instance this Visibility Handler is working on.","name":"game"}],"memberof":"Phaser.Core","longname":"Phaser.Core.VisibilityHandler","scope":"static","___s":true},{"meta":{"filename":"BLUR_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Blur Event.\n\nThis event is dispatched by the Game Visibility Handler when the window in which the Game instance is embedded\nenters a blurred state. The blur event is raised when the window loses focus. This can happen if a user swaps\ntab, or if they simply remove focus from the browser to another app.","kind":"event","name":"BLUR","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:BLUR","scope":"instance","___s":true},{"meta":{"filename":"BOOT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Boot Event.\n\nThis event is dispatched when the Phaser Game instance has finished booting, but before it is ready to start running.\nThe global systems use this event to know when to set themselves up, dispatching their own `ready` events as required.","kind":"event","name":"BOOT","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:BOOT","scope":"instance","___s":true},{"meta":{"filename":"CONTEXT_LOST_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Context Lost Event.\n\nThis event is dispatched by the Game if the WebGL Renderer it is using encounters a WebGL Context Lost event from the browser.\n\nThe partner event is `CONTEXT_RESTORED`.","kind":"event","name":"CONTEXT_LOST","since":"3.19.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:CONTEXT_LOST","scope":"instance","___s":true},{"meta":{"filename":"CONTEXT_RESTORED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Context Restored Event.\n\nThis event is dispatched by the Game if the WebGL Renderer it is using encounters a WebGL Context Restored event from the browser.\n\nThe partner event is `CONTEXT_LOST`.","kind":"event","name":"CONTEXT_RESTORED","since":"3.19.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:CONTEXT_RESTORED","scope":"instance","___s":true},{"meta":{"filename":"DESTROY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Destroy Event.\n\nThis event is dispatched when the game instance has been told to destroy itself.\nLots of internal systems listen to this event in order to clear themselves out.\nCustom plugins and game code should also do the same.","kind":"event","name":"DESTROY","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:DESTROY","scope":"instance","___s":true},{"meta":{"filename":"FOCUS_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Focus Event.\n\nThis event is dispatched by the Game Visibility Handler when the window in which the Game instance is embedded\nenters a focused state. The focus event is raised when the window re-gains focus, having previously lost it.","kind":"event","name":"FOCUS","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:FOCUS","scope":"instance","___s":true},{"meta":{"filename":"HIDDEN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Hidden Event.\n\nThis event is dispatched by the Game Visibility Handler when the document in which the Game instance is embedded\nenters a hidden state. Only browsers that support the Visibility API will cause this event to be emitted.\n\nIn most modern browsers, when the document enters a hidden state, the Request Animation Frame and setTimeout, which\ncontrol the main game loop, will automatically pause. There is no way to stop this from happening. It is something\nyour game should account for in its own code, should the pause be an issue (i.e. for multiplayer games)","kind":"event","name":"HIDDEN","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:HIDDEN","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Pause Event.\n\nThis event is dispatched when the Game loop enters a paused state, usually as a result of the Visibility Handler.","kind":"event","name":"PAUSE","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:PAUSE","scope":"instance","___s":true},{"meta":{"filename":"POST_RENDER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Post-Render Event.\n\nThis event is dispatched right at the end of the render process.\n\nEvery Scene will have rendered and been drawn to the canvas by the time this event is fired.\nUse it for any last minute post-processing before the next game step begins.","kind":"event","name":"POST_RENDER","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"A reference to the current renderer being used by the Game instance.","name":"renderer"}],"memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:POST_RENDER","scope":"instance","___s":true},{"meta":{"filename":"POST_STEP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Post-Step Event.\n\nThis event is dispatched after the Scene Manager has updated.\nHook into it from plugins or systems that need to do things before the render starts.","kind":"event","name":"POST_STEP","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:POST_STEP","scope":"instance","___s":true},{"meta":{"filename":"PRE_RENDER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Pre-Render Event.\n\nThis event is dispatched immediately before any of the Scenes have started to render.\n\nThe renderer will already have been initialized this frame, clearing itself and preparing to receive the Scenes for rendering, but it won't have actually drawn anything yet.","kind":"event","name":"PRE_RENDER","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"A reference to the current renderer being used by the Game instance.","name":"renderer"}],"memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:PRE_RENDER","scope":"instance","___s":true},{"meta":{"filename":"PRE_STEP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Pre-Step Event.\n\nThis event is dispatched before the main Game Step starts. By this point in the game cycle none of the Scene updates have yet happened.\nHook into it from plugins or systems that need to update before the Scene Manager does.","kind":"event","name":"PRE_STEP","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:PRE_STEP","scope":"instance","___s":true},{"meta":{"filename":"READY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Ready Event.\n\nThis event is dispatched when the Phaser Game instance has finished booting, the Texture Manager is fully ready,\nand all local systems are now able to start.","kind":"event","name":"READY","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:READY","scope":"instance","___s":true},{"meta":{"filename":"RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Resume Event.\n\nThis event is dispatched when the game loop leaves a paused state and resumes running.","kind":"event","name":"RESUME","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:RESUME","scope":"instance","___s":true},{"meta":{"filename":"STEP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Step Event.\n\nThis event is dispatched after the Game Pre-Step and before the Scene Manager steps.\nHook into it from plugins or systems that need to update before the Scene Manager does, but after the core Systems have.","kind":"event","name":"STEP","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:STEP","scope":"instance","___s":true},{"meta":{"filename":"VISIBLE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"description":"The Game Visible Event.\n\nThis event is dispatched by the Game Visibility Handler when the document in which the Game instance is embedded\nenters a visible state, previously having been hidden.\n\nOnly browsers that support the Visibility API will cause this event to be emitted.","kind":"event","name":"VISIBLE","since":"3.0.0","memberof":"Phaser.Core.Events","longname":"Phaser.Core.Events#event:VISIBLE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Core","longname":"Phaser.Core.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core"},"kind":"namespace","name":"Core","memberof":"Phaser","longname":"Phaser.Core","scope":"static","___s":true},{"meta":{"filename":"AudioConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"description":"Config object containing various sound settings.","kind":"typedef","name":"AudioConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use HTML5 Audio instead of Web Audio.","name":"disableWebAudio"},{"type":{"names":["AudioContext"]},"optional":true,"description":"An existing Web Audio context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Disable all audio output.","name":"noAudio"}],"see":["Phaser.Sound.SoundManagerCreator"],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.AudioConfig","scope":"static","___s":true},{"meta":{"filename":"BannerConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"BannerConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Omit Phaser's name and version from the banner.","name":"hidePhaser"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#ffffff'","description":"The color of the banner text.","name":"text"},{"type":{"names":["Array."]},"optional":true,"description":"The background colors of the banner.","name":"background"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.BannerConfig","scope":"static","___s":true},{"meta":{"filename":"BootCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"BootCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The game.","name":"game"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.BootCallback","scope":"static","___s":true},{"meta":{"filename":"CallbacksConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"CallbacksConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.Core.BootCallback"]},"optional":true,"defaultvalue":"Phaser.Types.Core.NOOP","description":"A function to run at the start of the boot sequence.","name":"preBoot"},{"type":{"names":["Phaser.Types.Core.BootCallback"]},"optional":true,"defaultvalue":"Phaser.Types.Core.NOOP","description":"A function to run at the end of the boot sequence. At this point, all the game systems have started and plugins have been loaded.","name":"postBoot"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.CallbacksConfig","scope":"static","___s":true},{"meta":{"filename":"DOMContainerConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"DOMContainerConfig","type":{"names":["object"]},"since":"3.12.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the game create a div element to act as a DOM Container? Only enable if you're using DOM Element objects. You must provide a parent object if you use this feature.","name":"createContainer"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the DOM Container that is created (if `dom.createContainer` is true) be positioned behind (true) or over the top (false, the default) of the game canvas?","name":"behindCanvas"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.DOMContainerConfig","scope":"static","___s":true},{"meta":{"filename":"FPSConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"FPSConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":5,"description":"The minimum acceptable rendering rate, in frames per second.","name":"min"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":60,"description":"The optimum rendering rate, in frames per second.","name":"target"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use setTimeout instead of requestAnimationFrame to run the game loop.","name":"forceSetTimeOut"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"Calculate the average frame delta from this many consecutive frame intervals.","name":"deltaHistory"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":120,"description":"The amount of frames the time step counts before we trust the delta values again.","name":"panicMax"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Apply delta smoothing during the game update to help avoid spikes?","name":"smoothStep"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.FPSConfig","scope":"static","___s":true},{"meta":{"filename":"GameConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"GameConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["integer","string"]},"optional":true,"defaultvalue":1024,"description":"The width of the game, in game pixels.","name":"width"},{"type":{"names":["integer","string"]},"optional":true,"defaultvalue":768,"description":"The height of the game, in game pixels.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Simple scale applied to the game canvas. 2 is double size, 0.5 is half size, etc.","name":"zoom"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The size of each game pixel, in canvas pixels. Values larger than 1 are \"high\" resolution.","name":"resolution"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"CONST.AUTO","description":"Which renderer to use. Phaser.AUTO, Phaser.CANVAS, Phaser.HEADLESS, or Phaser.WEBGL. AUTO picks WEBGL if available, otherwise CANVAS.","name":"type"},{"type":{"names":["HTMLElement","string"]},"optional":true,"defaultvalue":null,"description":"The DOM element that will contain the game canvas, or its `id`. If undefined or if the named element doesn't exist, the game canvas is inserted directly into the document body. If `null` no parent will be used and you are responsible for adding the canvas to your environment.","name":"parent"},{"type":{"names":["HTMLCanvasElement"]},"optional":true,"defaultvalue":null,"description":"Provide your own Canvas element for Phaser to use instead of creating one.","name":"canvas"},{"type":{"names":["string"]},"optional":true,"defaultvalue":null,"description":"CSS styles to apply to the game canvas instead of Phasers default styles.","name":"canvasStyle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is Phaser running under a custom (non-native web) environment? If so, set this to `true` to skip internal Feature detection. If `true` the `renderType` cannot be left as `AUTO`.","name":"customEnvironment"},{"type":{"names":["CanvasRenderingContext2D"]},"optional":true,"description":"Provide your own Canvas Context for Phaser to use, instead of creating one.","name":"context"},{"type":{"names":["Phaser.Scene","Array.","Phaser.Types.Scenes.SettingsConfig","Array.","Phaser.Types.Scenes.CreateSceneFromObjectConfig","Array.","function","Array."]},"optional":true,"defaultvalue":null,"description":"A scene or scenes to add to the game. If several are given, the first is started; the remainder are started only if they have `{ active: true }`. See the `sceneConfig` argument in `Phaser.Scenes.SceneManager#add`.","name":"scene"},{"type":{"names":["Array."]},"optional":true,"description":"Seed for the random number generator.","name":"seed"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The title of the game. Shown in the browser console.","name":"title"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'http://phaser.io'","description":"The URL of the game. Shown in the browser console.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The version of the game. Shown in the browser console.","name":"version"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Automatically call window.focus() when the game boots. Usually necessary to capture input events if the game is in a separate frame.","name":"autoFocus"},{"type":{"names":["boolean","Phaser.Types.Core.InputConfig"]},"optional":true,"description":"Input configuration, or `false` to disable all game input.","name":"input"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Disable the browser's default 'contextmenu' event (usually triggered by a right-button mouse click).","name":"disableContextMenu"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the game canvas will have a transparent background.","name":"transparent"},{"type":{"names":["boolean","Phaser.Types.Core.BannerConfig"]},"optional":true,"defaultvalue":false,"description":"Configuration for the banner printed in the browser console when the game starts.","name":"banner"},{"type":{"names":["Phaser.Types.Core.DOMContainerConfig"]},"optional":true,"description":"The DOM Container configuration object.","name":"dom"},{"type":{"names":["Phaser.Types.Core.FPSConfig"]},"optional":true,"description":"Game loop configuration.","name":"fps"},{"type":{"names":["Phaser.Types.Core.RenderConfig"]},"optional":true,"description":"Game renderer configuration.","name":"render"},{"type":{"names":["string","number"]},"optional":true,"defaultvalue":"0x000000","description":"The background color of the game canvas. The default is black.","name":"backgroundColor"},{"type":{"names":["Phaser.Types.Core.CallbacksConfig"]},"optional":true,"description":"Optional callbacks to run before or after game boot.","name":"callbacks"},{"type":{"names":["Phaser.Types.Core.LoaderConfig"]},"optional":true,"description":"Loader configuration.","name":"loader"},{"type":{"names":["Phaser.Types.Core.ImagesConfig"]},"optional":true,"description":"Images configuration.","name":"images"},{"type":{"names":["Phaser.Types.Core.PhysicsConfig"]},"optional":true,"description":"Physics configuration.","name":"physics"},{"type":{"names":["Phaser.Types.Core.PluginObject","Array."]},"optional":true,"description":"Plugins to install.","name":"plugins"},{"type":{"names":["Phaser.Types.Core.ScaleConfig"]},"optional":true,"description":"The Scale Manager configuration.","name":"scale"},{"type":{"names":["Phaser.Types.Core.AudioConfig"]},"optional":true,"description":"The Audio Configuration object.","name":"audio"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.GameConfig","scope":"static","___s":true},{"meta":{"filename":"GamepadInputConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"GamepadInputConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["*"]},"optional":true,"defaultvalue":"window","description":"Where the Gamepad Manager listens for gamepad input events.","name":"target"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.GamepadInputConfig","scope":"static","___s":true},{"meta":{"filename":"ImagesConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"ImagesConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"URL to use for the 'default' texture.","name":"default"},{"type":{"names":["string"]},"optional":true,"description":"URL to use for the 'missing' texture.","name":"missing"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.ImagesConfig","scope":"static","___s":true},{"meta":{"filename":"InputConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"InputConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean","Phaser.Types.Core.KeyboardInputConfig"]},"optional":true,"defaultvalue":true,"description":"Keyboard input configuration. `true` uses the default configuration and `false` disables keyboard input.","name":"keyboard"},{"type":{"names":["boolean","Phaser.Types.Core.MouseInputConfig"]},"optional":true,"defaultvalue":true,"description":"Mouse input configuration. `true` uses the default configuration and `false` disables mouse input.","name":"mouse"},{"type":{"names":["boolean","Phaser.Types.Core.TouchInputConfig"]},"optional":true,"defaultvalue":true,"description":"Touch input configuration. `true` uses the default configuration and `false` disables touch input.","name":"touch"},{"type":{"names":["boolean","Phaser.Types.Core.GamepadInputConfig"]},"optional":true,"defaultvalue":false,"description":"Gamepad input configuration. `true` enables gamepad input.","name":"gamepad"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The maximum number of touch pointers. See {@link Phaser.Input.InputManager#pointers}.","name":"activePointers"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The smoothing factor to apply during Pointer movement. See {@link Phaser.Input.Pointer#smoothFactor}.","name":"smoothFactor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should Phaser listen for input events on the Window? If you disable this, events like 'POINTER_UP_OUTSIDE' will no longer fire.","name":"windowEvents"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.InputConfig","scope":"static","___s":true},{"meta":{"filename":"KeyboardInputConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"KeyboardInputConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["*"]},"optional":true,"defaultvalue":"window","description":"Where the Keyboard Manager listens for keyboard input events.","name":"target"},{"type":{"names":["Array."]},"optional":true,"nullable":true,"description":"`preventDefault` will be called on every non-modified key which has a key code in this array. By default it is empty.","name":"capture"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.KeyboardInputConfig","scope":"static","___s":true},{"meta":{"filename":"LoaderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"LoaderConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"A URL used to resolve paths given to the loader. Example: 'http://labs.phaser.io/assets/'.","name":"baseURL"},{"type":{"names":["string"]},"optional":true,"description":"A URL path used to resolve relative paths given to the loader. Example: 'images/sprites/'.","name":"path"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The maximum number of resources the loader will start loading at once.","name":"maxParallelDownloads"},{"type":{"names":["string","undefined"]},"optional":true,"description":"'anonymous', 'use-credentials', or `undefined`. If you're not making cross-origin requests, leave this as `undefined`. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes}.","name":"crossOrigin"},{"type":{"names":["string"]},"optional":true,"description":"The response type of the XHR request, e.g. `blob`, `text`, etc.","name":"responseType"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the XHR request use async or not?","name":"async"},{"type":{"names":["string"]},"optional":true,"description":"Optional username for all XHR requests.","name":"user"},{"type":{"names":["string"]},"optional":true,"description":"Optional password for all XHR requests.","name":"password"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optional XHR timeout value, in ms.","name":"timeout"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.LoaderConfig","scope":"static","___s":true},{"meta":{"filename":"MouseInputConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"MouseInputConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["*"]},"optional":true,"defaultvalue":null,"description":"Where the Mouse Manager listens for mouse input events. The default is the game canvas.","name":"target"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether mouse input events have `preventDefault` called on them.","name":"capture"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.MouseInputConfig","scope":"static","___s":true},{"meta":{"filename":"NOOP.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"description":"This callback type is completely empty, a no-operation.","kind":"typedef","name":"NOOP","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.NOOP","scope":"static","___s":true},{"meta":{"filename":"PhysicsConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"PhysicsConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"The default physics system. It will be started for each scene. Phaser provides 'arcade', 'impact', and 'matter'.","name":"default"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeWorldConfig"]},"optional":true,"description":"Arcade Physics configuration.","name":"arcade"},{"type":{"names":["Phaser.Types.Physics.Impact.WorldConfig"]},"optional":true,"description":"Impact Physics configuration.","name":"impact"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterWorldConfig"]},"optional":true,"description":"Matter Physics configuration.","name":"matter"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.PhysicsConfig","scope":"static","___s":true},{"meta":{"filename":"PluginObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"PluginObject","type":{"names":["object"]},"since":"3.8.0","properties":[{"type":{"names":["Array."]},"optional":true,"nullable":true,"description":"Global plugins to install.","name":"global"},{"type":{"names":["Array."]},"optional":true,"nullable":true,"description":"Scene plugins to install.","name":"scene"},{"type":{"names":["Array."]},"optional":true,"description":"The default set of scene plugins (names).","name":"default"},{"type":{"names":["Array."]},"optional":true,"description":"Plugins to *add* to the default set of scene plugins.","name":"defaultMerge"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.PluginObject","scope":"static","___s":true},{"meta":{"filename":"PluginObjectItem.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"PluginObjectItem","type":{"names":["object"]},"since":"3.8.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"A key to identify the plugin in the Plugin Manager.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The plugin itself. Usually a class/constructor.","name":"plugin"},{"type":{"names":["boolean"]},"optional":true,"description":"Whether the plugin should be started automatically.","name":"start"},{"type":{"names":["string"]},"optional":true,"description":"For a scene plugin, add the plugin to the scene's systems object under this key (`this.sys.KEY`, from the scene).","name":"systemKey"},{"type":{"names":["string"]},"optional":true,"description":"For a scene plugin, add the plugin to the scene object under this key (`this.KEY`, from the scene).","name":"sceneKey"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Scene Systems, this is the property key map used.","name":"mapping"},{"type":{"names":["*"]},"optional":true,"description":"Arbitrary data passed to the plugin's init() method.","name":"data"}],"examples":["// Global plugin\n{ key: 'BankPlugin', plugin: BankPluginV3, start: true, data: { gold: 5000 } }","// Scene plugin\n{ key: 'WireFramePlugin', plugin: WireFramePlugin, systemKey: 'wireFramePlugin', sceneKey: 'wireframe' }"],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.PluginObjectItem","scope":"static","___s":true},{"meta":{"filename":"RenderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"RenderConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"When set to `true`, WebGL uses linear interpolation to draw scaled or rotated textures, giving a smooth appearance. When set to `false`, WebGL uses nearest-neighbor interpolation, giving a crisper appearance. `false` also disables antialiasing of the game canvas itself, if the browser supports it, when the game canvas is scaled.","name":"antialias"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets the `antialias` property when the WebGL context is created. Setting this value does not impact any subsequent textures that are created, or the canvas style attributes.","name":"antialiasGL"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When set to `true` it will create a desynchronized context for both 2D and WebGL. See https://developers.google.com/web/updates/2019/05/desynchronized for details.","name":"desynchronized"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets `antialias` and `roundPixels` to true. This is the best setting for pixel-art games.","name":"pixelArt"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Draw texture-based Game Objects at only whole-integer positions. Game Objects without textures, like Graphics, ignore this property.","name":"roundPixels"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the game canvas will be transparent. Boolean that indicates if the canvas contains an alpha channel. If set to false, the browser now knows that the backdrop is always opaque, which can speed up drawing of transparent content and images.","name":"transparent"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether the game canvas will be cleared between each rendering frame.","name":"clearBeforeRender"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"In WebGL mode, the drawing buffer contains colors with pre-multiplied alpha.","name":"premultipliedAlpha"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Let the browser abort creating a WebGL context if it judges performance would be unacceptable.","name":"failIfMajorPerformanceCaveat"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'default'","description":"\"high-performance\", \"low-power\" or \"default\". A hint to the browser on how much device power the game might use.","name":"powerPreference"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":2000,"description":"The default WebGL batch size.","name":"batchSize"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The maximum number of lights allowed to be visible within range of a single Camera in the LightManager.","name":"maxLights"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'LINEAR'","description":"The mipmap magFilter to be used when creating WebGL textures.","name":"mipmapFilter"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.RenderConfig","scope":"static","___s":true},{"meta":{"filename":"ScaleConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"ScaleConfig","type":{"names":["object"]},"since":"3.16.0","properties":[{"type":{"names":["integer","string"]},"optional":true,"defaultvalue":1024,"description":"The base width of your game. Can be an integer or a string: '100%'. If a string it will only work if you have set a parent element that has a size.","name":"width"},{"type":{"names":["integer","string"]},"optional":true,"defaultvalue":768,"description":"The base height of your game. Can be an integer or a string: '100%'. If a string it will only work if you have set a parent element that has a size.","name":"height"},{"type":{"names":["Phaser.Scale.ZoomType","integer"]},"optional":true,"defaultvalue":1,"description":"The zoom value of the game canvas.","name":"zoom"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The rendering resolution of the canvas. This is reserved for future use and is currently ignored.","name":"resolution"},{"type":{"names":["HTMLElement","string"]},"optional":true,"nullable":true,"description":"The DOM element that will contain the game canvas, or its `id`. If undefined, or if the named element doesn't exist, the game canvas is inserted directly into the document body. If `null` no parent will be used and you are responsible for adding the canvas to your environment.","name":"parent"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Is the Scale Manager allowed to adjust the CSS height property of the parent and/or document body to be 100%?","name":"expandParent"},{"type":{"names":["Phaser.Scale.ScaleModeType"]},"optional":true,"defaultvalue":"Phaser.Scale.ScaleModes.NONE","description":"The scale mode.","name":"mode"},{"type":{"names":["WidthHeight"]},"optional":true,"description":"The minimum width and height the canvas can be scaled down to.","name":"min"},{"type":{"names":["WidthHeight"]},"optional":true,"description":"The maximum width the canvas can be scaled up to.","name":"max"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Automatically round the display and style sizes of the canvas. This can help with performance in lower-powered devices.","name":"autoRound"},{"type":{"names":["Phaser.Scale.CenterType"]},"optional":true,"defaultvalue":"Phaser.Scale.Center.NO_CENTER","description":"Automatically center the canvas within the parent?","name":"autoCenter"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":500,"description":"How many ms should elapse before checking if the browser size has changed?","name":"resizeInterval"},{"type":{"names":["HTMLElement","string"]},"optional":true,"nullable":true,"description":"The DOM element that will be sent into full screen mode, or its `id`. If undefined Phaser will create its own div and insert the canvas into it when entering fullscreen mode.","name":"fullscreenTarget"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.ScaleConfig","scope":"static","___s":true},{"meta":{"filename":"TimeStepCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"TimeStepCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The Delta Average.","name":"average"},{"type":{"names":["number"]},"description":"Interpolation - how far between what is expected and where we are?","name":"interpolation"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.TimeStepCallback","scope":"static","___s":true},{"meta":{"filename":"TouchInputConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"TouchInputConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["*"]},"optional":true,"defaultvalue":null,"description":"Where the Touch Manager listens for touch input events. The default is the game canvas.","name":"target"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether touch input events have preventDefault() called on them.","name":"capture"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.TouchInputConfig","scope":"static","___s":true},{"meta":{"filename":"WidthHeight.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"typedef","name":"WidthHeight","type":{"names":["object"]},"since":"3.16.0","properties":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The width.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The height.","name":"height"}],"memberof":"Phaser.Types.Core","longname":"Phaser.Types.Core.WidthHeight","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/core/typedefs"},"kind":"namespace","name":"Core","memberof":"Phaser.Types","longname":"Phaser.Types.Core","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"GenerateTexture.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/create"},"name":"Arne16","longname":"Arne16","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GenerateTexture.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create"},"description":"[description]","kind":"function","name":"GenerateTexture","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Create.GenerateTextureConfig"]},"description":"[description]","name":"config"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"[description]"}],"memberof":"Phaser.Create","longname":"Phaser.Create.GenerateTexture","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create"},"kind":"namespace","name":"Create","memberof":"Phaser","longname":"Phaser.Create","scope":"static","___s":true},{"meta":{"filename":"Arne16.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/palettes"},"description":"A 16 color palette by [Arne](http://androidarts.com/palette/16pal.htm)","name":"ARNE16","since":"3.0.0","type":{"names":["Phaser.Types.Create.Palette"]},"memberof":"Phaser.Create.Palettes","longname":"Phaser.Create.Palettes.ARNE16","scope":"static","kind":"member","___s":true},{"meta":{"filename":"C64.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/palettes"},"description":"A 16 color palette inspired by the Commodore 64.","name":"C64","since":"3.0.0","type":{"names":["Phaser.Types.Create.Palette"]},"memberof":"Phaser.Create.Palettes","longname":"Phaser.Create.Palettes.C64","scope":"static","kind":"member","___s":true},{"meta":{"filename":"CGA.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/palettes"},"description":"A 16 color CGA inspired palette by [Arne](http://androidarts.com/palette/16pal.htm)","name":"CGA","since":"3.0.0","type":{"names":["Phaser.Types.Create.Palette"]},"memberof":"Phaser.Create.Palettes","longname":"Phaser.Create.Palettes.CGA","scope":"static","kind":"member","___s":true},{"meta":{"filename":"JMP.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/palettes"},"description":"A 16 color JMP palette by [Arne](http://androidarts.com/palette/16pal.htm)","name":"JMP","since":"3.0.0","type":{"names":["Phaser.Types.Create.Palette"]},"memberof":"Phaser.Create.Palettes","longname":"Phaser.Create.Palettes.JMP","scope":"static","kind":"member","___s":true},{"meta":{"filename":"MSX.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/palettes"},"description":"A 16 color palette inspired by Japanese computers like the MSX.","name":"MSX","since":"3.0.0","type":{"names":["Phaser.Types.Create.Palette"]},"memberof":"Phaser.Create.Palettes","longname":"Phaser.Create.Palettes.MSX","scope":"static","kind":"member","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/palettes"},"kind":"namespace","name":"Palettes","memberof":"Phaser.Create","longname":"Phaser.Create.Palettes","scope":"static","___s":true},{"meta":{"filename":"GenerateTextureConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/typedefs"},"kind":"typedef","name":"GenerateTextureCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"[description]","name":"canvas"},{"type":{"names":["CanvasRenderingContext2D"]},"description":"[description]","name":"context"}],"memberof":"Phaser.Types.Create","longname":"Phaser.Types.Create.GenerateTextureCallback","scope":"static","___s":true},{"meta":{"filename":"GenerateTextureConfig.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/typedefs"},"kind":"typedef","name":"GenerateTextureConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["array"]},"optional":true,"defaultvalue":"[]","description":"[description]","name":"data"},{"type":{"names":["HTMLCanvasElement"]},"optional":true,"defaultvalue":null,"description":"[description]","name":"canvas"},{"type":{"names":["Phaser.Types.Create.Palette"]},"optional":true,"defaultvalue":"Arne16","description":"[description]","name":"palette"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The width of each 'pixel' in the generated texture.","name":"pixelWidth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The height of each 'pixel' in the generated texture.","name":"pixelHeight"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"[description]","name":"resizeCanvas"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"[description]","name":"clearCanvas"},{"type":{"names":["Phaser.Types.Create.GenerateTextureCallback"]},"optional":true,"description":"[description]","name":"preRender"},{"type":{"names":["Phaser.Types.Create.GenerateTextureCallback"]},"optional":true,"description":"[description]","name":"postRender"}],"memberof":"Phaser.Types.Create","longname":"Phaser.Types.Create.GenerateTextureConfig","scope":"static","___s":true},{"meta":{"filename":"Palette.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/typedefs"},"kind":"typedef","name":"Palette","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"Color value 1.","name":"0"},{"type":{"names":["string"]},"description":"Color value 2.","name":"1"},{"type":{"names":["string"]},"description":"Color value 3.","name":"2"},{"type":{"names":["string"]},"description":"Color value 4.","name":"3"},{"type":{"names":["string"]},"description":"Color value 5.","name":"4"},{"type":{"names":["string"]},"description":"Color value 6.","name":"5"},{"type":{"names":["string"]},"description":"Color value 7.","name":"6"},{"type":{"names":["string"]},"description":"Color value 8.","name":"7"},{"type":{"names":["string"]},"description":"Color value 9.","name":"8"},{"type":{"names":["string"]},"description":"Color value 10.","name":"9"},{"type":{"names":["string"]},"description":"Color value 11.","name":"A"},{"type":{"names":["string"]},"description":"Color value 12.","name":"B"},{"type":{"names":["string"]},"description":"Color value 13.","name":"C"},{"type":{"names":["string"]},"description":"Color value 14.","name":"D"},{"type":{"names":["string"]},"description":"Color value 15.","name":"E"},{"type":{"names":["string"]},"description":"Color value 16.","name":"F"}],"memberof":"Phaser.Types.Create","longname":"Phaser.Types.Create.Palette","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/create/typedefs"},"kind":"namespace","name":"Create","memberof":"Phaser.Types","longname":"Phaser.Types.Create","scope":"static","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"classdesc":"A higher-order Bézier curve constructed of four points.","kind":"class","name":"CubicBezier","augments":["Phaser.Curves.Curve"],"memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Array."]},"description":"Start point, or an array of point pairs.","name":"p0"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"Control Point 1.","name":"p1"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"Control Point 2.","name":"p2"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"End Point.","name":"p3"}],"scope":"static","longname":"Phaser.Curves.CubicBezier","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The start point of this curve.","name":"p0","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#p0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The first control point of this curve.","name":"p1","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#p1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The second control point of this curve.","name":"p2","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#p2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The end point of this curve.","name":"p3","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#p3","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the starting point on the curve.","kind":"function","name":"getStartPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getStartPoint","scope":"instance","overrides":"Phaser.Curves.Curve#getStartPoint","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns the resolution of this curve.","kind":"function","name":"getResolution","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of divisions used by this curve.","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"The resolution of the curve."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getResolution","scope":"instance","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":118,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get point at relative position in curve according to length.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getPoint","scope":"instance","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":143,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Draws this curve to the specified graphics object.","kind":"function","name":"draw","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The graphics object this curve should be drawn to.","name":"graphics"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The number of intermediary points that make up this curve. A higher number of points will result in a smoother curve.","name":"pointsTotal"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The graphics object this curve was drawn to. Useful for method chaining."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#draw","scope":"instance","overrides":"Phaser.Curves.Curve#draw","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":176,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a JSON object that describes this curve.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#toJSON","scope":"instance","___s":true},{"meta":{"filename":"CubicBezierCurve.js","lineno":199,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Generates a curve from a JSON object.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Curves.CubicBezier"]},"description":"The curve generated from the JSON object."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier.fromJSON","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Curve.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Curve.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"classdesc":"A Base Curve class, which all other curve types extend.\n\nBased on the three.js Curve classes created by [zz85](http://www.lab4games.net/zz85/blog)","kind":"class","name":"Curve","memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The curve type.","name":"type"}],"scope":"static","longname":"Phaser.Curves.Curve","___s":true},{"meta":{"filename":"Curve.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"String based identifier for the type of curve.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The default number of divisions within the curve.","name":"defaultDivisions","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#defaultDivisions","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The quantity of arc length divisions within the curve.","name":"arcLengthDivisions","type":{"names":["integer"]},"defaultvalue":"100","since":"3.0.0","memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#arcLengthDivisions","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"An array of cached arc length values.","name":"cacheArcLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#cacheArcLengths","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Does the data of this curve need updating?","name":"needsUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#needsUpdate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"For a curve on a Path, `false` means the Path will ignore this curve.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":111,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Draws this curve on the given Graphics object.\n\nThe curve is drawn using `Graphics.strokePoints` so will be drawn at whatever the present Graphics stroke color is.\nThe Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.","kind":"function","name":"draw","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics instance onto which this curve will be drawn.","name":"graphics"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The resolution of the curve. The higher the value the smoother it will render, at the cost of rendering performance.","name":"pointsTotal"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to which the curve was drawn."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#draw","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a Rectangle where the position and dimensions match the bounds of this Curve.\n\nYou can control the accuracy of the bounds. The value given is used to work out how many points\nto plot across the curve. Higher values are more accurate at the cost of calculation speed.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the bounds in. If falsey a new object will be created.","name":"out"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":16,"description":"The accuracy of the bounds calculations.","name":"accuracy"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A Rectangle object holding the bounds of this curve. If `out` was given it will be this object."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getBounds","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns an array of points, spaced out X distance pixels apart.\nThe smaller the distance, the larger the array will be.","kind":"function","name":"getDistancePoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The distance, in pixels, between each point along the curve.","name":"distance"}],"returns":[{"type":{"names":["Array."]},"description":"An Array of Point objects."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getDistancePoints","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the end of the curve.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"Optional Vector object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector2 containing the coordinates of the curves end point."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getEndPoint","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get total curve arc length","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the curve."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getLength","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a list of cumulative segment lengths.\n\nThese lengths are\n\n- [0] 0\n- [1] The first segment\n- [2] The first and second segment\n- ...\n- [divisions] All segments","kind":"function","name":"getLengths","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions or segments.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cumulative lengths."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getLengths","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at a relative position on the curve, by arc length.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getPointAt","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of evenly spaced points from the curve.\n\nYou can pass `divisions`, `stepRate`, or neither.\n\nThe number of divisions will be\n\n1. `divisions`, if `divisions` > 0; or\n2. `this.getLength / stepRate`, if `stepRate` > 0; or\n3. `this.defaultDivisions`\n\n`1 + divisions` points will be returned.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"The curve distance between points, implying `divisions`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the curve."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a random point from the curve.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of equally spaced points (by arc distance) from the curve.\n\n`1 + divisions` points will be returned.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.defaultDivisions","description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array of points."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getSpacedPoints","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the start of the curve.","kind":"function","name":"getStartPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getStartPoint","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve.\nIn case any sub curve does not implement its tangent derivation,\n2 points a small delta apart will be used to find its gradient\nwhich seems to give a reasonable approximation","kind":"function","name":"getTangent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector approximating the tangent line at the point t (delta +/- 0.0001)"}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getTangent","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve, by arc length.","kind":"function","name":"getTangentAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getTangentAt","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getTFromDistance","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getTFromDistance","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getUtoTmapping","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"u"},{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#getUtoTmapping","scope":"instance","___s":true},{"meta":{"filename":"Curve.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Calculate and cache the arc lengths.","kind":"function","name":"updateArcLengths","since":"3.0.0","see":["Phaser.Curves.Curve#getLengths()"],"memberof":"Phaser.Curves.Curve","longname":"Phaser.Curves.Curve#updateArcLengths","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"classdesc":"An Elliptical Curve derived from the Base Curve class.\n\nSee https://en.wikipedia.org/wiki/Elliptic_curve for more details.","kind":"class","name":"Ellipse","augments":["Phaser.Curves.Curve"],"memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Types.Curves.EllipseCurveConfig"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the ellipse, or an Ellipse Curve configuration object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the ellipse.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal radius of ellipse.","name":"xRadius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical radius of ellipse.","name":"yRadius"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The start angle of the ellipse, in degrees.","name":"startAngle"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":360,"description":"The end angle of the ellipse, in degrees.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the ellipse angles are given as clockwise (`true`) or counter-clockwise (`false`).","name":"clockwise"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The rotation of the ellipse, in degrees.","name":"rotation"}],"scope":"static","longname":"Phaser.Curves.Ellipse","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The center point of the ellipse. Used for calculating rotation.","name":"p0","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#p0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":143,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the starting point on the curve.","kind":"function","name":"getStartPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getStartPoint","scope":"instance","overrides":"Phaser.Curves.Curve#getStartPoint","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":162,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getResolution","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getResolution","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":177,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get point at relative position in curve according to length.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getPoint","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":253,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the horizontal radius of this curve.","kind":"function","name":"setXRadius","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal radius of this curve.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setXRadius","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the vertical radius of this curve.","kind":"function","name":"setYRadius","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical radius of this curve.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setYRadius","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the width of this curve.","kind":"function","name":"setWidth","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this curve.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setWidth","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":304,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the height of this curve.","kind":"function","name":"setHeight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The height of this curve.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setHeight","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the start angle of this curve.","kind":"function","name":"setStartAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The start angle of this curve, in radians.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setStartAngle","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":338,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the end angle of this curve.","kind":"function","name":"setEndAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The end angle of this curve, in radians.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setEndAngle","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets if this curve extends clockwise or anti-clockwise.","kind":"function","name":"setClockwise","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The clockwise state of this curve.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setClockwise","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Sets the rotation of this curve.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The rotation of this curve, in radians.","name":"value"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#setRotation","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":389,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The x coordinate of the center of the ellipse.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The y coordinate of the center of the ellipse.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The horizontal radius of the ellipse.","name":"xRadius","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#xRadius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":452,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The vertical radius of the ellipse.","name":"yRadius","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#yRadius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":473,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The start angle of the ellipse in degrees.","name":"startAngle","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#startAngle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The end angle of the ellipse in degrees.","name":"endAngle","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#endAngle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":515,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"`true` if the ellipse rotation is clockwise or `false` if anti-clockwise.","name":"clockwise","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#clockwise","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":536,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The rotation of the ellipse, relative to the center, in degrees.","name":"angle","type":{"names":["number"]},"since":"3.14.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":557,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The rotation of the ellipse, relative to the center, in radians.","name":"rotation","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":578,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"JSON serialization of the curve.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONEllipseCurve"]},"description":"The JSON object containing this curve data."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#toJSON","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurve.js","lineno":603,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Creates a curve from the provided Ellipse Curve Configuration object.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Curves.JSONEllipseCurve"]},"description":"The JSON object containing this curve data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Curves.Ellipse"]},"description":"The ellipse curve constructed from the configuration object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse.fromJSON","scope":"static","___s":true},{"meta":{"filename":"LineCurve.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"classdesc":"A LineCurve is a \"curve\" comprising exactly two points (a line segment).","kind":"class","name":"Line","augments":["Phaser.Curves.Curve"],"memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Array."]},"description":"The first endpoint.","name":"p0"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"The second endpoint.","name":"p1"}],"scope":"static","longname":"Phaser.Curves.Line","___s":true},{"meta":{"filename":"LineCurve.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The first endpoint.","name":"p0","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#p0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LineCurve.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The second endpoint.","name":"p1","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#p1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LineCurve.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The quantity of arc length divisions within the curve.","name":"arcLengthDivisions","type":{"names":["integer"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#arcLengthDivisions","scope":"instance","kind":"member","overrides":"Phaser.Curves.Curve#arcLengthDivisions","___s":true},{"meta":{"filename":"LineCurve.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a Rectangle where the position and dimensions match the bounds of this Curve.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"A Rectangle object to store the bounds in. If not given a new Rectangle will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A Rectangle object holding the bounds of this curve. If `out` was given it will be this object."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getBounds","scope":"instance","overrides":"Phaser.Curves.Curve#getBounds","___s":true},{"meta":{"filename":"LineCurve.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the starting point on the curve.","kind":"function","name":"getStartPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getStartPoint","scope":"instance","overrides":"Phaser.Curves.Curve#getStartPoint","___s":true},{"meta":{"filename":"LineCurve.js","lineno":116,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the resolution of the line.","kind":"function","name":"getResolution","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The number of divisions to consider.","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"The resolution. Equal to the number of divisions."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getResolution","scope":"instance","___s":true},{"meta":{"filename":"LineCurve.js","lineno":133,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get point at relative position in curve according to length.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getPoint","scope":"instance","___s":true},{"meta":{"filename":"LineCurve.js","lineno":162,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets a point at a given position on the line.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getPointAt","scope":"instance","overrides":"Phaser.Curves.Curve#getPointAt","___s":true},{"meta":{"filename":"LineCurve.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the slope of the line as a unit vector.","kind":"function","name":"getTangent","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getTangent","scope":"instance","overrides":"Phaser.Curves.Curve#getTangent","___s":true},{"meta":{"filename":"LineCurve.js","lineno":199,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getUtoTmapping","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"u"},{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getUtoTmapping","scope":"instance","overrides":"Phaser.Curves.Curve#getUtoTmapping","___s":true},{"meta":{"filename":"LineCurve.js","lineno":235,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Draws this curve on the given Graphics object.\n\nThe curve is drawn using `Graphics.lineBetween` so will be drawn at whatever the present Graphics line color is.\nThe Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.","kind":"function","name":"draw","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics instance onto which this curve will be drawn.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to which the curve was drawn."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#draw","scope":"instance","overrides":"Phaser.Curves.Curve#draw","___s":true},{"meta":{"filename":"LineCurve.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets a JSON representation of the line.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#toJSON","scope":"instance","___s":true},{"meta":{"filename":"LineCurve.js","lineno":279,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Configures this line from a JSON representation.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Curves.Line"]},"description":"A new LineCurve object."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line.fromJSON","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"QuadraticBezierCurve.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"classdesc":"[description]","kind":"class","name":"QuadraticBezier","augments":["Phaser.Curves.Curve"],"memberof":"Phaser.Curves","since":"3.2.0","params":[{"type":{"names":["Phaser.Math.Vector2","Array."]},"description":"Start point, or an array of point pairs.","name":"p0"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"Control Point 1.","name":"p1"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"Control Point 2.","name":"p2"}],"scope":"static","longname":"Phaser.Curves.QuadraticBezier","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","name":"p0","type":{"names":["Phaser.Math.Vector2"]},"since":"3.2.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#p0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","name":"p1","type":{"names":["Phaser.Math.Vector2"]},"since":"3.2.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#p1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","name":"p2","type":{"names":["Phaser.Math.Vector2"]},"since":"3.2.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#p2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the starting point on the curve.","kind":"function","name":"getStartPoint","since":"3.2.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getStartPoint","scope":"instance","overrides":"Phaser.Curves.Curve#getStartPoint","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getResolution","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getResolution","scope":"instance","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get point at relative position in curve according to length.","kind":"function","name":"getPoint","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getPoint","scope":"instance","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"draw","since":"3.2.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`Graphics` object to draw onto.","name":"graphics"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"Number of points to be used for drawing the curve. Higher numbers result in smoother curve but require more processing.","name":"pointsTotal"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`Graphics` object that was drawn to."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#draw","scope":"instance","overrides":"Phaser.Curves.Curve#draw","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":165,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Converts the curve into a JSON compatible object.","kind":"function","name":"toJSON","since":"3.2.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#toJSON","scope":"instance","___s":true},{"meta":{"filename":"QuadraticBezierCurve.js","lineno":187,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Creates a curve from a JSON object, e. g. created by `toJSON`.","kind":"function","name":"fromJSON","since":"3.2.0","params":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Curves.QuadraticBezier"]},"description":"The created curve instance."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier.fromJSON","scope":"static","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"classdesc":"Create a smooth 2d spline curve from a series of points.","kind":"class","name":"Spline","augments":["Phaser.Curves.Curve"],"memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["Array.","Array.","Array.>"]},"optional":true,"description":"The points that configure the curve.","name":"points"}],"scope":"static","longname":"Phaser.Curves.Spline","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The Vector2 points that configure the curve.","name":"points","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#points","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":51,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Add a list of points to the current list of Vector2 points of the curve.","kind":"function","name":"addPoints","since":"3.0.0","params":[{"type":{"names":["Array.","Array.","Array.>"]},"description":"The points that configure the curve.","name":"points"}],"returns":[{"type":{"names":["Phaser.Curves.Spline"]},"description":"This curve object."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#addPoints","scope":"instance","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Add a point to the current list of Vector2 points of the curve.","kind":"function","name":"addPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of this curve","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of this curve","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The new Vector2 added to the curve"}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#addPoint","scope":"instance","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":111,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Gets the starting point on the curve.","kind":"function","name":"getStartPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getStartPoint","scope":"instance","overrides":"Phaser.Curves.Curve#getStartPoint","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":130,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getResolution","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getResolution","scope":"instance","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get point at relative position in curve according to length.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getPoint","scope":"instance","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Exports a JSON object containing this curve data.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#toJSON","scope":"instance","___s":true},{"meta":{"filename":"SplineCurve.js","lineno":204,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Imports a JSON object containing this curve data.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"The JSON object containing this curve data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Curves.Spline"]},"description":"The spline curve created."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline.fromJSON","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"kind":"namespace","name":"Curves","memberof":"Phaser","longname":"Phaser.Curves","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"MoveTo.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MoveTo.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"classdesc":"A MoveTo Curve is a very simple curve consisting of only a single point. Its intended use is to move the ending point in a Path.","kind":"class","name":"MoveTo","memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"`x` pixel coordinate.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"`y` pixel coordinate.","name":"y"}],"scope":"static","longname":"Phaser.Curves.MoveTo","___s":true},{"meta":{"filename":"MoveTo.js","lineno":30,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Denotes that this Curve does not influence the bounds, points, and drawing of its parent Path. Must be `false` or some methods in the parent Path will throw errors.","name":"active","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MoveTo.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"The lone point which this curve consists of.","name":"p0","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#p0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MoveTo.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Get point at relative position in curve according to length.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position along the curve to return. Where 0 is the start and 1 is the end.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to store the result in. If not given will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates of the point on the curve. If an `out` object was given this will be returned."}],"memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#getPoint","scope":"instance","___s":true},{"meta":{"filename":"MoveTo.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Retrieves the point at given position in the curve. This will always return this curve's only point.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The position in the path to retrieve, between 0 and 1. Not used.","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"An optional vector in which to store the point.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The modified `out` vector, or a new `Vector2` if none was provided."}],"memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#getPointAt","scope":"instance","___s":true},{"meta":{"filename":"MoveTo.js","lineno":88,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Gets the resolution of this curve.","kind":"function","name":"getResolution","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The resolution of this curve. For a MoveTo the value is always 1."}],"memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#getResolution","scope":"instance","___s":true},{"meta":{"filename":"MoveTo.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Gets the length of this curve.","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this curve. For a MoveTo the value is always 0."}],"memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#getLength","scope":"instance","___s":true},{"meta":{"filename":"MoveTo.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Converts this curve into a JSON-serializable object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONCurve"]},"description":"A primitive object with the curve's type and only point."}],"memberof":"Phaser.Curves.MoveTo","longname":"Phaser.Curves.MoveTo#toJSON","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":21,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"classdesc":"A Path combines multiple Curves into one continuous compound curve.\nIt does not matter how many Curves are in the Path or what type they are.\n\nA Curve in a Path does not have to start where the previous Curve ends - that is to say, a Path does not\nhave to be an uninterrupted curve. Only the order of the Curves influences the actual points on the Path.","kind":"class","name":"Path","memberof":"Phaser.Curves","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The X coordinate of the Path's starting point or a {@link Phaser.Types.Curves.JSONPath}.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The Y coordinate of the Path's starting point.","name":"y"}],"scope":"static","longname":"Phaser.Curves.Path","___s":true},{"meta":{"filename":"Path.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"The name of this Path.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Path.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"The list of Curves which make up this Path.","name":"curves","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#curves","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Path.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"The cached length of each Curve in the Path.\n\nUsed internally by {@link #getCurveLengths}.","name":"cacheLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#cacheLengths","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Path.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Automatically closes the path.","name":"autoClose","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#autoClose","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Path.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"The starting point of the Path.\n\nThis is not necessarily equivalent to the starting point of the first Curve in the Path. In an empty Path, it's also treated as the ending point.","name":"startPoint","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#startPoint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Path.js","lineno":130,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Appends a Curve to the end of the Path.\n\nThe Curve does not have to start where the Path ends or, for an empty Path, at its defined starting point.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Curves.Curve"]},"description":"The Curve to append.","name":"curve"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#add","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a circular Ellipse Curve positioned at the end of the Path.","kind":"function","name":"circleTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"`true` to create a clockwise circle as opposed to a counter-clockwise circle.","name":"clockwise"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of the circle in degrees.","name":"rotation"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#circleTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":168,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Ensures that the Path is closed.\n\nA closed Path starts and ends at the same point. If the Path is not closed, a straight Line Curve will be created from the ending point directly to the starting point. During the check, the actual starting point of the Path, i.e. the starting point of the first Curve, will be used as opposed to the Path's defined {@link startPoint}, which could differ.\n\nCalling this method on an empty Path will result in an error.","kind":"function","name":"closePath","since":"3.0.0","returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#closePath","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a cubic bezier curve starting at the previous end point and ending at p3, using p1 and p2 as control points.","kind":"function","name":"cubicBezierTo","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Math.Vector2"]},"description":"The x coordinate of the end point. Or, if a Vector2, the p1 value.","name":"x"},{"type":{"names":["number","Phaser.Math.Vector2"]},"description":"The y coordinate of the end point. Or, if a Vector2, the p2 value.","name":"y"},{"type":{"names":["number","Phaser.Math.Vector2"]},"description":"The x coordinate of the first control point. Or, if a Vector2, the p3 value.","name":"control1X"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate of the first control point. Not used if Vector2s are provided as the first 3 arguments.","name":"control1Y"},{"type":{"names":["number"]},"optional":true,"description":"The x coordinate of the second control point. Not used if Vector2s are provided as the first 3 arguments.","name":"control2X"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate of the second control point. Not used if Vector2s are provided as the first 3 arguments.","name":"control2Y"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#cubicBezierTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":236,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a Quadratic Bezier Curve starting at the ending point of the Path.","kind":"function","name":"quadraticBezierTo","since":"3.2.0","params":[{"type":{"names":["number","Array."]},"description":"The X coordinate of the second control point or, if it's a `Vector2`, the first control point.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The Y coordinate of the second control point or, if `x` is a `Vector2`, the second control point.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"If `x` is not a `Vector2`, the X coordinate of the first control point.","name":"controlX"},{"type":{"names":["number"]},"optional":true,"description":"If `x` is not a `Vector2`, the Y coordinate of the first control point.","name":"controlY"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#quadraticBezierTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Draws all Curves in the Path to a Graphics Game Object.","kind":"function","name":"draw","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics Game Object to draw to.","name":"graphics"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The number of points to draw for each Curve. Higher numbers result in a smoother curve but require more processing.","name":"pointsTotal"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object which was drawn to."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#draw","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates an ellipse curve positioned at the previous end point, using the given parameters.","kind":"function","name":"ellipseTo","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal radius of ellipse.","name":"xRadius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical radius of ellipse.","name":"yRadius"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The start angle of the ellipse, in degrees.","name":"startAngle"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":360,"description":"The end angle of the ellipse, in degrees.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the ellipse angles are given as clockwise (`true`) or counter-clockwise (`false`).","name":"clockwise"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of the ellipse, in degrees.","name":"rotation"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#ellipseTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a Path from a Path Configuration object.\n\nThe provided object should be a {@link Phaser.Types.Curves.JSONPath}, as returned by {@link #toJSON}. Providing a malformed object may cause errors.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Curves.JSONPath"]},"description":"The JSON object containing the Path data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#fromJSON","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":386,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Returns a Rectangle with a position and size matching the bounds of this Path.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the bounds in.","name":"out"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":16,"description":"The accuracy of the bounds calculations. Higher values are more accurate at the cost of calculation speed.","name":"accuracy"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified `out` Rectangle, or a new Rectangle if none was provided."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getBounds","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":435,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Returns an array containing the length of the Path at the end of each Curve.\n\nThe result of this method will be cached to avoid recalculating it in subsequent calls. The cache is only invalidated when the {@link #curves} array changes in length, leading to potential inaccuracies if a Curve in the Path is changed, or if a Curve is removed and another is added in its place.","kind":"function","name":"getCurveLengths","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"An array containing the length of the Path at the end of each one of its Curves."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getCurveLengths","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Returns the ending point of the Path.\n\nA Path's ending point is equivalent to the ending point of the last Curve in the Path. For an empty Path, the ending point is at the Path's defined {@link #startPoint}.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"The object to store the point in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The modified `out` object, or a new Vector2 if none was provided."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getEndPoint","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":502,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Returns the total length of the Path.","see":["{@link #getCurveLengths}"],"kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the Path."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getLength","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":528,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Calculates the coordinates of the point at the given normalized location (between 0 and 1) on the Path.\n\nThe location is relative to the entire Path, not to an individual Curve. A location of 0.5 is always in the middle of the Path and is thus an equal distance away from both its starting and ending points. In a Path with one Curve, it would be in the middle of the Curve; in a Path with two Curves, it could be anywhere on either one of them depending on their lengths.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The location of the point to return, between 0 and 1.","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"The object in which to store the calculated point.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"nullable":true,"description":"The modified `out` object, or a new `Vector2` if none was provided."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getPoint","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":571,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Get a sequence of points on the path.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":12,"description":"The number of divisions per resolution per curve.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Vector2 objects that containing the points along the Path."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Returns a randomly chosen point anywhere on the path. This follows the same rules as `getPoint` in that it may return a point on any Curve inside this path.\n\nWhen calling this method multiple times, the points are not guaranteed to be equally spaced spatially.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"`Vector2` instance that should be used for storing the result. If `undefined` a new `Vector2` will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The modified `out` object, or a new `Vector2` if none was provided."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":646,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Divides this Path into a set of equally spaced points,\n\nThe resulting points are equally spaced with respect to the points' position on the path, but not necessarily equally spaced spatially.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":40,"description":"The amount of points to divide this Path into.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"A list of the points this path was subdivided into."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getSpacedPoints","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":677,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Returns the starting point of the Path.","kind":"function","name":"getStartPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"`Vector2` instance that should be used for storing the result. If `undefined` a new `Vector2` will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The modified `out` object, or a new Vector2 if none was provided."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#getStartPoint","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":696,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a line curve from the previous end point to x/y.","kind":"function","name":"lineTo","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Math.Vector2"]},"description":"The X coordinate of the line's end point, or a `Vector2` containing the entire end point.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The Y coordinate of the line's end point, if a number was passed as the X parameter.","name":"y"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#lineTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a spline curve starting at the previous end point, using the given points on the curve.","kind":"function","name":"splineTo","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The points the newly created spline curve should consist of.","name":"points"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#splineTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":740,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a \"gap\" in this path from the path's current end point to the given coordinates.\n\nAfter calling this function, this Path's end point will be equal to the given coordinates","kind":"function","name":"moveTo","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Math.Vector2"]},"description":"The X coordinate of the position to move the path's end point to, or a `Vector2` containing the entire new end point.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the position to move the path's end point to, if a number was passed as the X coordinate.","name":"y"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"This Path object."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#moveTo","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":765,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Converts this Path to a JSON object containing the path information and its constituent curves.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Curves.JSONPath"]},"description":"The JSON object containing this path's data."}],"memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#toJSON","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":791,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"cacheLengths must be recalculated.","kind":"function","name":"updateArcLengths","since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#updateArcLengths","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":804,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Disposes of this Path, clearing its internal references to objects so they can be garbage-collected.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Curves.Path","longname":"Phaser.Curves.Path#destroy","scope":"instance","___s":true},{"meta":{"filename":"Path.js","lineno":819,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/path"},"description":"Creates a new Path Object.","kind":"function","name":"path","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Path.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Path.","name":"y"}],"returns":[{"type":{"names":["Phaser.Curves.Path"]},"description":"The Path Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#path","scope":"instance","___s":true},{"meta":{"filename":"EllipseCurveConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/typedefs"},"kind":"typedef","name":"EllipseCurveConfig","type":{"names":["object"]},"properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the ellipse.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the ellipse.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal radius of the ellipse.","name":"xRadius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical radius of the ellipse.","name":"yRadius"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The start angle of the ellipse, in degrees.","name":"startAngle"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":360,"description":"The end angle of the ellipse, in degrees.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets if the the ellipse rotation is clockwise (true) or anti-clockwise (false)","name":"clockwise"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The rotation of the ellipse, in degrees.","name":"rotation"}],"memberof":"Phaser.Types.Curves","longname":"Phaser.Types.Curves.EllipseCurveConfig","scope":"static","___s":true},{"meta":{"filename":"JSONCurve.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/typedefs"},"kind":"typedef","name":"JSONCurve","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The of the curve","name":"type"},{"type":{"names":["Array."]},"description":"The arrays of points like `[x1, y1, x2, y2]`","name":"points"}],"memberof":"Phaser.Types.Curves","longname":"Phaser.Types.Curves.JSONCurve","scope":"static","___s":true},{"meta":{"filename":"JSONEllipseCurve.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/typedefs"},"kind":"typedef","name":"JSONEllipseCurve","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The of the curve.","name":"type"},{"type":{"names":["number"]},"description":"The x coordinate of the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the ellipse.","name":"y"},{"type":{"names":["number"]},"description":"The horizontal radius of ellipse.","name":"xRadius"},{"type":{"names":["number"]},"description":"The vertical radius of ellipse.","name":"yRadius"},{"type":{"names":["integer"]},"description":"The start angle of the ellipse, in degrees.","name":"startAngle"},{"type":{"names":["integer"]},"description":"The end angle of the ellipse, in degrees.","name":"endAngle"},{"type":{"names":["boolean"]},"description":"Sets if the the ellipse rotation is clockwise (true) or anti-clockwise (false)","name":"clockwise"},{"type":{"names":["integer"]},"description":"The rotation of ellipse, in degrees.","name":"rotation"}],"memberof":"Phaser.Types.Curves","longname":"Phaser.Types.Curves.JSONEllipseCurve","scope":"static","___s":true},{"meta":{"filename":"JSONPath.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/typedefs"},"kind":"typedef","name":"JSONPath","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The of the curve.","name":"type"},{"type":{"names":["number"]},"description":"The X coordinate of the curve's starting point.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the path's starting point.","name":"y"},{"type":{"names":["boolean"]},"description":"The path is auto closed.","name":"autoClose"},{"type":{"names":["Array."]},"description":"The list of the curves","name":"curves"}],"memberof":"Phaser.Types.Curves","longname":"Phaser.Types.Curves.JSONPath","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/curves/typedefs"},"kind":"namespace","name":"Curves","memberof":"Phaser.Types","longname":"Phaser.Types.Curves","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"DataManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DataManager.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"kind":"typedef","name":"DataEachCallback","type":{"names":["function"]},"params":[{"type":{"names":["*"]},"description":"The parent object of the DataManager.","name":"parent"},{"type":{"names":["string"]},"description":"The key of the value.","name":"key"},{"type":{"names":["*"]},"description":"The value.","name":"value"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the game object, key, and data.","name":"args"}],"longname":"DataEachCallback","scope":"global","___s":true},{"meta":{"filename":"DataManager.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"classdesc":"The Data Manager Component features a means to store pieces of data specific to a Game Object, System or Plugin.\nYou can then search, query it, and retrieve the data. The parent must either extend EventEmitter,\nor have a property called `events` that is an instance of it.","kind":"class","name":"DataManager","memberof":"Phaser.Data","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object that this DataManager belongs to.","name":"parent"},{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"The DataManager's event emitter.","name":"eventEmitter"}],"scope":"static","longname":"Phaser.Data.DataManager","___s":true},{"meta":{"filename":"DataManager.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The object that this DataManager belongs to.","name":"parent","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManager.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The DataManager's event emitter.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManager.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The data list.","name":"list","type":{"names":["Object."]},"defaultvalue":"{}","since":"3.0.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#list","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManager.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The public values list. You can use this to access anything you have stored\nin this Data Manager. For example, if you set a value called `gold` you can\naccess it via:\n\n```javascript\nthis.data.values.gold;\n```\n\nYou can also modify it directly:\n\n```javascript\nthis.data.values.gold += 1000;\n```\n\nDoing so will emit a `setdata` event from the parent of this Data Manager.\n\nDo not modify this object directly. Adding properties directly to this object will not\nemit any events. Always use `DataManager.set` to create new items the first time around.","name":"values","type":{"names":["Object."]},"defaultvalue":"{}","since":"3.10.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#values","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManager.js","lineno":116,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Retrieves the value for the given key, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nthis.data.get('gold');\n```\n\nOr access the value directly:\n\n```javascript\nthis.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nthis.data.get([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#get","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Retrieves all data values in a new object.","kind":"function","name":"getAll","since":"3.0.0","returns":[{"type":{"names":["Object."]},"description":"All data values."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#getAll","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Queries the DataManager for the values of keys matching the given regular expression.","kind":"function","name":"query","since":"3.0.0","params":[{"type":{"names":["RegExp"]},"description":"A regular expression object. If a non-RegExp object obj is passed, it is implicitly converted to a RegExp by using new RegExp(obj).","name":"search"}],"returns":[{"type":{"names":["Object."]},"description":"The values of the keys matching the search string."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#query","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Sets a value for the given key. If the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\ndata.set('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\ndata.set({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `get`:\n\n```javascript\ndata.get('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\ndata.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"set","fires":["Phaser.Data.Events#event:SET_DATA","Phaser.Data.Events#event:CHANGE_DATA","Phaser.Data.Events#event:CHANGE_DATA_KEY"],"since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object or key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#set","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Passes all data entries to the given callback.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["DataEachCallback"]},"description":"The function to call.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"Value to use as `this` when executing callback.","name":"context"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the game object, key, and data.","name":"args"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#each","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":381,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Merge the given object of key value pairs into this DataManager.\n\nAny newly created values will emit a `setdata` event. Any updated values (see the `overwrite` argument)\nwill emit a `changedata` event.","kind":"function","name":"merge","fires":["Phaser.Data.Events#event:SET_DATA","Phaser.Data.Events#event:CHANGE_DATA","Phaser.Data.Events#event:CHANGE_DATA_KEY"],"since":"3.0.0","params":[{"type":{"names":["Object."]},"description":"The data to merge.","name":"data"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to overwrite existing data. Defaults to true.","name":"overwrite"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#merge","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":414,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Remove the value for the given key.\n\nIf the key is found in this Data Manager it is removed from the internal lists and a\n`removedata` event is emitted.\n\nYou can also pass in an array of keys, in which case all keys in the array will be removed:\n\n```javascript\nthis.data.remove([ 'gold', 'armor', 'health' ]);\n```","kind":"function","name":"remove","fires":["Phaser.Data.Events#event:REMOVE_DATA"],"since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key to remove, or an array of keys to remove.","name":"key"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#remove","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Retrieves the data associated with the given 'key', deletes it from this Data Manager, then returns it.","kind":"function","name":"pop","fires":["Phaser.Data.Events#event:REMOVE_DATA"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the value to retrieve and delete.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value of the given key."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#pop","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":511,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Determines whether the given key is set in this Data Manager.\n\nPlease note that the keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if the key exists, otherwise `false`."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#has","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Freeze or unfreeze this Data Manager. A frozen Data Manager will block all attempts\nto create new values or update existing ones.","kind":"function","name":"setFreeze","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether to freeze or unfreeze the Data Manager.","name":"value"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#setFreeze","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":547,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Delete all data in this Data Manager and unfreeze it.","kind":"function","name":"reset","since":"3.0.0","returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#reset","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Destroy this data manager.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#destroy","scope":"instance","___s":true},{"meta":{"filename":"DataManager.js","lineno":585,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Gets or sets the frozen state of this Data Manager.\nA frozen Data Manager will block all attempts to create new values or update existing ones.","name":"freeze","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#freeze","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManager.js","lineno":607,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Return the total number of entries in this Data Manager.","name":"count","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Data.DataManager","longname":"Phaser.Data.DataManager#count","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,213],"filename":"DataManagerPlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DataManagerPlugin.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"classdesc":"The Data Component features a means to store pieces of data specific to a Game Object, System or Plugin.\nYou can then search, query it, and retrieve the data. The parent must either extend EventEmitter,\nor have a property called `events` that is an instance of it.","kind":"class","name":"DataManagerPlugin","augments":["Phaser.Data.DataManager"],"memberof":"Phaser.Data","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that this DataManager belongs to.","name":"scene"}],"scope":"static","longname":"Phaser.Data.DataManagerPlugin","___s":true},{"meta":{"filename":"DataManagerPlugin.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"A reference to the Scene that this DataManager belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManagerPlugin.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"A reference to the Scene's Systems.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DataManagerPlugin.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The Scene that owns this plugin is being destroyed.\nWe need to shutdown and then kill off all external references.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#destroy","scope":"instance","overrides":"Phaser.Data.DataManager#destroy","___s":true},{"meta":{"filename":"CHANGE_DATA_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data/events"},"description":"The Change Data Event.\n\nThis event is dispatched by a Data Manager when an item in the data store is changed.\n\nGame Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\na change data event from a Game Object you would use: `sprite.data.on('changedata', listener)`.\n\nThis event is dispatched for all items that change in the Data Manager.\nTo listen for the change of a specific item, use the `CHANGE_DATA_KEY_EVENT` event.","kind":"event","name":"CHANGE_DATA","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"A reference to the object that the Data Manager responsible for this event belongs to.","name":"parent"},{"type":{"names":["string"]},"description":"The unique key of the data item within the Data Manager.","name":"key"},{"type":{"names":["any"]},"description":"The new value of the item in the Data Manager.","name":"value"},{"type":{"names":["any"]},"description":"The previous value of the item in the Data Manager.","name":"previousValue"}],"memberof":"Phaser.Data.Events","longname":"Phaser.Data.Events#event:CHANGE_DATA","scope":"instance","___s":true},{"meta":{"filename":"CHANGE_DATA_KEY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data/events"},"description":"The Change Data Key Event.\n\nThis event is dispatched by a Data Manager when an item in the data store is changed.\n\nGame Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\nthe change of a specific data item from a Game Object you would use: `sprite.data.on('changedata-key', listener)`,\nwhere `key` is the unique string key of the data item. For example, if you have a data item stored called `gold`\nthen you can listen for `sprite.data.on('changedata-gold')`.","kind":"event","name":"CHANGE_DATA_KEY","since":"3.16.1","params":[{"type":{"names":["any"]},"description":"A reference to the object that owns the instance of the Data Manager responsible for this event.","name":"parent"},{"type":{"names":["any"]},"description":"The item that was updated in the Data Manager. This can be of any data type, i.e. a string, boolean, number, object or instance.","name":"value"},{"type":{"names":["any"]},"description":"The previous item that was updated in the Data Manager. This can be of any data type, i.e. a string, boolean, number, object or instance.","name":"previousValue"}],"memberof":"Phaser.Data.Events","longname":"Phaser.Data.Events#event:CHANGE_DATA_KEY","scope":"instance","___s":true},{"meta":{"filename":"REMOVE_DATA_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data/events"},"description":"The Remove Data Event.\n\nThis event is dispatched by a Data Manager when an item is removed from it.\n\nGame Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\nthe removal of a data item on a Game Object you would use: `sprite.data.on('removedata', listener)`.","kind":"event","name":"REMOVE_DATA","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"A reference to the object that owns the instance of the Data Manager responsible for this event.","name":"parent"},{"type":{"names":["string"]},"description":"The unique key of the data item within the Data Manager.","name":"key"},{"type":{"names":["any"]},"description":"The item that was removed from the Data Manager. This can be of any data type, i.e. a string, boolean, number, object or instance.","name":"data"}],"memberof":"Phaser.Data.Events","longname":"Phaser.Data.Events#event:REMOVE_DATA","scope":"instance","___s":true},{"meta":{"filename":"SET_DATA_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data/events"},"description":"The Set Data Event.\n\nThis event is dispatched by a Data Manager when a new item is added to the data store.\n\nGame Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\nthe addition of a new data item on a Game Object you would use: `sprite.data.on('setdata', listener)`.","kind":"event","name":"SET_DATA","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"A reference to the object that owns the instance of the Data Manager responsible for this event.","name":"parent"},{"type":{"names":["string"]},"description":"The unique key of the data item within the Data Manager.","name":"key"},{"type":{"names":["any"]},"description":"The item that was added to the Data Manager. This can be of any data type, i.e. a string, boolean, number, object or instance.","name":"data"}],"memberof":"Phaser.Data.Events","longname":"Phaser.Data.Events#event:SET_DATA","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Data","longname":"Phaser.Data.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"kind":"namespace","name":"Data","memberof":"Phaser","longname":"Phaser.Data","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"Audio.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"name":"Browser","longname":"Browser","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Audio.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the audio playback capabilities of the device running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.audio` from within any Scene.","kind":"typedef","name":"Audio","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Can this device play HTML Audio tags?","name":"audioData"},{"type":{"names":["boolean"]},"description":"Can this device play EC-3 Dolby Digital Plus files?","name":"dolby"},{"type":{"names":["boolean"]},"description":"Can this device can play m4a files.","name":"m4a"},{"type":{"names":["boolean"]},"description":"Can this device play mp3 files?","name":"mp3"},{"type":{"names":["boolean"]},"description":"Can this device play ogg files?","name":"ogg"},{"type":{"names":["boolean"]},"description":"Can this device play opus files?","name":"opus"},{"type":{"names":["boolean"]},"description":"Can this device play wav files?","name":"wav"},{"type":{"names":["boolean"]},"description":"Does this device have the Web Audio API?","name":"webAudio"},{"type":{"names":["boolean"]},"description":"Can this device play webm files?","name":"webm"}],"memberof":"Phaser.Device","longname":"Phaser.Device.Audio","scope":"static","___s":true},{"meta":{"range":[180,200],"filename":"Browser.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"name":"OS","longname":"OS","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Browser.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the browser type and version running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.browser` from within any Scene.","kind":"typedef","name":"Browser","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Set to true if running in Chrome.","name":"chrome"},{"type":{"names":["boolean"]},"description":"Set to true if running in Microsoft Edge browser.","name":"edge"},{"type":{"names":["boolean"]},"description":"Set to true if running in Firefox.","name":"firefox"},{"type":{"names":["boolean"]},"description":"Set to true if running in Internet Explorer 11 or less (not Edge).","name":"ie"},{"type":{"names":["boolean"]},"description":"Set to true if running in Mobile Safari.","name":"mobileSafari"},{"type":{"names":["boolean"]},"description":"Set to true if running in Opera.","name":"opera"},{"type":{"names":["boolean"]},"description":"Set to true if running in Safari.","name":"safari"},{"type":{"names":["boolean"]},"description":"Set to true if running in the Silk browser (as used on the Amazon Kindle)","name":"silk"},{"type":{"names":["boolean"]},"description":"Set to true if running a Trident version of Internet Explorer (IE11+)","name":"trident"},{"type":{"names":["number"]},"description":"If running in Chrome this will contain the major version number.","name":"chromeVersion"},{"type":{"names":["number"]},"description":"If running in Firefox this will contain the major version number.","name":"firefoxVersion"},{"type":{"names":["number"]},"description":"If running in Internet Explorer this will contain the major version number. Beyond IE10 you should use Browser.trident and Browser.tridentVersion.","name":"ieVersion"},{"type":{"names":["number"]},"description":"If running in Safari this will contain the major version number.","name":"safariVersion"},{"type":{"names":["number"]},"description":"If running in Internet Explorer 11 this will contain the major version number. See {@link http://msdn.microsoft.com/en-us/library/ie/ms537503(v=vs.85).aspx}","name":"tridentVersion"}],"memberof":"Phaser.Device","longname":"Phaser.Device.Browser","scope":"static","___s":true},{"meta":{"range":[180,232],"filename":"CanvasFeatures.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CanvasFeatures.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the canvas features of the browser running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.canvasFeatures` from within any Scene.","kind":"typedef","name":"CanvasFeatures","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Set to true if the browser supports inversed alpha.","name":"supportInverseAlpha"},{"type":{"names":["boolean"]},"description":"Set to true if the browser supports new canvas blend modes.","name":"supportNewBlendModes"}],"memberof":"Phaser.Device","longname":"Phaser.Device.CanvasFeatures","scope":"static","___s":true},{"meta":{"range":[180,200],"filename":"Features.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"name":"OS","longname":"OS","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Features.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the features of the browser running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.features` from within any Scene.","kind":"typedef","name":"Features","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"nullable":true,"description":"True if canvas supports a 'copy' bitblt onto itself when the source and destination regions overlap.","name":"canvasBitBltShift"},{"type":{"names":["boolean"]},"description":"Is canvas available?","name":"canvas"},{"type":{"names":["boolean"]},"description":"Is file available?","name":"file"},{"type":{"names":["boolean"]},"description":"Is fileSystem available?","name":"fileSystem"},{"type":{"names":["boolean"]},"description":"Does the device support the getUserMedia API?","name":"getUserMedia"},{"type":{"names":["boolean"]},"description":"Is the device big or little endian? (only detected if the browser supports TypedArrays)","name":"littleEndian"},{"type":{"names":["boolean"]},"description":"Is localStorage available?","name":"localStorage"},{"type":{"names":["boolean"]},"description":"Is Pointer Lock available?","name":"pointerLock"},{"type":{"names":["boolean"]},"description":"Does the device context support 32bit pixel manipulation using array buffer views?","name":"support32bit"},{"type":{"names":["boolean"]},"description":"Does the device support the Vibration API?","name":"vibration"},{"type":{"names":["boolean"]},"description":"Is webGL available?","name":"webGL"},{"type":{"names":["boolean"]},"description":"Is worker available?","name":"worker"}],"memberof":"Phaser.Device","longname":"Phaser.Device.Features","scope":"static","___s":true},{"meta":{"filename":"Fullscreen.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the full screen support of the browser running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.fullscreen` from within any Scene.","kind":"typedef","name":"Fullscreen","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Does the browser support the Full Screen API?","name":"available"},{"type":{"names":["boolean"]},"description":"Does the browser support access to the Keyboard during Full Screen mode?","name":"keyboard"},{"type":{"names":["string"]},"description":"If the browser supports the Full Screen API this holds the call you need to use to cancel it.","name":"cancel"},{"type":{"names":["string"]},"description":"If the browser supports the Full Screen API this holds the call you need to use to activate it.","name":"request"}],"memberof":"Phaser.Device","longname":"Phaser.Device.Fullscreen","scope":"static","___s":true},{"meta":{"range":[1183,2777],"filename":"Fullscreen.js","lineno":35,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Checks for support of the Full Screen API.","ignore":true,"name":"init","longname":"init","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[180,210],"filename":"Input.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"name":"Browser","longname":"Browser","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Input.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the input support of the browser running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.input` from within any Scene.","kind":"typedef","name":"Input","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"nullable":true,"description":"The newest type of Wheel/Scroll event supported: 'wheel', 'mousewheel', 'DOMMouseScroll'","name":"wheelType"},{"type":{"names":["boolean"]},"description":"Is navigator.getGamepads available?","name":"gamepads"},{"type":{"names":["boolean"]},"description":"Is mspointer available?","name":"mspointer"},{"type":{"names":["boolean"]},"description":"Is touch available?","name":"touch"}],"memberof":"Phaser.Device","longname":"Phaser.Device.Input","scope":"static","___s":true},{"meta":{"filename":"OS.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the operating system of the device running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.os` from within any Scene.","kind":"typedef","name":"OS","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Is running on android?","name":"android"},{"type":{"names":["boolean"]},"description":"Is running on chromeOS?","name":"chromeOS"},{"type":{"names":["boolean"]},"description":"Is the game running under Apache Cordova?","name":"cordova"},{"type":{"names":["boolean"]},"description":"Is the game running under the Intel Crosswalk XDK?","name":"crosswalk"},{"type":{"names":["boolean"]},"description":"Is running on a desktop?","name":"desktop"},{"type":{"names":["boolean"]},"description":"Is the game running under Ejecta?","name":"ejecta"},{"type":{"names":["boolean"]},"description":"Is the game running under GitHub Electron?","name":"electron"},{"type":{"names":["boolean"]},"description":"Is running on iOS?","name":"iOS"},{"type":{"names":["boolean"]},"description":"Is running on iPad?","name":"iPad"},{"type":{"names":["boolean"]},"description":"Is running on iPhone?","name":"iPhone"},{"type":{"names":["boolean"]},"description":"Is running on an Amazon Kindle?","name":"kindle"},{"type":{"names":["boolean"]},"description":"Is running on linux?","name":"linux"},{"type":{"names":["boolean"]},"description":"Is running on macOS?","name":"macOS"},{"type":{"names":["boolean"]},"description":"Is the game running under Node.js?","name":"node"},{"type":{"names":["boolean"]},"description":"Is the game running under Node-Webkit?","name":"nodeWebkit"},{"type":{"names":["boolean"]},"description":"Set to true if running as a WebApp, i.e. within a WebView","name":"webApp"},{"type":{"names":["boolean"]},"description":"Is running on windows?","name":"windows"},{"type":{"names":["boolean"]},"description":"Is running on a Windows Phone?","name":"windowsPhone"},{"type":{"names":["number"]},"description":"If running in iOS this will contain the major version number.","name":"iOSVersion"},{"type":{"names":["number"]},"description":"PixelRatio of the host device?","name":"pixelRatio"}],"memberof":"Phaser.Device","longname":"Phaser.Device.OS","scope":"static","___s":true},{"meta":{"filename":"Video.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"description":"Determines the video support of the browser running this Phaser Game instance.\nThese values are read-only and populated during the boot sequence of the game.\nThey are then referenced by internal game systems and are available for you to access\nvia `this.sys.game.device.video` from within any Scene.\n\nIn Phaser 3.20 the properties were renamed to drop the 'Video' suffix.","kind":"typedef","name":"Video","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Can this device play h264 mp4 video files?","name":"h264"},{"type":{"names":["boolean"]},"description":"Can this device play hls video files?","name":"hls"},{"type":{"names":["boolean"]},"description":"Can this device play h264 mp4 video files?","name":"mp4"},{"type":{"names":["boolean"]},"description":"Can this device play ogg video files?","name":"ogg"},{"type":{"names":["boolean"]},"description":"Can this device play vp9 video files?","name":"vp9"},{"type":{"names":["boolean"]},"description":"Can this device play webm video files?","name":"webm"}],"memberof":"Phaser.Device","longname":"Phaser.Device.Video","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"kind":"namespace","name":"Device","since":"3.0.0","memberof":"Phaser","longname":"Phaser.Device","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/device"},"kind":"typedef","name":"DeviceConf","type":{"names":["object"]},"properties":[{"type":{"names":["Phaser.Device.OS"]},"description":"The OS Device functions.","name":"os"},{"type":{"names":["Phaser.Device.Browser"]},"description":"The Browser Device functions.","name":"browser"},{"type":{"names":["Phaser.Device.Features"]},"description":"The Features Device functions.","name":"features"},{"type":{"names":["Phaser.Device.Input"]},"description":"The Input Device functions.","name":"input"},{"type":{"names":["Phaser.Device.Audio"]},"description":"The Audio Device functions.","name":"audio"},{"type":{"names":["Phaser.Device.Video"]},"description":"The Video Device functions.","name":"video"},{"type":{"names":["Phaser.Device.Fullscreen"]},"description":"The Fullscreen Device functions.","name":"fullscreen"},{"type":{"names":["Phaser.Device.CanvasFeatures"]},"description":"The Canvas Device functions.","name":"canvasFeatures"}],"memberof":"Phaser","longname":"Phaser.DeviceConf","scope":"static","___s":true},{"meta":{"range":[180,2832],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"name":"ALIGN_CONST","longname":"ALIGN_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a top-left alignment or position.","kind":"constant","name":"TOP_LEFT","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.TOP_LEFT","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a top-center alignment or position.","kind":"constant","name":"TOP_CENTER","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.TOP_CENTER","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a top-right alignment or position.","kind":"constant","name":"TOP_RIGHT","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.TOP_RIGHT","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a left-top alignment or position.","kind":"constant","name":"LEFT_TOP","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.LEFT_TOP","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a left-center alignment or position.","kind":"constant","name":"LEFT_CENTER","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.LEFT_CENTER","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a left-bottom alignment or position.","kind":"constant","name":"LEFT_BOTTOM","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.LEFT_BOTTOM","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a center alignment or position.","kind":"constant","name":"CENTER","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.CENTER","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a right-top alignment or position.","kind":"constant","name":"RIGHT_TOP","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.RIGHT_TOP","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a right-center alignment or position.","kind":"constant","name":"RIGHT_CENTER","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.RIGHT_CENTER","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a right-bottom alignment or position.","kind":"constant","name":"RIGHT_BOTTOM","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.RIGHT_BOTTOM","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":99,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a bottom-left alignment or position.","kind":"constant","name":"BOTTOM_LEFT","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.BOTTOM_LEFT","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a bottom-center alignment or position.","kind":"constant","name":"BOTTOM_CENTER","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.BOTTOM_CENTER","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"description":"A constant representing a bottom-right alignment or position.","kind":"constant","name":"BOTTOM_RIGHT","since":"3.0.0","type":{"names":["integer"]},"memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.BOTTOM_RIGHT","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"BottomCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BottomCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the bottom center of the other.","kind":"function","name":"BottomCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.BottomCenter","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"BottomLeft.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BottomLeft.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the bottom left of the other.","kind":"function","name":"BottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.BottomLeft","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"BottomRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BottomRight.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the bottom right of the other.","kind":"function","name":"BottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.BottomRight","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"Center.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"CenterOn","longname":"CenterOn","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Center.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the center of the other.","kind":"function","name":"Center","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.Center","scope":"static","___s":true},{"meta":{"range":[180,227],"filename":"LeftCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetCenterY","longname":"GetCenterY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LeftCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the left center of the other.","kind":"function","name":"LeftCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.LeftCenter","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"QuickSet.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"ALIGN_CONST","longname":"ALIGN_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuickSet.js","lineno":25,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned relative to the other.\nThe alignment used is based on the `position` argument, which is an `ALIGN_CONST` value, such as `LEFT_CENTER` or `TOP_RIGHT`.","kind":"function","name":"QuickSet","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"child"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["integer"]},"description":"The position to align the Game Object with. This is an align constant, such as `ALIGN_CONST.LEFT_CENTER`.","name":"position"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.QuickSet","scope":"static","___s":true},{"meta":{"range":[180,227],"filename":"RightCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetCenterY","longname":"GetCenterY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RightCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the right center of the other.","kind":"function","name":"RightCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.RightCenter","scope":"static","___s":true},{"meta":{"range":[180,227],"filename":"TopCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetCenterX","longname":"GetCenterX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TopCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the top center of the other.","kind":"function","name":"TopCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.TopCenter","scope":"static","___s":true},{"meta":{"range":[180,221],"filename":"TopLeft.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetLeft","longname":"GetLeft","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TopLeft.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the top left of the other.","kind":"function","name":"TopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.TopLeft","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"TopRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"name":"GetRight","longname":"GetRight","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TopRight.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"description":"Takes given Game Object and aligns it so that it is positioned in the top right of the other.","kind":"function","name":"TopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignIn"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.In","longname":"Phaser.Display.Align.In.TopRight","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/in"},"kind":"namespace","name":"In","memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.In","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align"},"kind":"namespace","name":"Align","memberof":"Phaser.Display","longname":"Phaser.Display.Align","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"BottomCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BottomCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the bottom center position of the other.","kind":"function","name":"BottomCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.BottomCenter","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"BottomLeft.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BottomLeft.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the bottom left position of the other.","kind":"function","name":"BottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.BottomLeft","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"BottomRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BottomRight.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the bottom right position of the other.","kind":"function","name":"BottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.BottomRight","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"LeftBottom.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LeftBottom.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the left bottom position of the other.","kind":"function","name":"LeftBottom","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.LeftBottom","scope":"static","___s":true},{"meta":{"range":[180,227],"filename":"LeftCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetCenterY","longname":"GetCenterY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LeftCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the left center position of the other.","kind":"function","name":"LeftCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.LeftCenter","scope":"static","___s":true},{"meta":{"range":[180,221],"filename":"LeftTop.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetLeft","longname":"GetLeft","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LeftTop.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the left top position of the other.","kind":"function","name":"LeftTop","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.LeftTop","scope":"static","___s":true},{"meta":{"range":[149,182],"filename":"QuickSet.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"ALIGN_CONST","longname":"ALIGN_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuickSet.js","lineno":24,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes a Game Object and aligns it next to another, at the given position.\nThe alignment used is based on the `position` argument, which is a `Phaser.Display.Align` property such as `LEFT_CENTER` or `TOP_RIGHT`.","kind":"function","name":"QuickSet","since":"3.22.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"child"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["integer"]},"description":"The position to align the Game Object with. This is an align constant, such as `Phaser.Display.Align.LEFT_CENTER`.","name":"position"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.QuickSet","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"RightBottom.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetBottom","longname":"GetBottom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RightBottom.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the right bottom position of the other.","kind":"function","name":"RightBottom","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.RightBottom","scope":"static","___s":true},{"meta":{"range":[180,227],"filename":"RightCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetCenterY","longname":"GetCenterY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RightCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the right center position of the other.","kind":"function","name":"RightCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.RightCenter","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"RightTop.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetRight","longname":"GetRight","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RightTop.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the right top position of the other.","kind":"function","name":"RightTop","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.RightTop","scope":"static","___s":true},{"meta":{"range":[180,227],"filename":"TopCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetCenterX","longname":"GetCenterX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TopCenter.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the top center position of the other.","kind":"function","name":"TopCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.TopCenter","scope":"static","___s":true},{"meta":{"range":[180,221],"filename":"TopLeft.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetLeft","longname":"GetLeft","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TopLeft.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the top left position of the other.","kind":"function","name":"TopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.TopLeft","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"TopRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"name":"GetRight","longname":"GetRight","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TopRight.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"description":"Takes given Game Object and aligns it so that it is positioned next to the top right position of the other.","kind":"function","name":"TopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be positioned.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to base the alignment position on.","name":"alignTo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset from the position.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset from the position.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was aligned."}],"memberof":"Phaser.Display.Align.To","longname":"Phaser.Display.Align.To.TopRight","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/align/to"},"kind":"namespace","name":"To","memberof":"Phaser.Display.Align","longname":"Phaser.Display.Align.To","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"CenterOn.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"name":"SetCenterX","longname":"SetCenterX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CenterOn.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that it is centered on the given coordinates.","kind":"function","name":"CenterOn","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The horizontal coordinate to position the Game Object on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to position the Game Object on.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.CenterOn","scope":"static","___s":true},{"meta":{"filename":"GetBottom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the bottom coordinate from the bounds of the Game Object.","kind":"function","name":"GetBottom","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The bottom coordinate of the bounds of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetBottom","scope":"static","___s":true},{"meta":{"filename":"GetCenterX.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the center x coordinate from the bounds of the Game Object.","kind":"function","name":"GetCenterX","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The center x coordinate of the bounds of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetCenterX","scope":"static","___s":true},{"meta":{"filename":"GetCenterY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the center y coordinate from the bounds of the Game Object.","kind":"function","name":"GetCenterY","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The center y coordinate of the bounds of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetCenterY","scope":"static","___s":true},{"meta":{"filename":"GetLeft.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the left coordinate from the bounds of the Game Object.","kind":"function","name":"GetLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The left coordinate of the bounds of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetLeft","scope":"static","___s":true},{"meta":{"filename":"GetOffsetX.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the amount the Game Object is visually offset from its x coordinate.\nThis is the same as `width * origin.x`.\nThis value will only be > 0 if `origin.x` is not equal to zero.","kind":"function","name":"GetOffsetX","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The horizontal offset of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetOffsetX","scope":"static","___s":true},{"meta":{"filename":"GetOffsetY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the amount the Game Object is visually offset from its y coordinate.\nThis is the same as `width * origin.y`.\nThis value will only be > 0 if `origin.y` is not equal to zero.","kind":"function","name":"GetOffsetY","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The vertical offset of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetOffsetY","scope":"static","___s":true},{"meta":{"filename":"GetRight.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the right coordinate from the bounds of the Game Object.","kind":"function","name":"GetRight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The right coordinate of the bounds of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetRight","scope":"static","___s":true},{"meta":{"filename":"GetTop.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Returns the top coordinate from the bounds of the Game Object.","kind":"function","name":"GetTop","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to get the bounds value from.","name":"gameObject"}],"returns":[{"type":{"names":["number"]},"description":"The top coordinate of the bounds of the Game Object."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.GetTop","scope":"static","___s":true},{"meta":{"filename":"SetBottom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that the bottom of its bounds aligns with the given coordinate.","kind":"function","name":"SetBottom","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The coordinate to position the Game Object bounds on.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.SetBottom","scope":"static","___s":true},{"meta":{"filename":"SetCenterX.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that the center top of its bounds aligns with the given coordinate.","kind":"function","name":"SetCenterX","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The coordinate to position the Game Object bounds on.","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.SetCenterX","scope":"static","___s":true},{"meta":{"filename":"SetCenterY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that the center top of its bounds aligns with the given coordinate.","kind":"function","name":"SetCenterY","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The coordinate to position the Game Object bounds on.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.SetCenterY","scope":"static","___s":true},{"meta":{"filename":"SetLeft.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that the left of its bounds aligns with the given coordinate.","kind":"function","name":"SetLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The coordinate to position the Game Object bounds on.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.SetLeft","scope":"static","___s":true},{"meta":{"filename":"SetRight.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that the left of its bounds aligns with the given coordinate.","kind":"function","name":"SetRight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The coordinate to position the Game Object bounds on.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.SetRight","scope":"static","___s":true},{"meta":{"filename":"SetTop.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"description":"Positions the Game Object so that the top of its bounds aligns with the given coordinate.","kind":"function","name":"SetTop","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will be re-positioned.","name":"gameObject"},{"type":{"names":["number"]},"description":"The coordinate to position the Game Object bounds on.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was positioned."}],"memberof":"Phaser.Display.Bounds","longname":"Phaser.Display.Bounds.SetTop","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/bounds"},"kind":"namespace","name":"Bounds","memberof":"Phaser.Display","longname":"Phaser.Display.Bounds","scope":"static","___s":true},{"meta":{"filename":"CanvasInterpolation.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"kind":"namespace","name":"CanvasInterpolation","since":"3.0.0","memberof":"Phaser.Display.Canvas","longname":"Phaser.Display.Canvas.CanvasInterpolation","scope":"static","___s":true},{"meta":{"filename":"CanvasInterpolation.js","lineno":13,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Sets the CSS image-rendering property on the given canvas to be 'crisp' (aka 'optimize contrast' on webkit).","kind":"function","name":"setCrisp","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas object to have the style set on.","name":"canvas"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas."}],"memberof":"Phaser.Display.Canvas.CanvasInterpolation","longname":"Phaser.Display.Canvas.CanvasInterpolation.setCrisp","scope":"static","___s":true},{"meta":{"filename":"CanvasInterpolation.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Sets the CSS image-rendering property on the given canvas to be 'bicubic' (aka 'auto').","kind":"function","name":"setBicubic","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas object to have the style set on.","name":"canvas"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas."}],"memberof":"Phaser.Display.Canvas.CanvasInterpolation","longname":"Phaser.Display.Canvas.CanvasInterpolation.setBicubic","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"CanvasPool.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CanvasPool.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"The CanvasPool is a global static object, that allows Phaser to recycle and pool 2D Context Canvas DOM elements.\nIt does not pool WebGL Contexts, because once the context options are set they cannot be modified again, \nwhich is useless for some of the Phaser pipelines / renderer.\n\nThis singleton is instantiated as soon as Phaser loads, before a Phaser.Game instance has even been created.\nWhich means all instances of Phaser Games on the same page can share the one single pool.","kind":"namespace","name":"CanvasPool","since":"3.0.0","memberof":"Phaser.Display.Canvas","longname":"Phaser.Display.Canvas.CanvasPool","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":29,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Creates a new Canvas DOM element, or pulls one from the pool if free.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The parent of the Canvas object.","name":"parent"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The width of the Canvas.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The height of the Canvas.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Phaser.CANVAS","description":"The type of the Canvas. Either `Phaser.CANVAS` or `Phaser.WEBGL`.","name":"canvasType"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use the generated Canvas element as the parent?","name":"selfParent"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas element that was created or pulled from the pool"}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.create","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Creates a new Canvas DOM element, or pulls one from the pool if free.","kind":"function","name":"create2D","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The parent of the Canvas object.","name":"parent"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The width of the Canvas.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The height of the Canvas.","name":"height"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The created canvas."}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.create2D","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Creates a new Canvas DOM element, or pulls one from the pool if free.","kind":"function","name":"createWebGL","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The parent of the Canvas object.","name":"parent"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The width of the Canvas.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The height of the Canvas.","name":"height"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The created WebGL canvas."}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.createWebGL","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Gets the first free canvas index from the pool.","kind":"function","name":"first","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Phaser.CANVAS","description":"The type of the Canvas. Either `Phaser.CANVAS` or `Phaser.WEBGL`.","name":"canvasType"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The first free canvas, or `null` if a WebGL canvas was requested or if the pool doesn't have free canvases."}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.first","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Looks up a canvas based on its parent, and if found puts it back in the pool, freeing it up for re-use.\nThe canvas has its width and height set to 1, and its parent attribute nulled.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The canvas or the parent of the canvas to free.","name":"parent"}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.remove","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Gets the total number of used canvas elements in the pool.","kind":"function","name":"total","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of used canvases."}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.total","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":205,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Gets the total number of free canvas elements in the pool.","kind":"function","name":"free","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of free canvases."}],"memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.free","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":218,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Disable context smoothing on any new Canvas element created.","kind":"function","name":"disableSmoothing","since":"3.0.0","memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.disableSmoothing","scope":"static","___s":true},{"meta":{"filename":"CanvasPool.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Enable context smoothing on any new Canvas element created.","kind":"function","name":"enableSmoothing","since":"3.0.0","memberof":"Phaser.Display.Canvas.CanvasPool","longname":"Phaser.Display.Canvas.CanvasPool.enableSmoothing","scope":"static","___s":true},{"meta":{"filename":"Smoothing.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"kind":"namespace","name":"Smoothing","since":"3.0.0","memberof":"Phaser.Display.Canvas","longname":"Phaser.Display.Canvas.Smoothing","scope":"static","___s":true},{"meta":{"filename":"Smoothing.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Gets the Smoothing Enabled vendor prefix being used on the given context, or null if not set.","kind":"function","name":"getPrefix","since":"3.0.0","params":[{"type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"description":"The canvas context to check.","name":"context"}],"returns":[{"type":{"names":["string"]},"description":"The name of the property on the context which controls image smoothing (either `imageSmoothingEnabled` or a vendor-prefixed version thereof), or `null` if not supported."}],"memberof":"Phaser.Display.Canvas.Smoothing","longname":"Phaser.Display.Canvas.Smoothing.getPrefix","scope":"static","___s":true},{"meta":{"filename":"Smoothing.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.\nBy default browsers have image smoothing enabled, which isn't always what you visually want, especially\nwhen using pixel art in a game. Note that this sets the property on the context itself, so that any image\ndrawn to the context will be affected. This sets the property across all current browsers but support is\npatchy on earlier browsers, especially on mobile.","kind":"function","name":"enable","since":"3.0.0","params":[{"type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"description":"The context on which to enable smoothing.","name":"context"}],"returns":[{"type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"description":"The provided context."}],"memberof":"Phaser.Display.Canvas.Smoothing","longname":"Phaser.Display.Canvas.Smoothing.enable","scope":"static","___s":true},{"meta":{"filename":"Smoothing.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.\nBy default browsers have image smoothing enabled, which isn't always what you visually want, especially\nwhen using pixel art in a game. Note that this sets the property on the context itself, so that any image\ndrawn to the context will be affected. This sets the property across all current browsers but support is\npatchy on earlier browsers, especially on mobile.","kind":"function","name":"disable","since":"3.0.0","params":[{"type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"description":"The context on which to disable smoothing.","name":"context"}],"returns":[{"type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"description":"The provided context."}],"memberof":"Phaser.Display.Canvas.Smoothing","longname":"Phaser.Display.Canvas.Smoothing.disable","scope":"static","___s":true},{"meta":{"filename":"Smoothing.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Returns `true` if the given context has image smoothing enabled, otherwise returns `false`.\nReturns null if no smoothing prefix is available.","kind":"function","name":"isEnabled","since":"3.0.0","params":[{"type":{"names":["CanvasRenderingContext2D","WebGLRenderingContext"]},"description":"The context to check.","name":"context"}],"returns":[{"type":{"names":["boolean"]},"nullable":true,"description":"`true` if smoothing is enabled on the context, otherwise `false`. `null` if not supported."}],"memberof":"Phaser.Display.Canvas.Smoothing","longname":"Phaser.Display.Canvas.Smoothing.isEnabled","scope":"static","___s":true},{"meta":{"filename":"TouchAction.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Sets the touch-action property on the canvas style. Can be used to disable default browser touch actions.","kind":"function","name":"TouchAction","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas element to have the style applied to.","name":"canvas"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'none'","description":"The touch action value to set on the canvas. Set to `none` to disable touch actions.","name":"value"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas element."}],"memberof":"Phaser.Display.Canvas","longname":"Phaser.Display.Canvas.TouchAction","scope":"static","___s":true},{"meta":{"filename":"UserSelect.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"description":"Sets the user-select property on the canvas style. Can be used to disable default browser selection actions.","kind":"function","name":"UserSelect","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas element to have the style applied to.","name":"canvas"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'none'","description":"The touch callout value to set on the canvas. Set to `none` to disable touch callouts.","name":"value"}],"returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas element."}],"memberof":"Phaser.Display.Canvas","longname":"Phaser.Display.Canvas.UserSelect","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/canvas"},"kind":"namespace","name":"Canvas","memberof":"Phaser.Display","longname":"Phaser.Display.Canvas","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Color.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Color.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"kind":"namespace","name":"Color","memberof":"Phaser.Display","longname":"Phaser.Display.Color","scope":"static","___s":true},{"meta":{"filename":"Color.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"classdesc":"The Color class holds a single color value and allows for easy modification and reading of it.","kind":"class","name":"Color","memberof":"Phaser.Display","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The red color value. A number between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The green color value. A number between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The blue color value. A number between 0 and 255.","name":"blue"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The alpha value. A number between 0 and 255.","name":"alpha"}],"scope":"static","longname":"Phaser.Display.Color","___s":true},{"meta":{"filename":"Color.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"An array containing the calculated color values for WebGL use.","name":"gl","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#gl","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":177,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets this color to be transparent. Sets all values to zero.","kind":"function","name":"transparent","since":"3.0.0","returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#transparent","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":199,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets the color of this Color component.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The red color value. A number between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"description":"The green color value. A number between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color value. A number between 0 and 255.","name":"blue"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The alpha value. A number between 0 and 255.","name":"alpha"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Update the HSV values after setting the RGB values?","name":"updateHSV"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#setTo","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":230,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets the red, green, blue and alpha GL values of this Color component.","kind":"function","name":"setGLTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The red color value. A number between 0 and 1.","name":"red"},{"type":{"names":["number"]},"description":"The green color value. A number between 0 and 1.","name":"green"},{"type":{"names":["number"]},"description":"The blue color value. A number between 0 and 1.","name":"blue"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value. A number between 0 and 1.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#setGLTo","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets the color based on the color object given.","kind":"function","name":"setFromRGB","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Display.InputColorObject"]},"description":"An object containing `r`, `g`, `b` and optionally `a` values in the range 0 to 255.","name":"color"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#setFromRGB","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets the color based on the hue, saturation and lightness values given.","kind":"function","name":"setFromHSV","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The hue, in the range 0 - 1. This is the base color.","name":"h"},{"type":{"names":["number"]},"description":"The saturation, in the range 0 - 1. This controls how much of the hue will be in the final color, where 1 is fully saturated and 0 will give you white.","name":"s"},{"type":{"names":["number"]},"description":"The value, in the range 0 - 1. This controls how dark the color is. Where 1 is as bright as possible and 0 is black.","name":"v"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#setFromHSV","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Returns a new Color component using the values from this one.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A new Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#clone","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets this Color object to be grayscaled based on the shade value given.","kind":"function","name":"gray","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"A value between 0 and 255.","name":"shade"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#gray","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":387,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets this Color object to be a random color between the `min` and `max` values given.","kind":"function","name":"random","since":"3.13.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The minimum random color value. Between 0 and 255.","name":"min"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The maximum random color value. Between 0 and 255.","name":"max"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#random","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Sets this Color object to be a random grayscale color between the `min` and `max` values given.","kind":"function","name":"randomGray","since":"3.13.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The minimum random color value. Between 0 and 255.","name":"min"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The maximum random color value. Between 0 and 255.","name":"max"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#randomGray","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Increase the saturation of this Color by the percentage amount given.\nThe saturation is the amount of the base color in the hue.","kind":"function","name":"saturate","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The percentage amount to change this color by. A value between 0 and 100.","name":"amount"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#saturate","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Decrease the saturation of this Color by the percentage amount given.\nThe saturation is the amount of the base color in the hue.","kind":"function","name":"desaturate","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The percentage amount to change this color by. A value between 0 and 100.","name":"amount"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#desaturate","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":467,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Increase the lightness of this Color by the percentage amount given.","kind":"function","name":"lighten","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The percentage amount to change this color by. A value between 0 and 100.","name":"amount"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#lighten","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":484,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Decrease the lightness of this Color by the percentage amount given.","kind":"function","name":"darken","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The percentage amount to change this color by. A value between 0 and 100.","name":"amount"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#darken","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Brighten this Color by the percentage amount given.","kind":"function","name":"brighten","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The percentage amount to change this color by. A value between 0 and 100.","name":"amount"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"This Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#brighten","scope":"instance","___s":true},{"meta":{"filename":"Color.js","lineno":524,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The color of this Color component, not including the alpha channel.","name":"color","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#color","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The color of this Color component, including the alpha channel.","name":"color32","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#color32","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":558,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The color of this Color component as a string which can be used in CSS color values.","name":"rgba","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#rgba","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":575,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The red color value, normalized to the range 0 to 1.","name":"redGL","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#redGL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":600,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The green color value, normalized to the range 0 to 1.","name":"greenGL","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#greenGL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The blue color value, normalized to the range 0 to 1.","name":"blueGL","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#blueGL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":650,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The alpha color value, normalized to the range 0 to 1.","name":"alphaGL","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#alphaGL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":675,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The red color value, normalized to the range 0 to 255.","name":"red","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#red","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":702,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The green color value, normalized to the range 0 to 255.","name":"green","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#green","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":729,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The blue color value, normalized to the range 0 to 255.","name":"blue","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#blue","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":756,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The alpha color value, normalized to the range 0 to 255.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":783,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The hue color value. A number between 0 and 1.\nThis is the base color.","name":"h","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#h","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":807,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The saturation color value. A number between 0 and 1.\nThis controls how much of the hue will be in the final color, where 1 is fully saturated and 0 will give you white.","name":"s","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#s","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Color.js","lineno":831,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"The lightness color value. A number between 0 and 1.\nThis controls how dark the color is. Where 1 is as bright as possible and 0 is black.","name":"v","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color#v","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ColorToRGBA.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts the given color value into an Object containing r,g,b and a properties.","kind":"function","name":"ColorToRGBA","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A color value, optionally including the alpha value.","name":"color"}],"returns":[{"type":{"names":["Phaser.Types.Display.ColorObject"]},"description":"An object containing the parsed color values."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.ColorToRGBA","scope":"static","___s":true},{"meta":{"filename":"ComponentToHex.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Returns a string containing a hex representation of the given color component.","kind":"function","name":"ComponentToHex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The color channel to get the hex value for, must be a value between 0 and 255.","name":"color"}],"returns":[{"type":{"names":["string"]},"description":"A string of length 2 characters, i.e. 255 = ff, 100 = 64."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.ComponentToHex","scope":"static","___s":true},{"meta":{"filename":"GetColor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Given 3 separate color values this will return an integer representation of it.","kind":"function","name":"GetColor","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The red color value. A number between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"description":"The green color value. A number between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color value. A number between 0 and 255.","name":"blue"}],"returns":[{"type":{"names":["number"]},"description":"The combined color value."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.GetColor","scope":"static","___s":true},{"meta":{"filename":"GetColor32.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Given an alpha and 3 color values this will return an integer representation of it.","kind":"function","name":"GetColor32","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The red color value. A number between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"description":"The green color value. A number between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color value. A number between 0 and 255.","name":"blue"},{"type":{"names":["integer"]},"description":"The alpha color value. A number between 0 and 255.","name":"alpha"}],"returns":[{"type":{"names":["number"]},"description":"The combined color value."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.GetColor32","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"HSLToColor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Color","longname":"Color","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HSLToColor.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts HSL (hue, saturation and lightness) values to a Phaser Color object.","kind":"function","name":"HSLToColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The hue value in the range 0 to 1.","name":"h"},{"type":{"names":["number"]},"description":"The saturation value in the range 0 to 1.","name":"s"},{"type":{"names":["number"]},"description":"The lightness value in the range 0 to 1.","name":"l"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object created from the results of the h, s and l values."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.HSLToColor","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"HSVColorWheel.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"HSVToRGB","longname":"HSVToRGB","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HSVColorWheel.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Get HSV color wheel values in an array which will be 360 elements in size.","kind":"function","name":"HSVColorWheel","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The saturation, in the range 0 - 1.","name":"s"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The value, in the range 0 - 1.","name":"v"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing 360 elements, where each contains a single numeric value corresponding to the color at that point in the HSV color wheel."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.HSVColorWheel","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"HSVToRGB.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"GetColor","longname":"GetColor","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HSVToRGB.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts an HSV (hue, saturation and value) color value to RGB.\nConversion formula from http://en.wikipedia.org/wiki/HSL_color_space.\nAssumes HSV values are contained in the set [0, 1].\nBased on code by Michael Jackson (https://github.com/mjijackson)","kind":"function","name":"HSVToRGB","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The hue, in the range 0 - 1. This is the base color.","name":"h"},{"type":{"names":["number"]},"description":"The saturation, in the range 0 - 1. This controls how much of the hue will be in the final color, where 1 is fully saturated and 0 will give you white.","name":"s"},{"type":{"names":["number"]},"description":"The value, in the range 0 - 1. This controls how dark the color is. Where 1 is as bright as possible and 0 is black.","name":"v"},{"type":{"names":["Phaser.Types.Display.ColorObject","Phaser.Display.Color"]},"optional":true,"description":"A Color object to store the results in. If not given a new ColorObject will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Types.Display.ColorObject","Phaser.Display.Color"]},"description":"An object with the red, green and blue values set in the r, g and b properties."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.HSVToRGB","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"HexStringToColor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Color","longname":"Color","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HexStringToColor.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts a hex string into a Phaser Color object.\n\nThe hex string can supplied as `'#0033ff'` or the short-hand format of `'#03f'`; it can begin with an optional \"#\" or \"0x\", or be unprefixed.\n\nAn alpha channel is _not_ supported.","kind":"function","name":"HexStringToColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The hex color value to convert, such as `#0033ff` or the short-hand format: `#03f`.","name":"hex"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object populated by the values of the given string."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.HexStringToColor","scope":"static","___s":true},{"meta":{"filename":"HueToComponent.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts a hue to an RGB color.\nBased on code by Michael Jackson (https://github.com/mjijackson)","kind":"function","name":"HueToComponent","since":"3.0.0","params":[{"type":{"names":["number"]},"name":"p"},{"type":{"names":["number"]},"name":"q"},{"type":{"names":["number"]},"name":"t"}],"returns":[{"type":{"names":["number"]},"description":"The combined color value."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.HueToComponent","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"IntegerToColor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Color","longname":"Color","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IntegerToColor.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts the given color value into an instance of a Color object.","kind":"function","name":"IntegerToColor","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The color value to convert into a Color object.","name":"input"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.IntegerToColor","scope":"static","___s":true},{"meta":{"filename":"IntegerToRGB.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Return the component parts of a color as an Object with the properties alpha, red, green, blue.\n\nAlpha will only be set if it exists in the given color (0xAARRGGBB)","kind":"function","name":"IntegerToRGB","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The color value to convert into a Color object.","name":"input"}],"returns":[{"type":{"names":["Phaser.Types.Display.ColorObject"]},"description":"An object with the red, green and blue values set in the r, g and b properties."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.IntegerToRGB","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"Interpolate.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Linear","longname":"Linear","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Interpolate.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"kind":"namespace","name":"Interpolate","memberof":"Phaser.Display.Color","since":"3.0.0","longname":"Phaser.Display.Color.Interpolate","scope":"static","___s":true},{"meta":{"filename":"Interpolate.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Interpolates between the two given color ranges over the length supplied.","kind":"function","name":"RGBWithRGB","memberof":"Phaser.Display.Color.Interpolate","scope":"static","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Red value.","name":"r1"},{"type":{"names":["number"]},"description":"Blue value.","name":"g1"},{"type":{"names":["number"]},"description":"Green value.","name":"b1"},{"type":{"names":["number"]},"description":"Red value.","name":"r2"},{"type":{"names":["number"]},"description":"Blue value.","name":"g2"},{"type":{"names":["number"]},"description":"Green value.","name":"b2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"Distance to interpolate over.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Index to start from.","name":"index"}],"returns":[{"type":{"names":["Phaser.Types.Display.ColorObject"]},"description":"An object containing the interpolated color values."}],"longname":"Phaser.Display.Color.Interpolate.RGBWithRGB","___s":true},{"meta":{"filename":"Interpolate.js","lineno":48,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Interpolates between the two given color objects over the length supplied.","kind":"function","name":"ColorWithColor","memberof":"Phaser.Display.Color.Interpolate","scope":"static","since":"3.0.0","params":[{"type":{"names":["Phaser.Display.Color"]},"description":"The first Color object.","name":"color1"},{"type":{"names":["Phaser.Display.Color"]},"description":"The second Color object.","name":"color2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"Distance to interpolate over.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Index to start from.","name":"index"}],"returns":[{"type":{"names":["Phaser.Types.Display.ColorObject"]},"description":"An object containing the interpolated color values."}],"longname":"Phaser.Display.Color.Interpolate.ColorWithColor","___s":true},{"meta":{"filename":"Interpolate.js","lineno":71,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Interpolates between the Color object and color values over the length supplied.","kind":"function","name":"ColorWithRGB","memberof":"Phaser.Display.Color.Interpolate","scope":"static","since":"3.0.0","params":[{"type":{"names":["Phaser.Display.Color"]},"description":"The first Color object.","name":"color1"},{"type":{"names":["number"]},"description":"Red value.","name":"r"},{"type":{"names":["number"]},"description":"Blue value.","name":"g"},{"type":{"names":["number"]},"description":"Green value.","name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"Distance to interpolate over.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Index to start from.","name":"index"}],"returns":[{"type":{"names":["Phaser.Types.Display.ColorObject"]},"description":"An object containing the interpolated color values."}],"longname":"Phaser.Display.Color.Interpolate.ColorWithRGB","___s":true},{"meta":{"range":[180,206],"filename":"ObjectToColor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Color","longname":"Color","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ObjectToColor.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts an object containing `r`, `g`, `b` and `a` properties into a Color class instance.","kind":"function","name":"ObjectToColor","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Display.InputColorObject"]},"description":"An object containing `r`, `g`, `b` and `a` properties in the range 0 to 255.","name":"input"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.ObjectToColor","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"RGBStringToColor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Color","longname":"Color","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RGBStringToColor.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts a CSS 'web' string into a Phaser Color object.\n\nThe web string can be in the format `'rgb(r,g,b)'` or `'rgba(r,g,b,a)'` where r/g/b are in the range [0..255] and a is in the range [0..1].","kind":"function","name":"RGBStringToColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The CSS format color string, using the `rgb` or `rgba` format.","name":"rgb"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.RGBStringToColor","scope":"static","___s":true},{"meta":{"filename":"RGBToHSV.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts an RGB color value to HSV (hue, saturation and value).\nConversion formula from http://en.wikipedia.org/wiki/HSL_color_space.\nAssumes RGB values are contained in the set [0, 255] and returns h, s and v in the set [0, 1].\nBased on code by Michael Jackson (https://github.com/mjijackson)","kind":"function","name":"RGBToHSV","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The red color value. A number between 0 and 255.","name":"r"},{"type":{"names":["integer"]},"description":"The green color value. A number between 0 and 255.","name":"g"},{"type":{"names":["integer"]},"description":"The blue color value. A number between 0 and 255.","name":"b"},{"type":{"names":["Phaser.Types.Display.HSVColorObject","Phaser.Display.Color"]},"optional":true,"description":"An object to store the color values in. If not given an HSV Color Object will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Types.Display.HSVColorObject","Phaser.Display.Color"]},"description":"An object with the properties `h`, `s` and `v` set."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.RGBToHSV","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"RGBToString.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"ComponentToHex","longname":"ComponentToHex","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RGBToString.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts the color values into an HTML compatible color string, prefixed with either `#` or `0x`.","kind":"function","name":"RGBToString","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The red color value. A number between 0 and 255.","name":"r"},{"type":{"names":["integer"]},"description":"The green color value. A number between 0 and 255.","name":"g"},{"type":{"names":["integer"]},"description":"The blue color value. A number between 0 and 255.","name":"b"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The alpha value. A number between 0 and 255.","name":"a"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"#","description":"The prefix of the string. Either `#` or `0x`.","name":"prefix"}],"returns":[{"type":{"names":["string"]},"description":"A string-based representation of the color values."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.RGBToString","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"RandomRGB.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Between","longname":"Between","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomRGB.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Creates a new Color object where the r, g, and b values have been set to random values\nbased on the given min max values.","kind":"function","name":"RandomRGB","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The minimum value to set the random range from (between 0 and 255)","name":"min"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The maximum value to set the random range from (between 0 and 255)","name":"max"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.RandomRGB","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"ValueToColor.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"HexStringToColor","longname":"HexStringToColor","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ValueToColor.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"description":"Converts the given source color value into an instance of a Color class.\nThe value can be either a string, prefixed with `rgb` or a hex string, a number or an Object.","kind":"function","name":"ValueToColor","since":"3.0.0","params":[{"type":{"names":["string","number","Phaser.Types.Display.InputColorObject"]},"description":"The source color value to convert.","name":"input"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"A Color object."}],"memberof":"Phaser.Display.Color","longname":"Phaser.Display.Color.ValueToColor","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/color"},"name":"Color","longname":"Color","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display"},"kind":"namespace","name":"Display","memberof":"Phaser","longname":"Phaser.Display","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"BitmapMask.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapMask.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"classdesc":"A Bitmap Mask combines the alpha (opacity) of a masked pixel with the alpha of another pixel.\nUnlike the Geometry Mask, which is a clipping path, a Bitmap Mask behaves like an alpha mask,\nnot a clipping path. It is only available when using the WebGL Renderer.\n\nA Bitmap Mask can use any Game Object to determine the alpha of each pixel of the masked Game Object(s).\nFor any given point of a masked Game Object's texture, the pixel's alpha will be multiplied by the alpha\nof the pixel at the same position in the Bitmap Mask's Game Object. The color of the pixel from the\nBitmap Mask doesn't matter.\n\nFor example, if a pure blue pixel with an alpha of 0.95 is masked with a pure red pixel with an\nalpha of 0.5, the resulting pixel will be pure blue with an alpha of 0.475. Naturally, this means\nthat a pixel in the mask with an alpha of 0 will hide the corresponding pixel in all masked Game Objects\n A pixel with an alpha of 1 in the masked Game Object will receive the same alpha as the\ncorresponding pixel in the mask.\n\nThe Bitmap Mask's location matches the location of its Game Object, not the location of the\nmasked objects. Moving or transforming the underlying Game Object will change the mask\n(and affect the visibility of any masked objects), whereas moving or transforming a masked object\nwill not affect the mask.\n\nThe Bitmap Mask will not render its Game Object by itself. If the Game Object is not in a\nScene's display list, it will only be used for the mask and its full texture will not be directly\nvisible. Adding the underlying Game Object to a Scene will not cause any problems - it will\nrender as a normal Game Object and will also serve as a mask.","kind":"class","name":"BitmapMask","memberof":"Phaser.Display.Masks","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene which this Bitmap Mask will be used in.","name":"scene"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"scope":"static","longname":"Phaser.Display.Masks.BitmapMask","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"A reference to either the Canvas or WebGL Renderer that this Mask is using.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.11.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"bitmapMask","type":{"names":["Phaser.GameObjects.GameObject"]},"since":"3.0.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#bitmapMask","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"The texture used for the mask's framebuffer.","name":"maskTexture","type":{"names":["WebGLTexture"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#maskTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"The texture used for the main framebuffer.","name":"mainTexture","type":{"names":["WebGLTexture"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#mainTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Whether the Bitmap Mask is dirty and needs to be updated.","name":"dirty","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"The framebuffer to which a masked Game Object is rendered.","name":"mainFramebuffer","type":{"names":["WebGLFramebuffer"]},"since":"3.0.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#mainFramebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"The framebuffer to which the Bitmap Mask's masking Game Object is rendered.","name":"maskFramebuffer","type":{"names":["WebGLFramebuffer"]},"since":"3.0.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#maskFramebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"The previous framebuffer set in the renderer before this one was enabled.","name":"prevFramebuffer","type":{"names":["WebGLFramebuffer"]},"since":"3.17.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#prevFramebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Whether to invert the masks alpha.\n\nIf `true`, the alpha of the masking pixel will be inverted before it's multiplied with the masked pixel. Essentially, this means that a masked area will be visible only if the corresponding area in the mask is invisible.","name":"invertAlpha","type":{"names":["boolean"]},"since":"3.1.2","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#invertAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":139,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Is this mask a stencil mask?","name":"isStencil","type":{"names":["boolean"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#isStencil","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Sets a new masking Game Object for the Bitmap Mask.","kind":"function","name":"setBitmap","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#setBitmap","scope":"instance","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":194,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Prepares the WebGL Renderer to render a Game Object with this mask applied.\n\nThis renders the masking Game Object to the mask framebuffer and switches to the main framebuffer so that the masked Game Object will be rendered to it instead of being rendered directly to the frame.","kind":"function","name":"preRenderWebGL","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The WebGL Renderer to prepare.","name":"renderer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The masked Game Object which will be drawn.","name":"maskedObject"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to render to.","name":"camera"}],"memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#preRenderWebGL","scope":"instance","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":211,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Finalizes rendering of a masked Game Object.\n\nThis resets the previously bound framebuffer and switches the WebGL Renderer to the Bitmap Mask Pipeline, which uses a special fragment shader to apply the masking effect.","kind":"function","name":"postRenderWebGL","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The WebGL Renderer to clean up.","name":"renderer"}],"memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#postRenderWebGL","scope":"instance","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":226,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"This is a NOOP method. Bitmap Masks are not supported by the Canvas Renderer.","kind":"function","name":"preRenderCanvas","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The Canvas Renderer which would be rendered to.","name":"renderer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The masked Game Object which would be rendered.","name":"mask"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to render to.","name":"camera"}],"memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#preRenderCanvas","scope":"instance","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"This is a NOOP method. Bitmap Masks are not supported by the Canvas Renderer.","kind":"function","name":"postRenderCanvas","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The Canvas Renderer which would be rendered to.","name":"renderer"}],"memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#postRenderCanvas","scope":"instance","___s":true},{"meta":{"filename":"BitmapMask.js","lineno":254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Destroys this BitmapMask and nulls any references it holds.\n\nNote that if a Game Object is currently using this mask it will _not_ automatically detect you have destroyed it,\nso be sure to call `clearMask` on any Game Object using it, before destroying it.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Display.Masks.BitmapMask","longname":"Phaser.Display.Masks.BitmapMask#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"GeometryMask.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GeometryMask.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"classdesc":"A Geometry Mask can be applied to a Game Object to hide any pixels of it which don't intersect\na visible pixel from the geometry mask. The mask is essentially a clipping path which can only\nmake a masked pixel fully visible or fully invisible without changing its alpha (opacity).\n\nA Geometry Mask uses a Graphics Game Object to determine which pixels of the masked Game Object(s)\nshould be clipped. For any given point of a masked Game Object's texture, the pixel will only be displayed\nif the Graphics Game Object of the Geometry Mask has a visible pixel at the same position. The color and\nalpha of the pixel from the Geometry Mask do not matter.\n\nThe Geometry Mask's location matches the location of its Graphics object, not the location of the masked objects.\nMoving or transforming the underlying Graphics object will change the mask (and affect the visibility\nof any masked objects), whereas moving or transforming a masked object will not affect the mask.\nYou can think of the Geometry Mask (or rather, of its Graphics object) as an invisible curtain placed\nin front of all masked objects which has its own visual properties and, naturally, respects the camera's\nvisual properties, but isn't affected by and doesn't follow the masked objects by itself.","kind":"class","name":"GeometryMask","memberof":"Phaser.Display.Masks","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"This parameter is not used.","name":"scene"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics Game Object to use for the Geometry Mask. Doesn't have to be in the Display List.","name":"graphicsGeometry"}],"scope":"static","longname":"Phaser.Display.Masks.GeometryMask","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"The Graphics object which describes the Geometry Mask.","name":"geometryMask","type":{"names":["Phaser.GameObjects.Graphics"]},"since":"3.0.0","memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#geometryMask","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Similar to the BitmapMasks invertAlpha setting this to true will then hide all pixels\ndrawn to the Geometry Mask.","name":"invertAlpha","type":{"names":["boolean"]},"since":"3.16.0","memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#invertAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Is this mask a stencil mask?","name":"isStencil","type":{"names":["boolean"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#isStencil","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Sets a new Graphics object for the Geometry Mask.","kind":"function","name":"setShape","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object which will be used for the Geometry Mask.","name":"graphicsGeometry"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#setShape","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Sets the `invertAlpha` property of this Geometry Mask.\nInverting the alpha essentially flips the way the mask works.","kind":"function","name":"setInvertAlpha","since":"3.17.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Invert the alpha of this mask?","name":"value"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#setInvertAlpha","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":118,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Renders the Geometry Mask's underlying Graphics object to the OpenGL stencil buffer and enables the stencil test, which clips rendered pixels according to the mask.","kind":"function","name":"preRenderWebGL","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The WebGL Renderer instance to draw to.","name":"renderer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object being rendered.","name":"child"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera the Game Object is being rendered through.","name":"camera"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#preRenderWebGL","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Applies the current stencil mask to the renderer.","kind":"function","name":"applyStencil","since":"3.17.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The WebGL Renderer instance to draw to.","name":"renderer"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera the Game Object is being rendered through.","name":"camera"},{"type":{"names":["boolean"]},"description":"Is this an INCR stencil or a DECR stencil?","name":"inc"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#applyStencil","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Flushes all rendered pixels and disables the stencil test of a WebGL context, thus disabling the mask for it.","kind":"function","name":"postRenderWebGL","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The WebGL Renderer instance to draw flush.","name":"renderer"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#postRenderWebGL","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Sets the clipping path of a 2D canvas context to the Geometry Mask's underlying Graphics object.","kind":"function","name":"preRenderCanvas","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"The Canvas Renderer instance to set the clipping path on.","name":"renderer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object being rendered.","name":"mask"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera the Game Object is being rendered through.","name":"camera"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#preRenderCanvas","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Restore the canvas context's previous clipping path, thus turning off the mask for it.","kind":"function","name":"postRenderCanvas","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"The Canvas Renderer instance being restored.","name":"renderer"}],"memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#postRenderCanvas","scope":"instance","___s":true},{"meta":{"filename":"GeometryMask.js","lineno":293,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"description":"Destroys this GeometryMask and nulls any references it holds.\n\nNote that if a Game Object is currently using this mask it will _not_ automatically detect you have destroyed it,\nso be sure to call `clearMask` on any Game Object using it, before destroying it.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Display.Masks.GeometryMask","longname":"Phaser.Display.Masks.GeometryMask#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/mask"},"kind":"namespace","name":"Masks","memberof":"Phaser.Display","longname":"Phaser.Display.Masks","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"BaseShader.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/display/shader"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BaseShader.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/shader"},"classdesc":"A BaseShader is a small resource class that contains the data required for a WebGL Shader to be created.\n\nIt contains the raw source code to the fragment and vertex shader, as well as an object that defines\nthe uniforms the shader requires, if any.\n\nBaseShaders are stored in the Shader Cache, available in a Scene via `this.cache.shaders` and are referenced\nby a unique key-based string. Retrieve them via `this.cache.shaders.get(key)`.\n\nBaseShaders are created automatically by the GLSL File Loader when loading an external shader resource.\nThey can also be created at runtime, allowing you to use dynamically generated shader source code.\n\nDefault fragment and vertex source is used if not provided in the constructor, setting-up a basic shader,\nsuitable for debug rendering.","kind":"class","name":"BaseShader","memberof":"Phaser.Display","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of this shader. Must be unique within the shader cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The fragment source for the shader.","name":"fragmentSrc"},{"type":{"names":["string"]},"optional":true,"description":"The vertex source for the shader.","name":"vertexSrc"},{"type":{"names":["any"]},"optional":true,"description":"Optional object defining the uniforms the shader uses.","name":"uniforms"}],"scope":"static","longname":"Phaser.Display.BaseShader","___s":true},{"meta":{"filename":"BaseShader.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/shader"},"description":"The key of this shader, unique within the shader cache of this Phaser game instance.","name":"key","type":{"names":["string"]},"since":"3.17.0","memberof":"Phaser.Display.BaseShader","longname":"Phaser.Display.BaseShader#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseShader.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/shader"},"description":"The source code, as a string, of the fragment shader being used.","name":"fragmentSrc","type":{"names":["string"]},"since":"3.17.0","memberof":"Phaser.Display.BaseShader","longname":"Phaser.Display.BaseShader#fragmentSrc","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseShader.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/shader"},"description":"The source code, as a string, of the vertex shader being used.","name":"vertexSrc","type":{"names":["string"]},"since":"3.17.0","memberof":"Phaser.Display.BaseShader","longname":"Phaser.Display.BaseShader#vertexSrc","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseShader.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/display/shader"},"description":"The default uniforms for this shader.","name":"uniforms","type":{"names":["any"]},"nullable":true,"since":"3.17.0","memberof":"Phaser.Display.BaseShader","longname":"Phaser.Display.BaseShader#uniforms","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ColorObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/typedefs"},"kind":"typedef","name":"ColorObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The red color value in the range 0 to 255.","name":"r"},{"type":{"names":["number"]},"description":"The green color value in the range 0 to 255.","name":"g"},{"type":{"names":["number"]},"description":"The blue color value in the range 0 to 255.","name":"b"},{"type":{"names":["number"]},"description":"The alpha color value in the range 0 to 255.","name":"a"}],"memberof":"Phaser.Types.Display","longname":"Phaser.Types.Display.ColorObject","scope":"static","___s":true},{"meta":{"filename":"HSVColorObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/typedefs"},"kind":"typedef","name":"HSVColorObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The hue color value. A number between 0 and 1","name":"h"},{"type":{"names":["number"]},"description":"The saturation color value. A number between 0 and 1","name":"s"},{"type":{"names":["number"]},"description":"The lightness color value. A number between 0 and 1","name":"v"}],"memberof":"Phaser.Types.Display","longname":"Phaser.Types.Display.HSVColorObject","scope":"static","___s":true},{"meta":{"filename":"InputColorObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/typedefs"},"kind":"typedef","name":"InputColorObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"The red color value in the range 0 to 255.","name":"r"},{"type":{"names":["number"]},"optional":true,"description":"The green color value in the range 0 to 255.","name":"g"},{"type":{"names":["number"]},"optional":true,"description":"The blue color value in the range 0 to 255.","name":"b"},{"type":{"names":["number"]},"optional":true,"description":"The alpha color value in the range 0 to 255.","name":"a"}],"memberof":"Phaser.Types.Display","longname":"Phaser.Types.Display.InputColorObject","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/display/typedefs"},"kind":"namespace","name":"Display","memberof":"Phaser.Types","longname":"Phaser.Types.Display","scope":"static","___s":true},{"meta":{"filename":"AddToDOM.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Adds the given element to the DOM. If a parent is provided the element is added as a child of the parent, providing it was able to access it.\nIf no parent was given it falls back to using `document.body`.","kind":"function","name":"AddToDOM","since":"3.0.0","params":[{"type":{"names":["HTMLElement"]},"description":"The element to be added to the DOM. Usually a Canvas object.","name":"element"},{"type":{"names":["string","HTMLElement"]},"optional":true,"description":"The parent in which to add the element. Can be a string which is passed to `getElementById` or an actual DOM object.","name":"parent"}],"returns":[{"type":{"names":["HTMLElement"]},"description":"The element that was added to the DOM."}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.AddToDOM","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"CreateDOMContainer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"name":"AddToDOM","longname":"AddToDOM","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,208],"filename":"DOMContentLoaded.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"name":"OS","longname":"OS","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DOMContentLoaded.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"kind":"typedef","name":"ContentLoadedCallback","type":{"names":["function"]},"longname":"ContentLoadedCallback","scope":"global","___s":true},{"meta":{"filename":"DOMContentLoaded.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Inspects the readyState of the document. If the document is already complete then it invokes the given callback.\nIf not complete it sets up several event listeners such as `deviceready`, and once those fire, it invokes the callback.\nCalled automatically by the Phaser.Game instance. Should not usually be accessed directly.","kind":"function","name":"DOMContentLoaded","since":"3.0.0","params":[{"type":{"names":["ContentLoadedCallback"]},"description":"The callback to be invoked when the device is ready and the DOM content is loaded.","name":"callback"}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.DOMContentLoaded","scope":"static","___s":true},{"meta":{"filename":"GetInnerHeight.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Attempts to determine the document inner height across iOS and standard devices.\nBased on code by @tylerjpeterson","kind":"function","name":"GetInnerHeight","since":"3.16.0","params":[{"type":{"names":["boolean"]},"description":"Is this running on iOS?","name":"iOS"}],"returns":[{"type":{"names":["number"]},"description":"The inner height value."}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.GetInnerHeight","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"GetScreenOrientation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetScreenOrientation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Attempts to determine the screen orientation using the Orientation API.","kind":"function","name":"GetScreenOrientation","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The width of the viewport.","name":"width"},{"type":{"names":["number"]},"description":"The height of the viewport.","name":"height"}],"returns":[{"type":{"names":["string"]},"description":"The orientation."}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.GetScreenOrientation","scope":"static","___s":true},{"meta":{"filename":"GetTarget.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Attempts to get the target DOM element based on the given value, which can be either\na string, in which case it will be looked-up by ID, or an element node. If nothing\ncan be found it will return a reference to the document.body.","kind":"function","name":"GetTarget","since":"3.16.0","params":[{"type":{"names":["HTMLElement"]},"description":"The DOM element to look-up.","name":"element"}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.GetTarget","scope":"static","___s":true},{"meta":{"filename":"ParseXML.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Takes the given data string and parses it as XML.\nFirst tries to use the window.DOMParser and reverts to the Microsoft.XMLDOM if that fails.\nThe parsed XML object is returned, or `null` if there was an error while parsing the data.","kind":"function","name":"ParseXML","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The XML source stored in a string.","name":"data"}],"returns":[{"type":{"names":["DOMParser","ActiveXObject"]},"nullable":true,"description":"The parsed XML data, or `null` if the data could not be parsed."}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.ParseXML","scope":"static","___s":true},{"meta":{"filename":"RemoveFromDOM.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Attempts to remove the element from its parentNode in the DOM.","kind":"function","name":"RemoveFromDOM","since":"3.0.0","params":[{"type":{"names":["HTMLElement"]},"description":"The DOM element to remove from its parent node.","name":"element"}],"memberof":"Phaser.DOM","longname":"Phaser.DOM.RemoveFromDOM","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"RequestAnimationFrame.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"classdesc":"Abstracts away the use of RAF or setTimeOut for the core game update loop.\nThis is invoked automatically by the Phaser.Game instance.","kind":"class","name":"RequestAnimationFrame","memberof":"Phaser.DOM","since":"3.0.0","scope":"static","longname":"Phaser.DOM.RequestAnimationFrame","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":26,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"True if RequestAnimationFrame is running, otherwise false.","name":"isRunning","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#isRunning","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The callback to be invoked each step.","name":"callback","type":{"names":["FrameRequestCallback"]},"since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#callback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The most recent timestamp. Either a DOMHighResTimeStamp under RAF or `Date.now` under SetTimeout.","name":"tick","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#tick","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"True if the step is using setTimeout instead of RAF.","name":"isSetTimeOut","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#isSetTimeOut","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The setTimeout or RAF callback ID used when canceling them.","name":"timeOutID","type":{"names":["number"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#timeOutID","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The previous time the step was called.","name":"lastTime","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#lastTime","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":85,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The target FPS rate in ms.\nOnly used when setTimeout is used instead of RAF.","name":"target","type":{"names":["number"]},"defaultvalue":"0","since":"3.21.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#target","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The RAF step function.\nUpdates the local tick value, invokes the callback and schedules another call to requestAnimationFrame.","name":"step","type":{"names":["FrameRequestCallback"]},"since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#step","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"The SetTimeout step function.\nUpdates the local tick value, invokes the callback and schedules another call to setTimeout.","name":"stepTimeout","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#stepTimeout","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Starts the requestAnimationFrame or setTimeout process running.","kind":"function","name":"start","since":"3.0.0","params":[{"type":{"names":["FrameRequestCallback"]},"description":"The callback to invoke each step.","name":"callback"},{"type":{"names":["boolean"]},"description":"Should it use SetTimeout, even if RAF is available?","name":"forceSetTimeOut"},{"type":{"names":["number"]},"description":"The target fps rate (in ms). Only used when setTimeout is used.","name":"targetFPS"}],"memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#start","scope":"instance","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Stops the requestAnimationFrame or setTimeout from running.","kind":"function","name":"stop","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#stop","scope":"instance","___s":true},{"meta":{"filename":"RequestAnimationFrame.js","lineno":193,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"description":"Stops the step from running and clears the callback reference.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.DOM.RequestAnimationFrame","longname":"Phaser.DOM.RequestAnimationFrame#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/dom"},"kind":"namespace","name":"DOM","memberof":"Phaser","longname":"Phaser.DOM","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"EventEmitter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"classdesc":"EventEmitter is a Scene Systems plugin compatible version of eventemitter3.","kind":"class","name":"EventEmitter","memberof":"Phaser.Events","since":"3.0.0","scope":"static","longname":"Phaser.Events.EventEmitter","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#shutdown","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":42,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#destroy","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#eventNames","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#listeners","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#listenerCount","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#emit","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"`this`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#on","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"`this`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#addListener","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"`this`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#once","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"`this`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#removeListener","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"`this`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#off","scope":"instance","___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Events.EventEmitter"]},"description":"`this`."}],"memberof":"Phaser.Events.EventEmitter","longname":"Phaser.Events.EventEmitter#removeAllListeners","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"kind":"namespace","name":"Events","memberof":"Phaser","longname":"Phaser.Events","scope":"static","___s":true},{"meta":{"range":[180,226],"filename":"BuildGameObject.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"BlendModes","longname":"BlendModes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BuildGameObject.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Builds a Game Object using the provided configuration object.","kind":"function","name":"BuildGameObject","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene.","name":"scene"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The initial GameObject.","name":"gameObject"},{"type":{"names":["Phaser.Types.GameObjects.GameObjectConfig"]},"description":"The config to build the GameObject with.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The built Game Object."}],"memberof":"Phaser.GameObjects","longname":"Phaser.GameObjects.BuildGameObject","scope":"static","___s":true},{"meta":{"range":[180,242],"filename":"BuildGameObjectAnimation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"GetAdvancedValue","longname":"GetAdvancedValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BuildGameObjectAnimation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds an Animation component to a Sprite and populates it based on the given config.","kind":"function","name":"BuildGameObjectAnimation","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"The sprite to add an Animation component to.","name":"sprite"},{"type":{"names":["object"]},"description":"The animation config.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"The updated Sprite."}],"memberof":"Phaser.GameObjects","longname":"Phaser.GameObjects.BuildGameObjectAnimation","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"DisplayList.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DisplayList.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"classdesc":"The Display List plugin.\n\nDisplay Lists belong to a Scene and maintain the list of Game Objects to render every frame.\n\nSome of these Game Objects may also be part of the Scene's [Update List]{@link Phaser.GameObjects.UpdateList}, for updating.","kind":"class","name":"DisplayList","augments":["Phaser.Structs.List."],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that this Display List belongs to.","name":"scene"}],"scope":"static","longname":"Phaser.GameObjects.DisplayList","___s":true},{"meta":{"filename":"DisplayList.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flag the determines whether Game Objects should be sorted when `depthSort()` is called.","name":"sortChildrenFlag","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#sortChildrenFlag","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DisplayList.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Scene that this Display List belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DisplayList.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Scene's Systems.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DisplayList.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Force a sort of the display list on the next call to depthSort.","kind":"function","name":"queueDepthSort","since":"3.0.0","memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#queueDepthSort","scope":"instance","___s":true},{"meta":{"filename":"DisplayList.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Immediately sorts the display list if the flag is set.","kind":"function","name":"depthSort","since":"3.0.0","memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#depthSort","scope":"instance","___s":true},{"meta":{"filename":"DisplayList.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compare the depth of two Game Objects.","kind":"function","name":"sortByDepth","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first Game Object.","name":"childA"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The second Game Object.","name":"childB"}],"returns":[{"type":{"names":["integer"]},"description":"The difference between the depths of each Game Object."}],"memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#sortByDepth","scope":"instance","___s":true},{"meta":{"filename":"DisplayList.js","lineno":141,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array which contains all objects currently on the Display List.\nThis is a reference to the main list array, not a copy of it, so be careful not to modify it.","kind":"function","name":"getChildren","since":"3.12.0","returns":[{"type":{"names":["Array."]},"description":"The group members."}],"memberof":"Phaser.GameObjects.DisplayList","longname":"Phaser.GameObjects.DisplayList#getChildren","scope":"instance","___s":true},{"meta":{"range":[180,213],"filename":"GameObject.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GameObject.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"classdesc":"The base class that all Game Objects extend.\nYou don't create GameObjects directly and they cannot be added to the display list.\nInstead, use them as the base for your own custom classes.","kind":"class","name":"GameObject","memberof":"Phaser.GameObjects","augments":["Phaser.Events.EventEmitter"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs.","name":"scene"},{"type":{"names":["string"]},"description":"A textual representation of the type of Game Object, i.e. `sprite`.","name":"type"}],"scope":"static","longname":"Phaser.GameObjects.GameObject","___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#state","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#parentContainer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#tabIndex","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#renderFlags","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#cameraFilter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#input","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#body","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#ignoreDestroy","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#setActive","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#setName","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#setState","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#setDataEnabled","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#setData","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#getData","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#setInteractive","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#disableInteractive","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#removeInteractive","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#update","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#toJSON","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#willRender","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#getIndexList","scope":"instance","___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"GameObject.js","lineno":626,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The bitmask that `GameObject.renderFlags` is compared against to determine if the Game Object will render or not.","kind":"constant","name":"RENDER_MASK","type":{"names":["integer"]},"memberof":"Phaser.GameObjects.GameObject","scope":"static","longname":"Phaser.GameObjects.GameObject.RENDER_MASK","___s":true},{"meta":{"range":[180,213],"filename":"GameObjectCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GameObjectCreator.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"classdesc":"The Game Object Creator is a Scene plugin that allows you to quickly create many common\ntypes of Game Objects and return them. Unlike the Game Object Factory, they are not automatically\nadded to the Scene.\n\nGame Objects directly register themselves with the Creator and inject their own creation\nmethods into the class.","kind":"class","name":"GameObjectCreator","memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object Factory belongs.","name":"scene"}],"scope":"static","longname":"Phaser.GameObjects.GameObjectCreator","___s":true},{"meta":{"range":[180,213],"filename":"GameObjectFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GameObjectFactory.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"classdesc":"The Game Object Factory is a Scene plugin that allows you to quickly create many common\ntypes of Game Objects and have them automatically registered with the Scene.\n\nGame Objects directly register themselves with the Factory and inject their own creation\nmethods into the class.","kind":"class","name":"GameObjectFactory","memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object Factory belongs.","name":"scene"}],"scope":"static","longname":"Phaser.GameObjects.GameObjectFactory","___s":true},{"meta":{"filename":"GameObjectFactory.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds an existing Game Object to this Scene.\n\nIf the Game Object renders, it will be added to the Display List.\nIf it has a `preUpdate` method, it will be added to the Update List.","kind":"function","name":"existing","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Group"]},"description":"The child to be added to this Scene.","name":"child"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was added."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#existing","scope":"instance","___s":true},{"meta":{"filename":"GameObjectFactory.js","lineno":170,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Static method called directly by the Game Object factory functions.\nWith this method you can register a custom GameObject factory in the GameObjectFactory,\nproviding a name (`factoryType`) and the constructor (`factoryFunction`) in order\nto be called when you call to Phaser.Scene.add[ factoryType ] method.","kind":"function","name":"register","scope":"static","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the factory that you will use to call to Phaser.Scene.add[ factoryType ] method.","name":"factoryType"},{"type":{"names":["function"]},"description":"The constructor function to be called when you invoke to the Phaser.Scene.add method.","name":"factoryFunction"}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory.register","___s":true},{"meta":{"filename":"GameObjectFactory.js","lineno":191,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Static method called directly by the Game Object factory functions.\nWith this method you can remove a custom GameObject factory registered in the GameObjectFactory,\nproviding a its `factoryType`.","kind":"function","name":"remove","scope":"static","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the factory that you want to remove from the GameObjectFactory.","name":"factoryType"}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory.remove","___s":true},{"meta":{"range":[180,213],"filename":"UpdateList.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"UpdateList.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"classdesc":"The Update List plugin.\n\nUpdate Lists belong to a Scene and maintain the list Game Objects to be updated every frame.\n\nSome or all of these Game Objects may also be part of the Scene's [Display List]{@link Phaser.GameObjects.DisplayList}, for Rendering.","kind":"class","name":"UpdateList","augments":["Phaser.Structs.ProcessQueue."],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that the Update List belongs to.","name":"scene"}],"scope":"static","longname":"Phaser.GameObjects.UpdateList","___s":true},{"meta":{"filename":"UpdateList.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Scene that the Update List belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.GameObjects.UpdateList","longname":"Phaser.GameObjects.UpdateList#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"UpdateList.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Scene's Systems.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.GameObjects.UpdateList","longname":"Phaser.GameObjects.UpdateList#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"UpdateList.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The update step.\n\nPre-updates every active Game Object in the list.","kind":"function","name":"sceneUpdate","since":"3.20.0","params":[{"type":{"names":["number"]},"description":"The current timestamp.","name":"time"},{"type":{"names":["number"]},"description":"The delta time elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.GameObjects.UpdateList","longname":"Phaser.GameObjects.UpdateList#sceneUpdate","scope":"instance","___s":true},{"meta":{"filename":"UpdateList.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Scene that owns this plugin is shutting down.\n\nWe need to kill and reset all internal properties as well as stop listening to Scene events.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.UpdateList","longname":"Phaser.GameObjects.UpdateList#shutdown","scope":"instance","___s":true},{"meta":{"filename":"UpdateList.js","lineno":204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Scene that owns this plugin is being destroyed.\n\nWe need to shutdown and then kill off all external references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.GameObjects.UpdateList","longname":"Phaser.GameObjects.UpdateList#destroy","scope":"instance","___s":true},{"meta":{"range":[180,232],"filename":"ParseFromAtlas.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"name":"ParseXMLBitmapFont","longname":"ParseXMLBitmapFont","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,229],"filename":"ParseRetroFont.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"name":"GetValue","longname":"GetValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseRetroFont.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Parses a Retro Font configuration object so you can pass it to the BitmapText constructor\nand create a BitmapText object using a fixed-width retro font.","kind":"function","name":"Parse","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Phaser Scene.","name":"scene"},{"type":{"names":["Phaser.Types.GameObjects.BitmapText.RetroFontConfig"]},"description":"The font configuration object.","name":"config"}],"returns":[{"type":{"names":["object"]},"description":"A parsed Bitmap Font data entry for the Bitmap Font cache."}],"memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.Parse","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"RetroFont.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"name":"RETRO_FONT_CONST","longname":"RETRO_FONT_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RetroFont.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"kind":"namespace","name":"RetroFont","since":"3.6.0","memberof":"Phaser.GameObjects","longname":"Phaser.GameObjects.RetroFont","scope":"static","___s":true},{"meta":{"range":[180,3027],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"name":"RETRO_FONT_CONST","longname":"RETRO_FONT_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 1 = !\\\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\\\]^_`abcdefghijklmnopqrstuvwxyz{|}~","name":"TEXT_SET1","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET1","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 2 = !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ","name":"TEXT_SET2","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET2","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 3 = ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789","name":"TEXT_SET3","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET3","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 4 = ABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789","name":"TEXT_SET4","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET4","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 5 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,/() '!?-*:0123456789","name":"TEXT_SET5","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET5","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 6 = ABCDEFGHIJKLMNOPQRSTUVWXYZ!?:;0123456789\"(),-.'","name":"TEXT_SET6","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET6","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 7 = AGMSY+:4BHNTZ!;5CIOU.?06DJPV,(17EKQW\")28FLRX-'39","name":"TEXT_SET7","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET7","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 8 = 0123456789 .ABCDEFGHIJKLMNOPQRSTUVWXYZ","name":"TEXT_SET8","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET8","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 9 = ABCDEFGHIJKLMNOPQRSTUVWXYZ()-0123456789.:,'\"?!","name":"TEXT_SET9","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET9","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 10 = ABCDEFGHIJKLMNOPQRSTUVWXYZ","name":"TEXT_SET10","type":{"names":["string"]},"since":"3.6.0","memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET10","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":99,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext"},"description":"Text Set 11 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,\"-+!?()':;0123456789","name":"TEXT_SET11","since":"3.6.0","type":{"names":["string"]},"memberof":"Phaser.GameObjects.RetroFont","longname":"Phaser.GameObjects.RetroFont.TEXT_SET11","scope":"static","kind":"member","___s":true},{"meta":{"range":[180,224],"filename":"DynamicBitmapText.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"name":"BitmapText","longname":"BitmapText","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"classdesc":"BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\n\nDuring rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to\nmatch the font structure.\n\nDynamic Bitmap Text objects are different from Static Bitmap Text in that they invoke a callback for each\nletter being rendered during the render pass. This callback allows you to manipulate the properties of\neach letter being rendered, such as its position, scale or tint, allowing you to create interesting effects\nlike jiggling text, which can't be done with Static text. This means that Dynamic Text takes more processing\ntime, so only use them if you require the callback ability they have.\n\nBitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\nto use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\nprocessing the font texture in an image editor, applying fills and any other effects required.\n\nTo create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\n\nTo create a BitmapText data files you need a 3rd party app such as:\n\nBMFont (Windows, free): http://www.angelcode.com/products/bmfont/\nGlyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner\nLittera (Web-based, free): http://kvazars.com/littera/\n\nFor most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\nconverting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: http://codebeautify.org/xmltojson","kind":"class","name":"DynamicBitmapText","augments":["Phaser.GameObjects.BitmapText"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. It can only belong to one Scene at any given time.","name":"scene"},{"type":{"names":["number"]},"description":"The x coordinate of this Game Object in world space.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of this Game Object in world space.","name":"y"},{"type":{"names":["string"]},"description":"The key of the font to use from the Bitmap Font cache.","name":"font"},{"type":{"names":["string","Array."]},"optional":true,"description":"The string, or array of strings, to be set as the content of this Bitmap Text.","name":"text"},{"type":{"names":["number"]},"optional":true,"description":"The font size of this Bitmap Text.","name":"size"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The alignment of the text in a multi-line BitmapText object.","name":"align"}],"scope":"static","longname":"Phaser.GameObjects.DynamicBitmapText","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"The horizontal scroll position of the Bitmap Text.","name":"scrollX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scrollX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"The vertical scroll position of the Bitmap Text.","name":"scrollY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scrollY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"The crop width of the Bitmap Text.","name":"cropWidth","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#cropWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"The crop height of the Bitmap Text.","name":"cropHeight","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#cropHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":109,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"A callback that alters how each character of the Bitmap Text is rendered.","name":"displayCallback","type":{"names":["Phaser.Types.GameObjects.BitmapText.DisplayCallback"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#displayCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"The data object that is populated during rendering, then passed to the displayCallback.\nYou should modify this object then return it back from the callback. It's updated values\nwill be used to render the specific glyph.\n\nPlease note that if you need a reference to this object locally in your game code then you\nshould shallow copy it, as it's updated and re-used for every glyph in the text.","name":"callbackData","type":{"names":["Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig"]},"since":"3.11.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#callbackData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"Set the crop size of this Bitmap Text.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the crop.","name":"width"},{"type":{"names":["number"]},"description":"The height of the crop.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setSize","scope":"instance","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":168,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"Set a callback that alters how each character of the Bitmap Text is rendered.\n\nThe callback receives a {@link Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig} object that contains information about the character that's\nabout to be rendered.\n\nIt should return an object with `x`, `y`, `scale` and `rotation` properties that will be used instead of the\nusual values when rendering.","kind":"function","name":"setDisplayCallback","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.DisplayCallback"]},"description":"The display callback to set.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setDisplayCallback","scope":"instance","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"Set the horizontal scroll position of this Bitmap Text.","kind":"function","name":"setScrollX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll position to set.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setScrollX","scope":"instance","___s":true},{"meta":{"filename":"DynamicBitmapText.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"Set the vertical scroll position of this Bitmap Text.","kind":"function","name":"setScrollY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical scroll position to set.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setScrollY","scope":"instance","___s":true},{"meta":{"range":[180,249],"filename":"DynamicBitmapTextCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"name":"SetTransform","longname":"SetTransform","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"DynamicBitmapTextCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"name":"BitmapText","longname":"BitmapText","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DynamicBitmapTextCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"Creates a new Dynamic Bitmap Text Game Object and returns it.\n\nNote: This method will only be available if the Dynamic Bitmap Text Game Object has been built into Phaser.","kind":"function","name":"dynamicBitmapText","since":"3.0.0\n²","params":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapTextConfig"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#dynamicBitmapText","scope":"instance","___s":true},{"meta":{"range":[180,230],"filename":"DynamicBitmapTextFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"name":"DynamicBitmapText","longname":"DynamicBitmapText","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DynamicBitmapTextFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"description":"Creates a new Dynamic Bitmap Text Game Object and adds it to the Scene.\n\nBitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\n\nDuring rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to\nmatch the font structure.\n\nDynamic Bitmap Text objects are different from Static Bitmap Text in that they invoke a callback for each\nletter being rendered during the render pass. This callback allows you to manipulate the properties of\neach letter being rendered, such as its position, scale or tint, allowing you to create interesting effects\nlike jiggling text, which can't be done with Static text. This means that Dynamic Text takes more processing\ntime, so only use them if you require the callback ability they have.\n\nBitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\nto use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\nprocessing the font texture in an image editor, applying fills and any other effects required.\n\nTo create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\n\nTo create a BitmapText data files you need a 3rd party app such as:\n\nBMFont (Windows, free): http://www.angelcode.com/products/bmfont/\nGlyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner\nLittera (Web-based, free): http://kvazars.com/littera/\n\nFor most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\nconverting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: http://codebeautify.org/xmltojson\n\nNote: This method will only be available if the Dynamic Bitmap Text Game Object has been built into Phaser.","kind":"function","name":"dynamicBitmapText","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the Game Object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Game Object.","name":"y"},{"type":{"names":["string"]},"description":"The key of the font to use from the BitmapFont cache.","name":"font"},{"type":{"names":["string","Array."]},"optional":true,"description":"The string, or array of strings, to be set as the content of this Bitmap Text.","name":"text"},{"type":{"names":["number"]},"optional":true,"description":"The font size to set.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#dynamicBitmapText","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"DynamicBitmapTextRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"DynamicBitmapTextWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"BitmapText.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapText.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"classdesc":"BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\n\nDuring rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to\nmatch the font structure.\n\nBitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\nto use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\nprocessing the font texture in an image editor, applying fills and any other effects required.\n\nTo create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\n\nTo create a BitmapText data files you need a 3rd party app such as:\n\nBMFont (Windows, free): {@link http://www.angelcode.com/products/bmfont/|http://www.angelcode.com/products/bmfont/}\nGlyph Designer (OS X, commercial): {@link http://www.71squared.com/en/glyphdesigner|http://www.71squared.com/en/glyphdesigner}\nLittera (Web-based, free): {@link http://kvazars.com/littera/|http://kvazars.com/littera/}\n\nFor most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\nconverting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: {@link http://codebeautify.org/xmltojson|http://codebeautify.org/xmltojson}","kind":"class","name":"BitmapText","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. It can only belong to one Scene at any given time.","name":"scene"},{"type":{"names":["number"]},"description":"The x coordinate of this Game Object in world space.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of this Game Object in world space.","name":"y"},{"type":{"names":["string"]},"description":"The key of the font to use from the Bitmap Font cache.","name":"font"},{"type":{"names":["string","Array."]},"optional":true,"description":"The string, or array of strings, to be set as the content of this Bitmap Text.","name":"text"},{"type":{"names":["number"]},"optional":true,"description":"The font size of this Bitmap Text.","name":"size"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The alignment of the text in a multi-line BitmapText object.","name":"align"}],"scope":"static","longname":"Phaser.GameObjects.BitmapText","___s":true},{"meta":{"filename":"BitmapText.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The key of the Bitmap Font used by this Bitmap Text.\nTo change the font after creation please use `setFont`.","name":"font","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#font","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The data of the Bitmap Font used by this Bitmap Text.","name":"fontData","type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapFontData"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#fontData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The character code used to detect for word wrapping.\nDefaults to 32 (a space character).","name":"wordWrapCharCode","type":{"names":["number"]},"since":"3.21.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#wordWrapCharCode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":214,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the lines of text in this BitmapText to be left-aligned.\nThis only has any effect if this BitmapText contains more than one line of text.","kind":"function","name":"setLeftAlign","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setLeftAlign","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":232,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the lines of text in this BitmapText to be center-aligned.\nThis only has any effect if this BitmapText contains more than one line of text.","kind":"function","name":"setCenterAlign","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setCenterAlign","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":250,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the lines of text in this BitmapText to be right-aligned.\nThis only has any effect if this BitmapText contains more than one line of text.","kind":"function","name":"setRightAlign","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setRightAlign","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the font size of this Bitmap Text.","kind":"function","name":"setFontSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The font size to set.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setFontSize","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Sets the letter spacing between each character of this Bitmap Text.\nCan be a positive value to increase the space, or negative to reduce it.\nSpacing is applied after the kerning values have been set.","kind":"function","name":"setLetterSpacing","since":"3.4.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The amount of horizontal space to add between each character.","name":"spacing"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setLetterSpacing","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the textual content of this BitmapText.\n\nAn array of strings will be converted into multi-line text. Use the align methods to change multi-line alignment.","kind":"function","name":"setText","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The string, or array of strings, to be set as the content of this BitmapText.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setText","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":346,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Calculate the bounds of this Bitmap Text.\n\nAn object is returned that contains the position, width and height of the Bitmap Text in local and global\ncontexts.\n\nLocal size is based on just the font size and a [0, 0] position.\n\nGlobal size takes into account the Game Object's scale, world position and display origin.\n\nAlso in the object is data regarding the length of each line, should this be a multi-line BitmapText.","kind":"function","name":"getTextBounds","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"description":"Whether to round the results to the nearest integer.","name":"round"}],"returns":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapTextSize"]},"description":"An object that describes the size of this Bitmap Text."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getTextBounds","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Changes the font this BitmapText is using to render.\n\nThe new texture is loaded and applied to the BitmapText. The existing test, size and alignment are preserved,\nunless overridden via the arguments.","kind":"function","name":"setFont","since":"3.11.0","params":[{"type":{"names":["string"]},"description":"The key of the font to use from the Bitmap Font cache.","name":"font"},{"type":{"names":["number"]},"optional":true,"description":"The font size of this Bitmap Text. If not specified the current size will be used.","name":"size"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The alignment of the text in a multi-line BitmapText object. If not specified the current alignment will be used.","name":"align"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setFont","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Sets the maximum display width of this BitmapText in pixels.\n\nIf `BitmapText.text` is longer than `maxWidth` then the lines will be automatically wrapped\nbased on the previous whitespace character found in the line.\n\nIf no whitespace was found then no wrapping will take place and consequently the `maxWidth` value will not be honored.\n\nDisable maxWidth by setting the value to 0.\n\nYou can set the whitespace character to be searched for by setting the `wordWrapCharCode` parameter or property.","kind":"function","name":"setMaxWidth","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The maximum display width of this BitmapText in pixels. Set to zero to disable.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"The character code to check for when word wrapping. Defaults to 32 (the space character).","name":"wordWrapCharCode"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setMaxWidth","scope":"instance","___s":true},{"meta":{"filename":"BitmapText.js","lineno":459,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Controls the alignment of each line of text in this BitmapText object.\n\nOnly has any effect when this BitmapText contains multiple lines of text, split with carriage-returns.\nHas no effect with single-lines of text.\n\nSee the methods `setLeftAlign`, `setCenterAlign` and `setRightAlign`.\n\n0 = Left aligned (default)\n1 = Middle aligned\n2 = Right aligned\n\nThe alignment position is based on the longest line of text.","name":"align","type":{"names":["integer"]},"since":"3.11.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#align","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":492,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The text that this Bitmap Text object displays.\n\nYou can also use the method `setText` if you want a chainable way to change the text content.","name":"text","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#text","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":515,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The font size of this Bitmap Text.\n\nYou can also use the method `setFontSize` if you want a chainable way to change the font size.","name":"fontSize","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#fontSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":539,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Adds / Removes spacing between characters.\n\nCan be a negative or positive number.\n\nYou can also use the method `setLetterSpacing` if you want a chainable way to change the letter spacing.","name":"letterSpacing","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#letterSpacing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":565,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The maximum display width of this BitmapText in pixels.\n\nIf BitmapText.text is longer than maxWidth then the lines will be automatically wrapped\nbased on the last whitespace character found in the line.\n\nIf no whitespace was found then no wrapping will take place and consequently the maxWidth value will not be honored.\n\nDisable maxWidth by setting the value to 0.","name":"maxWidth","type":{"names":["number"]},"since":"3.21.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#maxWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":594,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The width of this Bitmap Text.","name":"width","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":613,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The height of this bitmap text.","name":"height","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Build a JSON representation of this Bitmap Text.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.JSONBitmapText"]},"description":"A JSON representation of this Bitmap Text."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#toJSON","scope":"instance","overrides":"Phaser.GameObjects.GameObject#toJSON","___s":true},{"meta":{"filename":"BitmapText.js","lineno":661,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Left align the text characters in a multi-line BitmapText object.","name":"ALIGN_LEFT","type":{"names":["integer"]},"since":"3.11.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText.ALIGN_LEFT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":670,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Center align the text characters in a multi-line BitmapText object.","name":"ALIGN_CENTER","type":{"names":["integer"]},"since":"3.11.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText.ALIGN_CENTER","scope":"static","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":679,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Right align the text characters in a multi-line BitmapText object.","name":"ALIGN_RIGHT","type":{"names":["integer"]},"since":"3.11.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText.ALIGN_RIGHT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"BitmapText.js","lineno":688,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Parse an XML Bitmap Font from an Atlas.\n\nAdds the parsed Bitmap Font data to the cache with the `fontName` key.","kind":"function","name":"ParseFromAtlas","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to parse the Bitmap Font for.","name":"scene"},{"type":{"names":["string"]},"description":"The key of the font to add to the Bitmap Font cache.","name":"fontName"},{"type":{"names":["string"]},"description":"The key of the BitmapFont's texture.","name":"textureKey"},{"type":{"names":["string"]},"description":"The key of the BitmapFont texture's frame.","name":"frameKey"},{"type":{"names":["string"]},"description":"The key of the XML data of the font to parse.","name":"xmlKey"},{"type":{"names":["integer"]},"optional":true,"description":"The x-axis spacing to add between each letter.","name":"xSpacing"},{"type":{"names":["integer"]},"optional":true,"description":"The y-axis spacing to add to the line height.","name":"ySpacing"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the parsing was successful or not."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText.ParseFromAtlas","scope":"static","___s":true},{"meta":{"filename":"BitmapText.js","lineno":708,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Parse an XML font to Bitmap Font data for the Bitmap Font cache.","kind":"function","name":"ParseXMLBitmapFont","since":"3.17.0","params":[{"type":{"names":["XMLDocument"]},"description":"The XML Document to parse the font from.","name":"xml"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x-axis spacing to add between each letter.","name":"xSpacing"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y-axis spacing to add to the line height.","name":"ySpacing"},{"type":{"names":["Phaser.Textures.Frame"]},"optional":true,"description":"The texture frame to take into account while parsing.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapFontData"]},"description":"The parsed Bitmap Font data."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText.ParseXMLBitmapFont","scope":"static","___s":true},{"meta":{"range":[180,249],"filename":"BitmapTextCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"name":"SetTransform","longname":"SetTransform","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"BitmapTextCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"name":"BitmapText","longname":"BitmapText","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapTextCreator.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Creates a new Bitmap Text Game Object and returns it.\n\nNote: This method will only be available if the Bitmap Text Game Object has been built into Phaser.","kind":"function","name":"bitmapText","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapTextConfig"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#bitmapText","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"BitmapTextFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"name":"BitmapText","longname":"BitmapText","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapTextFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Creates a new Bitmap Text Game Object and adds it to the Scene.\n\nBitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\n\nDuring rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to\nmatch the font structure.\n\nBitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\nto use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\nprocessing the font texture in an image editor, applying fills and any other effects required.\n\nTo create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\n\nTo create a BitmapText data files you need a 3rd party app such as:\n\nBMFont (Windows, free): http://www.angelcode.com/products/bmfont/\nGlyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner\nLittera (Web-based, free): http://kvazars.com/littera/\n\nFor most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\nconverting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: http://codebeautify.org/xmltojson\n\nNote: This method will only be available if the Bitmap Text Game Object has been built into Phaser.","kind":"function","name":"bitmapText","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the Game Object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Game Object.","name":"y"},{"type":{"names":["string"]},"description":"The key of the font to use from the BitmapFont cache.","name":"font"},{"type":{"names":["string","Array."]},"optional":true,"description":"The string, or array of strings, to be set as the content of this Bitmap Text.","name":"text"},{"type":{"names":["number"]},"optional":true,"description":"The font size to set.","name":"size"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The alignment of the text in a multi-line BitmapText object.","name":"align"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#bitmapText","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"BitmapTextRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"BitmapTextWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapFontCharacterData.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"description":"The font data for an individual character of a Bitmap Font.\n\nDescribes the character's position, size, offset and kerning.","kind":"typedef","name":"BitmapFontCharacterData","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The x position of the character.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the character.","name":"y"},{"type":{"names":["number"]},"description":"The width of the character.","name":"width"},{"type":{"names":["number"]},"description":"The height of the character.","name":"height"},{"type":{"names":["number"]},"description":"The center x position of the character.","name":"centerX"},{"type":{"names":["number"]},"description":"The center y position of the character.","name":"centerY"},{"type":{"names":["number"]},"description":"The x offset of the character.","name":"xOffset"},{"type":{"names":["number"]},"description":"The y offset of the character.","name":"yOffset"},{"type":{"names":["object"]},"description":"Extra data for the character.","name":"data"},{"type":{"names":["Object."]},"description":"Kerning values, keyed by character code.","name":"kerning"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData","scope":"static","___s":true},{"meta":{"filename":"BitmapFontData.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"description":"Bitmap Font data that can be used by a BitmapText Game Object.","kind":"typedef","name":"BitmapFontData","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The name of the font.","name":"font"},{"type":{"names":["number"]},"description":"The size of the font.","name":"size"},{"type":{"names":["number"]},"description":"The line height of the font.","name":"lineHeight"},{"type":{"names":["boolean"]},"description":"Whether this font is a retro font (monospace).","name":"retroFont"},{"type":{"names":["Object."]},"description":"The character data of the font, keyed by character code. Each character datum includes a position, size, offset and more.","name":"chars"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.BitmapFontData","scope":"static","___s":true},{"meta":{"filename":"BitmapTextConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"BitmapTextConfig","type":{"names":["object"]},"augments":["Phaser.Types.GameObjects.GameObjectConfig"],"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The key of the font to use from the BitmapFont cache.","name":"font"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The string, or array of strings, to be set as the content of this Bitmap Text.","name":"text"},{"type":{"names":["number","false"]},"optional":true,"defaultvalue":false,"description":"The font size to set.","name":"size"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.BitmapTextConfig","scope":"static","___s":true},{"meta":{"filename":"BitmapTextSize.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"BitmapTextSize","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.GlobalBitmapTextSize"]},"description":"The position and size of the BitmapText, taking into account the position and scale of the Game Object.","name":"global"},{"type":{"names":["Phaser.Types.GameObjects.BitmapText.LocalBitmapTextSize"]},"description":"The position and size of the BitmapText, taking just the font size into account.","name":"local"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.BitmapTextSize","scope":"static","___s":true},{"meta":{"filename":"DisplayCallbackConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"DisplayCallbackConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"The Dynamic Bitmap Text object that owns this character being rendered.","name":"parent"},{"type":{"names":["Phaser.Types.GameObjects.BitmapText.TintConfig"]},"description":"The tint of the character being rendered. Always zero in Canvas.","name":"tint"},{"type":{"names":["number"]},"description":"The index of the character being rendered.","name":"index"},{"type":{"names":["number"]},"description":"The character code of the character being rendered.","name":"charCode"},{"type":{"names":["number"]},"description":"The x position of the character being rendered.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the character being rendered.","name":"y"},{"type":{"names":["number"]},"description":"The scale of the character being rendered.","name":"scale"},{"type":{"names":["number"]},"description":"The rotation of the character being rendered.","name":"rotation"},{"type":{"names":["any"]},"description":"Custom data stored with the character being rendered.","name":"data"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig","scope":"static","___s":true},{"meta":{"filename":"DisplayCallbackConfig.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"DisplayCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig"]},"description":"Settings of the character that is about to be rendered.","name":"display"}],"returns":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig"]},"description":"Altered position, scale and rotation values for the character that is about to be rendered."}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.DisplayCallback","scope":"static","___s":true},{"meta":{"filename":"GlobalBitmapTextSize.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"description":"The position and size of the Bitmap Text in global space, taking into account the Game Object's scale and world position.","kind":"typedef","name":"GlobalBitmapTextSize","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The x position of the BitmapText, taking into account the x position and scale of the Game Object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the BitmapText, taking into account the y position and scale of the Game Object.","name":"y"},{"type":{"names":["number"]},"description":"The width of the BitmapText, taking into account the x scale of the Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of the BitmapText, taking into account the y scale of the Game Object.","name":"height"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.GlobalBitmapTextSize","scope":"static","___s":true},{"meta":{"filename":"JSONBitmapText.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"JSONBitmapText","type":{"names":["object"]},"augments":["Phaser.Types.GameObjects.JSONGameObject"],"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The name of the font.","name":"font"},{"type":{"names":["string"]},"description":"The text that this Bitmap Text displays.","name":"text"},{"type":{"names":["number"]},"description":"The size of the font.","name":"fontSize"},{"type":{"names":["number"]},"description":"Adds / Removes spacing between characters.","name":"letterSpacing"},{"type":{"names":["integer"]},"description":"The alignment of the text in a multi-line BitmapText object.","name":"align"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.JSONBitmapText","scope":"static","___s":true},{"meta":{"filename":"LocalBitmapTextSize.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"description":"The position and size of the Bitmap Text in local space, taking just the font size into account.","kind":"typedef","name":"LocalBitmapTextSize","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The x position of the BitmapText.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the BitmapText.","name":"y"},{"type":{"names":["number"]},"description":"The width of the BitmapText.","name":"width"},{"type":{"names":["number"]},"description":"The height of the BitmapText.","name":"height"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.LocalBitmapTextSize","scope":"static","___s":true},{"meta":{"filename":"RetroFontConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"RetroFontConfig","type":{"names":["object"]},"since":"3.6.0","properties":[{"type":{"names":["string"]},"description":"The key of the image containing the font.","name":"image"},{"type":{"names":["number"]},"description":"If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.","name":"offset.x"},{"type":{"names":["number"]},"description":"If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.","name":"offset.y"},{"type":{"names":["number"]},"description":"The width of each character in the font set.","name":"width"},{"type":{"names":["number"]},"description":"The height of each character in the font set.","name":"height"},{"type":{"names":["string"]},"description":"The characters used in the font set, in display order. You can use the TEXT_SET consts for common font set arrangements.","name":"chars"},{"type":{"names":["number"]},"description":"The number of characters per row in the font set. If not given charsPerRow will be the image width / characterWidth.","name":"charsPerRow"},{"type":{"names":["number"]},"description":"If the characters in the font set have horizontal spacing between them set the required amount here.","name":"spacing.x"},{"type":{"names":["number"]},"description":"If the characters in the font set have vertical spacing between them set the required amount here.","name":"spacing.y"},{"type":{"names":["number"]},"description":"The amount of vertical space to add to the line height of the font.","name":"lineSpacing"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.RetroFontConfig","scope":"static","___s":true},{"meta":{"filename":"TintConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"typedef","name":"TintConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The top left tint value. Always zero in canvas.","name":"topLeft"},{"type":{"names":["number"]},"description":"The top right tint value. Always zero in canvas.","name":"topRight"},{"type":{"names":["number"]},"description":"The bottom left tint value. Always zero in canvas.","name":"bottomLeft"},{"type":{"names":["number"]},"description":"The bottom right tint value. Always zero in canvas.","name":"bottomRight"}],"memberof":"Phaser.Types.GameObjects.BitmapText","longname":"Phaser.Types.GameObjects.BitmapText.TintConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs"},"kind":"namespace","name":"BitmapText","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.BitmapText","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"Blitter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"name":"BlitterRender","longname":"BlitterRender","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Blitter.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"kind":"typedef","name":"CreateCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"The Bob that was created by the Blitter.","name":"bob"},{"type":{"names":["integer"]},"description":"The position of the Bob within the Blitter display list.","name":"index"}],"longname":"CreateCallback","scope":"global","___s":true},{"meta":{"filename":"Blitter.js","lineno":22,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"classdesc":"A Blitter Game Object.\n\nThe Blitter Game Object is a special kind of container that creates, updates and manages Bob objects.\nBobs are designed for rendering speed rather than flexibility. They consist of a texture, or frame from a texture,\na position and an alpha value. You cannot scale or rotate them. They use a batched drawing method for speed\nduring rendering.\n\nA Blitter Game Object has one texture bound to it. Bobs created by the Blitter can use any Frame from this\nTexture to render with, but they cannot use any other Texture. It is this single texture-bind that allows\nthem their speed.\n\nIf you have a need to blast a large volume of frames around the screen then Blitter objects are well worth\ninvestigating. They are especially useful for using as a base for your own special effects systems.","kind":"class","name":"Blitter","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. It can only belong to one Scene at any given time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of this Game Object in world space.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of this Game Object in world space.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'__DEFAULT'","description":"The key of the texture this Game Object will use for rendering. The Texture must already exist in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":0,"description":"The Frame of the Texture that this Game Object will use. Only set if the Texture has multiple frames, such as a Texture Atlas or Sprite Sheet.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.Blitter","___s":true},{"meta":{"filename":"Blitter.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The children of this Blitter.\nThis List contains all of the Bob objects created by the Blitter.","name":"children","type":{"names":["Phaser.Structs.List."]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#children","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Blitter.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Is the Blitter considered dirty?\nA 'dirty' Blitter has had its child count changed since the last frame.","name":"dirty","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Blitter.js","lineno":122,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Creates a new Bob in this Blitter.\n\nThe Bob is created at the given coordinates, relative to the Blitter and uses the given frame.\nA Bob can use any frame belonging to the texture bound to the Blitter.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.","name":"y"},{"type":{"names":["string","integer","Phaser.Textures.Frame"]},"optional":true,"description":"The Frame the Bob will use. It _must_ be part of the Texture the parent Blitter object is using.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the created Bob render or not?","name":"visible"},{"type":{"names":["integer"]},"optional":true,"description":"The position in the Blitters Display List to add the new Bob at. Defaults to the top of the list.","name":"index"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"The newly created Bob object."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#create","scope":"instance","___s":true},{"meta":{"filename":"Blitter.js","lineno":162,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Creates multiple Bob objects within this Blitter and then passes each of them to the specified callback.","kind":"function","name":"createFromCallback","since":"3.0.0","params":[{"type":{"names":["CreateCallback"]},"description":"The callback to invoke after creating a bob. It will be sent two arguments: The Bob and the index of the Bob.","name":"callback"},{"type":{"names":["integer"]},"description":"The quantity of Bob objects to create.","name":"quantity"},{"type":{"names":["string","integer","Phaser.Textures.Frame","Array.","Array.","Array."]},"optional":true,"description":"The Frame the Bobs will use. It must be part of the Blitter Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the created Bob render or not?","name":"visible"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Bob objects that were created."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#createFromCallback","scope":"instance","___s":true},{"meta":{"filename":"Blitter.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Creates multiple Bobs in one call.\n\nThe amount created is controlled by a combination of the `quantity` argument and the number of frames provided.\n\nIf the quantity is set to 10 and you provide 2 frames, then 20 Bobs will be created. 10 with the first\nframe and 10 with the second.","kind":"function","name":"createMultiple","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The quantity of Bob objects to create.","name":"quantity"},{"type":{"names":["string","integer","Phaser.Textures.Frame","Array.","Array.","Array."]},"optional":true,"description":"The Frame the Bobs will use. It must be part of the Blitter Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the created Bob render or not?","name":"visible"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Bob objects that were created."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#createMultiple","scope":"instance","___s":true},{"meta":{"filename":"Blitter.js","lineno":230,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Checks if the given child can render or not, by checking its `visible` and `alpha` values.","kind":"function","name":"childCanRender","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"The Bob to check for rendering.","name":"child"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if the given child can render, otherwise `false`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#childCanRender","scope":"instance","___s":true},{"meta":{"filename":"Blitter.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Returns an array of Bobs to be rendered.\nIf the Blitter is dirty then a new list is generated and stored in `renderList`.","kind":"function","name":"getRenderList","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"An array of Bob objects that will be rendered this frame."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getRenderList","scope":"instance","___s":true},{"meta":{"filename":"Blitter.js","lineno":265,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Removes all Bobs from the children List and clears the dirty flag.","kind":"function","name":"clear","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#clear","scope":"instance","___s":true},{"meta":{"range":[180,210],"filename":"BlitterCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"name":"Blitter","longname":"Blitter","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BlitterCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Creates a new Blitter Game Object and returns it.\n\nNote: This method will only be available if the Blitter Game Object has been built into Phaser.","kind":"function","name":"blitter","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#blitter","scope":"instance","___s":true},{"meta":{"range":[180,210],"filename":"BlitterFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"name":"Blitter","longname":"Blitter","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BlitterFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Creates a new Blitter Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Blitter Game Object has been built into Phaser.","kind":"function","name":"blitter","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the Game Object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Game Object.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture the Blitter object will use.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The default Frame children of the Blitter will use.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#blitter","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"BlitterRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"BlitterWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"Bob.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Bob.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"classdesc":"A Bob Game Object.\n\nA Bob belongs to a Blitter Game Object. The Blitter is responsible for managing and rendering this object.\n\nA Bob has a position, alpha value and a frame from a texture that it uses to render with. You can also toggle\nthe flipped and visible state of the Bob. The Frame the Bob uses to render can be changed dynamically, but it\nmust be a Frame within the Texture used by the parent Blitter.\n\nBob positions are relative to the Blitter parent. So if you move the Blitter parent, all Bob children will\nhave their positions impacted by this change as well.\n\nYou can manipulate Bob objects directly from your game code, but the creation and destruction of them should be\nhandled via the Blitter parent.","kind":"class","name":"Bob","memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"The parent Blitter object is responsible for updating this Bob.","name":"blitter"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world, relative to the parent Blitter position.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world, relative to the parent Blitter position.","name":"y"},{"type":{"names":["string","integer"]},"description":"The Frame this Bob will render with, as defined in the Texture the parent Blitter is using.","name":"frame"},{"type":{"names":["boolean"]},"description":"Should the Bob render visible or not to start with?","name":"visible"}],"scope":"static","longname":"Phaser.GameObjects.Bob","___s":true},{"meta":{"filename":"Bob.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The Blitter object that this Bob belongs to.","name":"parent","type":{"names":["Phaser.GameObjects.Blitter"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The x position of this Bob, relative to the x position of the Blitter.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The y position of this Bob, relative to the y position of the Blitter.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"A blank object which can be used to store data related to this Bob in.","name":"data","type":{"names":["object"]},"defaultvalue":"{}","since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The tint value of this Bob.","name":"tint","type":{"names":["number"]},"defaultvalue":"0xffffff","since":"3.20.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#tint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The horizontally flipped state of the Bob.\nA Bob that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture.","name":"flipX","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#flipX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The vertically flipped state of the Bob.\nA Bob that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture.","name":"flipY","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#flipY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Changes the Texture Frame being used by this Bob.\nThe frame must be part of the Texture the parent Blitter is using.\nIf no value is given it will use the default frame of the Blitter parent.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer","Phaser.Textures.Frame"]},"optional":true,"description":"The frame to be used during rendering.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setFrame","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Resets the horizontal and vertical flipped state of this Bob back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#resetFlip","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Resets this Bob.\n\nChanges the position to the values given, and optionally changes the frame.\n\nAlso resets the flipX and flipY values, sets alpha back to 1 and visible to true.","kind":"function","name":"reset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.","name":"y"},{"type":{"names":["string","integer","Phaser.Textures.Frame"]},"optional":true,"description":"The Frame the Bob will use. It _must_ be part of the Texture the parent Blitter object is using.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#reset","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":228,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Changes the position of this Bob to the values given.","kind":"function","name":"setPosition","since":"3.20.0","params":[{"type":{"names":["number"]},"description":"The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":247,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Sets the horizontal flipped state of this Bob.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setFlipX","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":264,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Sets the vertical flipped state of this Bob.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setFlipY","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":281,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Sets the horizontal and vertical flipped state of this Bob.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setFlip","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Sets the visibility of this Bob.\n\nAn invisible Bob will skip rendering.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setVisible","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Set the Alpha level of this Bob. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nA Bob with alpha 0 will skip rendering.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The alpha value used for this Bob. Between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setAlpha","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":339,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Sets the tint of this Bob.","kind":"function","name":"setTint","since":"3.20.0","params":[{"type":{"names":["number"]},"description":"The tint value used for this Bob. Between 0 and 0xffffff.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Bob"]},"description":"This Bob Game Object."}],"memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#setTint","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":356,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"Destroys this Bob instance.\nRemoves itself from the Blitter and clears the parent, frame and data properties.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#destroy","scope":"instance","___s":true},{"meta":{"filename":"Bob.js","lineno":374,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The visible state of the Bob.\n\nAn invisible Bob will skip rendering.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#visible","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Bob.js","lineno":398,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter"},"description":"The alpha value of the Bob, between 0 and 1.\n\nA Bob with alpha 0 will skip rendering.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Bob","longname":"Phaser.GameObjects.Bob#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,215],"filename":"Alpha.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Alpha.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the alpha properties of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Alpha","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Alpha","scope":"static","___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Alpha"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#clearAlpha","scope":"instance","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Alpha"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#setAlpha","scope":"instance","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#alphaTopRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Alpha","longname":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,215],"filename":"AlphaSingle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the alpha property of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"AlphaSingle","since":"3.22.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.AlphaSingle","scope":"static","___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.AlphaSingle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.AlphaSingle","longname":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","scope":"instance","___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.AlphaSingle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.AlphaSingle","longname":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","scope":"instance","___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.AlphaSingle","longname":"Phaser.GameObjects.Components.AlphaSingle#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,233],"filename":"Animation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"BaseAnimation","longname":"BaseAnimation","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Animation.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"classdesc":"A Game Object Animation Controller.\n\nThis controller lives as an instance within a Game Object, accessible as `sprite.anims`.","kind":"class","name":"Animation","memberof":"Phaser.GameObjects.Components","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to which this animation controller belongs.","name":"parent"}],"scope":"static","longname":"Phaser.GameObjects.Components.Animation","___s":true},{"meta":{"filename":"Animation.js","lineno":30,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Game Object to which this animation controller belongs.","name":"parent","type":{"names":["Phaser.GameObjects.GameObject"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A reference to the global Animation Manager.","name":"animationManager","type":{"names":["Phaser.Animations.AnimationManager"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#animationManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Is an animation currently playing or not?","name":"isPlaying","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#isPlaying","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current Animation loaded into this Animation Controller.","name":"currentAnim","type":{"names":["Phaser.Animations.Animation"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#currentAnim","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current AnimationFrame being displayed by this Animation Controller.","name":"currentFrame","type":{"names":["Phaser.Animations.AnimationFrame"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#currentFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The key of the next Animation to be loaded into this Animation Controller when the current animation completes.","name":"nextAnim","type":{"names":["string"]},"nullable":true,"defaultvalue":"null","since":"3.16.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#nextAnim","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The frame rate of playback in frames per second.\nThe default is 24 if the `duration` property is `null`.","name":"frameRate","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#frameRate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"How long the animation should play for, in milliseconds.\nIf the `frameRate` property has been set then it overrides this value,\notherwise the `frameRate` is derived from `duration`.","name":"duration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"ms per frame, not including frame specific modifiers that may be present in the Animation data.","name":"msPerFrame","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#msPerFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Skip frames if the time lags, or always advanced anyway?","name":"skipMissedFrames","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#skipMissedFrames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":188,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Will the playhead move forwards (`true`) or in reverse (`false`).","name":"forward","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#forward","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":210,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Internal time overflow accumulator.","name":"accumulator","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#accumulator","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The time point at which the next animation frame will change.","name":"nextTick","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#nextTick","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":230,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"An internal counter keeping track of how many repeats are left to play.","name":"repeatCounter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#repeatCounter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":240,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"An internal flag keeping track of pending repeats.","name":"pendingRepeat","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#pendingRepeat","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an animation to be played immediately after the current one completes.\n\nThe current animation must enter a 'completed' state for this to happen, i.e. finish all of its repeats, delays, etc, or have the `stop` method called directly on it.\n\nAn animation set to repeat forever will never enter a completed state.\n\nYou can chain a new animation at any point, including before the current one starts playing, during it, or when it ends (via its `animationcomplete` callback).\nChained animations are specific to a Game Object, meaning different Game Objects can have different chained animations without impacting the global animation they're playing.\n\nCall this method with no arguments to reset the chained animation.","kind":"function","name":"chain","since":"3.16.0","params":[{"type":{"names":["string","Phaser.Animations.Animation"]},"optional":true,"description":"The string-based key of the animation to play next, as defined previously in the Animation Manager. Or an Animation instance.","name":"key"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#chain","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":329,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the amount of time, in milliseconds, that the animation will be delayed before starting playback.","kind":"function","name":"setDelay","since":"3.4.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The amount of time, in milliseconds, to wait before starting playback.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setDelay","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":348,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the amount of time, in milliseconds that the animation will be delayed before starting playback.","kind":"function","name":"getDelay","since":"3.4.0","returns":[{"type":{"names":["integer"]},"description":"The amount of time, in milliseconds, the Animation will wait before starting playback."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getDelay","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":361,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Waits for the specified delay, in milliseconds, then starts playback of the requested animation.","kind":"function","name":"delayedPlay","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The delay, in milliseconds, to wait before starting the animation playing.","name":"delay"},{"type":{"names":["string"]},"description":"The key of the animation to play.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The frame of the animation to start from.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#delayedPlay","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":382,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Returns the key of the animation currently loaded into this component.","kind":"function","name":"getCurrentKey","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The key of the Animation loaded into this component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getCurrentKey","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Pause the current animation and set the `isPlaying` property to `false`.\nYou can optionally pause it at a specific frame.","kind":"function","name":"pause","since":"3.0.0","params":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"optional":true,"description":"An optional frame to set after pausing the animation.","name":"atFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#pause","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":453,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resumes playback of a paused animation and sets the `isPlaying` property to `true`.\nYou can optionally tell it to start playback from a specific frame.","kind":"function","name":"resume","since":"3.0.0","params":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"optional":true,"description":"An optional frame to set before restarting playback.","name":"fromFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#resume","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":480,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"`true` if the current animation is paused, otherwise `false`.","name":"isPaused","readonly":true,"type":{"names":["boolean"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#isPaused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Animation.js","lineno":497,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Plays an Animation on a Game Object that has the Animation component, such as a Sprite.\n\nAnimations are stored in the global Animation Manager and are referenced by a unique string-based key.","kind":"function","name":"play","fires":["Phaser.GameObjects.Components.Animation#event:onStartEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Animations.Animation"]},"description":"The string-based key of the animation to play, as defined previously in the Animation Manager. Or an Animation instance.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#play","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":535,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Plays an Animation (in reverse mode) on the Game Object that owns this Animation Component.","kind":"function","name":"playReverse","fires":["Phaser.GameObjects.Components.Animation#event:onStartEvent"],"since":"3.12.0","params":[{"type":{"names":["string","Phaser.Animations.Animation"]},"description":"The string-based key of the animation to play, as defined previously in the Animation Manager. Or an Animation instance.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If an animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#playReverse","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":569,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Load an Animation and fires 'onStartEvent' event, extracted from 'play' method.","kind":"function","name":"_startAnimation","fires":["Phaser.Animations.Events#event:START_ANIMATION_EVENT","Phaser.Animations.Events#event:SPRITE_START_ANIMATION_EVENT","Phaser.Animations.Events#event:SPRITE_START_KEY_ANIMATION_EVENT"],"since":"3.12.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play, as defined previously in the Animation Manager.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#_startAnimation","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":619,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Reverse the Animation that is already playing on the Game Object.","kind":"function","name":"reverse","since":"3.12.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#reverse","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":639,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Returns a value between 0 and 1 indicating how far this animation is through, ignoring repeats and yoyos.\nIf the animation has a non-zero repeat defined, `getProgress` and `getTotalProgress` will be different\nbecause `getProgress` doesn't include any repeats or repeat delays, whereas `getTotalProgress` does.","kind":"function","name":"getProgress","since":"3.4.0","returns":[{"type":{"names":["number"]},"description":"The progress of the current animation, between 0 and 1."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getProgress","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":661,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Takes a value between 0 and 1 and uses it to set how far this animation is through playback.\nDoes not factor in repeats or yoyos, but does handle playing forwards or backwards.","kind":"function","name":"setProgress","since":"3.4.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The progress value, between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setProgress","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":684,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Handle the removal of an animation from the Animation Manager.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The key of the removed Animation.","name":"key"},{"type":{"names":["Phaser.Animations.Animation"]},"optional":true,"description":"The removed Animation.","name":"animation"}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#remove","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":705,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the number of times that the animation will repeat\nafter its first iteration. For example, if returns 1, the animation will\nplay a total of twice (the initial play plus 1 repeat).\nA value of -1 means the animation will repeat indefinitely.","kind":"function","name":"getRepeat","since":"3.4.0","returns":[{"type":{"names":["integer"]},"description":"The number of times that the animation will repeat."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getRepeat","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":721,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the number of times that the animation should repeat\nafter its first iteration. For example, if repeat is 1, the animation will\nplay a total of twice (the initial play plus 1 repeat).\nTo repeat indefinitely, use -1. repeat should always be an integer.","kind":"function","name":"setRepeat","since":"3.4.0","params":[{"type":{"names":["integer"]},"description":"The number of times that the animation should repeat.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setRepeat","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":743,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the amount of delay between repeats, if any.","kind":"function","name":"getRepeatDelay","since":"3.4.0","returns":[{"type":{"names":["number"]},"description":"The delay between repeats."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getRepeatDelay","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":756,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the amount of time in seconds between repeats.\nFor example, if `repeat` is 2 and `repeatDelay` is 10, the animation will play initially,\nthen wait for 10 seconds before repeating, then play again, then wait another 10 seconds\nbefore doing its final repeat.","kind":"function","name":"setRepeatDelay","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The delay to wait between repeats, in seconds.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setRepeatDelay","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":776,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Restarts the current animation from its beginning, optionally including its delay value.","kind":"function","name":"restart","fires":["Phaser.Animations.Events#event:RESTART_ANIMATION_EVENT","Phaser.Animations.Events#event:SPRITE_RESTART_ANIMATION_EVENT","Phaser.Animations.Events#event:SPRITE_RESTART_KEY_ANIMATION_EVENT"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to include the delay value of the animation when restarting.","name":"includeDelay"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#restart","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":817,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Immediately stops the current animation from playing and dispatches the `animationcomplete` event.\n\nIf no animation is set, no event will be dispatched.\n\nIf there is another animation queued (via the `chain` method) then it will start playing immediately.","kind":"function","name":"stop","fires":["Phaser.GameObjects.Components.Animation#event:onCompleteEvent"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#stop","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":861,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Stops the current animation from playing after the specified time delay, given in milliseconds.","kind":"function","name":"stopAfterDelay","fires":["Phaser.GameObjects.Components.Animation#event:onCompleteEvent"],"since":"3.4.0","params":[{"type":{"names":["integer"]},"description":"The number of milliseconds to wait before stopping this animation.","name":"delay"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#stopAfterDelay","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":880,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Stops the current animation from playing when it next repeats.","kind":"function","name":"stopOnRepeat","fires":["Phaser.GameObjects.Components.Animation#event:onCompleteEvent"],"since":"3.4.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#stopOnRepeat","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":896,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Stops the current animation from playing when it next sets the given frame.\nIf this frame doesn't exist within the animation it will not stop it from playing.","kind":"function","name":"stopOnFrame","fires":["Phaser.GameObjects.Components.Animation#event:onCompleteEvent"],"since":"3.4.0","params":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The frame to check before stopping this animation.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#stopOnFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":916,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Time Scale factor, allowing you to make the animation go go faster or slower than default.\nWhere 1 = normal speed (the default), 0.5 = half speed, 2 = double speed, etc.","kind":"function","name":"setTimeScale","since":"3.4.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The time scale factor, where 1 is no change, 0.5 is half speed, etc.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that owns this Animation Component."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setTimeScale","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":936,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the Time Scale factor.","kind":"function","name":"getTimeScale","since":"3.4.0","returns":[{"type":{"names":["number"]},"description":"The Time Scale value."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getTimeScale","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":949,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Returns the total number of frames in this animation.","kind":"function","name":"getTotalFrames","since":"3.4.0","returns":[{"type":{"names":["integer"]},"description":"The total number of frames in this animation."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getTotalFrames","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":962,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The internal update loop for the Animation Component.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current timestamp.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#update","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":996,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the given Animation Frame as being the current frame\nand applies it to the parent Game Object, adjusting its size and origin as needed.","kind":"function","name":"setCurrentFrame","since":"3.4.0","params":[{"type":{"names":["Phaser.Animations.AnimationFrame"]},"description":"The Animation Frame to set as being current.","name":"animationFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object this Animation Component belongs to."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setCurrentFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":1070,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Advances the animation to the next frame, regardless of the time or animation state.\nIf the animation is set to repeat, or yoyo, this will still take effect.\n\nCalling this does not change the direction of the animation. I.e. if it was currently\nplaying in reverse, calling this method doesn't then change the direction to forwards.","kind":"function","name":"nextFrame","since":"3.16.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object this Animation Component belongs to."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#nextFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":1092,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Advances the animation to the previous frame, regardless of the time or animation state.\nIf the animation is set to repeat, or yoyo, this will still take effect.\n\nCalling this does not change the direction of the animation. I.e. if it was currently\nplaying in forwards, calling this method doesn't then change the direction to backwards.","kind":"function","name":"previousFrame","since":"3.16.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object this Animation Component belongs to."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#previousFrame","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":1114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets if the current Animation will yoyo when it reaches the end.\nA yoyo'ing animation will play through consecutively, and then reverse-play back to the start again.","kind":"function","name":"setYoyo","since":"3.4.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"`true` if the animation should yoyo, `false` to not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object this Animation Component belongs to."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#setYoyo","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":1134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets if the current Animation will yoyo when it reaches the end.\nA yoyo'ing animation will play through consecutively, and then reverse-play back to the start again.","kind":"function","name":"getYoyo","since":"3.4.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the animation is set to yoyo, `false` if not."}],"memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#getYoyo","scope":"instance","___s":true},{"meta":{"filename":"Animation.js","lineno":1148,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Destroy this Animation component.\n\nUnregisters event listeners and cleans up its references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Animation","longname":"Phaser.GameObjects.Components.Animation#destroy","scope":"instance","___s":true},{"meta":{"range":[180,229],"filename":"BlendMode.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"BlendModes","longname":"BlendModes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BlendMode.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the blend mode of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"BlendMode","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.BlendMode","scope":"static","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.BlendMode","longname":"Phaser.GameObjects.Components.BlendMode#blendMode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.BlendMode"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.BlendMode","longname":"Phaser.GameObjects.Components.BlendMode#setBlendMode","scope":"instance","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for calculating and setting the size of a non-Frame based Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"ComputedSize","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.ComputedSize","scope":"static","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.ComputedSize","longname":"Phaser.GameObjects.Components.ComputedSize#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.ComputedSize","longname":"Phaser.GameObjects.Components.ComputedSize#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.ComputedSize","longname":"Phaser.GameObjects.Components.ComputedSize#displayWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.ComputedSize","longname":"Phaser.GameObjects.Components.ComputedSize#displayHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.ComputedSize"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.ComputedSize","longname":"Phaser.GameObjects.Components.ComputedSize#setSize","scope":"instance","___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.ComputedSize"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.ComputedSize","longname":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","scope":"instance","___s":true},{"meta":{"filename":"Crop.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the texture of a Game Object.","kind":"namespace","name":"Crop","since":"3.12.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Crop","scope":"static","___s":true},{"meta":{"filename":"Crop.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Crop","longname":"Phaser.GameObjects.Components.Crop#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Crop.js","lineno":25,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Crop","longname":"Phaser.GameObjects.Components.Crop#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Crop.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Components.Crop","longname":"Phaser.GameObjects.Components.Crop#isCropped","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Crop.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Crop"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Crop","longname":"Phaser.GameObjects.Components.Crop#setCrop","scope":"instance","___s":true},{"meta":{"filename":"Depth.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the depth of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Depth","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Depth","scope":"static","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Depth","longname":"Phaser.GameObjects.Components.Depth#depth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Depth"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Depth","longname":"Phaser.GameObjects.Components.Depth#setDepth","scope":"instance","___s":true},{"meta":{"filename":"Flip.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for visually flipping a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Flip","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Flip","scope":"static","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#flipX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#flipY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Flip"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#toggleFlipX","scope":"instance","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Flip"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#toggleFlipY","scope":"instance","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Flip"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#setFlipX","scope":"instance","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Flip"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#setFlipY","scope":"instance","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Flip"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#setFlip","scope":"instance","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Flip"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Flip","longname":"Phaser.GameObjects.Components.Flip#resetFlip","scope":"instance","___s":true},{"meta":{"range":[180,233],"filename":"GetBounds.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetBounds.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for obtaining the bounds of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"GetBounds","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.GetBounds","scope":"static","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getCenter","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getTopLeft","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getTopCenter","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getTopRight","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getRightCenter","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getBottomRight","scope":"instance","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Components.GetBounds","longname":"Phaser.GameObjects.Components.GetBounds#getBounds","scope":"instance","___s":true},{"meta":{"range":[180,233],"filename":"Mask.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"BitmapMask","longname":"BitmapMask","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Mask.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the mask of a Game Object.","kind":"namespace","name":"Mask","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Mask","scope":"static","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Mask","longname":"Phaser.GameObjects.Components.Mask#mask","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Mask"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Mask","longname":"Phaser.GameObjects.Components.Mask#setMask","scope":"instance","___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Mask"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Mask","longname":"Phaser.GameObjects.Components.Mask#clearMask","scope":"instance","___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Components.Mask","longname":"Phaser.GameObjects.Components.Mask#createBitmapMask","scope":"instance","___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Components.Mask","longname":"Phaser.GameObjects.Components.Mask#createGeometryMask","scope":"instance","___s":true},{"meta":{"filename":"Origin.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the origin of a Game Object.\nValues are normalized, given in the range 0 to 1.\nDisplay values contain the calculated pixel values.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Origin","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Origin","scope":"static","___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#originX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#originY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#displayOriginX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#displayOriginY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Origin"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#setOrigin","scope":"instance","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Origin"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","scope":"instance","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Origin"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","scope":"instance","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Origin"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Origin","longname":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"PathFollower.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"DegToRad","longname":"DegToRad","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PathFollower.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for managing a Game Object following a Path.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"PathFollower","since":"3.17.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.PathFollower","scope":"static","___s":true},{"meta":{"filename":"PathFollower.js","lineno":23,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Path this PathFollower is following. It can only follow one Path at a time.","name":"path","type":{"names":["Phaser.Curves.Path"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#path","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Should the PathFollower automatically rotate to point in the direction of the Path?","name":"rotateToPath","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#rotateToPath","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":42,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"If the PathFollower is rotating to match the Path (@see Phaser.GameObjects.PathFollower#rotateToPath)\nthis value is added to the rotation value. This allows you to rotate objects to a path but control\nthe angle of the rotation as well.","name":"pathRotationOffset","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pathRotationOffset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"An additional vector to add to the PathFollowers position, allowing you to offset it from the\nPath coordinates.","name":"pathOffset","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pathOffset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A Vector2 that stores the current point of the path the follower is on.","name":"pathVector","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pathVector","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Tween used for following the Path.","name":"pathTween","type":{"names":["Phaser.Tweens.Tween"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pathTween","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Settings for the PathFollower.","name":"pathConfig","type":{"names":["Phaser.Types.GameObjects.PathFollower.PathConfig"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pathConfig","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PathFollower.js","lineno":102,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Path that this PathFollower should follow.\n\nOptionally accepts {@link Phaser.Types.GameObjects.PathFollower.PathConfig} settings.","kind":"function","name":"setPath","since":"3.0.0","params":[{"type":{"names":["Phaser.Curves.Path"]},"description":"The Path this PathFollower is following. It can only follow one Path at a time.","name":"path"},{"type":{"names":["number","Phaser.Types.GameObjects.PathFollower.PathConfig","Phaser.Types.Tweens.NumberTweenBuilderConfig"]},"optional":true,"description":"Settings for the PathFollower.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#setPath","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set whether the PathFollower should automatically rotate to point in the direction of the Path.","kind":"function","name":"setRotateToPath","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether the PathFollower should automatically rotate to point in the direction of the Path.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Rotation offset in degrees.","name":"offset"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#setRotateToPath","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Is this PathFollower actively following a Path or not?\n\nTo be considered as `isFollowing` it must be currently moving on a Path, and not paused.","kind":"function","name":"isFollowing","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` is this PathFollower is actively following a Path, otherwise `false`."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#isFollowing","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Starts this PathFollower following its given Path.","kind":"function","name":"startFollow","since":"3.3.0","params":[{"type":{"names":["number","Phaser.Types.GameObjects.PathFollower.PathConfig","Phaser.Types.Tweens.NumberTweenBuilderConfig"]},"optional":true,"defaultvalue":"{}","description":"The duration of the follow, or a PathFollower config object.","name":"config"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional start position of the follow, between 0 and 1.","name":"startAt"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#startFollow","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":267,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Pauses this PathFollower. It will still continue to render, but it will remain motionless at the\npoint on the Path at which you paused it.","kind":"function","name":"pauseFollow","since":"3.3.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#pauseFollow","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":288,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resumes a previously paused PathFollower.\n\nIf the PathFollower was not paused this has no effect.","kind":"function","name":"resumeFollow","since":"3.3.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#resumeFollow","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Stops this PathFollower from following the path any longer.\n\nThis will invoke any 'stop' conditions that may exist on the Path, or for the follower.","kind":"function","name":"stopFollow","since":"3.3.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#stopFollow","scope":"instance","___s":true},{"meta":{"filename":"PathFollower.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Internal update handler that advances this PathFollower along the path.\n\nCalled automatically by the Scene step, should not typically be called directly.","kind":"function","name":"pathUpdate","since":"3.17.0","memberof":"Phaser.GameObjects.Components.PathFollower","longname":"Phaser.GameObjects.Components.PathFollower#pathUpdate","scope":"instance","___s":true},{"meta":{"filename":"Pipeline.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the WebGL rendering pipeline of a Game Object.","kind":"namespace","name":"Pipeline","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Pipeline","scope":"static","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Pipeline","longname":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Pipeline","longname":"Phaser.GameObjects.Components.Pipeline#pipeline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Components.Pipeline","longname":"Phaser.GameObjects.Components.Pipeline#initPipeline","scope":"instance","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Pipeline"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Pipeline","longname":"Phaser.GameObjects.Components.Pipeline#setPipeline","scope":"instance","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Components.Pipeline","longname":"Phaser.GameObjects.Components.Pipeline#resetPipeline","scope":"instance","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Components.Pipeline","longname":"Phaser.GameObjects.Components.Pipeline#getPipelineName","scope":"instance","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the Scroll Factor of a Game Object.","kind":"namespace","name":"ScrollFactor","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.ScrollFactor","scope":"static","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Components.ScrollFactor","longname":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Components.ScrollFactor","longname":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.ScrollFactor"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.ScrollFactor","longname":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the size of a Game Object.","kind":"namespace","name":"Size","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Size","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#displayWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#displayHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Size"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#setSizeToFrame","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Size"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#setSize","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Size"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Size","longname":"Phaser.GameObjects.Components.Size#setDisplaySize","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the texture of a Game Object.","kind":"namespace","name":"Texture","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Texture","scope":"static","___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Texture","longname":"Phaser.GameObjects.Components.Texture#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Texture","longname":"Phaser.GameObjects.Components.Texture#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Texture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Texture","longname":"Phaser.GameObjects.Components.Texture#setTexture","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Texture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Texture","longname":"Phaser.GameObjects.Components.Texture#setFrame","scope":"instance","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the texture of a Game Object.","kind":"namespace","name":"TextureCrop","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.TextureCrop","scope":"static","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.TextureCrop","longname":"Phaser.GameObjects.Components.TextureCrop#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.TextureCrop","longname":"Phaser.GameObjects.Components.TextureCrop#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Components.TextureCrop","longname":"Phaser.GameObjects.Components.TextureCrop#isCropped","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TextureCrop"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.TextureCrop","longname":"Phaser.GameObjects.Components.TextureCrop#setCrop","scope":"instance","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TextureCrop"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.TextureCrop","longname":"Phaser.GameObjects.Components.TextureCrop#setTexture","scope":"instance","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TextureCrop"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.TextureCrop","longname":"Phaser.GameObjects.Components.TextureCrop#setFrame","scope":"instance","___s":true},{"meta":{"filename":"Tint.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the tint of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Tint","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Tint","scope":"static","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#tintFill","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.Tint"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#clearTint","scope":"instance","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Tint"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#setTint","scope":"instance","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Tint"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#setTintFill","scope":"instance","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#tintTopLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#tintTopRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#tintBottomLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#tintBottomRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#tint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.Components.Tint","longname":"Phaser.GameObjects.Components.Tint#isTinted","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ToJSON.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Build a JSON representation of the given Game Object.\n\nThis is typically extended further by Game Object specific implementations.","kind":"function","name":"ToJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to export as JSON.","name":"gameObject"}],"returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.ToJSON","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"Transform.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Transform.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for getting and setting the position, scale and rotation of a Game Object.","kind":"namespace","name":"Transform","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Transform","scope":"static","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#z","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#w","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#scale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#scaleX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#scaleY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setRandomPosition","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setRotation","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setAngle","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setScale","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setX","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setY","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setZ","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Transform"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#setW","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Components.Transform","longname":"Phaser.GameObjects.Components.Transform#getParentRotation","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"TransformMatrix.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"classdesc":"A Matrix used for display transformations for rendering.\n\nIt is represented like so:\n\n```\n| a | c | tx |\n| b | d | ty |\n| 0 | 0 | 1 |\n```","kind":"class","name":"TransformMatrix","memberof":"Phaser.GameObjects.Components","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The Scale X value.","name":"a"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The Skew Y value.","name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The Skew X value.","name":"c"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The Scale Y value.","name":"d"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The Translate X value.","name":"tx"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The Translate Y value.","name":"ty"}],"scope":"static","longname":"Phaser.GameObjects.Components.TransformMatrix","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The matrix values.","name":"matrix","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#matrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The decomposed matrix.","name":"decomposedMatrix","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#decomposedMatrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Scale X value.","name":"a","type":{"names":["number"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#a","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":94,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Skew Y value.","name":"b","type":{"names":["number"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#b","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":115,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Skew X value.","name":"c","type":{"names":["number"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#c","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Scale Y value.","name":"d","type":{"names":["number"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#d","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Translate X value.","name":"e","type":{"names":["number"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#e","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Translate Y value.","name":"f","type":{"names":["number"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#f","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":199,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Translate X value.","name":"tx","type":{"names":["number"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#tx","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Translate Y value.","name":"ty","type":{"names":["number"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#ty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The rotation of the Matrix. Value is in radians.","name":"rotation","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The rotation of the Matrix, normalized to be within the Phaser right-handed\nclockwise rotation space. Value is in radians.","name":"rotationNormalized","type":{"names":["number"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#rotationNormalized","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The decomposed horizontal scale of the Matrix. This value is always positive.","name":"scaleX","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#scaleX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":315,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The decomposed vertical scale of the Matrix. This value is always positive.","name":"scaleY","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#scaleY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Reset the Matrix to an identity matrix.","kind":"function","name":"loadIdentity","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#loadIdentity","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":354,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Translate the Matrix.","kind":"function","name":"translate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal translation value.","name":"x"},{"type":{"names":["number"]},"description":"The vertical translation value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#translate","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":375,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Scale the Matrix.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale value.","name":"x"},{"type":{"names":["number"]},"description":"The vertical scale value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#scale","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":398,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Rotate the Matrix.","kind":"function","name":"rotate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#rotate","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":428,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Multiply this Matrix by the given Matrix.\n\nIf an `out` Matrix is given then the results will be stored in it.\nIf it is not given, this matrix will be updated in place instead.\nUse an `out` Matrix if you do not wish to mutate this matrix.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The Matrix to multiply by.","name":"rhs"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"An optional Matrix to store the results in.","name":"out"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"Either this TransformMatrix, or the `out` Matrix, if given in the arguments."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#multiply","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":474,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Multiply this Matrix by the matrix given, including the offset.\n\nThe offsetX is added to the tx value: `offsetX * a + offsetY * c + tx`.\nThe offsetY is added to the ty value: `offsetY * b + offsetY * d + ty`.","kind":"function","name":"multiplyWithOffset","since":"3.11.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The source Matrix to copy from.","name":"src"},{"type":{"names":["number"]},"description":"Horizontal offset to factor in to the multiplication.","name":"offsetX"},{"type":{"names":["number"]},"description":"Vertical offset to factor in to the multiplication.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#multiplyWithOffset","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":521,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Transform the Matrix.","kind":"function","name":"transform","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The Scale X value.","name":"a"},{"type":{"names":["number"]},"description":"The Shear Y value.","name":"b"},{"type":{"names":["number"]},"description":"The Shear X value.","name":"c"},{"type":{"names":["number"]},"description":"The Scale Y value.","name":"d"},{"type":{"names":["number"]},"description":"The Translate X value.","name":"tx"},{"type":{"names":["number"]},"description":"The Translate Y value.","name":"ty"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#transform","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":557,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Transform a point using this Matrix.","kind":"function","name":"transformPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the point to transform.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the point to transform.","name":"y"},{"type":{"names":["Phaser.Geom.Point","Phaser.Math.Vector2","object"]},"description":"The Point object to store the transformed coordinates.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point","Phaser.Math.Vector2","object"]},"description":"The Point containing the transformed coordinates."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#transformPoint","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":588,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Invert the Matrix.","kind":"function","name":"invert","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#invert","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":619,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the values of this Matrix to copy those of the matrix given.","kind":"function","name":"copyFrom","since":"3.11.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The source Matrix to copy from.","name":"src"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#copyFrom","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":643,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the values of this Matrix to copy those of the array given.\nWhere array indexes 0, 1, 2, 3, 4 and 5 are mapped to a, b, c, d, e and f.","kind":"function","name":"copyFromArray","since":"3.11.0","params":[{"type":{"names":["array"]},"description":"The array of values to set into this matrix.","name":"src"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#copyFromArray","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":668,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Copy the values from this Matrix to the given Canvas Rendering Context.\nThis will use the Context.transform method.","kind":"function","name":"copyToContext","since":"3.12.0","params":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context to copy the matrix values to.","name":"ctx"}],"returns":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#copyToContext","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":688,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Copy the values from this Matrix to the given Canvas Rendering Context.\nThis will use the Context.setTransform method.","kind":"function","name":"setToContext","since":"3.12.0","params":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context to copy the matrix values to.","name":"ctx"}],"returns":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#setToContext","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":708,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Copy the values in this Matrix to the array given.\n\nWhere array indexes 0, 1, 2, 3, 4 and 5 are mapped to a, b, c, d, e and f.","kind":"function","name":"copyToArray","since":"3.12.0","params":[{"type":{"names":["array"]},"optional":true,"description":"The array to copy the matrix values in to.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array where elements 0 to 5 contain the values from this matrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#copyToArray","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":741,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the values of this Matrix.","kind":"function","name":"setTransform","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The Scale X value.","name":"a"},{"type":{"names":["number"]},"description":"The Shear Y value.","name":"b"},{"type":{"names":["number"]},"description":"The Shear X value.","name":"c"},{"type":{"names":["number"]},"description":"The Scale Y value.","name":"d"},{"type":{"names":["number"]},"description":"The Translate X value.","name":"tx"},{"type":{"names":["number"]},"description":"The Translate Y value.","name":"ty"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#setTransform","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":770,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Decompose this Matrix into its translation, scale and rotation values using QR decomposition.\n\nThe result must be applied in the following order to reproduce the current matrix:\n\ntranslate -> rotate -> scale","kind":"function","name":"decomposeMatrix","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"The decomposed Matrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#decomposeMatrix","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":829,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Apply the identity, translate, rotate and scale operations on the Matrix.","kind":"function","name":"applyITRS","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal translation.","name":"x"},{"type":{"names":["number"]},"description":"The vertical translation.","name":"y"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"rotation"},{"type":{"names":["number"]},"description":"The horizontal scale.","name":"scaleX"},{"type":{"names":["number"]},"description":"The vertical scale.","name":"scaleY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"This TransformMatrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#applyITRS","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":863,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Takes the `x` and `y` values and returns a new position in the `output` vector that is the inverse of\nthe current matrix with its transformation applied.\n\nCan be used to translate points from world to local space.","kind":"function","name":"applyInverse","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The x position to translate.","name":"x"},{"type":{"names":["number"]},"description":"The y position to translate.","name":"y"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2, or point-like object, to store the results in.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The coordinates, inverse-transformed through this matrix."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#applyInverse","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":899,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Returns the X component of this matrix multiplied by the given values.\nThis is the same as `x * a + y * c + e`.","kind":"function","name":"getX","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The x value.","name":"x"},{"type":{"names":["number"]},"description":"The y value.","name":"y"}],"returns":[{"type":{"names":["number"]},"description":"The calculated x value."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#getX","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":916,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Returns the Y component of this matrix multiplied by the given values.\nThis is the same as `x * b + y * d + f`.","kind":"function","name":"getY","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The x value.","name":"x"},{"type":{"names":["number"]},"description":"The y value.","name":"y"}],"returns":[{"type":{"names":["number"]},"description":"The calculated y value."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#getY","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":933,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Returns a string that can be used in a CSS Transform call as a `matrix` property.","kind":"function","name":"getCSSMatrix","since":"3.12.0","returns":[{"type":{"names":["string"]},"description":"A string containing the CSS Transform matrix values."}],"memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#getCSSMatrix","scope":"instance","___s":true},{"meta":{"filename":"TransformMatrix.js","lineno":948,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Destroys this Transform Matrix.","kind":"function","name":"destroy","since":"3.4.0","memberof":"Phaser.GameObjects.Components.TransformMatrix","longname":"Phaser.GameObjects.Components.TransformMatrix#destroy","scope":"instance","___s":true},{"meta":{"filename":"Visible.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Provides methods used for setting the visibility of a Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Visible","since":"3.0.0","memberof":"Phaser.GameObjects.Components","longname":"Phaser.GameObjects.Components.Visible","scope":"static","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Components.Visible","longname":"Phaser.GameObjects.Components.Visible#visible","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.Visible"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Components.Visible","longname":"Phaser.GameObjects.Components.Visible#setVisible","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"kind":"namespace","name":"Components","memberof":"Phaser.GameObjects","longname":"Phaser.GameObjects.Components","scope":"static","___s":true},{"meta":{"range":[225,266],"filename":"Container.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"name":"ArrayUtils","longname":"ArrayUtils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Container.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"classdesc":"A Container Game Object.\n\nA Container, as the name implies, can 'contain' other types of Game Object.\nWhen a Game Object is added to a Container, the Container becomes responsible for the rendering of it.\nBy default it will be removed from the Display List and instead added to the Containers own internal list.\n\nThe position of the Game Object automatically becomes relative to the position of the Container.\n\nWhen the Container is rendered, all of its children are rendered as well, in the order in which they exist\nwithin the Container. Container children can be repositioned using methods such as `MoveUp`, `MoveDown` and `SendToBack`.\n\nIf you modify a transform property of the Container, such as `Container.x` or `Container.rotation` then it will\nautomatically influence all children as well.\n\nContainers can include other Containers for deeply nested transforms.\n\nContainers can have masks set on them and can be used as a mask too. However, Container children cannot be masked.\nThe masks do not 'stack up'. Only a Container on the root of the display list will use its mask.\n\nContainers can be enabled for input. Because they do not have a texture you need to provide a shape for them\nto use as their hit area. Container children can also be enabled for input, independent of the Container.\n\nContainers can be given a physics body for either Arcade Physics, Impact Physics or Matter Physics. However,\nif Container _children_ are enabled for physics you may get unexpected results, such as offset bodies,\nif the Container itself, or any of its ancestors, is positioned anywhere other than at 0 x 0. Container children\nwith physics do not factor in the Container due to the excessive extra calculations needed. Please structure\nyour game to work around this.\n\nIt's important to understand the impact of using Containers. They add additional processing overhead into\nevery one of their children. The deeper you nest them, the more the cost escalates. This is especially true\nfor input events. You also loose the ability to set the display depth of Container children in the same\nflexible manner as those not within them. In short, don't use them for the sake of it. You pay a small cost\nevery time you create one, try to structure your game around avoiding that where possible.","kind":"class","name":"Container","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.AlphaSingle","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.4.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["Array."]},"optional":true,"description":"An optional array of Game Objects to add to this Container.","name":"children"}],"scope":"static","longname":"Phaser.GameObjects.Container","___s":true},{"meta":{"filename":"Container.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"An array holding the children of this Container.","name":"list","type":{"names":["Array."]},"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#list","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Does this Container exclusively manage its children?\n\nThe default is `true` which means a child added to this Container cannot\nbelong in another Container, which includes the Scene display list.\n\nIf you disable this then this Container will no longer exclusively manage its children.\nThis allows you to create all kinds of interesting graphical effects, such as replicating\nGame Objects without reparenting them all over the Scene.\nHowever, doing so will prevent children from receiving any kind of input event or have\ntheir physics bodies work by default, as they're no longer a single entity on the\ndisplay list, but are being replicated where-ever this Container is.","name":"exclusive","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#exclusive","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Containers can have an optional maximum size. If set to anything above 0 it\nwill constrict the addition of new Game Objects into the Container, capping off\nthe maximum limit the Container can grow in size to.","name":"maxSize","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#maxSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"The cursor position.","name":"position","type":{"names":["integer"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#position","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":145,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Internal Transform Matrix used for local space conversion.","name":"localTransform","type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#localTransform","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":194,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"The horizontal scroll factor of this Container.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Container.\n\nWhen a camera scrolls it will change the location at which this Container is rendered on-screen.\nIt does not change the Containers actual position values.\n\nFor a Container, setting this value will only update the Container itself, not its children.\nIf you wish to change the scrollFactor of the children as well, use the `setScrollFactor` method.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Container.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#scrollFactorX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":221,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"The vertical scroll factor of this Container.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Container.\n\nWhen a camera scrolls it will change the location at which this Container is rendered on-screen.\nIt does not change the Containers actual position values.\n\nFor a Container, setting this value will only update the Container itself, not its children.\nIf you wish to change the scrollFactor of the children as well, use the `setScrollFactor` method.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Container.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#scrollFactorY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Internal value to allow Containers to be used for input and physics.\nDo not change this value. It has no effect other than to break things.","name":"originX","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#originX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Internal value to allow Containers to be used for input and physics.\nDo not change this value. It has no effect other than to break things.","name":"originY","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#originY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":296,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Internal value to allow Containers to be used for input and physics.\nDo not change this value. It has no effect other than to break things.","name":"displayOriginX","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#displayOriginX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Internal value to allow Containers to be used for input and physics.\nDo not change this value. It has no effect other than to break things.","name":"displayOriginY","type":{"names":["number"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#displayOriginY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Does this Container exclusively manage its children?\n\nThe default is `true` which means a child added to this Container cannot\nbelong in another Container, which includes the Scene display list.\n\nIf you disable this then this Container will no longer exclusively manage its children.\nThis allows you to create all kinds of interesting graphical effects, such as replicating\nGame Objects without reparenting them all over the Scene.\nHowever, doing so will prevent children from receiving any kind of input event or have\ntheir physics bodies work by default, as they're no longer a single entity on the\ndisplay list, but are being replicated where-ever this Container is.","kind":"function","name":"setExclusive","since":"3.4.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The exclusive state of this Container.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setExclusive","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":361,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Gets the bounds of this Container. It works by iterating all children of the Container,\ngetting their respective bounds, and then working out a min-max rectangle from that.\nIt does not factor in if the children render or not, all are included.\n\nSome children are unable to return their bounds, such as Graphics objects, in which case\nthey are skipped.\n\nDepending on the quantity of children in this Container it could be a really expensive call,\nso cache it and only poll it as needed.\n\nThe values are stored and returned in a Rectangle object.","kind":"function","name":"getBounds","since":"3.4.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"A Geom.Rectangle object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getBounds","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":453,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Takes a Point-like object, such as a Vector2, Geom.Point or object with public x and y properties,\nand transforms it into the space of this Container, then returns it in the output object.","kind":"function","name":"pointToContainer","since":"3.4.0","params":[{"type":{"names":["object","Phaser.Geom.Point","Phaser.Math.Vector2"]},"description":"The Source Point to be transformed.","name":"source"},{"type":{"names":["object","Phaser.Geom.Point","Phaser.Math.Vector2"]},"optional":true,"description":"A destination object to store the transformed point in. If none given a Vector2 will be created and returned.","name":"output"}],"returns":[{"type":{"names":["object","Phaser.Geom.Point","Phaser.Math.Vector2"]},"description":"The transformed point."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#pointToContainer","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":486,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the world transform matrix as used for Bounds checks.\n\nThe returned matrix is temporal and shouldn't be stored.","kind":"function","name":"getBoundsTransformMatrix","since":"3.4.0","returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The world transform matrix."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getBoundsTransformMatrix","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Adds the given Game Object, or array of Game Objects, to this Container.\n\nEach Game Object must be unique within the Container.","kind":"function","name":"add","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"The Game Object, or array of Game Objects, to add to the Container.","name":"child"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#add","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":520,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Adds the given Game Object, or array of Game Objects, to this Container at the specified position.\n\nExisting Game Objects in the Container are shifted up.\n\nEach Game Object must be unique within the Container.","kind":"function","name":"addAt","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"The Game Object, or array of Game Objects, to add to the Container.","name":"child"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The position to insert the Game Object/s at.","name":"index"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#addAt","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":542,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the Game Object at the given position in this Container.","kind":"function","name":"getAt","since":"3.4.0","params":[{"type":{"names":["integer"]},"description":"The position to get the Game Object from.","name":"index"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The Game Object at the specified index, or `null` if none found."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getAt","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":557,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the index of the given Game Object in this Container.","kind":"function","name":"getIndex","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to search for in this Container.","name":"child"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the Game Object in this Container, or -1 if not found."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getIndex","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":572,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Sort the contents of this Container so the items are in order based on the given property.\nFor example: `sort('alpha')` would sort the elements based on the value of their `alpha` property.","kind":"function","name":"sort","since":"3.4.0","params":[{"type":{"names":["string"]},"description":"The property to lexically sort by.","name":"property"},{"type":{"names":["function"]},"optional":true,"description":"Provide your own custom handler function. Will receive 2 children which it should compare and return a boolean.","name":"handler"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#sort","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":604,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Searches for the first instance of a child with its `name` property matching the given argument.\nShould more than one child have the same name only the first is returned.","kind":"function","name":"getByName","since":"3.4.0","params":[{"type":{"names":["string"]},"description":"The name to search for.","name":"name"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The first child with a matching name, or `null` if none were found."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getByName","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":620,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns a random Game Object from this Container.","kind":"function","name":"getRandom","since":"3.4.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"An optional length, the total number of elements (from the startIndex) to choose from.","name":"length"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"description":"A random child from the Container, or `null` if the Container is empty."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getRandom","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":636,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Gets the first Game Object in this Container.\n\nYou can also specify a property and value to search for, in which case it will return the first\nGame Object in this Container with a matching property and / or value.\n\nFor example: `getFirst('visible', true)` would return the first Game Object that had its `visible` property set.\n\nYou can limit the search to the `startIndex` - `endIndex` range.","kind":"function","name":"getFirst","since":"3.4.0","params":[{"type":{"names":["string"]},"description":"The property to test on each Game Object in the Container.","name":"property"},{"type":{"names":["*"]},"description":"The value to test the property against. Must pass a strict (`===`) comparison check.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Container.length","description":"An optional end index to search up to (but not included)","name":"endIndex"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The first matching Game Object, or `null` if none was found."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getFirst","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":661,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns all Game Objects in this Container.\n\nYou can optionally specify a matching criteria using the `property` and `value` arguments.\n\nFor example: `getAll('body')` would return only Game Objects that have a body property.\n\nYou can also specify a value to compare the property to:\n\n`getAll('visible', true)` would return only Game Objects that have their visible property set to `true`.\n\nOptionally you can specify a start and end index. For example if this Container had 100 Game Objects,\nand you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\nthe first 50 Game Objects.","kind":"function","name":"getAll","since":"3.4.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The property to test on each Game Object in the Container.","name":"property"},{"type":{"names":["any"]},"optional":true,"description":"If property is set then the `property` must strictly equal this value to be included in the results.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Container.length","description":"An optional end index to search up to (but not included)","name":"endIndex"}],"returns":[{"type":{"names":["Array."]},"description":"An array of matching Game Objects from this Container."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getAll","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":691,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the total number of Game Objects in this Container that have a property\nmatching the given value.\n\nFor example: `count('visible', true)` would count all the elements that have their visible property set.\n\nYou can optionally limit the operation to the `startIndex` - `endIndex` range.","kind":"function","name":"count","since":"3.4.0","params":[{"type":{"names":["string"]},"description":"The property to check.","name":"property"},{"type":{"names":["any"]},"description":"The value to check.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Container.length","description":"An optional end index to search up to (but not included)","name":"endIndex"}],"returns":[{"type":{"names":["integer"]},"description":"The total number of Game Objects in this Container with a property matching the given value."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#count","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":714,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Swaps the position of two Game Objects in this Container.\nBoth Game Objects must belong to this Container.","kind":"function","name":"swap","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first Game Object to swap.","name":"child1"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The second Game Object to swap.","name":"child2"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#swap","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":733,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Moves a Game Object to a new position within this Container.\n\nThe Game Object must already be a child of this Container.\n\nThe Game Object is removed from its old position and inserted into the new one.\nTherefore the Container size does not change. Other children will change position accordingly.","kind":"function","name":"moveTo","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to move.","name":"child"},{"type":{"names":["integer"]},"description":"The new position of the Game Object in this Container.","name":"index"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#moveTo","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":756,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Removes the given Game Object, or array of Game Objects, from this Container.\n\nThe Game Objects must already be children of this Container.\n\nYou can also optionally call `destroy` on each Game Object that is removed from the Container.","kind":"function","name":"remove","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"The Game Object, or array of Game Objects, to be removed from the Container.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call `destroy` on each child successfully removed from this Container.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#remove","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":791,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Removes the Game Object at the given position in this Container.\n\nYou can also optionally call `destroy` on the Game Object, if one is found.","kind":"function","name":"removeAt","since":"3.4.0","params":[{"type":{"names":["integer"]},"description":"The index of the Game Object to be removed.","name":"index"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call `destroy` on the Game Object if successfully removed from this Container.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#removeAt","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":816,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Removes the Game Objects between the given positions in this Container.\n\nYou can also optionally call `destroy` on each Game Object that is removed from the Container.","kind":"function","name":"removeBetween","since":"3.4.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Container.length","description":"An optional end index to search up to (but not included)","name":"endIndex"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call `destroy` on each Game Object successfully removed from this Container.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#removeBetween","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":845,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Removes all Game Objects from this Container.\n\nYou can also optionally call `destroy` on each Game Object that is removed from the Container.","kind":"function","name":"removeAll","since":"3.4.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call `destroy` on each Game Object successfully removed from this Container.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#removeAll","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":872,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Brings the given Game Object to the top of this Container.\nThis will cause it to render on-top of any other objects in the Container.","kind":"function","name":"bringToTop","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to bring to the top of the Container.","name":"child"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#bringToTop","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":890,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Sends the given Game Object to the bottom of this Container.\nThis will cause it to render below any other objects in the Container.","kind":"function","name":"sendToBack","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to send to the bottom of the Container.","name":"child"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#sendToBack","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":908,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Moves the given Game Object up one place in this Container, unless it's already at the top.","kind":"function","name":"moveUp","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to be moved in the Container.","name":"child"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#moveUp","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":925,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Moves the given Game Object down one place in this Container, unless it's already at the bottom.","kind":"function","name":"moveDown","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to be moved in the Container.","name":"child"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#moveDown","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":942,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Reverses the order of all Game Objects in this Container.","kind":"function","name":"reverse","since":"3.4.0","returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#reverse","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":957,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Shuffles the all Game Objects in this Container using the Fisher-Yates implementation.","kind":"function","name":"shuffle","since":"3.4.0","returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#shuffle","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":972,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Replaces a Game Object in this Container with the new Game Object.\nThe new Game Object cannot already be a child of this Container.","kind":"function","name":"replace","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object in this Container that will be replaced.","name":"oldChild"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to be added to this Container.","name":"newChild"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call `destroy` on the Game Object if successfully removed from this Container.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#replace","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":1003,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns `true` if the given Game Object is a direct child of this Container.\n\nThis check does not scan nested Containers.","kind":"function","name":"exists","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to check for within this Container.","name":"child"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object is an immediate child of this Container, otherwise false."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#exists","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":1020,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Sets the property to the given value on all Game Objects in this Container.\n\nOptionally you can specify a start and end index. For example if this Container had 100 Game Objects,\nand you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\nthe first 50 Game Objects.","kind":"function","name":"setAll","since":"3.4.0","params":[{"type":{"names":["string"]},"description":"The property that must exist on the Game Object.","name":"property"},{"type":{"names":["any"]},"description":"The value to get the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"Container.length","description":"An optional end index to search up to (but not included)","name":"endIndex"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setAll","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":1044,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"kind":"typedef","name":"EachContainerCallback","type":{"names":["function"]},"params":[{"type":{"names":["*"]},"description":"The child Game Object of the Container.","name":"item"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"longname":"EachContainerCallback","scope":"global","___s":true},{"meta":{"filename":"Container.js","lineno":1052,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Passes all Game Objects in this Container to the given callback.\n\nA copy of the Container is made before passing each entry to your callback.\nThis protects against the callback itself modifying the Container.\n\nIf you know for sure that the callback will not change the size of this Container\nthen you can use the more performant `Container.iterate` method instead.","kind":"function","name":"each","since":"3.4.0","params":[{"type":{"names":["function"]},"description":"The function to call.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"Value to use as `this` when executing callback.","name":"context"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#each","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":1092,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Passes all Game Objects in this Container to the given callback.\n\nOnly use this method when you absolutely know that the Container will not be modified during\nthe iteration, i.e. by removing or adding to its contents.","kind":"function","name":"iterate","since":"3.4.0","params":[{"type":{"names":["function"]},"description":"The function to call.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"Value to use as `this` when executing callback.","name":"context"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Container instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#iterate","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":1127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Sets the scroll factor of this Container and optionally all of its children.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Apply this scrollFactor to all Container children as well?","name":"updateChildren"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setScrollFactor","scope":"instance","___s":true},{"meta":{"filename":"Container.js","lineno":1170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"The number of Game Objects inside this Container.","name":"length","type":{"names":["integer"]},"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#length","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":1187,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the first Game Object within the Container, or `null` if it is empty.\n\nYou can move the cursor by calling `Container.next` and `Container.previous`.","name":"first","type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#first","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":1215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the last Game Object within the Container, or `null` if it is empty.\n\nYou can move the cursor by calling `Container.next` and `Container.previous`.","name":"last","type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#last","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":1243,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the next Game Object within the Container, or `null` if it is empty.\n\nYou can move the cursor by calling `Container.next` and `Container.previous`.","name":"next","type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#next","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Container.js","lineno":1271,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Returns the previous Game Object within the Container, or `null` if it is empty.\n\nYou can move the cursor by calling `Container.next` and `Container.previous`.","name":"previous","type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"readonly":true,"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#previous","scope":"instance","kind":"member","___s":true},{"meta":{"range":[225,272],"filename":"ContainerCreator.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainerCreator.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Creates a new Container Game Object and returns it.\n\nNote: This method will only be available if the Container Game Object has been built into Phaser.","kind":"function","name":"container","since":"3.4.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#container","scope":"instance","___s":true},{"meta":{"range":[225,259],"filename":"ContainerFactory.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"name":"Container","longname":"Container","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainerFactory.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"description":"Creates a new Container Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Container Game Object has been built into Phaser.","kind":"function","name":"container","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"optional":true,"description":"An optional array of Game Objects to add to this Container.","name":"children"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#container","scope":"instance","___s":true},{"meta":{"range":[225,266],"filename":"ContainerRender.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/container"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CSSBlendModes.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Phaser Blend Modes to CSS Blend Modes Map.","name":"CSSBlendModes","kind":"member","isEnum":true,"type":{"names":["string"]},"memberof":"Phaser","readonly":true,"since":"3.12.0","longname":"Phaser.CSSBlendModes","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"DOMElement.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DOMElement.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"classdesc":"DOM Element Game Objects are a way to control and manipulate HTML Elements over the top of your game.\n\nIn order for DOM Elements to display you have to enable them by adding the following to your game\nconfiguration object:\n\n```javascript\ndom {\n createContainer: true\n}\n```\n\nWhen this is added, Phaser will automatically create a DOM Container div that is positioned over the top\nof the game canvas. This div is sized to match the canvas, and if the canvas size changes, as a result of\nsettings within the Scale Manager, the dom container is resized accordingly.\n\nYou can create a DOM Element by either passing in DOMStrings, or by passing in a reference to an existing\nElement that you wish to be placed under the control of Phaser. For example:\n\n```javascript\nthis.add.dom(x, y, 'div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\n```\n\nThe above code will insert a div element into the DOM Container at the given x/y coordinate. The DOMString in\nthe 4th argument sets the initial CSS style of the div and the final argument is the inner text. In this case,\nit will create a lime colored div that is 220px by 100px in size with the text Phaser in it, in an Arial font.\n\nYou should nearly always, without exception, use explicitly sized HTML Elements, in order to fully control\nalignment and positioning of the elements next to regular game content.\n\nRather than specify the CSS and HTML directly you can use the `load.html` File Loader to load it into the\ncache and then use the `createFromCache` method instead. You can also use `createFromHTML` and various other\nmethods available in this class to help construct your elements.\n\nOnce the element has been created you can then control it like you would any other Game Object. You can set its\nposition, scale, rotation, alpha and other properties. It will move as the main Scene Camera moves and be clipped\nat the edge of the canvas. It's important to remember some limitations of DOM Elements: The obvious one is that\nthey appear above or below your game canvas. You cannot blend them into the display list, meaning you cannot have\na DOM Element, then a Sprite, then another DOM Element behind it.\n\nThey also cannot be enabled for input. To do that, you have to use the `addListener` method to add native event\nlisteners directly. The final limitation is to do with cameras. The DOM Container is sized to match the game canvas\nentirely and clipped accordingly. DOM Elements respect camera scrolling and scrollFactor settings, but if you\nchange the size of the camera so it no longer matches the size of the canvas, they won't be clipped accordingly.\n\nAlso, all DOM Elements are inserted into the same DOM Container, regardless of which Scene they are created in.\n\nDOM Elements are a powerful way to align native HTML with your Phaser Game Objects. For example, you can insert\na login form for a multiplayer game directly into your title screen. Or a text input box for a highscore table.\nOr a banner ad from a 3rd party service. Or perhaps you'd like to use them for high resolution text display and\nUI. The choice is up to you, just remember that you're dealing with standard HTML and CSS floating over the top\nof your game, and should treat it accordingly.","kind":"class","name":"DOMElement","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.AlphaSingle","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.17.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this DOM Element in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this DOM Element in the world.","name":"y"},{"type":{"names":["Element","string"]},"optional":true,"description":"An existing DOM element, or a string. If a string starting with a # it will do a `getElementById` look-up on the string (minus the hash). Without a hash, it represents the type of element to create, i.e. 'div'.","name":"element"},{"type":{"names":["string","any"]},"optional":true,"description":"If a string, will be set directly as the elements `style` property value. If a plain object, will be iterated and the values transferred. In both cases the values replacing whatever CSS styles may have been previously set.","name":"style"},{"type":{"names":["string"]},"optional":true,"description":"If given, will be set directly as the elements `innerText` property value, replacing whatever was there before.","name":"innerText"}],"scope":"static","longname":"Phaser.GameObjects.DOMElement","___s":true},{"meta":{"filename":"DOMElement.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"A reference to the parent DOM Container that the Game instance created when it started.","name":"parent","type":{"names":["Element"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"A reference to the HTML Cache.","name":"cache","type":{"names":["Phaser.Cache.BaseCache"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#cache","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The actual DOM Element that this Game Object is bound to. For example, if you've created a `
`\nthen this property is a direct reference to that element within the dom.","name":"node","type":{"names":["Element"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#node","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":140,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"By default a DOM Element will have its transform, display, opacity, zIndex and blend mode properties\nupdated when its rendered. If, for some reason, you don't want any of these changed other than the\nCSS transform, then set this flag to `true`. When `true` only the CSS Transform is applied and it's\nup to you to keep track of and set the other properties as required.\n\nThis can be handy if, for example, you've a nested DOM Element and you don't want the opacity to be\npicked-up by any of its children.","name":"transformOnly","type":{"names":["boolean"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#transformOnly","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The angle, in radians, by which to skew the DOM Element on the horizontal axis.\n\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/transform","name":"skewX","type":{"names":["number"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#skewX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The angle, in radians, by which to skew the DOM Element on the vertical axis.\n\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/transform","name":"skewY","type":{"names":["number"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#skewY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"A Vector4 that contains the 3D rotation of this DOM Element around a fixed axis in 3D space.\n\nAll values in the Vector4 are treated as degrees, unless the `rotate3dAngle` property is changed.\n\nFor more details see the following MDN page:\n\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/rotate3d","name":"rotate3d","type":{"names":["Phaser.Math.Vector4"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#rotate3d","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The unit that represents the 3D rotation values. By default this is `deg` for degrees, but can\nbe changed to any supported unit. See this page for further details:\n\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/rotate3d","name":"rotate3dAngle","type":{"names":["string"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#rotate3dAngle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":204,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The native (un-scaled) width of this Game Object.\n\nFor a DOM Element this property is read-only.\n\nThe property `displayWidth` holds the computed bounds of this DOM Element, factoring in scaling.","name":"width","type":{"names":["number"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":218,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The native (un-scaled) height of this Game Object.\n\nFor a DOM Element this property is read-only.\n\nThe property `displayHeight` holds the computed bounds of this DOM Element, factoring in scaling.","name":"height","type":{"names":["number"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":232,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The computed display width of this Game Object, based on the `getBoundingClientRect` DOM call.\n\nThe property `width` holds the un-scaled width of this DOM Element.","name":"displayWidth","type":{"names":["number"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#displayWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":244,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The computed display height of this Game Object, based on the `getBoundingClientRect` DOM call.\n\nThe property `height` holds the un-scaled height of this DOM Element.","name":"displayHeight","type":{"names":["number"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#displayHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":309,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Sets the horizontal and vertical skew values of this DOM Element.\n\nFor more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/transform","kind":"function","name":"setSkew","since":"3.17.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The angle, in radians, by which to skew the DOM Element on the horizontal axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The angle, in radians, by which to skew the DOM Element on the vertical axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setSkew","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Sets the perspective CSS property of the _parent DOM Container_. This determines the distance between the z=0\nplane and the user in order to give a 3D-positioned element some perspective. Each 3D element with\nz > 0 becomes larger; each 3D-element with z < 0 becomes smaller. The strength of the effect is determined\nby the value of this property.\n\nFor more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/perspective\n\n**Changing this value changes it globally for all DOM Elements, as they all share the same parent container.**","kind":"function","name":"setPerspective","since":"3.17.0","params":[{"type":{"names":["number"]},"description":"The perspective value, in pixels, that determines the distance between the z plane and the user.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setPerspective","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":357,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"The perspective CSS property value of the _parent DOM Container_. This determines the distance between the z=0\nplane and the user in order to give a 3D-positioned element some perspective. Each 3D element with\nz > 0 becomes larger; each 3D-element with z < 0 becomes smaller. The strength of the effect is determined\nby the value of this property.\n\nFor more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/perspective\n\n**Changing this value changes it globally for all DOM Elements, as they all share the same parent container.**","name":"perspective","type":{"names":["number"]},"since":"3.17.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#perspective","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DOMElement.js","lineno":385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Adds one or more native DOM event listeners onto the underlying Element of this Game Object.\nThe event is then dispatched via this Game Objects standard event emitter.\n\nFor example:\n\n```javascript\nvar div = this.add.dom(x, y, element);\n\ndiv.addListener('click');\n\ndiv.on('click', handler);\n```","kind":"function","name":"addListener","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The DOM event/s to listen for. You can specify multiple events by separating them with spaces.","name":"events"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#addListener","scope":"instance","overrides":"Phaser.GameObjects.GameObject#addListener","___s":true},{"meta":{"filename":"DOMElement.js","lineno":421,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Removes one or more native DOM event listeners from the underlying Element of this Game Object.","kind":"function","name":"removeListener","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The DOM event/s to stop listening for. You can specify multiple events by separating them with spaces.","name":"events"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#removeListener","scope":"instance","overrides":"Phaser.GameObjects.GameObject#removeListener","___s":true},{"meta":{"filename":"DOMElement.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Creates a native DOM Element, adds it to the parent DOM Container and then binds it to this Game Object,\nso you can control it. The `tagName` should be a string and is passed to `document.createElement`:\n\n```javascript\nthis.add.dom().createElement('div');\n```\n\nFor more details on acceptable tag names see: https://developer.mozilla.org/en-US/docs/Web/API/Document/createElement\n\nYou can also pass in a DOMString or style object to set the CSS on the created element, and an optional `innerText`\nvalue as well. Here is an example of a DOMString:\n\n```javascript\nthis.add.dom().createElement('div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\n```\n\nAnd using a style object:\n\n```javascript\nvar style = {\n 'background-color': 'lime';\n 'width': '200px';\n 'height': '100px';\n 'font': '48px Arial';\n};\n\nthis.add.dom().createElement('div', style, 'Phaser');\n```\n\nIf this Game Object already has an Element, it is removed from the DOM entirely first.\nAny event listeners you may have previously created will need to be re-created after this call.","kind":"function","name":"createElement","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"A string that specifies the type of element to be created. The nodeName of the created element is initialized with the value of tagName. Don't use qualified names (like \"html:a\") with this method.","name":"tagName"},{"type":{"names":["string","any"]},"optional":true,"description":"Either a DOMString that holds the CSS styles to be applied to the created element, or an object the styles will be ready from.","name":"style"},{"type":{"names":["string"]},"optional":true,"description":"A DOMString that holds the text that will be set as the innerText of the created element.","name":"innerText"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#createElement","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":507,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Binds a new DOM Element to this Game Object. If this Game Object already has an Element it is removed from the DOM\nentirely first. Any event listeners you may have previously created will need to be re-created on the new element.\n\nThe `element` argument you pass to this method can be either a string tagName:\n\n```javascript\n

Phaser

\n\nthis.add.dom().setElement('heading');\n```\n\nOr a reference to an Element instance:\n\n```javascript\n

Phaser

\n\nvar h1 = document.getElementById('heading');\n\nthis.add.dom().setElement(h1);\n```\n\nYou can also pass in a DOMString or style object to set the CSS on the created element, and an optional `innerText`\nvalue as well. Here is an example of a DOMString:\n\n```javascript\nthis.add.dom().setElement(h1, 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\n```\n\nAnd using a style object:\n\n```javascript\nvar style = {\n 'background-color': 'lime';\n 'width': '200px';\n 'height': '100px';\n 'font': '48px Arial';\n};\n\nthis.add.dom().setElement(h1, style, 'Phaser');\n```","kind":"function","name":"setElement","since":"3.17.0","params":[{"type":{"names":["string","Element"]},"description":"If a string it is passed to `getElementById()`, or it should be a reference to an existing Element.","name":"element"},{"type":{"names":["string","any"]},"optional":true,"description":"Either a DOMString that holds the CSS styles to be applied to the created element, or an object the styles will be ready from.","name":"style"},{"type":{"names":["string"]},"optional":true,"description":"A DOMString that holds the text that will be set as the innerText of the created element.","name":"innerText"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setElement","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Takes a block of html from the HTML Cache, that has previously been preloaded into the game, and then\ncreates a DOM Element from it. The loaded HTML is set as the `innerHTML` property of the created\nelement.\n\nAssume the following html is stored in a file called `loginform.html`:\n\n```html\n\n\n```\n\nWhich is loaded into your game using the cache key 'login':\n\n```javascript\nthis.load.html('login', 'assets/loginform.html');\n```\n\nYou can create a DOM Element from it using the cache key:\n\n```javascript\nthis.add.dom().createFromCache('login');\n```\n\nThe optional `elementType` argument controls the container that is created, into which the loaded html is inserted.\nThe default is a plain `div` object, but any valid tagName can be given.\n\nIf this Game Object already has an Element, it is removed from the DOM entirely first.\nAny event listeners you may have previously created will need to be re-created after this call.","kind":"function","name":"createFromCache","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"key of the html cache entry to use for this DOM Element.","name":"The"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'div'","description":"The tag name of the element into which all of the loaded html will be inserted. Defaults to a plain div tag.","name":"tagName"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#createFromCache","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":675,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Takes a string of html and then creates a DOM Element from it. The HTML is set as the `innerHTML`\nproperty of the created element.\n\n```javascript\nlet form = `\n\n\n`;\n```\n\nYou can create a DOM Element from it using the string:\n\n```javascript\nthis.add.dom().createFromHTML(form);\n```\n\nThe optional `elementType` argument controls the type of container that is created, into which the html is inserted.\nThe default is a plain `div` object, but any valid tagName can be given.\n\nIf this Game Object already has an Element, it is removed from the DOM entirely first.\nAny event listeners you may have previously created will need to be re-created after this call.","kind":"function","name":"createFromHTML","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"string of html to be set as the `innerHTML` property of the created element.","name":"A"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'div'","description":"The tag name of the element into which all of the html will be inserted. Defaults to a plain div tag.","name":"tagName"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#createFromHTML","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":735,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Removes the current DOM Element bound to this Game Object from the DOM entirely and resets the\n`node` property of this Game Object to be `null`.","kind":"function","name":"removeElement","since":"3.17.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#removeElement","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":756,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Internal method that calls `getBoundingClientRect` on the `node` and then sets the bounds width\nand height into the `displayWidth` and `displayHeight` properties, and the `clientWidth` and `clientHeight`\nvalues into the `width` and `height` properties respectively.\n\nThis is called automatically whenever a new element is created or set.","kind":"function","name":"updateSize","since":"3.17.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#updateSize","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":783,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Gets all children from this DOM Elements node, using `querySelectorAll('*')` and then iterates through\nthem, looking for the first one that has a property matching the given key and value. It then returns this child\nif found, or `null` if not.","kind":"function","name":"getChildByProperty","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The property to search the children for.","name":"property"},{"type":{"names":["string"]},"description":"The value the property must strictly equal.","name":"value"}],"returns":[{"type":{"names":["Element"]},"nullable":true,"description":"The first matching child DOM Element, or `null` if not found."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getChildByProperty","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":814,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Gets all children from this DOM Elements node, using `querySelectorAll('*')` and then iterates through\nthem, looking for the first one that has a matching id. It then returns this child if found, or `null` if not.\n\nBe aware that class and id names are case-sensitive.","kind":"function","name":"getChildByID","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The id to search the children for.","name":"id"}],"returns":[{"type":{"names":["Element"]},"nullable":true,"description":"The first matching child DOM Element, or `null` if not found."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getChildByID","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":832,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Gets all children from this DOM Elements node, using `querySelectorAll('*')` and then iterates through\nthem, looking for the first one that has a matching name. It then returns this child if found, or `null` if not.\n\nBe aware that class and id names are case-sensitive.","kind":"function","name":"getChildByName","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The name to search the children for.","name":"name"}],"returns":[{"type":{"names":["Element"]},"nullable":true,"description":"The first matching child DOM Element, or `null` if not found."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getChildByName","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":850,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Sets the `className` property of the DOM Element node and updates the internal sizes.","kind":"function","name":"setClassName","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"A string representing the class or space-separated classes of the element.","name":"className"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setClassName","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":872,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Sets the `innerText` property of the DOM Element node and updates the internal sizes.\n\nNote that only certain types of Elements can have `innerText` set on them.","kind":"function","name":"setText","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"A DOMString representing the rendered text content of the element.","name":"text"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setText","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":896,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Sets the `innerHTML` property of the DOM Element node and updates the internal sizes.","kind":"function","name":"setHTML","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"A DOMString of html to be set as the `innerHTML` property of the element.","name":"html"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This DOM Element instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setHTML","scope":"instance","___s":true},{"meta":{"filename":"DOMElement.js","lineno":936,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\n\nDOMElements always return `true` as they need to still set values during the render pass, even if not visible.","kind":"function","name":"willRender","since":"3.17.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Game Object should be rendered, otherwise `false`."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#willRender","scope":"instance","overrides":"Phaser.GameObjects.GameObject#willRender","___s":true},{"meta":{"range":[180,222],"filename":"DOMElementCSSRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"name":"CSSBlendModes","longname":"CSSBlendModes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"DOMElementFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"name":"DOMElement","longname":"DOMElement","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DOMElementFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"description":"DOM Element Game Objects are a way to control and manipulate HTML Elements over the top of your game.\n\nIn order for DOM Elements to display you have to enable them by adding the following to your game\nconfiguration object:\n\n```javascript\ndom {\n createContainer: true\n}\n```\n\nWhen this is added, Phaser will automatically create a DOM Container div that is positioned over the top\nof the game canvas. This div is sized to match the canvas, and if the canvas size changes, as a result of\nsettings within the Scale Manager, the dom container is resized accordingly.\n\nYou can create a DOM Element by either passing in DOMStrings, or by passing in a reference to an existing\nElement that you wish to be placed under the control of Phaser. For example:\n\n```javascript\nthis.add.dom(x, y, 'div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\n```\n\nThe above code will insert a div element into the DOM Container at the given x/y coordinate. The DOMString in\nthe 4th argument sets the initial CSS style of the div and the final argument is the inner text. In this case,\nit will create a lime colored div that is 220px by 100px in size with the text Phaser in it, in an Arial font.\n\nYou should nearly always, without exception, use explicitly sized HTML Elements, in order to fully control\nalignment and positioning of the elements next to regular game content.\n\nRather than specify the CSS and HTML directly you can use the `load.html` File Loader to load it into the\ncache and then use the `createFromCache` method instead. You can also use `createFromHTML` and various other\nmethods available in this class to help construct your elements.\n\nOnce the element has been created you can then control it like you would any other Game Object. You can set its\nposition, scale, rotation, alpha and other properties. It will move as the main Scene Camera moves and be clipped\nat the edge of the canvas. It's important to remember some limitations of DOM Elements: The obvious one is that\nthey appear above or below your game canvas. You cannot blend them into the display list, meaning you cannot have\na DOM Element, then a Sprite, then another DOM Element behind it.\n\nThey also cannot be enabled for input. To do that, you have to use the `addListener` method to add native event\nlisteners directly. The final limitation is to do with cameras. The DOM Container is sized to match the game canvas\nentirely and clipped accordingly. DOM Elements respect camera scrolling and scrollFactor settings, but if you\nchange the size of the camera so it no longer matches the size of the canvas, they won't be clipped accordingly.\n\nAlso, all DOM Elements are inserted into the same DOM Container, regardless of which Scene they are created in.\n\nDOM Elements are a powerful way to align native HTML with your Phaser Game Objects. For example, you can insert\na login form for a multiplayer game directly into your title screen. Or a text input box for a highscore table.\nOr a banner ad from a 3rd party service. Or perhaps you'd like to use them for high resolution text display and\nUI. The choice is up to you, just remember that you're dealing with standard HTML and CSS floating over the top\nof your game, and should treat it accordingly.\n\nNote: This method will only be available if the DOM Element Game Object has been built into Phaser.","kind":"function","name":"dom","since":"3.17.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this DOM Element in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this DOM Element in the world.","name":"y"},{"type":{"names":["HTMLElement","string"]},"optional":true,"description":"An existing DOM element, or a string. If a string starting with a # it will do a `getElementById` look-up on the string (minus the hash). Without a hash, it represents the type of element to create, i.e. 'div'.","name":"element"},{"type":{"names":["string","any"]},"optional":true,"description":"If a string, will be set directly as the elements `style` property value. If a plain object, will be iterated and the values transferred. In both cases the values replacing whatever CSS styles may have been previously set.","name":"style"},{"type":{"names":["string"]},"optional":true,"description":"If given, will be set directly as the elements `innerText` property value, replacing whatever was there before.","name":"innerText"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#dom","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"DOMElementRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DESTROY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Game Object Destroy Event.\n\nThis event is dispatched when a Game Object instance is being destroyed.\n\nListen for it on a Game Object instance using `GameObject.on('destroy', listener)`.","kind":"event","name":"DESTROY","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object which is being destroyed.","name":"gameObject"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:DESTROY","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Complete Event.\n\nThis event is dispatched when a Video finishes playback by reaching the end of its duration. It\nis also dispatched if a video marker sequence is being played and reaches the end.\n\nNote that not all videos can fire this event. Live streams, for example, have no fixed duration,\nso never technically 'complete'.\n\nIf a video is stopped from playback, via the `Video.stop` method, it will emit the\n`VIDEO_STOP` event instead of this one.\n\nListen for it from a Video Game Object instance using `Video.on('complete', listener)`.","kind":"event","name":"VIDEO_COMPLETE","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which completed playback.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_CREATED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Created Event.\n\nThis event is dispatched when the texture for a Video has been created. This happens\nwhen enough of the video source has been loaded that the browser is able to render a\nframe from it.\n\nListen for it from a Video Game Object instance using `Video.on('created', listener)`.","kind":"event","name":"VIDEO_CREATED","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which raised the event.","name":"video"},{"type":{"names":["integer"]},"description":"The width of the video.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the video.","name":"height"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_CREATED","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_ERROR_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Error Event.\n\nThis event is dispatched when a Video tries to play a source that does not exist, or is the wrong file type.\n\nListen for it from a Video Game Object instance using `Video.on('error', listener)`.","kind":"event","name":"VIDEO_ERROR","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which threw the error.","name":"video"},{"type":{"names":["Event"]},"description":"The native DOM event the browser raised during playback.","name":"event"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_ERROR","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_LOOP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Loop Event.\n\nThis event is dispatched when a Video that is currently playing has looped. This only\nhappens if the `loop` parameter was specified, or the `setLoop` method was called,\nand if the video has a fixed duration. Video streams, for example, cannot loop, as\nthey have no duration.\n\nLooping is based on the result of the Video `timeupdate` event. This event is not\nframe-accurate, due to the way browsers work, so please do not rely on this loop\nevent to be time or frame precise.\n\nListen for it from a Video Game Object instance using `Video.on('loop', listener)`.","kind":"event","name":"VIDEO_LOOP","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which has looped.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_LOOP","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_PLAY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Play Event.\n\nThis event is dispatched when a Video begins playback. For videos that do not require\ninteraction unlocking, this is usually as soon as the `Video.play` method is called.\nHowever, for videos that require unlocking, it is fired once playback begins after\nthey've been unlocked.\n\nListen for it from a Video Game Object instance using `Video.on('play', listener)`.","kind":"event","name":"VIDEO_PLAY","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which started playback.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_PLAY","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_SEEKED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Seeked Event.\n\nThis event is dispatched when a Video completes seeking to a new point in its timeline.\n\nListen for it from a Video Game Object instance using `Video.on('seeked', listener)`.","kind":"event","name":"VIDEO_SEEKED","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which completed seeking.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_SEEKED","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_SEEKING_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Seeking Event.\n\nThis event is dispatched when a Video _begins_ seeking to a new point in its timeline.\nWhen the seek is complete, it will dispatch the `VIDEO_SEEKED` event to conclude.\n\nListen for it from a Video Game Object instance using `Video.on('seeking', listener)`.","kind":"event","name":"VIDEO_SEEKING","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which started seeking.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_SEEKING","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_STOP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Stopped Event.\n\nThis event is dispatched when a Video is stopped from playback via a call to the `Video.stop` method,\neither directly via game code, or indirectly as the result of changing a video source or destroying it.\n\nListen for it from a Video Game Object instance using `Video.on('stop', listener)`.","kind":"event","name":"VIDEO_STOP","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which stopped playback.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_STOP","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_TIMEOUT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Timeout Event.\n\nThis event is dispatched when a Video has exhausted its allocated time while trying to connect to a video\nsource to start playback.\n\nListen for it from a Video Game Object instance using `Video.on('timeout', listener)`.","kind":"event","name":"VIDEO_TIMEOUT","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which timed out.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_TIMEOUT","scope":"instance","___s":true},{"meta":{"filename":"VIDEO_UNLOCKED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"description":"The Video Game Object Unlocked Event.\n\nThis event is dispatched when a Video that was prevented from playback due to the browsers\nMedia Engagement Interaction policy, is unlocked by a user gesture.\n\nListen for it from a Video Game Object instance using `Video.on('unlocked', listener)`.","kind":"event","name":"VIDEO_UNLOCKED","since":"3.20.0","params":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Video Game Object which raised the event.","name":"video"}],"memberof":"Phaser.GameObjects.Events","longname":"Phaser.GameObjects.Events#event:VIDEO_UNLOCKED","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/events"},"kind":"namespace","name":"Events","memberof":"Phaser.GameObjects","longname":"Phaser.GameObjects.Events","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Extern.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/extern"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Extern.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/extern"},"classdesc":"An Extern Game Object is a special type of Game Object that allows you to pass\nrendering off to a 3rd party.\n\nWhen you create an Extern and place it in the display list of a Scene, the renderer will\nprocess the list as usual. When it finds an Extern it will flush the current batch,\nclear down the pipeline and prepare a transform matrix which your render function can\ntake advantage of, if required.\n\nThe WebGL context is then left is a 'clean' state, ready for you to bind your own shaders,\nor draw to it, whatever you wish to do. Once you've finished, you should free-up any\nof your resources. The Extern will then rebind the Phaser pipeline and carry on \nrendering the display list.\n\nAlthough this object has lots of properties such as Alpha, Blend Mode and Tint, none of\nthem are used during rendering unless you take advantage of them in your own render code.","kind":"class","name":"Extern","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.16.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"}],"scope":"static","longname":"Phaser.GameObjects.Extern","___s":true},{"meta":{"range":[180,208],"filename":"ExternFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/extern"},"name":"Extern","longname":"Extern","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ExternFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/extern"},"description":"Creates a new Extern Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Extern Game Object has been built into Phaser.","kind":"function","name":"extern","since":"3.16.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#extern","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"ExternRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/extern"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[176,604],"filename":"Commands.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"exports","longname":"module.exports","kind":"member","memberof":"module","scope":"static","___s":true},{"meta":{"range":[180,234],"filename":"Graphics.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"BaseCamera","longname":"BaseCamera","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Graphics.js","lineno":28,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"classdesc":"A Graphics object is a way to draw primitive shapes to your game. Primitives include forms of geometry, such as\nRectangles, Circles, and Polygons. They also include lines, arcs and curves. When you initially create a Graphics\nobject it will be empty.\n\nTo draw to it you must first specify a line style or fill style (or both), draw shapes using paths, and finally\nfill or stroke them. For example:\n\n```javascript\ngraphics.lineStyle(5, 0xFF00FF, 1.0);\ngraphics.beginPath();\ngraphics.moveTo(100, 100);\ngraphics.lineTo(200, 200);\ngraphics.closePath();\ngraphics.strokePath();\n```\n\nThere are also many helpful methods that draw and fill/stroke common shapes for you.\n\n```javascript\ngraphics.lineStyle(5, 0xFF00FF, 1.0);\ngraphics.fillStyle(0xFFFFFF, 1.0);\ngraphics.fillRect(50, 50, 400, 200);\ngraphics.strokeRect(50, 50, 400, 200);\n```\n\nWhen a Graphics object is rendered it will render differently based on if the game is running under Canvas or WebGL.\nUnder Canvas it will use the HTML Canvas context drawing operations to draw the path.\nUnder WebGL the graphics data is decomposed into polygons. Both of these are expensive processes, especially with\ncomplex shapes.\n\nIf your Graphics object doesn't change much (or at all) once you've drawn your shape to it, then you will help\nperformance by calling {@link Phaser.GameObjects.Graphics#generateTexture}. This will 'bake' the Graphics object into\na Texture, and return it. You can then use this Texture for Sprites or other display objects. If your Graphics object\nupdates frequently then you should avoid doing this, as it will constantly generate new textures, which will consume\nmemory.\n\nAs you can tell, Graphics objects are a bit of a trade-off. While they are extremely useful, you need to be careful\nin their complexity and quantity of them in your game.","kind":"class","name":"Graphics","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.AlphaSingle","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible","Phaser.GameObjects.Components.ScrollFactor"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Graphics object belongs.","name":"scene"},{"type":{"names":["Phaser.Types.GameObjects.Graphics.Options"]},"optional":true,"description":"Options that set the position and default style of this Graphics object.","name":"options"}],"scope":"static","longname":"Phaser.GameObjects.Graphics","___s":true},{"meta":{"filename":"Graphics.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The horizontal display origin of the Graphics.","name":"displayOriginX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#displayOriginX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":125,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The vertical display origin of the Graphics.","name":"displayOriginY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#displayOriginY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The array of commands used to render the Graphics.","name":"commandBuffer","type":{"names":["array"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#commandBuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":145,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The default fill color for shapes rendered by this Graphics object.","name":"defaultFillColor","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#defaultFillColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The default fill alpha for shapes rendered by this Graphics object.","name":"defaultFillAlpha","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#defaultFillAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The default stroke width for shapes rendered by this Graphics object.","name":"defaultStrokeWidth","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#defaultStrokeWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":175,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The default stroke color for shapes rendered by this Graphics object.","name":"defaultStrokeColor","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#defaultStrokeColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":185,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"The default stroke alpha for shapes rendered by this Graphics object.","name":"defaultStrokeAlpha","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#defaultStrokeAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Graphics.js","lineno":238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Set the default style settings for this Graphics object.","kind":"function","name":"setDefaultStyles","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Graphics.Styles"]},"description":"The styles to set as defaults.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setDefaultStyles","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Set the current line style.","kind":"function","name":"lineStyle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The stroke width.","name":"lineWidth"},{"type":{"names":["number"]},"description":"The stroke color.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The stroke alpha.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#lineStyle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":296,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Set the current fill style.","kind":"function","name":"fillStyle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The fill color.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The fill alpha.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillStyle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Sets a gradient fill style. This is a WebGL only feature.\n\nThe gradient color values represent the 4 corners of an untransformed rectangle.\nThe gradient is used to color all filled shapes and paths drawn after calling this method.\nIf you wish to turn a gradient off, call `fillStyle` and provide a new single fill color.\n\nWhen filling a triangle only the first 3 color values provided are used for the 3 points of a triangle.\n\nThis feature is best used only on rectangles and triangles. All other shapes will give strange results.\n\nNote that for objects such as arcs or ellipses, or anything which is made out of triangles, each triangle used\nwill be filled with a gradient on its own. There is no ability to gradient fill a shape or path as a single\nentity at this time.","kind":"function","name":"fillGradientStyle","since":"3.12.0","params":[{"type":{"names":["integer"]},"description":"The tint being applied to the top-left of the Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The fill alpha.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillGradientStyle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":358,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Sets a gradient line style. This is a WebGL only feature.\n\nThe gradient color values represent the 4 corners of an untransformed rectangle.\nThe gradient is used to color all stroked shapes and paths drawn after calling this method.\nIf you wish to turn a gradient off, call `lineStyle` and provide a new single line color.\n\nThis feature is best used only on single lines. All other shapes will give strange results.\n\nNote that for objects such as arcs or ellipses, or anything which is made out of triangles, each triangle used\nwill be filled with a gradient on its own. There is no ability to gradient stroke a shape or path as a single\nentity at this time.","kind":"function","name":"lineGradientStyle","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The stroke width.","name":"lineWidth"},{"type":{"names":["integer"]},"description":"The tint being applied to the top-left of the Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The fill alpha.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#lineGradientStyle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":396,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Sets the texture frame this Graphics Object will use when drawing all shapes defined after calling this.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.\n\nOnce set, all shapes will use this texture. Call this method with no arguments to clear it.\n\nThe textures are not tiled. They are stretched to the dimensions of the shapes being rendered. For this reason,\nit works best with seamless / tileable textures.\n\nThe mode argument controls how the textures are combined with the fill colors. The default value (0) will\nmultiply the texture by the fill color. A value of 1 will use just the fill color, but the alpha data from the texture,\nand a value of 2 will use just the texture and no fill color at all.","kind":"function","name":"setTexture","since":"3.12.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The key of the texture to be used, as stored in the Texture Manager. Leave blank to clear a previously set texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The texture tint mode. 0 is multiply, 1 is alpha only and 2 is texture only.","name":"mode"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setTexture","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":452,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Start a new shape path.","kind":"function","name":"beginPath","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#beginPath","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":469,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Close the current path.","kind":"function","name":"closePath","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#closePath","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":486,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the current path.","kind":"function","name":"fillPath","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillPath","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":503,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the current path.\n\nThis is an alias for `Graphics.fillPath` and does the same thing.\nIt was added to match the CanvasRenderingContext 2D API.","kind":"function","name":"fill","since":"3.16.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fill","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":523,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the current path.","kind":"function","name":"strokePath","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokePath","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":540,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the current path.\n\nThis is an alias for `Graphics.strokePath` and does the same thing.\nIt was added to match the CanvasRenderingContext 2D API.","kind":"function","name":"stroke","since":"3.16.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#stroke","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":560,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the given circle.","kind":"function","name":"fillCircleShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The circle to fill.","name":"circle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillCircleShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":575,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the given circle.","kind":"function","name":"strokeCircleShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The circle to stroke.","name":"circle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeCircleShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill a circle with the given position and radius.","kind":"function","name":"fillCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the circle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the circle.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillCircle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":611,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke a circle with the given position and radius.","kind":"function","name":"strokeCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the circle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the circle.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeCircle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the given rectangle.","kind":"function","name":"fillRectShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle to fill.","name":"rect"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillRectShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":647,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the given rectangle.","kind":"function","name":"strokeRectShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle to stroke.","name":"rect"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeRectShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":662,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill a rectangle with the given position and size.","kind":"function","name":"fillRect","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the top-left of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillRect","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":685,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke a rectangle with the given position and size.","kind":"function","name":"strokeRect","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the top-left of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeRect","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":727,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill a rounded rectangle with the given position, size and radius.","kind":"function","name":"fillRoundedRect","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the top-left of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"height"},{"type":{"names":["Phaser.Types.GameObjects.Graphics.RoundedRectRadius","number"]},"optional":true,"defaultvalue":20,"description":"The corner radius; It can also be an object to specify different radii for corners.","name":"radius"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillRoundedRect","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":773,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke a rounded rectangle with the given position, size and radius.","kind":"function","name":"strokeRoundedRect","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the top-left of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"height"},{"type":{"names":["Phaser.Types.GameObjects.Graphics.RoundedRectRadius","number"]},"optional":true,"defaultvalue":20,"description":"The corner radius; It can also be an object to specify different radii for corners.","name":"radius"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeRoundedRect","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":819,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the given point.\n\nDraws a square at the given position, 1 pixel in size by default.","kind":"function","name":"fillPointShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","Phaser.Math.Vector2","object"]},"description":"The point to fill.","name":"point"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The size of the square to draw.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillPointShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":837,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill a point at the given position.\n\nDraws a square at the given position, 1 pixel in size by default.","kind":"function","name":"fillPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the point.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the point.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The size of the square to draw.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillPoint","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":871,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the given triangle.","kind":"function","name":"fillTriangleShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The triangle to fill.","name":"triangle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillTriangleShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":886,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the given triangle.","kind":"function","name":"strokeTriangleShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The triangle to stroke.","name":"triangle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeTriangleShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":901,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill a triangle with the given points.","kind":"function","name":"fillTriangle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x0"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y0"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the third point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the third point.","name":"y2"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillTriangle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":926,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke a triangle with the given points.","kind":"function","name":"strokeTriangle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x0"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y0"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the third point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the third point.","name":"y2"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeTriangle","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":951,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Draw the given line.","kind":"function","name":"strokeLineShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to stroke.","name":"line"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeLineShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":966,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Draw a line between the given points.","kind":"function","name":"lineBetween","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the start point of the line.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the start point of the line.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the end point of the line.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the end point of the line.","name":"y2"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#lineBetween","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":989,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Draw a line from the current drawing position to the given position.\n\nMoves the current drawing position to the given position.","kind":"function","name":"lineTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to draw the line to.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to draw the line to.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#lineTo","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1012,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Move the current drawing position to the given position.","kind":"function","name":"moveTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to move to.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to move to.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#moveTo","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1033,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the shape represented by the given array of points.\n\nPass `closeShape` to automatically close the shape by joining the last to the first point.\n\nPass `closePath` to automatically close the path before it is stroked.","kind":"function","name":"strokePoints","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The points to stroke.","name":"points"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When `true`, the shape is closed by joining the last point to the first point.","name":"closeShape"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When `true`, the path is closed before being stroked.","name":"closePath"},{"type":{"names":["integer"]},"optional":true,"description":"The index of `points` to stop drawing at. Defaults to `points.length`.","name":"endIndex"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokePoints","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1080,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the shape represented by the given array of points.\n\nPass `closeShape` to automatically close the shape by joining the last to the first point.\n\nPass `closePath` to automatically close the path before it is filled.","kind":"function","name":"fillPoints","since":"3.0.0","params":[{"type":{"names":["array","Array."]},"description":"The points to fill.","name":"points"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When `true`, the shape is closed by joining the last point to the first point.","name":"closeShape"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When `true`, the path is closed before being stroked.","name":"closePath"},{"type":{"names":["integer"]},"optional":true,"description":"The index of `points` to stop at. Defaults to `points.length`.","name":"endIndex"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillPoints","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke the given ellipse.","kind":"function","name":"strokeEllipseShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The ellipse to stroke.","name":"ellipse"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The number of points to draw the ellipse with.","name":"smoothness"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeEllipseShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Stroke an ellipse with the given position and size.","kind":"function","name":"strokeEllipse","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the ellipse.","name":"y"},{"type":{"names":["number"]},"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"description":"The height of the ellipse.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The number of points to draw the ellipse with.","name":"smoothness"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#strokeEllipse","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1172,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill the given ellipse.","kind":"function","name":"fillEllipseShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The ellipse to fill.","name":"ellipse"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The number of points to draw the ellipse with.","name":"smoothness"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillEllipseShape","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1192,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Fill an ellipse with the given position and size.","kind":"function","name":"fillEllipse","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the ellipse.","name":"y"},{"type":{"names":["number"]},"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"description":"The height of the ellipse.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The number of points to draw the ellipse with.","name":"smoothness"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#fillEllipse","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1217,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Draw an arc.\n\nThis method can be used to create circles, or parts of circles.\n\nMake sure you call `beginPath` before starting the arc unless you wish for the arc to automatically\nclose when filled or stroked.\n\nUse the optional `overshoot` argument increase the number of iterations that take place when\nthe arc is rendered in WebGL. This is useful if you're drawing an arc with an especially thick line,\nas it will allow the arc to fully join-up. Try small values at first, i.e. 0.01.\n\nCall {@link Phaser.GameObjects.Graphics#fillPath} or {@link Phaser.GameObjects.Graphics#strokePath} after calling\nthis method to draw the arc.","kind":"function","name":"arc","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the circle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the circle.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["number"]},"description":"The starting angle, in radians.","name":"startAngle"},{"type":{"names":["number"]},"description":"The ending angle, in radians.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the drawing should be anticlockwise or clockwise.","name":"anticlockwise"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This value allows you to increase the segment iterations in WebGL rendering. Useful if the arc has a thick stroke and needs to overshoot to join-up cleanly. Use small numbers such as 0.01 to start with and increase as needed.","name":"overshoot"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#arc","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Creates a pie-chart slice shape centered at `x`, `y` with the given radius.\nYou must define the start and end angle of the slice.\n\nSetting the `anticlockwise` argument to `true` creates a shape similar to Pacman.\nSetting it to `false` creates a shape like a slice of pie.\n\nThis method will begin a new path and close the path at the end of it.\nTo display the actual slice you need to call either `strokePath` or `fillPath` after it.","kind":"function","name":"slice","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The horizontal center of the slice.","name":"x"},{"type":{"names":["number"]},"description":"The vertical center of the slice.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the slice.","name":"radius"},{"type":{"names":["number"]},"description":"The start angle of the slice, given in radians.","name":"startAngle"},{"type":{"names":["number"]},"description":"The end angle of the slice, given in radians.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the drawing should be anticlockwise or clockwise.","name":"anticlockwise"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This value allows you to overshoot the endAngle by this amount. Useful if the arc has a thick stroke and needs to overshoot to join-up cleanly.","name":"overshoot"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#slice","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Saves the state of the Graphics by pushing the current state onto a stack.\n\nThe most recently saved state can then be restored with {@link Phaser.GameObjects.Graphics#restore}.","kind":"function","name":"save","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#save","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1316,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Restores the most recently saved state of the Graphics by popping from the state stack.\n\nUse {@link Phaser.GameObjects.Graphics#save} to save the current state, and call this afterwards to restore that state.\n\nIf there is no saved state, this command does nothing.","kind":"function","name":"restore","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#restore","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Inserts a translation command into this Graphics objects command buffer.\n\nAll objects drawn _after_ calling this method will be translated\nby the given amount.\n\nThis does not change the position of the Graphics object itself,\nonly of the objects drawn by it after calling this method.","kind":"function","name":"translateCanvas","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal translation to apply.","name":"x"},{"type":{"names":["number"]},"description":"The vertical translation to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#translateCanvas","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1364,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Inserts a scale command into this Graphics objects command buffer.\n\nAll objects drawn _after_ calling this method will be scaled\nby the given amount.\n\nThis does not change the scale of the Graphics object itself,\nonly of the objects drawn by it after calling this method.","kind":"function","name":"scaleCanvas","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale to apply.","name":"x"},{"type":{"names":["number"]},"description":"The vertical scale to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#scaleCanvas","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Inserts a rotation command into this Graphics objects command buffer.\n\nAll objects drawn _after_ calling this method will be rotated\nby the given amount.\n\nThis does not change the rotation of the Graphics object itself,\nonly of the objects drawn by it after calling this method.","kind":"function","name":"rotateCanvas","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The rotation angle, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#rotateCanvas","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1417,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Clear the command buffer and reset the fill style and line style to their defaults.","kind":"function","name":"clear","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#clear","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1442,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Generate a texture from this Graphics object.\n\nIf `key` is a string it'll generate a new texture using it and add it into the\nTexture Manager (assuming no key conflict happens).\n\nIf `key` is a Canvas it will draw the texture to that canvas context. Note that it will NOT\nautomatically upload it to the GPU in WebGL mode.","kind":"function","name":"generateTexture","since":"3.0.0","params":[{"type":{"names":["string","HTMLCanvasElement"]},"description":"The key to store the texture with in the Texture Manager, or a Canvas to draw to.","name":"key"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the graphics to generate.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the graphics to generate.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#generateTexture","scope":"instance","___s":true},{"meta":{"filename":"Graphics.js","lineno":1535,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"A Camera used specifically by the Graphics system for rendering to textures.","name":"TargetCamera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"since":"3.1.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics.TargetCamera","scope":"static","kind":"member","___s":true},{"meta":{"range":[180,212],"filename":"GraphicsCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"Commands","longname":"Commands","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,231],"filename":"GraphicsCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"GameObjectCreator","longname":"GameObjectCreator","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GraphicsCreator.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Creates a new Graphics Game Object and returns it.\n\nNote: This method will only be available if the Graphics Game Object has been built into Phaser.","kind":"function","name":"graphics","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#graphics","scope":"instance","___s":true},{"meta":{"range":[180,212],"filename":"GraphicsFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"Graphics","longname":"Graphics","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GraphicsFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"description":"Creates a new Graphics Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Graphics Game Object has been built into Phaser.","kind":"function","name":"graphics","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Graphics.Options"]},"optional":true,"description":"The Graphics configuration.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#graphics","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"GraphicsRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,212],"filename":"GraphicsWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics"},"name":"Commands","longname":"Commands","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FillStyle.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs"},"description":"Graphics fill style settings.","kind":"typedef","name":"FillStyle","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"The fill color.","name":"color"},{"type":{"names":["number"]},"optional":true,"description":"The fill alpha.","name":"alpha"}],"memberof":"Phaser.Types.GameObjects.Graphics","longname":"Phaser.Types.GameObjects.Graphics.FillStyle","scope":"static","___s":true},{"meta":{"filename":"LineStyle.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs"},"description":"Graphics line style (or stroke style) settings.","kind":"typedef","name":"LineStyle","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"The stroke width.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The stroke color.","name":"color"},{"type":{"names":["number"]},"optional":true,"description":"The stroke alpha.","name":"alpha"}],"memberof":"Phaser.Types.GameObjects.Graphics","longname":"Phaser.Types.GameObjects.Graphics.LineStyle","scope":"static","___s":true},{"meta":{"filename":"Options.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs"},"description":"Options for the Graphics game Object.","kind":"typedef","name":"Options","type":{"names":["object"]},"augments":["Phaser.Types.GameObjects.Graphics.Styles"],"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"The x coordinate of the Graphics.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate of the Graphics.","name":"y"}],"memberof":"Phaser.Types.GameObjects.Graphics","longname":"Phaser.Types.GameObjects.Graphics.Options","scope":"static","___s":true},{"meta":{"filename":"RoundedRectRadius.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs"},"kind":"typedef","name":"RoundedRectRadius","type":{"names":["object"]},"since":"3.11.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":20,"description":"Top left","name":"tl"},{"type":{"names":["number"]},"optional":true,"defaultvalue":20,"description":"Top right","name":"tr"},{"type":{"names":["number"]},"optional":true,"defaultvalue":20,"description":"Bottom right","name":"br"},{"type":{"names":["number"]},"optional":true,"defaultvalue":20,"description":"Bottom left","name":"bl"}],"memberof":"Phaser.Types.GameObjects.Graphics","longname":"Phaser.Types.GameObjects.Graphics.RoundedRectRadius","scope":"static","___s":true},{"meta":{"filename":"Styles.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs"},"description":"Graphics style settings.","kind":"typedef","name":"Styles","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Graphics.LineStyle"]},"optional":true,"description":"The style applied to shape outlines.","name":"lineStyle"},{"type":{"names":["Phaser.Types.GameObjects.Graphics.FillStyle"]},"optional":true,"description":"The style applied to shape areas.","name":"fillStyle"}],"memberof":"Phaser.Types.GameObjects.Graphics","longname":"Phaser.Types.GameObjects.Graphics.Styles","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs"},"kind":"namespace","name":"Graphics","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.Graphics","scope":"static","___s":true},{"meta":{"range":[180,215],"filename":"Group.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"name":"Actions","longname":"Actions","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Group.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"classdesc":"A Group is a way for you to create, manipulate, or recycle similar Game Objects.\n\nGroup membership is non-exclusive. A Game Object can belong to several groups, one group, or none.\n\nGroups themselves aren't displayable, and can't be positioned, rotated, scaled, or hidden.","kind":"class","name":"Group","memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The scene this group belongs to.","name":"scene"},{"type":{"names":["Array.","Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Game Objects to add to this group; or the `config` argument.","name":"children"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Settings for this group. If `key` is set, Phaser.GameObjects.Group#createMultiple is also called with these settings.","name":"config"}],"see":["Phaser.Physics.Arcade.Group","Phaser.Physics.Arcade.StaticGroup"],"scope":"static","longname":"Phaser.GameObjects.Group","___s":true},{"meta":{"filename":"Group.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"This scene this group belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Members of this group.","name":"children","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#children","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A flag identifying this object as a group.","name":"isParent","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#isParent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A textual representation of this Game Object.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"defaultvalue":"'Group'","since":"3.21.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The class to create new group members from.","name":"classType","type":{"names":["function"]},"since":"3.0.0","defaultvalue":"Phaser.GameObjects.Sprite","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#classType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The name of this group.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.18.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether this group runs its {@link Phaser.GameObjects.Group#preUpdate} method\n(which may update any members).","name":"active","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The maximum size of this group, if used as a pool. -1 is no limit.","name":"maxSize","type":{"names":["integer"]},"since":"3.0.0","defaultvalue":"-1","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#maxSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A default texture key to use when creating new group members.\n\nThis is used in {@link Phaser.GameObjects.Group#create}\nbut not in {@link Phaser.GameObjects.Group#createMultiple}.","name":"defaultKey","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#defaultKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":170,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A default texture frame to use when creating new group members.","name":"defaultFrame","type":{"names":["string","integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#defaultFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":179,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether to call the update method of any members.","name":"runChildUpdate","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.GameObjects.Group#preUpdate"],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#runChildUpdate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":190,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when adding or creating group members.","name":"createCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#createCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":199,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when removing group members.","name":"removeCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#removeCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":208,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when creating several group members at once.","name":"createMultipleCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#createMultipleCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Group.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates a new Game Object and adds it to this group, unless the group {@link Phaser.GameObjects.Group#isFull is full}.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the new Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the new Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key of the new Game Object.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"The texture frame of the new Game Object.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of the new Game Object.","name":"visible"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.GameObject#active} state of the new Game Object.","name":"active"}],"returns":[{"type":{"names":["any"]},"description":"The new Game Object (usually a Sprite, etc.)."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#create","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":294,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates several Game Objects and adds them to this group.\n\nIf the group becomes {@link Phaser.GameObjects.Group#isFull}, no further Game Objects are created.\n\nCalls {@link Phaser.GameObjects.Group#createMultipleCallback} and {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"createMultiple","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCreateConfig","Array."]},"description":"Creation settings. This can be a single configuration object or an array of such objects, which will be applied in turn.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"The newly created Game Objects."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#createMultiple","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":335,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A helper for {@link Phaser.GameObjects.Group#createMultiple}.","kind":"function","name":"createFromConfig","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"description":"Creation settings.","name":"options"}],"returns":[{"type":{"names":["Array."]},"description":"The newly created Game Objects."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#createFromConfig","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Updates any group members, if {@link Phaser.GameObjects.Group#runChildUpdate} is enabled.","kind":"function","name":"preUpdate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current timestamp.","name":"time"},{"type":{"names":["number"]},"description":"The delta time elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#preUpdate","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds a Game Object to this group.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to add.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also add the Game Object to the scene.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#add","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":562,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds several Game Objects to this group.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"addMultiple","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The Game Objects to add.","name":"children"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also add the Game Objects to the scene.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This group."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#addMultiple","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Removes a member of this Group and optionally removes it from the Scene and / or destroys it.\n\nCalls {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to remove.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally remove the Group member from the Scene it belongs to.","name":"removeFromScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call destroy on the removed Group member.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#remove","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":645,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Removes all members of this Group and optionally removes them from the Scene and / or destroys them.\n\nDoes not call {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"clear","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally remove each Group member from the Scene.","name":"removeFromScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call destroy on the removed Group members.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This group."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#clear","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":691,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Tests if a Game Object is a member of this group.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A Game Object.","name":"child"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object is a member of this group."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#contains","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":706,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"All members of the group.","kind":"function","name":"getChildren","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"The group members."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getChildren","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":719,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The number of members of the group.","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["integer"]}}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getLength","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":732,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group, from top to bottom, for the first member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirst","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getFirst","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":757,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group, from top to bottom, for the nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstNth","since":"3.6.0","params":[{"type":{"names":["integer"]},"description":"The nth matching Group member to search for.","name":"nth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getFirstNth","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":783,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group for the last member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getLast","since":"3.6.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getLast","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":808,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group for the last nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getLastNth","since":"3.6.0","params":[{"type":{"names":["integer"]},"description":"The nth matching Group member to search for.","name":"nth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getLastNth","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":937,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\nassigns `x` and `y`, and returns the member.\n\nIf no inactive member is found and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nThe new Game Object will have its active state set to `true`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first inactive group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#get","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":961,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `true`,\nassigns `x` and `y`, and returns the member.\n\nIf no active member is found and `createIfNull` is `true` and the group isn't full then it will create a new one using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstAlive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"description":"The first active group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getFirstAlive","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":985,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\nassigns `x` and `y`, and returns the member.\n\nIf no inactive member is found and `createIfNull` is `true` and the group isn't full then it will create a new one using `x`, `y`, `key`, `frame`, and `visible`.\nThe new Game Object will have an active state set to `true`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstDead","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"description":"The first inactive group member, or a newly created member, or null."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getFirstDead","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1010,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"{@link Phaser.GameObjects.Components.Animation#play Plays} an animation for all members of this group.","kind":"function","name":"playAnimation","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["string"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#playAnimation","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1028,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether this group's size at its {@link Phaser.GameObjects.Group#maxSize maximum}.","kind":"function","name":"isFull","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if the number of members equals {@link Phaser.GameObjects.Group#maxSize}."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#isFull","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1048,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Counts the number of active (or inactive) group members.","kind":"function","name":"countActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Count active (true) or inactive (false) group members.","name":"value"}],"returns":[{"type":{"names":["integer"]},"description":"The number of group members with an active state matching the `active` argument."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#countActive","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1075,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Counts the number of in-use (active) group members.","kind":"function","name":"getTotalUsed","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of group members with an active state of true."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getTotalUsed","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The difference of {@link Phaser.GameObjects.Group#maxSize} and the number of active group members.\n\nThis represents the number of group members that could be created or reactivated before reaching the size limit.","kind":"function","name":"getTotalFree","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"maxSize minus the number of active group numbers; or a large number (if maxSize is -1)."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#getTotalFree","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the property as defined in `key` of each group member to the given value.","kind":"function","name":"propertyValueSet","since":"3.21.0","params":[{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#propertyValueSet","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the property as defined in `key` of each group member.","kind":"function","name":"propertyValueInc","since":"3.21.0","params":[{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#propertyValueInc","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1148,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the x of each group member.","kind":"function","name":"setX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setX","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the y of each group member.","kind":"function","name":"setY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setY","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the x, y of each group member.","kind":"function","name":"setXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the `x` property to.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to set the `y` property to. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setXY","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the x of each group member.","kind":"function","name":"incX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#incX","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the y of each group member.","kind":"function","name":"incY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `y` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#incY","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1240,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the x, y of each group member.","kind":"function","name":"incXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to be added to the `y` property. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#incXY","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Iterate through the group members changing the position of each element to be that of the element that came before\nit in the array (or after it if direction = 1)\n\nThe first group member position is set to x/y.","kind":"function","name":"shiftPosition","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to place the first item in the array at.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to place the first item in the array at.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The iteration direction. 0 = first to last and 1 = last to first.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#shiftPosition","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1282,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the angle of each group member.","kind":"function","name":"angle","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the angle to, in degrees.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#angle","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the rotation of each group member.","kind":"function","name":"rotate","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the rotation to, in radians.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#rotate","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Rotates each group member around the given point by the given angle.","kind":"function","name":"rotateAround","since":"3.21.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#rotateAround","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1336,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Rotates each group member around the given point by the given angle and distance.","kind":"function","name":"rotateAroundDistance","since":"3.21.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"},{"type":{"names":["number"]},"description":"The distance from the point of rotation in pixels.","name":"distance"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#rotateAroundDistance","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the alpha of each group member.","kind":"function","name":"setAlpha","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the alpha to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setAlpha","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the tint of each group member.","kind":"function","name":"setTint","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The tint being applied to top-left corner of item. If other parameters are given no value, this tint will be applied to whole item.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to top-right corner of item.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-left corner of item.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-right corner of item.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setTint","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1393,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the originX, originY of each group member.","kind":"function","name":"setOrigin","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the `originX` property to.","name":"originX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to set the `originY` property to. If `undefined` or `null` it uses the `originX` value.","name":"originY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originY` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setOrigin","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1413,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleX of each group member.","kind":"function","name":"scaleX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#scaleX","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleY of each group member.","kind":"function","name":"scaleY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#scaleY","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleX, scaleY of each group member.","kind":"function","name":"scaleXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `scaleX` property.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to be added to the `scaleY` property. If `undefined` or `null` it uses the `scaleX` value.","name":"scaleY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleY` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#scaleXY","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1469,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the depth of each group member.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setDepth","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1487,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the blendMode of each group member.","kind":"function","name":"setBlendMode","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setBlendMode","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1504,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Passes all group members to the Input Manager to enable them for input with identical areas and callbacks.","kind":"function","name":"setHitArea","since":"3.21.0","params":[{"type":{"names":["*"]},"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"hitAreaCallback"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setHitArea","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1522,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Shuffles the group members in place.","kind":"function","name":"shuffle","since":"3.21.0","returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#shuffle","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Deactivates a member of this group.","kind":"function","name":"kill","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A member of this group.","name":"gameObject"}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#kill","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1553,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Deactivates and hides a member of this group.","kind":"function","name":"killAndHide","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A member of this group.","name":"gameObject"}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#killAndHide","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1570,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the visible of each group member.","kind":"function","name":"setVisible","since":"3.21.0","params":[{"type":{"names":["boolean"]},"description":"The value to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#setVisible","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1589,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Toggles (flips) the visible state of each member of this group.","kind":"function","name":"toggleVisible","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#toggleVisible","scope":"instance","___s":true},{"meta":{"filename":"Group.js","lineno":1604,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Empties this group and removes it from the Scene.\n\nDoes not call {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"destroy","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also {@link Phaser.GameObjects.GameObject#destroy} each group member.","name":"destroyChildren"}],"memberof":"Phaser.GameObjects.Group","longname":"Phaser.GameObjects.Group#destroy","scope":"instance","___s":true},{"meta":{"range":[180,231],"filename":"GroupCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"name":"GameObjectCreator","longname":"GameObjectCreator","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GroupCreator.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates a new Group Game Object and returns it.\n\nNote: This method will only be available if the Group Game Object has been built into Phaser.","kind":"function","name":"group","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#group","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"GroupFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"name":"Group","longname":"Group","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GroupFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates a new Group Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Group Game Object has been built into Phaser.","kind":"function","name":"group","since":"3.0.0","params":[{"type":{"names":["Array.","Phaser.Types.GameObjects.Group.GroupConfig","Array."]},"optional":true,"description":"Game Objects to add to this Group; or the `config` argument.","name":"children"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"A Group Configuration object.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#group","scope":"instance","___s":true},{"meta":{"filename":"GroupCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs"},"kind":"typedef","name":"GroupCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A group member","name":"item"}],"memberof":"Phaser.Types.GameObjects.Group","longname":"Phaser.Types.GameObjects.Group.GroupCallback","scope":"static","___s":true},{"meta":{"filename":"GroupConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs"},"kind":"typedef","name":"GroupConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["function"]},"optional":true,"nullable":true,"defaultvalue":"Sprite","description":"Sets {@link Phaser.GameObjects.Group#classType}.","name":"classType"},{"type":{"names":["string"]},"optional":true,"nullable":true,"defaultvalue":"''","description":"Sets {@link Phaser.GameObjects.Group#name}.","name":"name"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":true,"description":"Sets {@link Phaser.GameObjects.Group#active}.","name":"active"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":-1,"description":"Sets {@link Phaser.GameObjects.Group#maxSize}.","name":"maxSize"},{"type":{"names":["string"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"Sets {@link Phaser.GameObjects.Group#defaultKey}.","name":"defaultKey"},{"type":{"names":["string","integer"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"Sets {@link Phaser.GameObjects.Group#defaultFrame}.","name":"defaultFrame"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":false,"description":"Sets {@link Phaser.GameObjects.Group#runChildUpdate}.","name":"runChildUpdate"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"Sets {@link Phaser.GameObjects.Group#createCallback}.","name":"createCallback"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"Sets {@link Phaser.GameObjects.Group#removeCallback}.","name":"removeCallback"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"Sets {@link Phaser.GameObjects.Group#createMultipleCallback}.","name":"createMultipleCallback"}],"memberof":"Phaser.Types.GameObjects.Group","longname":"Phaser.Types.GameObjects.Group.GroupConfig","scope":"static","___s":true},{"meta":{"filename":"GroupCreateConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs"},"description":"The total number of objects created will be\n\n key.length * frame.length * frameQuantity * (yoyo ? 2 : 1) * (1 + repeat)\n\nIf `max` is nonzero, then the total created will not exceed `max`.\n\n`key` is required. {@link Phaser.GameObjects.Group#defaultKey} is not used.","kind":"typedef","name":"GroupCreateConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["function"]},"optional":true,"nullable":true,"description":"The class of each new Game Object.","name":"classType"},{"type":{"names":["string","Array."]},"optional":true,"description":"The texture key of each new Game Object.","name":"key"},{"type":{"names":["string","Array.","integer","Array."]},"optional":true,"nullable":true,"defaultvalue":null,"description":"The texture frame of each new Game Object.","name":"frame"},{"type":{"names":["integer"]},"optional":true,"nullable":true,"defaultvalue":false,"description":"The number of Game Objects to create. If set, this overrides the `frameQuantity` value. Use `frameQuantity` for more advanced control.","name":"quantity"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":true,"description":"The visible state of each new Game Object.","name":"visible"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":true,"description":"The active state of each new Game Object.","name":"active"},{"type":{"names":["integer"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The number of times each `key` × `frame` combination will be *repeated* (after the first combination).","name":"repeat"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":false,"description":"Select a `key` at random.","name":"randomKey"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":false,"description":"Select a `frame` at random.","name":"randomFrame"},{"type":{"names":["boolean"]},"optional":true,"nullable":true,"defaultvalue":false,"description":"Select keys and frames by moving forward then backward through `key` and `frame`.","name":"yoyo"},{"type":{"names":["integer"]},"optional":true,"nullable":true,"defaultvalue":1,"description":"The number of times each `frame` should be combined with one `key`.","name":"frameQuantity"},{"type":{"names":["integer"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The maximum number of new Game Objects to create. 0 is no maximum.","name":"max"},{"type":{"names":["object"]},"optional":true,"nullable":true,"name":"setXY"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The horizontal position of each new Game Object.","name":"setXY.x"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The vertical position of each new Game Object.","name":"setXY.y"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's horizontal position from the previous by this amount, starting from `setXY.x`.","name":"setXY.stepX"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's vertical position from the previous by this amount, starting from `setXY.y`.","name":"setXY.stepY"},{"type":{"names":["object"]},"optional":true,"nullable":true,"name":"setRotation"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Rotation of each new Game Object.","name":"setRotation.value"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's rotation from the previous by this amount, starting at `setRotation.value`.","name":"setRotation.step"},{"type":{"names":["object"]},"optional":true,"nullable":true,"name":"setScale"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The horizontal scale of each new Game Object.","name":"setScale.x"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The vertical scale of each new Game Object.","name":"setScale.y"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's horizontal scale from the previous by this amount, starting from `setScale.x`.","name":"setScale.stepX"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game object's vertical scale from the previous by this amount, starting from `setScale.y`.","name":"setScale.stepY"},{"type":{"names":["object"]},"optional":true,"nullable":true,"name":"setAlpha"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The alpha value of each new Game Object.","name":"setAlpha.value"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's alpha from the previous by this amount, starting from `setAlpha.value`.","name":"setAlpha.step"},{"type":{"names":["object"]},"optional":true,"nullable":true,"name":"setDepth"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The depth value of each new Game Object.","name":"setDepth.value"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's depth from the previous by this amount, starting from `setDepth.value`.","name":"setDepth.step"},{"type":{"names":["object"]},"optional":true,"nullable":true,"name":"setScrollFactor"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The horizontal scroll factor of each new Game Object.","name":"setScrollFactor.x"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"The vertical scroll factor of each new Game Object.","name":"setScrollFactor.y"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game Object's horizontal scroll factor from the previous by this amount, starting from `setScrollFactor.x`.","name":"setScrollFactor.stepX"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":0,"description":"Increment each Game object's vertical scroll factor from the previous by this amount, starting from `setScrollFactor.y`.","name":"setScrollFactor.stepY"},{"type":{"names":["*"]},"optional":true,"nullable":true,"description":"A geometric shape that defines the hit area for the Game Object.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"nullable":true,"description":"A callback to be invoked when the Game Object is interacted with.","name":"hitAreaCallback"},{"type":{"names":["false","Phaser.Types.Actions.GridAlignConfig"]},"optional":true,"nullable":true,"defaultvalue":false,"description":"Align the new Game Objects in a grid using these settings.","name":"gridAlign"}],"see":["Phaser.Actions.GridAlign","Phaser.Actions.SetAlpha","Phaser.Actions.SetHitArea","Phaser.Actions.SetRotation","Phaser.Actions.SetScale","Phaser.Actions.SetXY","Phaser.Actions.SetDepth","Phaser.Actions.SetScrollFactor","Phaser.GameObjects.Group#createFromConfig","Phaser.Utils.Array.Range"],"memberof":"Phaser.Types.GameObjects.Group","longname":"Phaser.Types.GameObjects.Group.GroupCreateConfig","scope":"static","___s":true},{"meta":{"filename":"GroupMultipleCreateCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs"},"kind":"typedef","name":"GroupMultipleCreateCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The newly created group members","name":"items"}],"memberof":"Phaser.Types.GameObjects.Group","longname":"Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs"},"kind":"namespace","name":"Group","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.Group","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Image.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Image.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"classdesc":"An Image Game Object.\n\nAn Image is a light-weight Game Object useful for the display of static images in your game,\nsuch as logos, backgrounds, scenery or other non-animated elements. Images can have input\nevents and physics bodies, or be tweened, tinted or scrolled. The main difference between an\nImage and a Sprite is that you cannot animate an Image as they do not have the Animation component.","kind":"class","name":"Image","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.TextureCrop","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.Image","___s":true},{"meta":{"range":[180,227],"filename":"ImageCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImageCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"description":"Creates a new Image Game Object and returns it.\n\nNote: This method will only be available if the Image Game Object has been built into Phaser.","kind":"function","name":"image","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#image","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"ImageFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"name":"Image","longname":"Image","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImageFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"description":"Creates a new Image Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Image Game Object has been built into Phaser.","kind":"function","name":"image","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#image","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"ImageRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/image"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"kind":"namespace","name":"GameObjects","memberof":"Phaser","longname":"Phaser.GameObjects","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Light.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Light.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"classdesc":"A 2D point light.\n\nThese are typically created by a {@link Phaser.GameObjects.LightsManager}, available from within a scene via `this.lights`.\n\nAny Game Objects using the Light2D pipeline will then be affected by these Lights.\n\nThey can also simply be used to represent a point light for your own purposes.","kind":"class","name":"Light","memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the light.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the light.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the light.","name":"radius"},{"type":{"names":["number"]},"description":"The red color of the light. A value between 0 and 1.","name":"r"},{"type":{"names":["number"]},"description":"The green color of the light. A value between 0 and 1.","name":"g"},{"type":{"names":["number"]},"description":"The blue color of the light. A value between 0 and 1.","name":"b"},{"type":{"names":["number"]},"description":"The intensity of the light.","name":"intensity"}],"scope":"static","longname":"Phaser.GameObjects.Light","___s":true},{"meta":{"filename":"Light.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The horizontal position of the light.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The vertical position of the light.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The radius of the light.","name":"radius","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#radius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The red color of the light. A value between 0 and 1.","name":"r","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#r","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The green color of the light. A value between 0 and 1.","name":"g","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#g","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The blue color of the light. A value between 0 and 1.","name":"b","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#b","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The intensity of the light.","name":"intensity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#intensity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The horizontal scroll factor of the light.","name":"scrollFactorX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#scrollFactorX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The vertical scroll factor of the light.","name":"scrollFactorY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#scrollFactorY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Light.js","lineno":121,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the properties of the light.\n\nSets both horizontal and vertical scroll factor to 1. Use {@link Phaser.GameObjects.Light#setScrollFactor} to set\nthe scroll factor.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the light.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the light.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the light.","name":"radius"},{"type":{"names":["number"]},"description":"The red color. A value between 0 and 1.","name":"r"},{"type":{"names":["number"]},"description":"The green color. A value between 0 and 1.","name":"g"},{"type":{"names":["number"]},"description":"The blue color. A value between 0 and 1.","name":"b"},{"type":{"names":["number"]},"description":"The intensity of the light.","name":"intensity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"This Light object."}],"memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#set","scope":"instance","___s":true},{"meta":{"filename":"Light.js","lineno":159,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the scroll factor of the light.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of the light.","name":"x"},{"type":{"names":["number"]},"description":"The vertical scroll factor of the light.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"This Light object."}],"memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#setScrollFactor","scope":"instance","___s":true},{"meta":{"filename":"Light.js","lineno":181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the color of the light from a single integer RGB value.","kind":"function","name":"setColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The integer RGB color of the light.","name":"rgb"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"This Light object."}],"memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#setColor","scope":"instance","___s":true},{"meta":{"filename":"Light.js","lineno":202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the intensity of the light.","kind":"function","name":"setIntensity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The intensity of the light.","name":"intensity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"This Light object."}],"memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#setIntensity","scope":"instance","___s":true},{"meta":{"filename":"Light.js","lineno":219,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the position of the light.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the light.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the light.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"This Light object."}],"memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Light.js","lineno":238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the radius of the light.","kind":"function","name":"setRadius","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the light.","name":"radius"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"This Light object."}],"memberof":"Phaser.GameObjects.Light","longname":"Phaser.GameObjects.Light#setRadius","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"LightsManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LightsManager.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"kind":"typedef","name":"LightForEach","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"The Light.","name":"light"}],"longname":"LightForEach","scope":"global","___s":true},{"meta":{"filename":"LightsManager.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"classdesc":"Manages Lights for a Scene.\n\nAffects the rendering of Game Objects using the `Light2D` pipeline.","kind":"class","name":"LightsManager","memberof":"Phaser.GameObjects","since":"3.0.0","scope":"static","longname":"Phaser.GameObjects.LightsManager","___s":true},{"meta":{"filename":"LightsManager.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The pool of Lights.\n\nUsed to recycle removed Lights for a more efficient use of memory.","name":"lightPool","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#lightPool","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsManager.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The Lights in the Scene.","name":"lights","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#lights","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsManager.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Lights that have been culled from a Camera's viewport.\n\nLights in this list will not be rendered.","name":"culledLights","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#culledLights","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsManager.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The ambient color.","name":"ambientColor","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#ambientColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsManager.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Whether the Lights Manager is enabled.","name":"active","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsManager.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The maximum number of lights that a single Camera and the lights shader can process.\nChange this via the `maxLights` property in your game config, as it cannot be changed at runtime.","name":"maxLights","type":{"names":["integer"]},"readonly":true,"since":"3.15.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#maxLights","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsManager.js","lineno":99,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Enable the Lights Manager.","kind":"function","name":"enable","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#enable","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":119,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Disable the Lights Manager.","kind":"function","name":"disable","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#disable","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Cull any Lights that aren't visible to the given Camera.\n\nCulling Lights improves performance by ensuring that only Lights within a Camera's viewport are rendered.","kind":"function","name":"cull","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to cull Lights for.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"The culled Lights."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#cull","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Iterate over each Light with a callback.","kind":"function","name":"forEachLight","since":"3.0.0","params":[{"type":{"names":["LightForEach"]},"description":"The callback that is called with each Light.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#forEachLight","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the ambient light color.","kind":"function","name":"setAmbientColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The integer RGB color of the ambient light.","name":"rgb"}],"returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#setAmbientColor","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Returns the maximum number of Lights allowed to appear at once.","kind":"function","name":"getMaxVisibleLights","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The maximum number of Lights allowed to appear at once."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#getMaxVisibleLights","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Get the number of Lights managed by this Lights Manager.","kind":"function","name":"getLightCount","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of Lights managed by this Lights Manager."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#getLightCount","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Add a Light.","kind":"function","name":"addLight","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the Light.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the Light.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"The radius of the Light.","name":"radius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xffffff","description":"The integer RGB color of the light.","name":"rgb"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The intensity of the Light.","name":"intensity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"The Light that was added."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#addLight","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Remove a Light.","kind":"function","name":"removeLight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"The Light to remove.","name":"light"}],"returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#removeLight","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Shut down the Lights Manager.\n\nRecycles all active Lights into the Light pool, resets ambient light color and clears the lists of Lights and\nculled Lights.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#shutdown","scope":"instance","___s":true},{"meta":{"filename":"LightsManager.js","lineno":342,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Destroy the Lights Manager.\n\nCleans up all references by calling {@link Phaser.GameObjects.LightsManager#shutdown}.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.GameObjects.LightsManager","longname":"Phaser.GameObjects.LightsManager#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"LightsPlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LightsPlugin.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"classdesc":"A Scene plugin that provides a {@link Phaser.GameObjects.LightsManager} for the Light2D pipeline.\n\nAvailable from within a Scene via `this.lights`.\n\nAdd Lights using the {@link Phaser.GameObjects.LightsManager#addLight} method:\n\n```javascript\n// Enable the Lights Manager because it is disabled by default\nthis.lights.enable();\n\n// Create a Light at [400, 300] with a radius of 200\nthis.lights.addLight(400, 300, 200);\n```\n\nFor Game Objects to be affected by the Lights when rendered, you will need to set them to use the `Light2D` pipeline like so:\n\n```javascript\nsprite.setPipeline('Light2D');\n```","kind":"class","name":"LightsPlugin","augments":["Phaser.GameObjects.LightsManager"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that this Lights Plugin belongs to.","name":"scene"}],"scope":"static","longname":"Phaser.GameObjects.LightsPlugin","___s":true},{"meta":{"filename":"LightsPlugin.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"A reference to the Scene that this Lights Plugin belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsPlugin.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"A reference to the Scene's systems.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LightsPlugin.js","lineno":76,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Boot the Lights Plugin.","kind":"function","name":"boot","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#boot","scope":"instance","___s":true},{"meta":{"filename":"LightsPlugin.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Destroy the Lights Plugin.\n\nCleans up all references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#destroy","scope":"instance","overrides":"Phaser.GameObjects.LightsManager#destroy","___s":true},{"meta":{"range":[180,216],"filename":"Mesh.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Mesh.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"classdesc":"A Mesh Game Object.","kind":"class","name":"Mesh","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible","Phaser.GameObjects.Components.ScrollFactor"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["Array."]},"description":"An array containing the vertices data for this Mesh.","name":"vertices"},{"type":{"names":["Array."]},"description":"An array containing the uv data for this Mesh.","name":"uv"},{"type":{"names":["Array."]},"description":"An array containing the color data for this Mesh.","name":"colors"},{"type":{"names":["Array."]},"description":"An array containing the alpha data for this Mesh.","name":"alphas"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.Mesh","___s":true},{"meta":{"filename":"Mesh.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the vertices data for this Mesh.","name":"vertices","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#vertices","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Mesh.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the uv data for this Mesh.","name":"uv","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#uv","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Mesh.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the color data for this Mesh.","name":"colors","type":{"names":["Uint32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#colors","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Mesh.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the alpha data for this Mesh.","name":"alphas","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#alphas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Mesh.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"Fill or additive mode used when blending the color values?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#tintFill","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Mesh.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"This method is left intentionally empty and does not do anything.\nIt is retained to allow a Mesh or Quad to be added to a Container.","kind":"function","name":"setAlpha","since":"3.17.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setAlpha","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"MeshCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MeshCreator.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"Creates a new Mesh Game Object and returns it.\n\nNote: This method will only be available if the Mesh Game Object and WebGL support have been built into Phaser.","kind":"function","name":"mesh","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#mesh","scope":"instance","___s":true},{"meta":{"range":[180,204],"filename":"MeshFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"name":"Mesh","longname":"Mesh","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MeshFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"Creates a new Mesh Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Mesh Game Object and WebGL support have been built into Phaser.","kind":"function","name":"mesh","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["Array."]},"description":"An array containing the vertices data for this Mesh.","name":"vertices"},{"type":{"names":["Array."]},"description":"An array containing the uv data for this Mesh.","name":"uv"},{"type":{"names":["Array."]},"description":"An array containing the color data for this Mesh.","name":"colors"},{"type":{"names":["Array."]},"description":"An array containing the alpha data for this Mesh.","name":"alphas"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#mesh","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"MeshRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"MeshWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"EmitterOp.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"EmitterOp.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"classdesc":"A Particle Emitter property.\n\nFacilitates changing Particle properties as they are emitted and throughout their lifetime.","kind":"class","name":"EmitterOp","memberof":"Phaser.GameObjects.Particles","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig"]},"description":"Settings for the Particle Emitter that owns this property.","name":"config"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"},{"type":{"names":["number"]},"description":"The default value of the property.","name":"defaultValue"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the property can only be modified when a Particle is emitted.","name":"emitOnly"}],"scope":"static","longname":"Phaser.GameObjects.Particles.EmitterOp","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The name of this property.","name":"propertyKey","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#propertyKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The value of this property.","name":"propertyValue","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#propertyValue","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The default value of this property.","name":"defaultValue","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#defaultValue","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The number of steps for stepped easing between {@link Phaser.GameObjects.Particles.EmitterOp#start} and\n{@link Phaser.GameObjects.Particles.EmitterOp#end} values, per emit.","name":"steps","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#steps","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The step counter for stepped easing, per emit.","name":"counter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#counter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The start value for this property to ease between.","name":"start","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#start","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The end value for this property to ease between.","name":"end","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#end","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The easing function to use for updating this property.","name":"ease","type":{"names":["function"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#ease","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether this property can only be modified when a Particle is emitted.\n\nSet to `true` to allow only {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} callbacks to be set and\naffect this property.\n\nSet to `false` to allow both {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} and\n{@link Phaser.GameObjects.Particles.EmitterOp#onUpdate} callbacks to be set and affect this property.","name":"emitOnly","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#emitOnly","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The callback to run for Particles when they are emitted from the Particle Emitter.","name":"onEmit","type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#onEmit","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The callback to run for Particles when they are updated.","name":"onUpdate","type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#onUpdate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":153,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Load the property from a Particle Emitter configuration object.\n\nOptionally accepts a new property key to use, replacing the current one.","kind":"function","name":"loadConfig","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig"]},"optional":true,"description":"Settings for the Particle Emitter that owns this property.","name":"config"},{"type":{"names":["string"]},"optional":true,"description":"The new key to use for this property, if any.","name":"newKey"}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#loadConfig","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Build a JSON representation of this Particle Emitter property.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"A JSON representation of this Particle Emitter property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#toJSON","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Change the current value of the property and update its callback methods.","kind":"function","name":"onChange","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value of the property.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"description":"This Emitter Op object."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#onChange","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Update the {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} and\n{@link Phaser.GameObjects.Particles.EmitterOp#onUpdate} callbacks based on the type of the current\n{@link Phaser.GameObjects.Particles.EmitterOp#propertyValue}.","kind":"function","name":"setMethods","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"description":"This Emitter Op object."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#setMethods","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":366,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Check whether an object has the given property.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to check.","name":"object"},{"type":{"names":["string"]},"description":"The key of the property to look for in the object.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the property exists in the object, `false` otherwise."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#has","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":382,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Check whether an object has both of the given properties.","kind":"function","name":"hasBoth","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to check.","name":"object"},{"type":{"names":["string"]},"description":"The key of the first property to check the object for.","name":"key1"},{"type":{"names":["string"]},"description":"The key of the second property to check the object for.","name":"key2"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if both properties exist in the object, `false` otherwise."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#hasBoth","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":399,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Check whether an object has at least one of the given properties.","kind":"function","name":"hasEither","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to check.","name":"object"},{"type":{"names":["string"]},"description":"The key of the first property to check the object for.","name":"key1"},{"type":{"names":["string"]},"description":"The key of the second property to check the object for.","name":"key2"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if at least one of the properties exists in the object, `false` if neither exist."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#hasEither","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":416,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The returned value sets what the property will be at the START of the particles life, on emit.","kind":"function","name":"defaultEmit","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"},{"type":{"names":["number"]},"optional":true,"description":"The current value of the property.","name":"value"}],"returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#defaultEmit","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":433,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The returned value updates the property for the duration of the particles life.","kind":"function","name":"defaultUpdate","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"},{"type":{"names":["number"]},"description":"The T value (between 0 and 1)","name":"t"},{"type":{"names":["number"]},"description":"The current value of the property.","name":"value"}],"returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#defaultUpdate","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onEmit` callback that returns the current value of the property.","kind":"function","name":"staticValueEmit","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The current value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#staticValueEmit","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":464,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onUpdate` callback that returns the current value of the property.","kind":"function","name":"staticValueUpdate","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The current value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#staticValueUpdate","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":477,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onEmit` callback that returns a random value from the current value array.","kind":"function","name":"randomStaticValueEmit","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#randomStaticValueEmit","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":492,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onEmit` callback that returns a value between the {@link Phaser.GameObjects.Particles.EmitterOp#start} and\n{@link Phaser.GameObjects.Particles.EmitterOp#end} range.","kind":"function","name":"randomRangedValueEmit","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The key of the property.","name":"key"}],"returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#randomRangedValueEmit","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onEmit` callback that returns a stepped value between the\n{@link Phaser.GameObjects.Particles.EmitterOp#start} and {@link Phaser.GameObjects.Particles.EmitterOp#end}\nrange.","kind":"function","name":"steppedEmit","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#steppedEmit","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onEmit` callback for an eased property.\n\nIt prepares the particle for easing by {@link Phaser.GameObjects.Particles.EmitterOp#easeValueUpdate}.","kind":"function","name":"easedValueEmit","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"}],"returns":[{"type":{"names":["number"]},"description":"{@link Phaser.GameObjects.Particles.EmitterOp#start}, as the new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#easedValueEmit","scope":"instance","___s":true},{"meta":{"filename":"EmitterOp.js","lineno":563,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An `onUpdate` callback that returns an eased value between the\n{@link Phaser.GameObjects.Particles.EmitterOp#start} and {@link Phaser.GameObjects.Particles.EmitterOp#end}\nrange.","kind":"function","name":"easeValueUpdate","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"},{"type":{"names":["number"]},"description":"The T value (between 0 and 1)","name":"t"}],"returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.GameObjects.Particles.EmitterOp","longname":"Phaser.GameObjects.Particles.EmitterOp#easeValueUpdate","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"GravityWell.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GravityWell.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"classdesc":"The GravityWell action applies a force on the particle to draw it towards, or repel it from, a single point.\n\nThe force applied is inversely proportional to the square of the distance from the particle to the point, in accordance with Newton's law of gravity.\n\nThis simulates the effect of gravity over large distances (as between planets, for example).","kind":"class","name":"GravityWell","memberof":"Phaser.GameObjects.Particles","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Types.GameObjects.Particles.GravityWellConfig"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the Gravity Well, in world space.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the Gravity Well, in world space.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The strength of the gravity force - larger numbers produce a stronger force.","name":"power"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"The minimum distance for which the gravity force is calculated.","name":"epsilon"},{"type":{"names":["number"]},"optional":true,"defaultvalue":50,"description":"The gravitational force of this Gravity Well.","name":"gravity"}],"scope":"static","longname":"Phaser.GameObjects.Particles.GravityWell","___s":true},{"meta":{"filename":"GravityWell.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The x coordinate of the Gravity Well, in world space.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.GravityWell","longname":"Phaser.GameObjects.Particles.GravityWell#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GravityWell.js","lineno":63,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The y coordinate of the Gravity Well, in world space.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.GravityWell","longname":"Phaser.GameObjects.Particles.GravityWell#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GravityWell.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The active state of the Gravity Well. An inactive Gravity Well will not influence any particles.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.GravityWell","longname":"Phaser.GameObjects.Particles.GravityWell#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GravityWell.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The strength of the gravity force - larger numbers produce a stronger force.","name":"power","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.GravityWell","longname":"Phaser.GameObjects.Particles.GravityWell#power","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GravityWell.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The minimum distance for which the gravity force is calculated.","name":"epsilon","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.GravityWell","longname":"Phaser.GameObjects.Particles.GravityWell#epsilon","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GravityWell.js","lineno":133,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Takes a Particle and updates it based on the properties of this Gravity Well.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The Particle to update.","name":"particle"},{"type":{"names":["number"]},"description":"The delta time in ms.","name":"delta"},{"type":{"names":["number"]},"description":"The delta value divided by 1000.","name":"step"}],"memberof":"Phaser.GameObjects.Particles.GravityWell","longname":"Phaser.GameObjects.Particles.GravityWell#update","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"Particle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Particle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"classdesc":"A Particle is a simple Game Object controlled by a Particle Emitter and Manager, and rendered by the Manager.\nIt uses its own lightweight physics system, and can interact only with its Emitter's bounds and zones.","kind":"class","name":"Particle","memberof":"Phaser.GameObjects.Particles","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The Emitter to which this Particle belongs.","name":"emitter"}],"scope":"static","longname":"Phaser.GameObjects.Particles.Particle","___s":true},{"meta":{"filename":"Particle.js","lineno":29,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The Emitter to which this Particle belongs.\n\nA Particle can only belong to a single Emitter and is created, updated and destroyed via it.","name":"emitter","type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#emitter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The texture frame used to render this Particle.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The x coordinate of this Particle.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The y coordinate of this Particle.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The x velocity of this Particle.","name":"velocityX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#velocityX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The y velocity of this Particle.","name":"velocityY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#velocityY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":90,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The x acceleration of this Particle.","name":"accelerationX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#accelerationX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":100,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The y acceleration of this Particle.","name":"accelerationY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#accelerationY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The maximum horizontal velocity this Particle can travel at.","name":"maxVelocityX","type":{"names":["number"]},"defaultvalue":"10000","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#maxVelocityX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The maximum vertical velocity this Particle can travel at.","name":"maxVelocityY","type":{"names":["number"]},"defaultvalue":"10000","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#maxVelocityY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The bounciness, or restitution, of this Particle.","name":"bounce","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#bounce","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":140,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The horizontal scale of this Particle.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#scaleX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":150,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The vertical scale of this Particle.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#scaleY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":160,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The alpha value of this Particle.","name":"alpha","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":170,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The angle of this Particle in degrees.","name":"angle","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":180,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The angle of this Particle in radians.","name":"rotation","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":190,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The tint applied to this Particle.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#tint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":200,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The lifespan of this Particle in ms.","name":"life","type":{"names":["number"]},"defaultvalue":"1000","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#life","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":210,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The current life of this Particle in ms.","name":"lifeCurrent","type":{"names":["number"]},"defaultvalue":"1000","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#lifeCurrent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The delay applied to this Particle upon emission, in ms.","name":"delayCurrent","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#delayCurrent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":230,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The normalized lifespan T value, where 0 is the start and 1 is the end.","name":"lifeT","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#lifeT","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":240,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The data used by the ease equation.","name":"data","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Particle.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Checks to see if this Particle is alive and updating.","kind":"function","name":"isAlive","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Particle is alive and updating, otherwise `false`."}],"memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#isAlive","scope":"instance","___s":true},{"meta":{"filename":"Particle.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Resets the position of this particle back to zero.","kind":"function","name":"resetPosition","since":"3.16.0","memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#resetPosition","scope":"instance","___s":true},{"meta":{"filename":"Particle.js","lineno":281,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Starts this Particle from the given coordinates.","kind":"function","name":"fire","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to launch this Particle from.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to launch this Particle from.","name":"y"}],"memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#fire","scope":"instance","___s":true},{"meta":{"filename":"Particle.js","lineno":389,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An internal method that calculates the velocity of the Particle.","kind":"function","name":"computeVelocity","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The Emitter that is updating this Particle.","name":"emitter"},{"type":{"names":["number"]},"description":"The delta time in ms.","name":"delta"},{"type":{"names":["number"]},"description":"The delta value divided by 1000.","name":"step"},{"type":{"names":["array"]},"description":"Particle processors (gravity wells).","name":"processors"}],"memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#computeVelocity","scope":"instance","___s":true},{"meta":{"filename":"Particle.js","lineno":452,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Checks if this Particle is still within the bounds defined by the given Emitter.\n\nIf not, and depending on the Emitter collision flags, the Particle may either stop or rebound.","kind":"function","name":"checkBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The Emitter to check the bounds against.","name":"emitter"}],"memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#checkBounds","scope":"instance","___s":true},{"meta":{"filename":"Particle.js","lineno":490,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The main update method for this Particle.\n\nUpdates its life values, computes the velocity and repositions the Particle.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delta time in ms.","name":"delta"},{"type":{"names":["number"]},"description":"The delta value divided by 1000.","name":"step"},{"type":{"names":["array"]},"description":"An optional array of update processors.","name":"processors"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if this Particle has now expired and should be removed, otherwise `false` if still active."}],"memberof":"Phaser.GameObjects.Particles.Particle","longname":"Phaser.GameObjects.Particles.Particle#update","scope":"instance","___s":true},{"meta":{"range":[180,229],"filename":"ParticleEmitter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"BlendModes","longname":"BlendModes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":24,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"classdesc":"A particle emitter represents a single particle stream.\nIt controls a pool of {@link Phaser.GameObjects.Particles.Particle Particles} and is controlled by a {@link Phaser.GameObjects.Particles.ParticleEmitterManager Particle Emitter Manager}.","kind":"class","name":"ParticleEmitter","memberof":"Phaser.GameObjects.Particles","since":"3.0.0","augments":["Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Visible"],"params":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"The Emitter Manager this Emitter belongs to.","name":"manager"},{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig"]},"description":"Settings for this emitter.","name":"config"}],"scope":"static","longname":"Phaser.GameObjects.Particles.ParticleEmitter","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The Emitter Manager this Emitter belongs to.","name":"manager","type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The texture assigned to particles.","name":"texture","type":{"names":["Phaser.Textures.Texture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The texture frames assigned to particles.","name":"frames","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#frames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The default texture frame assigned to particles.","name":"defaultFrame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#defaultFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Names of simple configuration properties.","name":"configFastMap","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#configFastMap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Names of complex configuration properties.","name":"configOpMap","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#configOpMap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":154,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The name of this Particle Emitter.\n\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The Particle Class which will be emitted by this Emitter.","name":"particleClass","type":{"names":["Phaser.GameObjects.Particles.Particle"]},"defaultvalue":"Phaser.GameObjects.Particles.Particle","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#particleClass","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":176,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The x-coordinate of the particle origin (where particles will be emitted).","name":"x","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setPosition"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The y-coordinate of the particle origin (where particles will be emitted).","name":"y","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setPosition"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":198,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A radial emitter will emit particles in all directions between angle min and max,\nusing {@link Phaser.GameObjects.Particles.ParticleEmitter#speed} as the value. If set to false then this acts as a point Emitter.\nA point emitter will emit particles only in the direction derived from the speedX and speedY values.","name":"radial","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setRadial"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#radial","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Horizontal acceleration applied to emitted particles, in pixels per second squared.","name":"gravityX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setGravity"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#gravityX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":222,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Vertical acceleration applied to emitted particles, in pixels per second squared.","name":"gravityY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setGravity"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#gravityY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":233,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether accelerationX and accelerationY are non-zero. Set automatically during configuration.","name":"acceleration","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#acceleration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":243,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Horizontal acceleration applied to emitted particles, in pixels per second squared.","name":"accelerationX","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#accelerationX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":253,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Vertical acceleration applied to emitted particles, in pixels per second squared.","name":"accelerationY","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#accelerationY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":263,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The maximum horizontal velocity of emitted particles, in pixels per second squared.","name":"maxVelocityX","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"10000","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The maximum vertical velocity of emitted particles, in pixels per second squared.","name":"maxVelocityY","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"10000","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":283,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The initial horizontal speed of emitted particles, in pixels per second.","name":"speedX","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setSpeedX"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#speedX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":294,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The initial vertical speed of emitted particles, in pixels per second.","name":"speedY","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setSpeedY"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#speedY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":305,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether moveToX and moveToY are nonzero. Set automatically during configuration.","name":"moveTo","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#moveTo","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":315,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The x-coordinate emitted particles move toward, when {@link Phaser.GameObjects.Particles.ParticleEmitter#moveTo} is true.","name":"moveToX","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#moveToX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":325,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The y-coordinate emitted particles move toward, when {@link Phaser.GameObjects.Particles.ParticleEmitter#moveTo} is true.","name":"moveToY","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#moveToY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":335,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether particles will rebound when they meet the emitter bounds.","name":"bounce","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#bounce","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":345,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The horizontal scale of emitted particles.","name":"scaleX","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"1","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setScale","Phaser.GameObjects.Particles.ParticleEmitter#setScaleX"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#scaleX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":357,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The vertical scale of emitted particles.","name":"scaleY","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"1","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setScale","Phaser.GameObjects.Particles.ParticleEmitter#setScaleY"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#scaleY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":369,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Color tint applied to emitted particles. Any alpha component (0xAA000000) is ignored.","name":"tint","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0xffffffff","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#tint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":379,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The alpha (transparency) of emitted particles.","name":"alpha","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"1","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setAlpha"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":390,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The lifespan of emitted particles, in ms.","name":"lifespan","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"1000","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setLifespan"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#lifespan","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":401,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The angle of the initial velocity of emitted particles, in degrees.","name":"angle","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"{ min: 0, max: 360 }","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setAngle"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":412,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The rotation of emitted particles, in degrees.","name":"rotate","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#rotate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":422,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A function to call when a particle is emitted.","name":"emitCallback","type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterCallback"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#emitCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":432,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The calling context for {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallback}.","name":"emitCallbackScope","type":{"names":["*"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":442,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A function to call when a particle dies.","name":"deathCallback","type":{"names":["Phaser.Types.GameObjects.Particles.ParticleDeathCallback"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#deathCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":452,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The calling context for {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallback}.","name":"deathCallbackScope","type":{"names":["*"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":462,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Set to hard limit the amount of particle objects this emitter is allowed to create.\n0 means unlimited.","name":"maxParticles","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#maxParticles","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":473,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"How many particles are emitted each time particles are emitted (one explosion or one flow cycle).","name":"quantity","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"1","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setFrequency","Phaser.GameObjects.Particles.ParticleEmitter#setQuantity"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#quantity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":485,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"How many ms to wait after emission before the particles start updating.","name":"delay","type":{"names":["Phaser.GameObjects.Particles.EmitterOp"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#delay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":495,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"For a flow emitter, the time interval (>= 0) between particle flow cycles in ms.\nA value of 0 means there is one particle flow cycle for each logic update (the maximum flow frequency). This is the default setting.\nFor an exploding emitter, this value will be -1.\nCalling {@link Phaser.GameObjects.Particles.ParticleEmitter#flow} also puts the emitter in flow mode (frequency >= 0).\nCalling {@link Phaser.GameObjects.Particles.ParticleEmitter#explode} also puts the emitter in explode mode (frequency = -1).","name":"frequency","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setFrequency"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#frequency","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":510,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Controls if the emitter is currently emitting a particle flow (when frequency >= 0).\nAlready alive particles will continue to update until they expire.\nControlled by {@link Phaser.GameObjects.Particles.ParticleEmitter#start} and {@link Phaser.GameObjects.Particles.ParticleEmitter#stop}.","name":"on","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#on","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":522,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Newly emitted particles are added to the top of the particle list, i.e. rendered above those already alive.\nSet to false to send them to the back.","name":"particleBringToTop","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":533,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The time rate applied to active particles, affecting lifespan, movement, and tweens. Values larger than 1 are faster than normal.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":543,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An object describing a shape to emit particles from.","name":"emitZone","type":{"names":["Phaser.GameObjects.Particles.Zones.EdgeZone","Phaser.GameObjects.Particles.Zones.RandomZone"]},"defaultvalue":"null","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#emitZone","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":554,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"An object describing a shape that deactivates particles when they interact with it.","name":"deathZone","type":{"names":["Phaser.GameObjects.Particles.Zones.DeathZone"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setDeathZone"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#deathZone","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":565,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A rectangular boundary constraining particle movement.","name":"bounds","type":{"names":["Phaser.Geom.Rectangle"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setBounds"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#bounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":576,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether particles interact with the left edge of the emitter {@link Phaser.GameObjects.Particles.ParticleEmitter#bounds}.","name":"collideLeft","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#collideLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":586,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether particles interact with the right edge of the emitter {@link Phaser.GameObjects.Particles.ParticleEmitter#bounds}.","name":"collideRight","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#collideRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":596,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether particles interact with the top edge of the emitter {@link Phaser.GameObjects.Particles.ParticleEmitter#bounds}.","name":"collideTop","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#collideTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":606,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether particles interact with the bottom edge of the emitter {@link Phaser.GameObjects.Particles.ParticleEmitter#bounds}.","name":"collideBottom","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#collideBottom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":616,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether this emitter updates itself and its particles.\n\nControlled by {@link Phaser.GameObjects.Particles.ParticleEmitter#pause}\nand {@link Phaser.GameObjects.Particles.ParticleEmitter#resume}.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":629,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Set this to false to hide any active particles.","name":"visible","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setVisible"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#visible","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":640,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The blend mode of this emitter's particles.","name":"blendMode","type":{"names":["integer"]},"since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setBlendMode"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#blendMode","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":650,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A Game Object whose position is used as the particle origin.","name":"follow","type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#startFollow","Phaser.GameObjects.Particles.ParticleEmitter#stopFollow"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#follow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":662,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The offset of the particle origin from the {@link Phaser.GameObjects.Particles.ParticleEmitter#follow} target.","name":"followOffset","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#startFollow"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#followOffset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":672,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether the emitter's {@link Phaser.GameObjects.Particles.ParticleEmitter#visible} state will track\nthe {@link Phaser.GameObjects.Particles.ParticleEmitter#follow} target's visibility state.","name":"trackVisible","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#startFollow"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#trackVisible","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":684,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The current texture frame, as an index of {@link Phaser.GameObjects.Particles.ParticleEmitter#frames}.","name":"currentFrame","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setFrame"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#currentFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":695,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether texture {@link Phaser.GameObjects.Particles.ParticleEmitter#frames} are selected at random.","name":"randomFrame","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setFrame"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#randomFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":706,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The number of consecutive particles that receive a single texture frame (per frame cycle).","name":"frameQuantity","type":{"names":["integer"]},"defaultvalue":"1","since":"3.0.0","see":["Phaser.GameObjects.Particles.ParticleEmitter#setFrame"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#frameQuantity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":765,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Merges configuration settings into the emitter's current settings.","kind":"function","name":"fromJSON","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig"]},"description":"Settings for this emitter.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#fromJSON","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":869,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Creates a description of this emitter suitable for JSON serialization.","kind":"function","name":"toJSON","since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"An object to copy output into.","name":"output"}],"returns":[{"type":{"names":["object"]},"description":"- The output object."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#toJSON","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":919,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Continuously moves the particle origin to follow a Game Object's position.","kind":"function","name":"startFollow","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to follow.","name":"target"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Horizontal offset of the particle origin from the Game Object.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Vertical offset of the particle origin from the Game Object.","name":"offsetY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the emitter's visible state will track the target's visible state.","name":"trackVisible"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#startFollow","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":945,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Stops following a Game Object.","kind":"function","name":"stopFollow","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#stopFollow","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":962,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Chooses a texture frame from {@link Phaser.GameObjects.Particles.ParticleEmitter#frames}.","kind":"function","name":"getFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The texture frame."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#getFrame","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1002,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets a pattern for assigning texture frames to emitted particles.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["array","string","integer","Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig"]},"description":"One or more texture frames, or a configuration object.","name":"frames"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether frames should be assigned at random from `frames`.","name":"pickRandom"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The number of consecutive particles that will receive each frame.","name":"quantity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setFrame","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1059,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Turns {@link Phaser.GameObjects.Particles.ParticleEmitter#radial} particle movement on or off.","kind":"function","name":"setRadial","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Radial mode (true) or point mode (true).","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setRadial","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1078,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the position of the emitter's particle origin.\nNew particles will be emitted here.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The x-coordinate of the particle origin.","name":"x"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The y-coordinate of the particle origin.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setPosition","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1098,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets or modifies a rectangular boundary constraining the particles.\n\nTo remove the boundary, set {@link Phaser.GameObjects.Particles.ParticleEmitter#bounds} to null.","kind":"function","name":"setBounds","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Types.GameObjects.Particles.ParticleEmitterBounds","Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt"]},"description":"The x-coordinate of the left edge of the boundary, or an object representing a rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The y-coordinate of the top edge of the boundary.","name":"y"},{"type":{"names":["number"]},"description":"The width of the boundary.","name":"width"},{"type":{"names":["number"]},"description":"The height of the boundary.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setBounds","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1137,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the initial horizontal speed of emitted particles.\nChanges the emitter to point mode.","kind":"function","name":"setSpeedX","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The speed, in pixels per second.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setSpeedX","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the initial vertical speed of emitted particles.\nChanges the emitter to point mode.","kind":"function","name":"setSpeedY","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The speed, in pixels per second.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setSpeedY","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the initial radial speed of emitted particles.\nChanges the emitter to radial mode.","kind":"function","name":"setSpeed","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The speed, in pixels per second.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setSpeed","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the horizontal scale of emitted particles.","kind":"function","name":"setScaleX","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"description":"The scale, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setScaleX","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the vertical scale of emitted particles.","kind":"function","name":"setScaleY","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"description":"The scale, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setScaleY","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the scale of emitted particles.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"description":"The scale, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setScale","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the horizontal gravity applied to emitted particles.","kind":"function","name":"setGravityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Acceleration due to gravity, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setGravityX","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the vertical gravity applied to emitted particles.","kind":"function","name":"setGravityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Acceleration due to gravity, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setGravityY","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1290,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the gravity applied to emitted particles.","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Horizontal acceleration due to gravity, in pixels per second squared.","name":"x"},{"type":{"names":["number"]},"description":"Vertical acceleration due to gravity, in pixels per second squared.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setGravity","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1309,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the opacity of emitted particles.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"description":"A value between 0 (transparent) and 1 (opaque).","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setAlpha","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1326,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the color tint of emitted particles.","kind":"function","name":"setTint","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"description":"A value between 0 and 0xffffff.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setTint","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1343,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the angle of a {@link Phaser.GameObjects.Particles.ParticleEmitter#radial} particle stream.","kind":"function","name":"setEmitterAngle","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The angle of the initial velocity of emitted particles.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setEmitterAngle","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1360,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the angle of a {@link Phaser.GameObjects.Particles.ParticleEmitter#radial} particle stream.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The angle of the initial velocity of emitted particles.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setAngle","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1377,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the lifespan of newly emitted particles.","kind":"function","name":"setLifespan","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The particle lifespan, in ms.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setLifespan","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1394,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the number of particles released at each flow cycle or explosion.","kind":"function","name":"setQuantity","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"description":"The number of particles to release at each flow cycle or explosion.","name":"quantity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setQuantity","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the emitter's {@link Phaser.GameObjects.Particles.ParticleEmitter#frequency}\nand {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity}.","kind":"function","name":"setFrequency","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The time interval (>= 0) of each flow cycle, in ms; or -1 to put the emitter in explosion mode.","name":"frequency"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"The number of particles to release at each flow cycle or explosion.","name":"quantity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setFrequency","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1437,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets or removes the {@link Phaser.GameObjects.Particles.ParticleEmitter#emitZone}.\n\nAn {@link Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig EdgeZone} places particles on its edges. Its {@link Phaser.Types.GameObjects.Particles.EdgeZoneSource source} can be a Curve, Path, Circle, Ellipse, Line, Polygon, Rectangle, or Triangle; or any object with a suitable {@link Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback getPoints} method.\n\nA {@link Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig RandomZone} places randomly within its interior. Its {@link RandomZoneSource source} can be a Circle, Ellipse, Line, Polygon, Rectangle, or Triangle; or any object with a suitable {@link Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback getRandomPoint} method.","kind":"function","name":"setEmitZone","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig","Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig"]},"optional":true,"description":"An object describing the zone, or `undefined` to remove any current emit zone.","name":"zoneConfig"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1490,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets or removes the {@link Phaser.GameObjects.Particles.ParticleEmitter#deathZone}.","kind":"function","name":"setDeathZone","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig"]},"optional":true,"description":"An object describing the zone, or `undefined` to remove any current death zone.","name":"zoneConfig"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setDeathZone","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1526,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Creates inactive particles and adds them to this emitter's pool.","kind":"function","name":"reserve","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The number of particles to create.","name":"particleCount"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#reserve","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1548,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Gets the number of active (in-use) particles in this emitter.","kind":"function","name":"getAliveParticleCount","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of particles with `active=true`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#getAliveParticleCount","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1561,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Gets the number of inactive (available) particles in this emitter.","kind":"function","name":"getDeadParticleCount","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of particles with `active=false`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#getDeadParticleCount","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1574,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Gets the total number of particles in this emitter.","kind":"function","name":"getParticleCount","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of particles, including both alive and dead."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#getParticleCount","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Whether this emitter is at its limit (if set).","kind":"function","name":"atLimit","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if this Emitter is at its limit, or `false` if no limit, or below the `maxParticles` level."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#atLimit","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1600,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets a function to call for each newly emitted particle.","kind":"function","name":"onParticleEmit","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterCallback"]},"description":"The function.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"The calling context.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#onParticleEmit","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets a function to call for each particle death.","kind":"function","name":"onParticleDeath","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleDeathCallback"]},"description":"The function.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"The function's calling context.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#onParticleDeath","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1664,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Deactivates every particle in this emitter.","kind":"function","name":"killAll","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#killAll","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1685,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Calls a function for each active particle in this emitter.","kind":"function","name":"forEachAlive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterCallback"]},"description":"The function.","name":"callback"},{"type":{"names":["*"]},"description":"The function's calling context.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#forEachAlive","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1710,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Calls a function for each inactive particle in this emitter.","kind":"function","name":"forEachDead","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterCallback"]},"description":"The function.","name":"callback"},{"type":{"names":["*"]},"description":"The function's calling context.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#forEachDead","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1735,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Turns {@link Phaser.GameObjects.Particles.ParticleEmitter#on} the emitter and resets the flow counter.\n\nIf this emitter is in flow mode (frequency >= 0; the default), the particle flow will start (or restart).\n\nIf this emitter is in explode mode (frequency = -1), nothing will happen.\nUse {@link Phaser.GameObjects.Particles.ParticleEmitter#explode} or {@link Phaser.GameObjects.Particles.ParticleEmitter#flow} instead.","kind":"function","name":"start","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#start","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1757,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Turns {@link Phaser.GameObjects.Particles.ParticleEmitter#on off} the emitter.","kind":"function","name":"stop","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#stop","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1772,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"{@link Phaser.GameObjects.Particles.ParticleEmitter#active Deactivates} the emitter.","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#pause","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1787,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"{@link Phaser.GameObjects.Particles.ParticleEmitter#active Activates} the emitter.","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#resume","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1802,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Removes the emitter from its manager and the scene.","kind":"function","name":"remove","since":"3.22.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#remove","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1817,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sorts active particles with {@link Phaser.GameObjects.Particles.ParticleEmitter#depthSortCallback}.","kind":"function","name":"depthSort","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#depthSort","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1832,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Puts the emitter in flow mode (frequency >= 0) and starts (or restarts) a particle flow.\n\nTo resume a flow at the current frequency and quantity, use {@link Phaser.GameObjects.Particles.ParticleEmitter#start} instead.","kind":"function","name":"flow","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The time interval (>= 0) of each flow cycle, in ms.","name":"frequency"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"defaultvalue":1,"description":"The number of particles to emit at each flow cycle.","name":"count"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Particle Emitter."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#flow","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1856,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Puts the emitter in explode mode (frequency = -1), stopping any current particle flow, and emits several particles all at once.","kind":"function","name":"explode","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The amount of Particles to emit.","name":"count"},{"type":{"names":["number"]},"description":"The x coordinate to emit the Particles from.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to emit the Particles from.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The most recently emitted Particle."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#explode","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1875,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Emits particles at a given position (or the emitter's current position).","kind":"function","name":"emitParticleAt","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":"this.x","description":"The x coordinate to emit the Particles from.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"this.x","description":"The y coordinate to emit the Particles from.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.quantity","description":"The number of Particles to emit.","name":"count"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The most recently emitted Particle."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#emitParticleAt","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1892,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Emits particles at a given position (or the emitter's current position).","kind":"function","name":"emitParticle","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.quantity","description":"The number of Particles to emit.","name":"count"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"this.x","description":"The x coordinate to emit the Particles from.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"this.x","description":"The y coordinate to emit the Particles from.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The most recently emitted Particle."}],"see":["Phaser.GameObjects.Particles.Particle#fire"],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#emitParticle","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":1954,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Updates this emitter and its particles.","kind":"function","name":"preUpdate","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#preUpdate","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitter.js","lineno":2047,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Calculates the difference of two particles, for sorting them by depth.","kind":"function","name":"depthSortCallback","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The first particle.","name":"a"},{"type":{"names":["object"]},"description":"The second particle.","name":"b"}],"returns":[{"type":{"names":["integer"]},"description":"The difference of a and b's y coordinates."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#depthSortCallback","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"ParticleEmitterManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"classdesc":"A Particle Emitter Manager creates and controls {@link Phaser.GameObjects.Particles.ParticleEmitter Particle Emitters} and {@link Phaser.GameObjects.Particles.GravityWell Gravity Wells}.","kind":"class","name":"ParticleEmitterManager","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects.Particles","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Emitter Manager belongs.","name":"scene"},{"type":{"names":["string"]},"description":"The key of the Texture this Emitter Manager will use to render particles, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Emitter Manager will use to render particles.","name":"frame"},{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig","Array."]},"optional":true,"description":"Configuration settings for one or more emitters to create.","name":"emitters"}],"scope":"static","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The time scale applied to all emitters and particles, affecting flow rate, lifespan, and movement.\nValues larger than 1 are faster than normal.\nThis is multiplied with any timeScale set on each individual emitter.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The texture used to render this Emitter Manager's particles.","name":"texture","type":{"names":["Phaser.Textures.Texture"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"The texture frame used to render this Emitter Manager's particles.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#frame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Names of this Emitter Manager's texture frames.","name":"frameNames","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#frameNames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A list of Emitters being managed by this Emitter Manager.","name":"emitters","type":{"names":["Phaser.Structs.List."]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#emitters","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"A list of Gravity Wells being managed by this Emitter Manager.","name":"wells","type":{"names":["Phaser.Structs.List."]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#wells","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the texture and frame this Emitter Manager will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setTexture","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":172,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Sets the frame this Emitter Manager will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setFrame","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Assigns texture frames to an emitter.","kind":"function","name":"setEmitterFrames","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame","Array."]},"description":"The texture frames.","name":"frames"},{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The particle emitter to modify.","name":"emitter"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setEmitterFrames","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":250,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Adds an existing Particle Emitter to this Emitter Manager.","kind":"function","name":"addEmitter","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The Particle Emitter to add to this Emitter Manager.","name":"emitter"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The Particle Emitter that was added to this Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#addEmitter","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":265,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Creates a new Particle Emitter object, adds it to this Emitter Manager and returns a reference to it.","kind":"function","name":"createEmitter","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig"]},"description":"Configuration settings for the Particle Emitter to create.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"The Particle Emitter that was created."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#createEmitter","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Removes a Particle Emitter from this Emitter Manager, if the Emitter belongs to this Manager.","kind":"function","name":"removeEmitter","since":"3.22.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"name":"emitter"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"nullable":true,"description":"The Particle Emitter if it was removed or null if it was not."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#removeEmitter","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Adds an existing Gravity Well object to this Emitter Manager.","kind":"function","name":"addGravityWell","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.GravityWell"]},"description":"The Gravity Well to add to this Emitter Manager.","name":"well"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.GravityWell"]},"description":"The Gravity Well that was added to this Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#addGravityWell","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Creates a new Gravity Well, adds it to this Emitter Manager and returns a reference to it.","kind":"function","name":"createGravityWell","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.GravityWellConfig"]},"description":"Configuration settings for the Gravity Well to create.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.GravityWell"]},"description":"The Gravity Well that was created."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#createGravityWell","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":325,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Emits particles from each active emitter.","kind":"function","name":"emitParticle","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of particles to release from each emitter. The default is the emitter's own {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity}.","name":"count"},{"type":{"names":["number"]},"optional":true,"description":"The x-coordinate to to emit particles from. The default is the x-coordinate of the emitter's current location.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y-coordinate to to emit particles from. The default is the y-coordinate of the emitter's current location.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#emitParticle","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":354,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Emits particles from each active emitter.","kind":"function","name":"emitParticleAt","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x-coordinate to to emit particles from. The default is the x-coordinate of the emitter's current location.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y-coordinate to to emit particles from. The default is the y-coordinate of the emitter's current location.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The number of particles to release from each emitter. The default is the emitter's own {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity}.","name":"count"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#emitParticleAt","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":371,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Pauses this Emitter Manager.\n\nThis has the effect of pausing all emitters, and all particles of those emitters, currently under its control.\n\nThe particles will still render, but they will not have any of their logic updated.","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#pause","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":390,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Resumes this Emitter Manager, should it have been previously paused.","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Emitter Manager."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#resume","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":405,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Gets all active particle processors (gravity wells).","kind":"function","name":"getProcessors","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"- The active gravity wells."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getProcessors","scope":"instance","___s":true},{"meta":{"filename":"ParticleEmitterManager.js","lineno":418,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Updates all active emitters.","kind":"function","name":"preUpdate","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The current timestamp as generated by the Request Animation Frame or SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time, in ms, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#preUpdate","scope":"instance","___s":true},{"meta":{"range":[180,231],"filename":"ParticleManagerCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"GameObjectCreator","longname":"GameObjectCreator","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParticleManagerCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Creates a new Particle Emitter Manager Game Object and returns it.\n\nNote: This method will only be available if the Particles Game Object has been built into Phaser.","kind":"function","name":"particles","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#particles","scope":"instance","___s":true},{"meta":{"range":[180,231],"filename":"ParticleManagerFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParticleManagerFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"description":"Creates a new Particle Emitter Manager Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Particles Game Object has been built into Phaser.","kind":"function","name":"particles","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer","object"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"},{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterConfig","Array."]},"optional":true,"description":"Configuration settings for one or more emitters to create.","name":"emitters"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#particles","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"ParticleManagerRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"ParticleManagerWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles"},"kind":"namespace","name":"Particles","memberof":"Phaser.GameObjects","longname":"Phaser.GameObjects.Particles","scope":"static","___s":true},{"meta":{"filename":"DeathZoneSource.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"DeathZoneSource","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.DeathZoneSourceCallback"]},"name":"contains"}],"see":["Phaser.Geom.Circle","Phaser.Geom.Ellipse","Phaser.Geom.Polygon","Phaser.Geom.Rectangle","Phaser.Geom.Triangle"],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.DeathZoneSource","scope":"static","___s":true},{"meta":{"filename":"DeathZoneSourceCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"DeathZoneSourceCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the particle to check against this source area.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the particle to check against this source area.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"- True if the coordinates are within the source area."}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.DeathZoneSourceCallback","scope":"static","___s":true},{"meta":{"filename":"EdgeZoneSource.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"EdgeZoneSource","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback"]},"description":"A function placing points on the sources edge or edges.","name":"getPoints"}],"see":["Phaser.Curves.Curve","Phaser.Curves.Path","Phaser.Geom.Circle","Phaser.Geom.Ellipse","Phaser.Geom.Line","Phaser.Geom.Polygon","Phaser.Geom.Rectangle","Phaser.Geom.Triangle"],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EdgeZoneSource","scope":"static","___s":true},{"meta":{"filename":"EdgeZoneSourceCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"EdgeZoneSourceCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The number of particles to place on the source edge. If 0, `stepRate` should be used instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"The distance between each particle. When set, `quantity` is implied and should be set to `0`.","name":"stepRate"}],"returns":[{"type":{"names":["Array."]},"description":"- The points placed on the source edge."}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback","scope":"static","___s":true},{"meta":{"filename":"EmitterOpCustomEmitConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"EmitterOpCustomEmitConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback"]},"description":"A callback that is invoked each time the emitter emits a particle.","name":"onEmit"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpCustomEmitConfig","scope":"static","___s":true},{"meta":{"filename":"EmitterOpCustomUpdateConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"EmitterOpCustomUpdateConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback"]},"optional":true,"description":"A callback that is invoked each time the emitter emits a particle.","name":"onEmit"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback"]},"description":"A callback that is invoked each time the emitter updates.","name":"onUpdate"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpCustomUpdateConfig","scope":"static","___s":true},{"meta":{"filename":"EmitterOpEaseConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"Defines an operation yielding a value incremented continuously across a range.","kind":"typedef","name":"EmitterOpEaseConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The starting value.","name":"start"},{"type":{"names":["number"]},"description":"The ending value.","name":"end"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'Linear'","description":"The name of the easing function.","name":"ease"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpEaseConfig","scope":"static","___s":true},{"meta":{"filename":"EmitterOpOnEmitCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"The returned value sets what the property will be at the START of the particle's life, on emit.","kind":"typedef","name":"EmitterOpOnEmitCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"},{"type":{"names":["number"]},"description":"The current value of the property.","name":"value"}],"returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback","scope":"static","___s":true},{"meta":{"filename":"EmitterOpOnEmitType.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"EmitterOpOnEmitType","type":{"names":["number","Array.","Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback","Phaser.Types.GameObjects.Particles.EmitterOpRandomConfig","Phaser.Types.GameObjects.Particles.EmitterOpRandomMinMaxConfig","Phaser.Types.GameObjects.Particles.EmitterOpRandomStartEndConfig","Phaser.Types.GameObjects.Particles.EmitterOpSteppedConfig","Phaser.Types.GameObjects.Particles.EmitterOpCustomEmitConfig"]},"since":"3.18.0","memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","scope":"static","___s":true},{"meta":{"filename":"EmitterOpOnUpdateCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"The returned value updates the property for the duration of the particle's life.","kind":"typedef","name":"EmitterOpOnUpdateCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle.","name":"particle"},{"type":{"names":["string"]},"description":"The name of the property.","name":"key"},{"type":{"names":["number"]},"description":"The normalized lifetime of the particle, between 0 (start) and 1 (end).","name":"t"},{"type":{"names":["number"]},"description":"The current value of the property.","name":"value"}],"returns":[{"type":{"names":["number"]},"description":"The new value of the property."}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback","scope":"static","___s":true},{"meta":{"filename":"EmitterOpOnUpdateType.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"EmitterOpOnUpdateType","type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback","Phaser.Types.GameObjects.Particles.EmitterOpEaseConfig","Phaser.Types.GameObjects.Particles.EmitterOpCustomUpdateConfig"]},"since":"3.18.0","memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType","scope":"static","___s":true},{"meta":{"filename":"EmitterOpRandomConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"Defines an operation yielding a random value within a range.","kind":"typedef","name":"EmitterOpRandomConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Array."]},"description":"The minimum and maximum values, as [min, max].","name":"random"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpRandomConfig","scope":"static","___s":true},{"meta":{"filename":"EmitterOpRandomMinMaxConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"Defines an operation yielding a random value within a range.","kind":"typedef","name":"EmitterOpRandomMinMaxConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The minimum value.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value.","name":"max"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpRandomMinMaxConfig","scope":"static","___s":true},{"meta":{"filename":"EmitterOpRandomStartEndConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"Defines an operation yielding a random value within a range.","kind":"typedef","name":"EmitterOpRandomStartEndConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The starting value.","name":"start"},{"type":{"names":["number"]},"description":"The ending value.","name":"end"},{"type":{"names":["boolean"]},"description":"If false, this becomes {@link EmitterOpEaseConfig}.","name":"random"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpRandomStartEndConfig","scope":"static","___s":true},{"meta":{"filename":"EmitterOpSteppedConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"description":"Defines an operation yielding a value incremented by steps across a range.","kind":"typedef","name":"EmitterOpSteppedConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The starting value.","name":"start"},{"type":{"names":["number"]},"description":"The ending value.","name":"end"},{"type":{"names":["number"]},"description":"The number of steps between start and end.","name":"steps"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.EmitterOpSteppedConfig","scope":"static","___s":true},{"meta":{"filename":"GravityWellConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"GravityWellConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the Gravity Well, in world space.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the Gravity Well, in world space.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The strength of the gravity force - larger numbers produce a stronger force.","name":"power"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"The minimum distance for which the gravity force is calculated.","name":"epsilon"},{"type":{"names":["number"]},"optional":true,"defaultvalue":50,"description":"The gravitational force of this Gravity Well.","name":"gravity"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.GravityWellConfig","scope":"static","___s":true},{"meta":{"filename":"ParticleDeathCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleDeathCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle that died.","name":"particle"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleDeathCallback","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterBounds.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterBounds","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The left edge of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The top edge of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"height"}],"see":["Phaser.GameObjects.Particles.ParticleEmitter#setBounds"],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterBounds","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterBoundsAlt.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterBoundsAlt","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The left edge of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The top edge of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"w"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"h"}],"see":["Phaser.GameObjects.Particles.ParticleEmitter#setBounds"],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The particle associated with the call.","name":"particle"},{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This particle emitter associated with the call.","name":"emitter"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterCallback","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#active}.","name":"active"},{"type":{"names":["Phaser.BlendModes","string"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#blendMode}.","name":"blendMode"},{"type":{"names":["*"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope} and {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope}.","name":"callbackScope"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideBottom}.","name":"collideBottom"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideLeft}.","name":"collideLeft"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideRight}.","name":"collideRight"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideTop}.","name":"collideTop"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallback}.","name":"deathCallback"},{"type":{"names":["*"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope}.","name":"deathCallbackScope"},{"type":{"names":["function"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallback}.","name":"emitCallback"},{"type":{"names":["*"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope}.","name":"emitCallbackScope"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#follow}.","name":"follow"},{"type":{"names":["number"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#frequency}.","name":"frequency"},{"type":{"names":["number"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#gravityX}.","name":"gravityX"},{"type":{"names":["number"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#gravityY}.","name":"gravityY"},{"type":{"names":["integer"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxParticles}.","name":"maxParticles"},{"type":{"names":["string"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#name}.","name":"name"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#on}.","name":"on"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop}.","name":"particleBringToTop"},{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleClass}.","name":"particleClass"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#radial}.","name":"radial"},{"type":{"names":["number"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#timeScale}.","name":"timeScale"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#trackVisible}.","name":"trackVisible"},{"type":{"names":["boolean"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#visible}.","name":"visible"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationX} (emit only).","name":"accelerationX"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationY} (emit only).","name":"accelerationY"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#alpha}.","name":"alpha"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#angle} (emit only).","name":"angle"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#bounce} (emit only).","name":"bounce"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#delay} (emit only).","name":"delay"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#lifespan} (emit only).","name":"lifespan"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX} (emit only).","name":"maxVelocityX"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY} (emit only).","name":"maxVelocityY"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToX} (emit only).","name":"moveToX"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToY} (emit only).","name":"moveToY"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity} (emit only).","name":"quantity"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#rotate}.","name":"rotate"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"optional":true,"description":"As {@link Phaser.GameObjects.Particles.ParticleEmitter#setScale}.","name":"scale"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#scaleX}.","name":"scaleX"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#scaleY}.","name":"scaleY"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"As {@link Phaser.GameObjects.Particles.ParticleEmitter#setSpeed} (emit only).","name":"speed"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedX} (emit only).","name":"speedX"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedY} (emit only).","name":"speedY"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType","Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#tint}.","name":"tint"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#x} (emit only).","name":"x"},{"type":{"names":["Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#y} (emit only).","name":"y"},{"type":{"names":["object"]},"optional":true,"description":"As {@link Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone}.","name":"emitZone"},{"type":{"names":["Phaser.Types.GameObjects.Particles.ParticleEmitterBounds","Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt"]},"optional":true,"description":"As {@link Phaser.GameObjects.Particles.ParticleEmitter#setBounds}.","name":"bounds"},{"type":{"names":["object"]},"optional":true,"description":"Assigns to {@link Phaser.GameObjects.Particles.ParticleEmitter#followOffset}.","name":"followOffset"},{"type":{"names":["number"]},"optional":true,"description":"x-coordinate of the offset.","name":"followOffset.x"},{"type":{"names":["number"]},"optional":true,"description":"y-coordinate of the offset.","name":"followOffset.y"},{"type":{"names":["number","Array.","string","Array.","Phaser.Textures.Frame","Array.","Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig"]},"optional":true,"description":"Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#frames}.","name":"frame"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterConfig","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterDeathZoneConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterDeathZoneConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.DeathZoneSource"]},"description":"A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.DeathZone#source}.","name":"source"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'onEnter'","description":"'onEnter' or 'onLeave'.","name":"type"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterEdgeZoneConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterEdgeZoneConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EdgeZoneSource"]},"description":"A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.EdgeZone#source}.","name":"source"},{"type":{"names":["string"]},"description":"'edge'.","name":"type"},{"type":{"names":["integer"]},"description":"The number of particles to place on the source edge. Set to 0 to use `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"The distance between each particle. When set, `quantity` is implied and should be set to 0.","name":"stepRate"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether particles are placed from start to end and then end to start.","name":"yoyo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether one endpoint will be removed if it's identical to the other.","name":"seamless"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterFrameConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterFrameConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number","Array.","string","Array.","Phaser.Textures.Frame","Array."]},"optional":true,"description":"One or more texture frames.","name":"frames"},{"type":{"names":["boolean"]},"optional":true,"description":"Whether texture frames will be assigned consecutively (true) or at random (false).","name":"cycle"},{"type":{"names":["integer"]},"optional":true,"description":"The number of consecutive particles receiving each texture frame, when `cycle` is true.","name":"quantity"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig","scope":"static","___s":true},{"meta":{"filename":"ParticleEmitterRandomZoneConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"ParticleEmitterRandomZoneConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.RandomZoneSource"]},"description":"A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.RandomZone#source}.","name":"source"},{"type":{"names":["string"]},"optional":true,"description":"'random'.","name":"type"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig","scope":"static","___s":true},{"meta":{"filename":"RandomZoneSource.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"RandomZoneSource","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback"]},"description":"A function modifying its point argument.","name":"getRandomPoint"}],"see":["Phaser.Geom.Circle","Phaser.Geom.Ellipse","Phaser.Geom.Line","Phaser.Geom.Polygon","Phaser.Geom.Rectangle","Phaser.Geom.Triangle"],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.RandomZoneSource","scope":"static","___s":true},{"meta":{"filename":"RandomZoneSourceCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"typedef","name":"RandomZoneSourceCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A point to modify.","name":"point"}],"memberof":"Phaser.Types.GameObjects.Particles","longname":"Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs"},"kind":"namespace","name":"Particles","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.Particles","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"DeathZone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DeathZone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"classdesc":"A Death Zone.\n\nA Death Zone is a special type of zone that will kill a Particle as soon as it either enters, or leaves, the zone.\n\nThe zone consists of a `source` which could be a Geometric shape, such as a Rectangle or Ellipse, or your own\nobject as long as it includes a `contains` method for which the Particles can be tested against.","kind":"class","name":"DeathZone","memberof":"Phaser.GameObjects.Particles.Zones","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.DeathZoneSource"]},"description":"An object instance that has a `contains` method that returns a boolean when given `x` and `y` arguments.","name":"source"},{"type":{"names":["boolean"]},"description":"Should the Particle be killed when it enters the zone? `true` or leaves it? `false`","name":"killOnEnter"}],"scope":"static","longname":"Phaser.GameObjects.Particles.Zones.DeathZone","___s":true},{"meta":{"filename":"DeathZone.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"An object instance that has a `contains` method that returns a boolean when given `x` and `y` arguments.\nThis could be a Geometry shape, such as `Phaser.Geom.Circle`, or your own custom object.","name":"source","type":{"names":["Phaser.Types.GameObjects.Particles.DeathZoneSource"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.DeathZone","longname":"Phaser.GameObjects.Particles.Zones.DeathZone#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DeathZone.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Set to `true` if the Particle should be killed if it enters this zone.\nSet to `false` to kill the Particle if it leaves this zone.","name":"killOnEnter","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.DeathZone","longname":"Phaser.GameObjects.Particles.Zones.DeathZone#killOnEnter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DeathZone.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Checks if the given Particle will be killed or not by this zone.","kind":"function","name":"willKill","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The Particle to be checked against this zone.","name":"particle"}],"returns":[{"type":{"names":["boolean"]},"description":"Return `true` if the Particle is to be killed, otherwise return `false`."}],"memberof":"Phaser.GameObjects.Particles.Zones.DeathZone","longname":"Phaser.GameObjects.Particles.Zones.DeathZone#willKill","scope":"instance","___s":true},{"meta":{"range":[180,219],"filename":"EdgeZone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"EdgeZone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"classdesc":"A zone that places particles on a shape's edges.","kind":"class","name":"EdgeZone","memberof":"Phaser.GameObjects.Particles.Zones","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EdgeZoneSource"]},"description":"An object instance with a `getPoints(quantity, stepRate)` method returning an array of points.","name":"source"},{"type":{"names":["integer"]},"description":"The number of particles to place on the source edge. Set to 0 to use `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"description":"The distance between each particle. When set, `quantity` is implied and should be set to 0.","name":"stepRate"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether particles are placed from start to end and then end to start.","name":"yoyo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether one endpoint will be removed if it's identical to the other.","name":"seamless"}],"scope":"static","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":33,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"An object instance with a `getPoints(quantity, stepRate)` method returning an array of points.","name":"source","type":{"names":["Phaser.Types.GameObjects.Particles.EdgeZoneSource","Phaser.Types.GameObjects.Particles.RandomZoneSource"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"The points placed on the source edge.","name":"points","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#points","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"The number of particles to place on the source edge. Set to 0 to use `stepRate` instead.","name":"quantity","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#quantity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"The distance between each particle. When set, `quantity` is implied and should be set to 0.","name":"stepRate","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#stepRate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Whether particles are placed from start to end and then end to start.","name":"yoyo","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#yoyo","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"The counter used for iterating the EdgeZone's points.","name":"counter","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#counter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Whether one endpoint will be removed if it's identical to the other.","name":"seamless","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#seamless","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Update the {@link Phaser.GameObjects.Particles.Zones.EdgeZone#points} from the EdgeZone's\n{@link Phaser.GameObjects.Particles.Zones.EdgeZone#source}.\n\nAlso updates internal properties.","kind":"function","name":"updateSource","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.Zones.EdgeZone"]},"description":"This Edge Zone."}],"memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#updateSource","scope":"instance","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":165,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Change the source of the EdgeZone.","kind":"function","name":"changeSource","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.EdgeZoneSource"]},"description":"An object instance with a `getPoints(quantity, stepRate)` method returning an array of points.","name":"source"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.Zones.EdgeZone"]},"description":"This Edge Zone."}],"memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#changeSource","scope":"instance","___s":true},{"meta":{"filename":"EdgeZone.js","lineno":182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Get the next point in the Zone and set its coordinates on the given Particle.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The Particle.","name":"particle"}],"memberof":"Phaser.GameObjects.Particles.Zones.EdgeZone","longname":"Phaser.GameObjects.Particles.Zones.EdgeZone#getPoint","scope":"instance","___s":true},{"meta":{"range":[180,219],"filename":"RandomZone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomZone.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"classdesc":"A zone that places particles randomly within a shape's area.","kind":"class","name":"RandomZone","memberof":"Phaser.GameObjects.Particles.Zones","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Particles.RandomZoneSource"]},"description":"An object instance with a `getRandomPoint(point)` method.","name":"source"}],"scope":"static","longname":"Phaser.GameObjects.Particles.Zones.RandomZone","___s":true},{"meta":{"filename":"RandomZone.js","lineno":27,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"An object instance with a `getRandomPoint(point)` method.","name":"source","type":{"names":["Phaser.Types.GameObjects.Particles.RandomZoneSource"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.Zones.RandomZone","longname":"Phaser.GameObjects.Particles.Zones.RandomZone#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RandomZone.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"description":"Get the next point in the Zone and set its coordinates on the given Particle.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Particles.Particle"]},"description":"The Particle.","name":"particle"}],"memberof":"Phaser.GameObjects.Particles.Zones.RandomZone","longname":"Phaser.GameObjects.Particles.Zones.RandomZone#getPoint","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones"},"kind":"namespace","name":"Zones","memberof":"Phaser.GameObjects.Particles","longname":"Phaser.GameObjects.Particles.Zones","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"PathFollower.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PathFollower.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower"},"classdesc":"A PathFollower Game Object.\n\nA PathFollower is a Sprite Game Object with some extra helpers to allow it to follow a Path automatically.\n\nAnything you can do with a standard Sprite can be done with this PathFollower, such as animate it, tint it,\nscale it and so on.\n\nPathFollowers are bound to a single Path at any one time and can traverse the length of the Path, from start\nto finish, forwards or backwards, or from any given point on the Path to its end. They can optionally rotate\nto face the direction of the path, be offset from the path coordinates or rotate independently of the Path.","kind":"class","name":"PathFollower","augments":["Phaser.GameObjects.Sprite","Phaser.GameObjects.Components.PathFollower"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this PathFollower belongs.","name":"scene"},{"type":{"names":["Phaser.Curves.Path"]},"description":"The Path this PathFollower is following. It can only follow one Path at a time.","name":"path"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.PathFollower","___s":true},{"meta":{"range":[180,231],"filename":"PathFollowerFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PathFollowerFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower"},"description":"Creates a new PathFollower Game Object and adds it to the Scene.\n\nNote: This method will only be available if the PathFollower Game Object has been built into Phaser.","kind":"function","name":"follower","since":"3.0.0","params":[{"type":{"names":["Phaser.Curves.Path"]},"description":"The Path this PathFollower is connected to.","name":"path"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#follower","scope":"instance","___s":true},{"meta":{"filename":"PathConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower/typedefs"},"description":"Settings for a PathFollower.","kind":"typedef","name":"PathConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1000,"description":"The duration of the path follow in ms. Must be `> 0`.","name":"duration"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The start position of the path follow, between 0 and 1. Must be less than `to`.","name":"from"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The end position of the path follow, between 0 and 1. Must be more than `from`.","name":"to"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to position the PathFollower on the Path using its path offset.","name":"positionOnPath"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the PathFollower automatically rotate to point in the direction of the Path?","name":"rotateToPath"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"If the PathFollower is rotating to match the Path, this value is added to the rotation value. This allows you to rotate objects to a path but control the angle of the rotation as well.","name":"rotationOffset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Current start position of the path follow, must be between `from` and `to`.","name":"startAt"}],"memberof":"Phaser.Types.GameObjects.PathFollower","longname":"Phaser.Types.GameObjects.PathFollower.PathConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower/typedefs"},"kind":"namespace","name":"PathFollower","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.PathFollower","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Quad.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Quad.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"classdesc":"A Quad Game Object.\n\nA Quad is a Mesh Game Object pre-configured with two triangles arranged into a rectangle, with a single\ntexture spread across them.\n\nYou can manipulate the corner points of the quad via the getters and setters such as `topLeftX`, and also\nchange their alpha and color values. The quad itself can be moved by adjusting the `x` and `y` properties.","kind":"class","name":"Quad","augments":["Phaser.GameObjects.Mesh"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Quad belongs.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.Quad","___s":true},{"meta":{"filename":"Quad.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.11.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setFrame","scope":"instance","overrides":"Phaser.GameObjects.Mesh#setFrame","___s":true},{"meta":{"filename":"Quad.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-left x vertex of this Quad.","name":"topLeftX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topLeftX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":171,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-left y vertex of this Quad.","name":"topLeftY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topLeftY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":193,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-right x vertex of this Quad.","name":"topRightX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topRightX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":214,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-right y vertex of this Quad.","name":"topRightY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topRightY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":235,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-left x vertex of this Quad.","name":"bottomLeftX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomLeftX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-left y vertex of this Quad.","name":"bottomLeftY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomLeftY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":277,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-right x vertex of this Quad.","name":"bottomRightX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomRightX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":299,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-right y vertex of this Quad.","name":"bottomRightY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomRightY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-left alpha value of this Quad.","name":"topLeftAlpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topLeftAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":343,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-right alpha value of this Quad.","name":"topRightAlpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topRightAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":364,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-left alpha value of this Quad.","name":"bottomLeftAlpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomLeftAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-right alpha value of this Quad.","name":"bottomRightAlpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomRightAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":407,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-left color value of this Quad.","name":"topLeftColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topLeftColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":429,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The top-right color value of this Quad.","name":"topRightColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#topRightColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":450,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-left color value of this Quad.","name":"bottomLeftColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomLeftColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":471,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"The bottom-right color value of this Quad.","name":"bottomRightColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#bottomRightColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quad.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Sets the top-left vertex position of this Quad.","kind":"function","name":"setTopLeft","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the vertex.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the vertex.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setTopLeft","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":512,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Sets the top-right vertex position of this Quad.","kind":"function","name":"setTopRight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the vertex.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the vertex.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setTopRight","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":531,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Sets the bottom-left vertex position of this Quad.","kind":"function","name":"setBottomLeft","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the vertex.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the vertex.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setBottomLeft","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":550,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Sets the bottom-right vertex position of this Quad.","kind":"function","name":"setBottomRight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the vertex.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the vertex.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setBottomRight","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":569,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Resets the positions of the four corner vertices of this Quad.","kind":"function","name":"resetPosition","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#resetPosition","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":592,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Resets the alpha values used by this Quad back to 1.","kind":"function","name":"resetAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#resetAlpha","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":614,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Resets the color values used by this Quad back to 0xffffff.","kind":"function","name":"resetColors","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#resetColors","scope":"instance","___s":true},{"meta":{"filename":"Quad.js","lineno":636,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Resets the position, alpha and color values used by this Quad.","kind":"function","name":"reset","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#reset","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"QuadCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuadCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Creates a new Quad Game Object and returns it.\n\nNote: This method will only be available if the Quad Game Object and WebGL support have been built into Phaser.","kind":"function","name":"quad","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#quad","scope":"instance","___s":true},{"meta":{"range":[180,204],"filename":"QuadFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"name":"Quad","longname":"Quad","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuadFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/quad"},"description":"Creates a new Quad Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Quad Game Object and WebGL support have been built into Phaser.","kind":"function","name":"quad","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#quad","scope":"instance","___s":true},{"meta":{"range":[180,229],"filename":"RenderTexture.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"name":"BlendModes","longname":"BlendModes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RenderTexture.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"classdesc":"A Render Texture.\n\nA Render Texture is a special texture that allows any number of Game Objects to be drawn to it. You can take many complex objects and\ndraw them all to this one texture, which can they be used as the texture for other Game Object's. It's a way to generate dynamic\ntextures at run-time that are WebGL friendly and don't invoke expensive GPU uploads.\n\nNote that under WebGL a FrameBuffer, which is what the Render Texture uses internally, cannot be anti-aliased. This means\nthat when drawing objects such as Shapes to a Render Texture they will appear to be drawn with no aliasing, however this\nis a technical limitation of WebGL. To get around it, create your shape as a texture in an art package, then draw that\nto the Render Texture.","kind":"class","name":"RenderTexture","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Crop","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.2.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The width of the Render Texture.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The height of the Render Texture.","name":"height"}],"properties":[{"type":{"names":["string"]},"optional":true,"description":"The texture key to make the RenderTexture from.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"the frame to make the RenderTexture from.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.RenderTexture","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"A reference to either the Canvas or WebGL Renderer that the Game instance is using.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.2.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"A reference to the Texture Manager.","name":"textureManager","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.12.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#textureManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"The tint of the Render Texture when rendered.","name":"globalTint","type":{"names":["number"]},"defaultvalue":"0xffffff","since":"3.2.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#globalTint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"The alpha of the Render Texture when rendered.","name":"globalAlpha","type":{"names":["number"]},"defaultvalue":"1","since":"3.2.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#globalAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"The HTML Canvas Element that the Render Texture is drawing to when using the Canvas Renderer.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.2.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"A reference to the GL Frame Buffer this Render Texture is drawing to.\nThis is only set if Phaser is running with the WebGL Renderer.","name":"framebuffer","type":{"names":["WebGLFramebuffer"]},"nullable":true,"since":"3.2.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#framebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Is this Render Texture dirty or not? If not it won't spend time clearing or filling itself.","name":"dirty","type":{"names":["boolean"]},"since":"3.12.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":170,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"The Texture corresponding to this Render Texture.","name":"texture","type":{"names":["Phaser.Textures.Texture"]},"since":"3.12.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#texture","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Crop#texture","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":179,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"The Frame corresponding to this Render Texture.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.12.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#frame","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Crop#frame","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":224,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"A reference to the Rendering Context belonging to the Canvas Element this Render Texture is drawing to.","name":"context","type":{"names":["CanvasRenderingContext2D"]},"since":"3.2.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":243,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"An internal Camera that can be used to move around the Render Texture.\nControl it just like you would any Scene Camera. The difference is that it only impacts the placement of what\nis drawn to the Render Texture. You can scroll, zoom and rotate this Camera.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"since":"3.12.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":254,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"A reference to the WebGL Rendering Context.","name":"gl","type":{"names":["WebGLRenderingContext"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#gl","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":264,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"A reference to the WebGLTexture that is being rendered to in a WebGL Context.","name":"glTexture","type":{"names":["WebGLTexture"]},"defaultvalue":"null","readonly":true,"since":"3.19.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#glTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":304,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Sets the size of this Game Object.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setSize","scope":"instance","overrides":"Phaser.GameObjects.Components.ComputedSize#setSize","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":320,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Resizes the Render Texture to the new dimensions given.\n\nIf Render Texture was created from specific frame, only the size of the frame will be changed. The size of the source\ntexture will not change.\n\nIf Render Texture was not created from specific frame, the following will happen:\nIn WebGL it will destroy and then re-create the frame buffer being used by the Render Texture.\nIn Canvas it will resize the underlying canvas element.\nBoth approaches will erase everything currently drawn to the Render Texture.\n\nIf the dimensions given are the same as those already being used, calling this method will do nothing.","kind":"function","name":"resize","since":"3.10.0","params":[{"type":{"names":["number"]},"description":"The new width of the Render Texture.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The new height of the Render Texture. If not specified, will be set the same as the `width`.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#resize","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":417,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Set the tint to use when rendering this Render Texture.","kind":"function","name":"setGlobalTint","since":"3.2.0","params":[{"type":{"names":["integer"]},"description":"The tint value.","name":"tint"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setGlobalTint","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":434,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Set the alpha to use when rendering this Render Texture.","kind":"function","name":"setGlobalAlpha","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The alpha value.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setGlobalAlpha","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Stores a copy of this Render Texture in the Texture Manager using the given key.\n\nAfter doing this, any texture based Game Object, such as a Sprite, can use the contents of this\nRender Texture by using the texture key:\n\n```javascript\nvar rt = this.add.renderTexture(0, 0, 128, 128);\n\n// Draw something to the Render Texture\n\nrt.saveTexture('doodle');\n\nthis.add.image(400, 300, 'doodle');\n```\n\nUpdating the contents of this Render Texture will automatically update _any_ Game Object\nthat is using it as a texture. Calling `saveTexture` again will not save another copy\nof the same texture, it will just rename the key of the existing copy.\n\nBy default it will create a single base texture. You can add frames to the texture\nby using the `Texture.add` method. After doing this, you can then allow Game Objects\nto use a specific frame from a Render Texture.","kind":"function","name":"saveTexture","since":"3.12.0","params":[{"type":{"names":["string"]},"description":"The unique key to store the texture as within the global Texture Manager.","name":"key"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"The Texture that was saved."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#saveTexture","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":491,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Fills the Render Texture with the given color.","kind":"function","name":"fill","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The color to fill the Render Texture with.","name":"rgb"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used by the fill.","name":"alpha"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The left coordinate of the fill rectangle.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The top coordinate of the fill rectangle.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"this.frame.cutWidth","description":"The width of the fill rectangle.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"this.frame.cutHeight","description":"The height of the fill rectangle.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#fill","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":565,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Clears the Render Texture.","kind":"function","name":"clear","since":"3.2.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#clear","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":611,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Draws the given object, or an array of objects, to this Render Texture using a blend mode of ERASE.\nThis has the effect of erasing any filled pixels in the objects from this Render Texture.\n\nIt can accept any of the following:\n\n* Any renderable Game Object, such as a Sprite, Text, Graphics or TileSprite.\n* Dynamic and Static Tilemap Layers.\n* A Group. The contents of which will be iterated and drawn in turn.\n* A Container. The contents of which will be iterated fully, and drawn in turn.\n* A Scene's Display List. Pass in `Scene.children` to draw the whole list.\n* Another Render Texture.\n* A Texture Frame instance.\n* A string. This is used to look-up a texture from the Texture Manager.\n\nNote: You cannot erase a Render Texture from itself.\n\nIf passing in a Group or Container it will only draw children that return `true`\nwhen their `willRender()` method is called. I.e. a Container with 10 children,\n5 of which have `visible=false` will only draw the 5 visible ones.\n\nIf passing in an array of Game Objects it will draw them all, regardless if\nthey pass a `willRender` check or not.\n\nYou can pass in a string in which case it will look for a texture in the Texture\nManager matching that string, and draw the base frame.\n\nYou can pass in the `x` and `y` coordinates to draw the objects at. The use of\nthe coordinates differ based on what objects are being drawn. If the object is\na Group, Container or Display List, the coordinates are _added_ to the positions\nof the children. For all other types of object, the coordinates are exact.\n\nCalling this method causes the WebGL batch to flush, so it can write the texture\ndata to the framebuffer being used internally. The batch is flushed at the end,\nafter the entries have been iterated. So if you've a bunch of objects to draw,\ntry and pass them in an array in one single call, rather than making lots of\nseparate calls.","kind":"function","name":"erase","since":"3.16.0","params":[{"type":{"names":["any"]},"description":"Any renderable Game Object, or Group, Container, Display List, other Render Texture, Texture Frame or an array of any of these.","name":"entries"},{"type":{"names":["number"]},"optional":true,"description":"The x position to draw the Frame at, or the offset applied to the object.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y position to draw the Frame at, or the offset applied to the object.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#erase","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":675,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Draws the given object, or an array of objects, to this Render Texture.\n\nIt can accept any of the following:\n\n* Any renderable Game Object, such as a Sprite, Text, Graphics or TileSprite.\n* Dynamic and Static Tilemap Layers.\n* A Group. The contents of which will be iterated and drawn in turn.\n* A Container. The contents of which will be iterated fully, and drawn in turn.\n* A Scene's Display List. Pass in `Scene.children` to draw the whole list.\n* Another Render Texture.\n* A Texture Frame instance.\n* A string. This is used to look-up a texture from the Texture Manager.\n\nNote: You cannot draw a Render Texture to itself.\n\nIf passing in a Group or Container it will only draw children that return `true`\nwhen their `willRender()` method is called. I.e. a Container with 10 children,\n5 of which have `visible=false` will only draw the 5 visible ones.\n\nIf passing in an array of Game Objects it will draw them all, regardless if\nthey pass a `willRender` check or not.\n\nYou can pass in a string in which case it will look for a texture in the Texture\nManager matching that string, and draw the base frame. If you need to specify\nexactly which frame to draw then use the method `drawFrame` instead.\n\nYou can pass in the `x` and `y` coordinates to draw the objects at. The use of\nthe coordinates differ based on what objects are being drawn. If the object is\na Group, Container or Display List, the coordinates are _added_ to the positions\nof the children. For all other types of object, the coordinates are exact.\n\nThe `alpha` and `tint` values are only used by Texture Frames.\nGame Objects use their own alpha and tint values when being drawn.\n\nCalling this method causes the WebGL batch to flush, so it can write the texture\ndata to the framebuffer being used internally. The batch is flushed at the end,\nafter the entries have been iterated. So if you've a bunch of objects to draw,\ntry and pass them in an array in one single call, rather than making lots of\nseparate calls.","kind":"function","name":"draw","since":"3.2.0","params":[{"type":{"names":["any"]},"description":"Any renderable Game Object, or Group, Container, Display List, other Render Texture, Texture Frame or an array of any of these.","name":"entries"},{"type":{"names":["number"]},"optional":true,"description":"The x position to draw the Frame at, or the offset applied to the object.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y position to draw the Frame at, or the offset applied to the object.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value. Only used for Texture Frames and if not specified defaults to the `globalAlpha` property. Game Objects use their own current alpha value.","name":"alpha"},{"type":{"names":["number"]},"optional":true,"description":"WebGL only. The tint color value. Only used for Texture Frames and if not specified defaults to the `globalTint` property. Game Objects use their own current tint value.","name":"tint"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#draw","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":788,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Draws the Texture Frame to the Render Texture at the given position.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.\n\n```javascript\nvar rt = this.add.renderTexture(0, 0, 800, 600);\nrt.drawFrame(key, frame);\n```\n\nYou can optionally provide a position, alpha and tint value to apply to the frame\nbefore it is drawn.\n\nCalling this method will cause a batch flush, so if you've got a stack of things to draw\nin a tight loop, try using the `draw` method instead.\n\nIf you need to draw a Sprite to this Render Texture, use the `draw` method instead.","kind":"function","name":"drawFrame","since":"3.12.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position to draw the frame at.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position to draw the frame at.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The alpha to use. If not specified it uses the `globalAlpha` property.","name":"alpha"},{"type":{"names":["number"]},"optional":true,"description":"WebGL only. The tint color to use. If not specified it uses the `globalTint` property.","name":"tint"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#drawFrame","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":1094,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Takes a snapshot of the given area of this Render Texture.\n\nThe snapshot is taken immediately.\n\nTo capture the whole Render Texture see the `snapshot` method. To capture a specific pixel, see `snapshotPixel`.\n\nSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\nIt then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\nwhich is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\nwhich gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshotArea","since":"3.19.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate to grab from.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate to grab from.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the area to grab.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the area to grab.","name":"height"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#snapshotArea","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":1133,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Takes a snapshot of the whole of this Render Texture.\n\nThe snapshot is taken immediately.\n\nTo capture just a portion of the Render Texture see the `snapshotArea` method. To capture a specific pixel, see `snapshotPixel`.\n\nSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\nIt then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\nwhich is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\nwhich gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshot","since":"3.19.0","params":[{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#snapshot","scope":"instance","___s":true},{"meta":{"filename":"RenderTexture.js","lineno":1168,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Takes a snapshot of the given pixel from this Render Texture.\n\nThe snapshot is taken immediately.\n\nTo capture the whole Render Texture see the `snapshot` method. To capture a specific portion, see `snapshotArea`.\n\nUnlike the other two snapshot methods, this one will send your callback a `Color` object containing the color data for\nthe requested pixel. It doesn't need to create an internal Canvas or Image object, so is a lot faster to execute,\nusing less memory, than the other snapshot methods.","kind":"function","name":"snapshotPixel","since":"3.19.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel to get.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel to get.","name":"y"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot pixel data is extracted.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Render Texture instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#snapshotPixel","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"RenderTextureCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RenderTextureCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Creates a new Render Texture Game Object and returns it.\n\nNote: This method will only be available if the Render Texture Game Object has been built into Phaser.","kind":"function","name":"renderTexture","since":"3.2.0","params":[{"type":{"names":["Phaser.Types.GameObjects.RenderTexture.RenderTextureConfig"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#renderTexture","scope":"instance","___s":true},{"meta":{"range":[180,231],"filename":"RenderTextureFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RenderTextureFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"description":"Creates a new Render Texture Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Render Texture Game Object has been built into Phaser.\n\nA Render Texture is a special texture that allows any number of Game Objects to be drawn to it. You can take many complex objects and\ndraw them all to this one texture, which can they be used as the texture for other Game Object's. It's a way to generate dynamic\ntextures at run-time that are WebGL friendly and don't invoke expensive GPU uploads.","kind":"function","name":"renderTexture","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The width of the Render Texture.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The height of the Render Texture.","name":"height"}],"properties":[{"type":{"names":["string"]},"optional":true,"description":"The texture key to make the RenderTexture from.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"the frame to make the RenderTexture from.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#renderTexture","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"RenderTextureRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"RenderTextureWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RenderTextureConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/typedefs"},"kind":"typedef","name":"RenderTextureConfig","type":{"names":["object"]},"since":"3.2.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the RenderTextures position.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the RenderTextures position.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The width of the RenderTexture.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of the RenderTexture.","name":"height"},{"type":{"names":["string"]},"optional":true,"description":"The texture key to make the RenderTexture from.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"the frame to make the RenderTexture from.","name":"frame"}],"memberof":"Phaser.Types.GameObjects.RenderTexture","longname":"Phaser.Types.GameObjects.RenderTexture.RenderTextureConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/typedefs"},"kind":"namespace","name":"RenderTexture","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.RenderTexture","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Shader.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Shader.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"classdesc":"A Shader Game Object.\n\nThis Game Object allows you to easily add a quad with its own shader into the display list, and manipulate it\nas you would any other Game Object, including scaling, rotating, positioning and adding to Containers. Shaders\ncan be masked with either Bitmap or Geometry masks and can also be used as a Bitmap Mask for a Camera or other\nGame Object. They can also be made interactive and used for input events.\n\nIt works by taking a reference to a `Phaser.Display.BaseShader` instance, as found in the Shader Cache. These can\nbe created dynamically at runtime, or loaded in via the GLSL File Loader:\n\n```javascript\nfunction preload ()\n{\n this.load.glsl('fire', 'shaders/fire.glsl.js');\n}\n \nfunction create ()\n{\n this.add.shader('fire', 400, 300, 512, 512);\n}\n```\n\nPlease see the Phaser 3 Examples GitHub repo for examples of loading and creating shaders dynamically.\n\nDue to the way in which they work, you cannot directly change the alpha or blend mode of a Shader. This should\nbe handled via exposed uniforms in the shader code itself.\n\nBy default a Shader will be created with a standard set of uniforms. These were added to match those\nfound on sites such as ShaderToy or GLSLSandbox, and provide common functionality a shader may need,\nsuch as the timestamp, resolution or pointer position. You can replace them by specifying your own uniforms\nin the Base Shader.\n\nThese Shaders work by halting the current pipeline during rendering, creating a viewport matched to the\nsize of this Game Object and then renders a quad using the bound shader. At the end, the pipeline is restored.\n\nBecause it blocks the pipeline it means it will interrupt any batching that is currently going on, so you should\nuse these Game Objects sparingly. If you need to have a fully batched custom shader, then please look at using\na custom pipeline instead. However, for background or special masking effects, they are extremely effective.","kind":"class","name":"Shader","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.17.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["string","Phaser.Display.BaseShader"]},"description":"The key of the shader to use from the shader cache, or a BaseShader instance.","name":"key"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the Game Object.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the Game Object.","name":"height"},{"type":{"names":["Array."]},"optional":true,"description":"Optional array of texture keys to bind to the iChannel0...3 uniforms. The textures must already exist in the Texture Manager.","name":"textures"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data if you want to create shader with none NPOT textures.","name":"textureData"}],"scope":"static","longname":"Phaser.GameObjects.Shader","___s":true},{"meta":{"filename":"Shader.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The underlying shader object being used.\nEmpty by default and set during a call to the `setShader` method.","name":"shader","type":{"names":["Phaser.Display.BaseShader"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#shader","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A reference to the current renderer.\nShaders only work with the WebGL Renderer.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The WebGL context belonging to the renderer.","name":"gl","type":{"names":["WebGLRenderingContext"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#gl","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":150,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Raw byte buffer of vertices this Shader uses.","name":"vertexData","type":{"names":["ArrayBuffer"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#vertexData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The WebGL vertex buffer object this shader uses.","name":"vertexBuffer","type":{"names":["WebGLBuffer"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#vertexBuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The WebGL shader program this shader uses.","name":"program","type":{"names":["WebGLProgram"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#program","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Uint8 view to the vertex raw buffer. Used for uploading vertex buffer resources to the GPU.","name":"bytes","type":{"names":["Uint8Array"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#bytes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":186,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Float32 view of the array buffer containing the shaders vertices.","name":"vertexViewF32","type":{"names":["Float32Array"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#vertexViewF32","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":225,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The view matrix the shader uses during rendering.","name":"viewMatrix","type":{"names":["Float32Array"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#viewMatrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":235,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The projection matrix the shader uses during rendering.","name":"projectionMatrix","type":{"names":["Float32Array"]},"readonly":true,"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#projectionMatrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":245,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The default uniform mappings. These can be added to (or replaced) by specifying your own uniforms when\ncreating this shader game object. The uniforms are updated automatically during the render step.\n\nThe defaults are:\n\n`resolution` (2f) - Set to the size of this shader.\n`time` (1f) - The elapsed game time, in seconds.\n`mouse` (2f) - If a pointer has been bound (with `setPointer`), this uniform contains its position each frame.\n`date` (4fv) - A vec4 containing the year, month, day and time in seconds.\n`sampleRate` (1f) - Sound sample rate. 44100 by default.\n`iChannel0...3` (sampler2D) - Input channels 0 to 3. `null` by default.","name":"uniforms","type":{"names":["any"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#uniforms","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":264,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"The pointer bound to this shader, if any.\nSet via the chainable `setPointer` method, or by modifying this property directly.","name":"pointer","type":{"names":["Phaser.Input.Pointer"]},"since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#pointer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":304,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A reference to the GL Frame Buffer this Shader is drawing to.\nThis property is only set if you have called `Shader.setRenderToTexture`.","name":"framebuffer","type":{"names":["WebGLFramebuffer"]},"nullable":true,"since":"3.19.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#framebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":314,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A reference to the WebGLTexture this Shader is rendering to.\nThis property is only set if you have called `Shader.setRenderToTexture`.","name":"glTexture","type":{"names":["WebGLTexture"]},"nullable":true,"since":"3.19.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#glTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":324,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A flag that indicates if this Shader has been set to render to a texture instead of the display list.\n\nThis property is `true` if you have called `Shader.setRenderToTexture`, otherwise it's `false`.\n\nA Shader that is rendering to a texture _does not_ appear on the display list.","name":"renderToTexture","type":{"names":["boolean"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#renderToTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":338,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A reference to the Phaser.Textures.Texture that has been stored in the Texture Manager for this Shader.\n\nThis property is only set if you have called `Shader.setRenderToTexture`, otherwise it is `null`.","name":"texture","type":{"names":["Phaser.Textures.Texture"]},"since":"3.19.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shader.js","lineno":355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#willRender","scope":"instance","overrides":"Phaser.GameObjects.GameObject#willRender","___s":true},{"meta":{"filename":"Shader.js","lineno":378,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Changes this Shader so instead of rendering to the display list it renders to a\nWebGL Framebuffer and WebGL Texture instead. This allows you to use the output\nof this shader as an input for another shader, by mapping a sampler2D uniform\nto it.\n\nAfter calling this method the `Shader.framebuffer` and `Shader.glTexture` properties\nare populated.\n\nAdditionally, you can provide a key to this method. Doing so will create a Phaser Texture\nfrom this Shader and save it into the Texture Manager, allowing you to then use it for\nany texture-based Game Object, such as a Sprite or Image:\n\n```javascript\nvar shader = this.add.shader('myShader', x, y, width, height);\n\nshader.setRenderToTexture('doodle');\n\nthis.add.image(400, 300, 'doodle');\n```\n\nNote that it stores an active reference to this Shader. That means as this shader updates,\nso does the texture and any object using it to render with. Also, if you destroy this\nshader, be sure to clear any objects that may have been using it as a texture too.\n\nYou can access the Phaser Texture that is created via the `Shader.texture` property.\n\nBy default it will create a single base texture. You can add frames to the texture\nby using the `Texture.add` method. After doing this, you can then allow Game Objects\nto use a specific frame from a Render Texture.","kind":"function","name":"setRenderToTexture","since":"3.19.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The unique key to store the texture as within the global Texture Manager.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Does this texture need vertically flipping before rendering? This should usually be set to `true` if being fed from a buffer.","name":"flipY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setRenderToTexture","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":463,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Sets the fragment and, optionally, the vertex shader source code that this Shader will use.\nThis will immediately delete the active shader program, if set, and then create a new one\nwith the given source. Finally, the shader uniforms are initialized.","kind":"function","name":"setShader","since":"3.17.0","params":[{"type":{"names":["string","Phaser.Display.BaseShader"]},"description":"The key of the shader to use from the shader cache, or a BaseShader instance.","name":"key"},{"type":{"names":["Array."]},"optional":true,"description":"Optional array of texture keys to bind to the iChannel0...3 uniforms. The textures must already exist in the Texture Manager.","name":"textures"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setShader","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Binds a Phaser Pointer object to this Shader.\n\nThe screen position of the pointer will be set in to the shaders `mouse` uniform\nautomatically every frame. Call this method with no arguments to unbind the pointer.","kind":"function","name":"setPointer","since":"3.17.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"optional":true,"description":"The Pointer to bind to this shader.","name":"pointer"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setPointer","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":574,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Sets this shader to use an orthographic projection matrix.\nThis matrix is stored locally in the `projectionMatrix` property,\nas well as being bound to the `uProjectionMatrix` uniform.","kind":"function","name":"projOrtho","since":"3.17.0","params":[{"type":{"names":["number"]},"description":"The left value.","name":"left"},{"type":{"names":["number"]},"description":"The right value.","name":"right"},{"type":{"names":["number"]},"description":"The bottom value.","name":"bottom"},{"type":{"names":["number"]},"description":"The top value.","name":"top"}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#projOrtho","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":649,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Sets a sampler2D uniform on this shader where the source texture is a WebGLTexture.\n\nThis allows you to feed the output from one Shader into another:\n\n```javascript\nlet shader1 = this.add.shader(baseShader1, 0, 0, 512, 512).setRenderToTexture();\nlet shader2 = this.add.shader(baseShader2, 0, 0, 512, 512).setRenderToTexture('output');\n\nshader1.setSampler2DBuffer('iChannel0', shader2.glTexture, 512, 512);\nshader2.setSampler2DBuffer('iChannel0', shader1.glTexture, 512, 512);\n```\n\nIn the above code, the result of baseShader1 is fed into Shader2 as the `iChannel0` sampler2D uniform.\nThe result of baseShader2 is then fed back into shader1 again, creating a feedback loop.\n\nIf you wish to use an image from the Texture Manager as a sampler2D input for this shader,\nsee the `Shader.setSampler2D` method.","kind":"function","name":"setSampler2DBuffer","since":"3.19.0","params":[{"type":{"names":["string"]},"description":"The key of the sampler2D uniform to be updated, i.e. `iChannel0`.","name":"uniformKey"},{"type":{"names":["WebGLTexture"]},"description":"A WebGLTexture reference.","name":"texture"},{"type":{"names":["integer"]},"description":"The width of the texture.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the texture.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The texture index.","name":"textureIndex"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setSampler2DBuffer","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":701,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Sets a sampler2D uniform on this shader.\n\nThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\nfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.\n\nIf you wish to use another Shader as a sampler2D input for this shader, see the `Shader.setSampler2DBuffer` method.","kind":"function","name":"setSampler2D","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the sampler2D uniform to be updated, i.e. `iChannel0`.","name":"uniformKey"},{"type":{"names":["string"]},"description":"The key of the texture, as stored in the Texture Manager. Must already be loaded.","name":"textureKey"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The texture index.","name":"textureIndex"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setSampler2D","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":759,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Sets a property of a uniform already present on this shader.\n\nTo modify the value of a uniform such as a 1f or 1i use the `value` property directly:\n\n```javascript\nshader.setUniform('size.value', 16);\n```\n\nYou can use dot notation to access deeper values, for example:\n\n```javascript\nshader.setUniform('resolution.value.x', 512);\n```\n\nThe change to the uniform will take effect the next time the shader is rendered.","kind":"function","name":"setUniform","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the uniform to modify. Use dots for deep properties, i.e. `resolution.value.x`.","name":"key"},{"type":{"names":["any"]},"description":"The value to set into the uniform.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setUniform","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":791,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Returns the uniform object for the given key, or `null` if the uniform couldn't be found.","kind":"function","name":"getUniform","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the uniform to return the value for.","name":"key"}],"returns":[{"type":{"names":["any"]},"description":"A reference to the uniform object. This is not a copy, so modifying it will update the original object also."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getUniform","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":806,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A short-cut method that will directly set the texture being used by the `iChannel0` sampler2D uniform.\n\nThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\nfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.","kind":"function","name":"setChannel0","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the texture, as stored in the Texture Manager. Must already be loaded.","name":"textureKey"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setChannel0","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":825,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A short-cut method that will directly set the texture being used by the `iChannel1` sampler2D uniform.\n\nThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\nfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.","kind":"function","name":"setChannel1","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the texture, as stored in the Texture Manager. Must already be loaded.","name":"textureKey"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setChannel1","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":844,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A short-cut method that will directly set the texture being used by the `iChannel2` sampler2D uniform.\n\nThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\nfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.","kind":"function","name":"setChannel2","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the texture, as stored in the Texture Manager. Must already be loaded.","name":"textureKey"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setChannel2","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":863,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"A short-cut method that will directly set the texture being used by the `iChannel3` sampler2D uniform.\n\nThe textureKey given is the key from the Texture Manager cache. You cannot use a single frame\nfrom a texture, only the full image. Also, lots of shaders expect textures to be power-of-two sized.","kind":"function","name":"setChannel3","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key of the texture, as stored in the Texture Manager. Must already be loaded.","name":"textureKey"},{"type":{"names":["any"]},"optional":true,"description":"Additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Shader instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setChannel3","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":1028,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Called automatically during render.\n\nThis method performs matrix ITRS and then stores the resulting value in the `uViewMatrix` uniform.\nIt then sets up the vertex buffer and shader, updates and syncs the uniforms ready\nfor flush to be called.","kind":"function","name":"load","since":"3.17.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The transform matrix to use during rendering.","name":"matrix2D"}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#load","scope":"instance","___s":true},{"meta":{"filename":"Shader.js","lineno":1099,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Called automatically during render.\n\nSets the active shader, loads the vertex buffer and then draws.","kind":"function","name":"flush","since":"3.17.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#flush","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"ShaderCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ShaderCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Creates a new Shader Game Object and returns it.\n\nNote: This method will only be available if the Shader Game Object and WebGL support have been built into Phaser.","kind":"function","name":"shader","since":"3.17.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#shader","scope":"instance","___s":true},{"meta":{"range":[180,208],"filename":"ShaderFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"name":"Shader","longname":"Shader","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ShaderFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"description":"Creates a new Shader Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Shader Game Object and WebGL support have been built into Phaser.","kind":"function","name":"shader","since":"3.17.0","params":[{"type":{"names":["string","Phaser.Display.BaseShader"]},"description":"The key of the shader to use from the shader cache, or a BaseShader instance.","name":"key"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the Game Object.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the Game Object.","name":"height"},{"type":{"names":["Array."]},"optional":true,"description":"Optional array of texture keys to bind to the iChannel0...3 uniforms. The textures must already exist in the Texture Manager.","name":"textures"},{"type":{"names":["object"]},"optional":true,"description":"Optional additional texture data.","name":"textureData"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#shader","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"ShaderRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shader"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"FillPathWebGL.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"Shape.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Shape.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"classdesc":"The Shape Game Object is a base class for the various different shapes, such as the Arc, Star or Polygon.\nYou cannot add a Shape directly to your Scene, it is meant as a base for your own custom Shape classes.","kind":"class","name":"Shape","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.AlphaSingle","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["string"]},"optional":true,"description":"The internal type of the Shape.","name":"type"},{"type":{"names":["any"]},"optional":true,"description":"The data of the source shape geometry, if any.","name":"data"}],"scope":"static","longname":"Phaser.GameObjects.Shape","___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#data","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.GameObject#data","___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#pathData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#pathIndexes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#fillColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#fillAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#strokeColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#strokeAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#lineWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#isFilled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#isStroked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#closePath","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setFillStyle","scope":"instance","___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setStrokeStyle","scope":"instance","___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setClosePath","scope":"instance","___s":true},{"meta":{"range":[180,225],"filename":"StrokePathWebGL.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,214],"filename":"Arc.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"name":"ArcRender","longname":"ArcRender","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Arc.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"classdesc":"The Arc Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nWhen it renders it displays an arc shape. You can control the start and end angles of the arc,\nas well as if the angles are winding clockwise or anti-clockwise. With the default settings\nit renders as a complete circle. By changing the angles you can create other arc shapes,\nsuch as half-circles.\n\nArcs also have an `iterations` property and corresponding `setIterations` method. This allows\nyou to control how smooth the shape renders in WebGL, by controlling the number of iterations\nthat take place during construction.","kind":"class","name":"Arc","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The radius of the arc.","name":"radius"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The start angle of the arc, in degrees.","name":"startAngle"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":360,"description":"The end angle of the arc, in degrees.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The winding order of the start and end angles.","name":"anticlockwise"},{"type":{"names":["number"]},"optional":true,"description":"The color the arc will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the arc will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Arc","___s":true},{"meta":{"filename":"Arc.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"The number of iterations used when drawing the arc.\nIncrease this value for smoother arcs, at the cost of more polygons being rendered.\nModify this value by small amounts, such as 0.01.","name":"iterations","type":{"names":["number"]},"defaultvalue":"0.01","since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#iterations","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Arc.js","lineno":151,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"The radius of the arc.","name":"radius","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#radius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Arc.js","lineno":177,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"The start angle of the arc, in degrees.","name":"startAngle","type":{"names":["integer"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#startAngle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Arc.js","lineno":200,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"The end angle of the arc, in degrees.","name":"endAngle","type":{"names":["integer"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#endAngle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Arc.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"The winding order of the start and end angles.","name":"anticlockwise","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#anticlockwise","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Arc.js","lineno":246,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"Sets the radius of the arc.\nThis call can be chained.","kind":"function","name":"setRadius","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The value to set the radius to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setRadius","scope":"instance","___s":true},{"meta":{"filename":"Arc.js","lineno":264,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"Sets the number of iterations used when drawing the arc.\nIncrease this value for smoother arcs, at the cost of more polygons being rendered.\nModify this value by small amounts, such as 0.01.\nThis call can be chained.","kind":"function","name":"setIterations","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The value to set the iterations to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setIterations","scope":"instance","___s":true},{"meta":{"filename":"Arc.js","lineno":286,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"Sets the starting angle of the arc, in degrees.\nThis call can be chained.","kind":"function","name":"setStartAngle","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The value to set the starting angle to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setStartAngle","scope":"instance","___s":true},{"meta":{"filename":"Arc.js","lineno":309,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"Sets the ending angle of the arc, in degrees.\nThis call can be chained.","kind":"function","name":"setEndAngle","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The value to set the ending angle to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setEndAngle","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"ArcCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"name":"DegToRad","longname":"DegToRad","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,202],"filename":"ArcFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"name":"Arc","longname":"Arc","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ArcFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"Creates a new Arc Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Arc Game Object has been built into Phaser.\n\nThe Arc Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nWhen it renders it displays an arc shape. You can control the start and end angles of the arc,\nas well as if the angles are winding clockwise or anti-clockwise. With the default settings\nit renders as a complete circle. By changing the angles you can create other arc shapes,\nsuch as half-circles.","kind":"function","name":"arc","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The radius of the arc.","name":"radius"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The start angle of the arc, in degrees.","name":"startAngle"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":360,"description":"The end angle of the arc, in degrees.","name":"endAngle"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The winding order of the start and end angles.","name":"anticlockwise"},{"type":{"names":["number"]},"optional":true,"description":"The color the arc will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the arc will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#arc","scope":"instance","___s":true},{"meta":{"filename":"ArcFactory.js","lineno":46,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"description":"Creates a new Circle Shape Game Object and adds it to the Scene.\n\nA Circle is an Arc with no defined start and end angle, making it render as a complete circle.\n\nNote: This method will only be available if the Arc Game Object has been built into Phaser.","kind":"function","name":"circle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The radius of the circle.","name":"radius"},{"type":{"names":["number"]},"optional":true,"description":"The color the circle will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the circle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#circle","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"ArcRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"ArcWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc"},"name":"FillPathWebGL","longname":"FillPathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"Curve.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Curve.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"classdesc":"The Curve Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nTo render a Curve Shape you must first create a `Phaser.Curves.Curve` object, then pass it to\nthe Curve Shape in the constructor.\n\nThe Curve shape also has a `smoothness` property and corresponding `setSmoothness` method.\nThis allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\nthat take place during construction. Increase and decrease the default value for smoother, or more\njagged, shapes.","kind":"class","name":"Curve","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["Phaser.Curves.Curve"]},"optional":true,"description":"The Curve object to use to create the Shape.","name":"curve"},{"type":{"names":["number"]},"optional":true,"description":"The color the curve will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the curve will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Curve","___s":true},{"meta":{"filename":"Curve.js","lineno":94,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"description":"The smoothness of the curve. The number of points used when rendering it.\nIncrease this value for smoother curves, at the cost of more polygons being rendered.","name":"smoothness","type":{"names":["integer"]},"defaultvalue":"32","since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#smoothness","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Curve.js","lineno":119,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"description":"Sets the smoothness of the curve. The number of points used when rendering it.\nIncrease this value for smoother curves, at the cost of more polygons being rendered.\nThis call can be chained.","kind":"function","name":"setSmoothness","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The value to set the smoothness to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setSmoothness","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"CurveCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"CurveFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CurveFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"description":"Creates a new Curve Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Curve Game Object has been built into Phaser.\n\nThe Curve Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nTo render a Curve Shape you must first create a `Phaser.Curves.Curve` object, then pass it to\nthe Curve Shape in the constructor.\n\nThe Curve shape also has a `smoothness` property and corresponding `setSmoothness` method.\nThis allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\nthat take place during construction. Increase and decrease the default value for smoother, or more\njagged, shapes.","kind":"function","name":"curve","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["Phaser.Curves.Curve"]},"optional":true,"description":"The Curve object to use to create the Shape.","name":"curve"},{"type":{"names":["number"]},"optional":true,"description":"The color the curve will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the curve will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#curve","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"CurveRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"CurveWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve"},"name":"FillPathWebGL","longname":"FillPathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"Ellipse.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Ellipse.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"classdesc":"The Ellipse Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nWhen it renders it displays an ellipse shape. You can control the width and height of the ellipse.\nIf the width and height match it will render as a circle. If the width is less than the height,\nit will look more like an egg shape.\n\nThe Ellipse shape also has a `smoothness` property and corresponding `setSmoothness` method.\nThis allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\nthat take place during construction. Increase and decrease the default value for smoother, or more\njagged, shapes.","kind":"class","name":"Ellipse","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the ellipse. An ellipse with equal width and height renders as a circle.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the ellipse. An ellipse with equal width and height renders as a circle.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The color the ellipse will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the ellipse will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Ellipse","___s":true},{"meta":{"filename":"Ellipse.js","lineno":89,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"description":"The smoothness of the ellipse. The number of points used when rendering it.\nIncrease this value for a smoother ellipse, at the cost of more polygons being rendered.","name":"smoothness","type":{"names":["integer"]},"defaultvalue":"64","since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#smoothness","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"description":"Sets the size of the ellipse by changing the underlying geometry data, rather than scaling the object.\nThis call can be chained.","kind":"function","name":"setSize","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"description":"The height of the ellipse.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setSize","scope":"instance","overrides":"Phaser.GameObjects.Shape#setSize","___s":true},{"meta":{"filename":"Ellipse.js","lineno":133,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"description":"Sets the smoothness of the ellipse. The number of points used when rendering it.\nIncrease this value for a smoother ellipse, at the cost of more polygons being rendered.\nThis call can be chained.","kind":"function","name":"setSmoothness","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The value to set the smoothness to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setSmoothness","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"EllipseCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,210],"filename":"EllipseFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"name":"Ellipse","longname":"Ellipse","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"EllipseFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"description":"Creates a new Ellipse Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Ellipse Game Object has been built into Phaser.\n\nThe Ellipse Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nWhen it renders it displays an ellipse shape. You can control the width and height of the ellipse.\nIf the width and height match it will render as a circle. If the width is less than the height,\nit will look more like an egg shape.\n\nThe Ellipse shape also has a `smoothness` property and corresponding `setSmoothness` method.\nThis allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\nthat take place during construction. Increase and decrease the default value for smoother, or more\njagged, shapes.","kind":"function","name":"ellipse","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the ellipse. An ellipse with equal width and height renders as a circle.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the ellipse. An ellipse with equal width and height renders as a circle.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The color the ellipse will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the ellipse will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#ellipse","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"EllipseRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"EllipseWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse"},"name":"FillPathWebGL","longname":"FillPathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"Grid.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Grid.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"classdesc":"The Grid Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only fill colors and cannot be stroked.\n\nA Grid Shape allows you to display a grid in your game, where you can control the size of the\ngrid as well as the width and height of the grid cells. You can set a fill color for each grid\ncell as well as an alternate fill color. When the alternate fill color is set then the grid\ncells will alternate the fill colors as they render, creating a chess-board effect. You can\nalso optionally have an outline fill color. If set, this draws lines between the grid cells\nin the given color. If you specify an outline color with an alpha of zero, then it will draw\nthe cells spaced out, but without the lines between them.","kind":"class","name":"Grid","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the grid.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the grid.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The width of one cell in the grid.","name":"cellWidth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of one cell in the grid.","name":"cellHeight"},{"type":{"names":["number"]},"optional":true,"description":"The color the grid cells will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"},{"type":{"names":["number"]},"optional":true,"description":"The color of the lines between the grid cells. See the `setOutline` method.","name":"outlineFillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha of the lines between the grid cells.","name":"outlineFillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Grid","___s":true},{"meta":{"filename":"Grid.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"The width of each grid cell.\nMust be a positive value.","name":"cellWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#cellWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"The height of each grid cell.\nMust be a positive value.","name":"cellHeight","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#cellHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Will the grid render its cells in the `fillColor`?","name":"showCells","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#showCells","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"The color of the lines between each grid cell.","name":"outlineFillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#outlineFillColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"The alpha value for the color of the lines between each grid cell.","name":"outlineFillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#outlineFillAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Will the grid display the lines between each cell when it renders?","name":"showOutline","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#showOutline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Will the grid render the alternating cells in the `altFillColor`?","name":"showAltCells","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#showAltCells","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"The color the alternating grid cells will be filled with, i.e. 0xff0000 for red.","name":"altFillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#altFillColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"The alpha the alternating grid cells will be filled with.\nYou can also set the alpha of the overall Shape using its `alpha` property.","name":"altFillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#altFillAlpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Grid.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Sets the fill color and alpha level the grid cells will use when rendering.\n\nIf this method is called with no values then the grid cells will not be rendered, \nhowever the grid lines and alternating cells may still be.\n\nAlso see the `setOutlineStyle` and `setAltFillStyle` methods.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color the grid cells will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setFillStyle","scope":"instance","overrides":"Phaser.GameObjects.Shape#setFillStyle","___s":true},{"meta":{"filename":"Grid.js","lineno":203,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Sets the fill color and alpha level that the alternating grid cells will use.\n\nIf this method is called with no values then alternating grid cells will not be rendered in a different color.\n\nAlso see the `setOutlineStyle` and `setFillStyle` methods.\n\nThis call can be chained.","kind":"function","name":"setAltFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color the alternating grid cells will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha the alternating grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setAltFillStyle","scope":"instance","___s":true},{"meta":{"filename":"Grid.js","lineno":238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Sets the fill color and alpha level that the lines between each grid cell will use.\n\nIf this method is called with no values then the grid lines will not be rendered at all, however\nthe cells themselves may still be if they have colors set.\n\nAlso see the `setFillStyle` and `setAltFillStyle` methods.\n\nThis call can be chained.","kind":"function","name":"setOutlineStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color the lines between the grid cells will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha the lines between the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setOutlineStyle","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"GridCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"GridFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GridFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"description":"Creates a new Grid Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Grid Game Object has been built into Phaser.\n\nThe Grid Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only fill colors and cannot be stroked.\n\nA Grid Shape allows you to display a grid in your game, where you can control the size of the\ngrid as well as the width and height of the grid cells. You can set a fill color for each grid\ncell as well as an alternate fill color. When the alternate fill color is set then the grid\ncells will alternate the fill colors as they render, creating a chess-board effect. You can\nalso optionally have an outline fill color. If set, this draws lines between the grid cells\nin the given color. If you specify an outline color with an alpha of zero, then it will draw\nthe cells spaced out, but without the lines between them.","kind":"function","name":"grid","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the grid.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the grid.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The width of one cell in the grid.","name":"cellWidth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of one cell in the grid.","name":"cellHeight"},{"type":{"names":["number"]},"optional":true,"description":"The color the grid cells will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"},{"type":{"names":["number"]},"optional":true,"description":"The color of the lines between the grid cells.","name":"outlineFillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha of the lines between the grid cells.","name":"outlineFillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#grid","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"GridRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"GridWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,220],"filename":"IsoBox.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"name":"IsoBoxRender","longname":"IsoBoxRender","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IsoBox.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"classdesc":"The IsoBox Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only fill colors and cannot be stroked.\n\nAn IsoBox is an 'isometric' rectangle. Each face of it has a different fill color. You can set\nthe color of the top, left and right faces of the rectangle respectively. You can also choose\nwhich of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\n\nYou cannot view an IsoBox from under-neath, however you can change the 'angle' by setting\nthe `projection` property.","kind":"class","name":"IsoBox","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":48,"description":"The width of the iso box in pixels. The left and right faces will be exactly half this value.","name":"size"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of the iso box. The left and right faces will be this tall. The overall height of the isobox will be this value plus half the `size` value.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xeeeeee","description":"The fill color of the top face of the iso box.","name":"fillTop"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x999999","description":"The fill color of the left face of the iso box.","name":"fillLeft"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xcccccc","description":"The fill color of the right face of the iso box.","name":"fillRight"}],"scope":"static","longname":"Phaser.GameObjects.IsoBox","___s":true},{"meta":{"filename":"IsoBox.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"The projection level of the iso box. Change this to change the 'angle' at which you are looking at the box.","name":"projection","type":{"names":["integer"]},"defaultvalue":"4","since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#projection","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"The color used to fill in the top of the iso box.","name":"fillTop","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#fillTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"The color used to fill in the left-facing side of the iso box.","name":"fillLeft","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#fillLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"The color used to fill in the right-facing side of the iso box.","name":"fillRight","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#fillRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Controls if the top-face of the iso box be rendered.","name":"showTop","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#showTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Controls if the left-face of the iso box be rendered.","name":"showLeft","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#showLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Controls if the right-face of the iso box be rendered.","name":"showRight","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#showRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoBox.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Sets the projection level of the iso box. Change this to change the 'angle' at which you are looking at the box.\nThis call can be chained.","kind":"function","name":"setProjection","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The value to set the projection to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setProjection","scope":"instance","___s":true},{"meta":{"filename":"IsoBox.js","lineno":157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Sets which faces of the iso box will be rendered.\nThis call can be chained.","kind":"function","name":"setFaces","since":"3.13.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Show the top-face of the iso box.","name":"showTop"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Show the left-face of the iso box.","name":"showLeft"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Show the right-face of the iso box.","name":"showRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setFaces","scope":"instance","___s":true},{"meta":{"filename":"IsoBox.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Sets the fill colors for each face of the iso box.\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill the top of the iso box.","name":"fillTop"},{"type":{"names":["number"]},"optional":true,"description":"The color used to fill in the left-facing side of the iso box.","name":"fillLeft"},{"type":{"names":["number"]},"optional":true,"description":"The color used to fill in the right-facing side of the iso box.","name":"fillRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setFillStyle","scope":"instance","overrides":"Phaser.GameObjects.Shape#setFillStyle","___s":true},{"meta":{"range":[180,227],"filename":"IsoBoxCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"IsoBoxFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IsoBoxFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"description":"Creates a new IsoBox Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the IsoBox Game Object has been built into Phaser.\n\nThe IsoBox Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only fill colors and cannot be stroked.\n\nAn IsoBox is an 'isometric' rectangle. Each face of it has a different fill color. You can set\nthe color of the top, left and right faces of the rectangle respectively. You can also choose\nwhich of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\n\nYou cannot view an IsoBox from under-neath, however you can change the 'angle' by setting\nthe `projection` property.","kind":"function","name":"isobox","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":48,"description":"The width of the iso box in pixels. The left and right faces will be exactly half this value.","name":"size"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of the iso box. The left and right faces will be this tall. The overall height of the isobox will be this value plus half the `size` value.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xeeeeee","description":"The fill color of the top face of the iso box.","name":"fillTop"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x999999","description":"The fill color of the left face of the iso box.","name":"fillLeft"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xcccccc","description":"The fill color of the right face of the iso box.","name":"fillRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#isobox","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"IsoBoxRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"IsoBoxWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"IsoTriangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"classdesc":"The IsoTriangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only fill colors and cannot be stroked.\n\nAn IsoTriangle is an 'isometric' triangle. Think of it like a pyramid. Each face has a different\nfill color. You can set the color of the top, left and right faces of the triangle respectively\nYou can also choose which of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\n\nYou cannot view an IsoTriangle from under-neath, however you can change the 'angle' by setting\nthe `projection` property. The `reversed` property controls if the IsoTriangle is rendered upside\ndown or not.","kind":"class","name":"IsoTriangle","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":48,"description":"The width of the iso triangle in pixels. The left and right faces will be exactly half this value.","name":"size"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of the iso triangle. The left and right faces will be this tall. The overall height of the iso triangle will be this value plus half the `size` value.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is the iso triangle upside down?","name":"reversed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xeeeeee","description":"The fill color of the top face of the iso triangle.","name":"fillTop"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x999999","description":"The fill color of the left face of the iso triangle.","name":"fillLeft"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xcccccc","description":"The fill color of the right face of the iso triangle.","name":"fillRight"}],"scope":"static","longname":"Phaser.GameObjects.IsoTriangle","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"The projection level of the iso box. Change this to change the 'angle' at which you are looking at the box.","name":"projection","type":{"names":["integer"]},"defaultvalue":"4","since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#projection","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"The color used to fill in the top of the iso triangle. This is only used if the triangle is reversed.","name":"fillTop","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#fillTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"The color used to fill in the left-facing side of the iso triangle.","name":"fillLeft","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#fillLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"The color used to fill in the right-facing side of the iso triangle.","name":"fillRight","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#fillRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Controls if the top-face of the iso triangle be rendered.","name":"showTop","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#showTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Controls if the left-face of the iso triangle be rendered.","name":"showLeft","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#showLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Controls if the right-face of the iso triangle be rendered.","name":"showRight","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#showRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Sets if the iso triangle will be rendered upside down or not.","name":"isReversed","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#isReversed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Sets the projection level of the iso triangle. Change this to change the 'angle' at which you are looking at the pyramid.\nThis call can be chained.","kind":"function","name":"setProjection","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The value to set the projection to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setProjection","scope":"instance","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Sets if the iso triangle will be rendered upside down or not.\nThis call can be chained.","kind":"function","name":"setReversed","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Sets if the iso triangle will be rendered upside down or not.","name":"reversed"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setReversed","scope":"instance","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Sets which faces of the iso triangle will be rendered.\nThis call can be chained.","kind":"function","name":"setFaces","since":"3.13.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Show the top-face of the iso triangle (only if `reversed` is true)","name":"showTop"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Show the left-face of the iso triangle.","name":"showLeft"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Show the right-face of the iso triangle.","name":"showRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setFaces","scope":"instance","___s":true},{"meta":{"filename":"IsoTriangle.js","lineno":214,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Sets the fill colors for each face of the iso triangle.\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill the top of the iso triangle.","name":"fillTop"},{"type":{"names":["number"]},"optional":true,"description":"The color used to fill in the left-facing side of the iso triangle.","name":"fillLeft"},{"type":{"names":["number"]},"optional":true,"description":"The color used to fill in the right-facing side of the iso triangle.","name":"fillRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setFillStyle","scope":"instance","overrides":"Phaser.GameObjects.Shape#setFillStyle","___s":true},{"meta":{"range":[180,227],"filename":"IsoTriangleCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"IsoTriangleFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"IsoTriangleFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"description":"Creates a new IsoTriangle Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the IsoTriangle Game Object has been built into Phaser.\n\nThe IsoTriangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only fill colors and cannot be stroked.\n\nAn IsoTriangle is an 'isometric' triangle. Think of it like a pyramid. Each face has a different\nfill color. You can set the color of the top, left and right faces of the triangle respectively\nYou can also choose which of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\n\nYou cannot view an IsoTriangle from under-neath, however you can change the 'angle' by setting\nthe `projection` property. The `reversed` property controls if the IsoTriangle is rendered upside\ndown or not.","kind":"function","name":"isotriangle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":48,"description":"The width of the iso triangle in pixels. The left and right faces will be exactly half this value.","name":"size"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The height of the iso triangle. The left and right faces will be this tall. The overall height of the iso triangle will be this value plus half the `size` value.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is the iso triangle upside down?","name":"reversed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xeeeeee","description":"The fill color of the top face of the iso triangle.","name":"fillTop"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x999999","description":"The fill color of the left face of the iso triangle.","name":"fillLeft"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xcccccc","description":"The fill color of the right face of the iso triangle.","name":"fillRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#isotriangle","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"IsoTriangleRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"IsoTriangleWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"Line.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Line.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"classdesc":"The Line Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only stroke colors and cannot be filled.\n\nA Line Shape allows you to draw a line between two points in your game. You can control the\nstroke color and thickness of the line. In WebGL only you can also specify a different\nthickness for the start and end of the line, allowing you to render lines that taper-off.\n\nIf you need to draw multiple lines in a sequence you may wish to use the Polygon Shape instead.\n\nBe aware that as with all Game Objects the default origin is 0.5. If you need to draw a Line\nbetween two points and want the x1/y1 values to match the x/y values, then set the origin to 0.","kind":"class","name":"Line","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the start of the line.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the start of the line.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The horizontal position of the end of the line.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the end of the line.","name":"y2"},{"type":{"names":["number"]},"optional":true,"description":"The color the line will be drawn in, i.e. 0xff0000 for red.","name":"strokeColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the line will be drawn in. You can also set the alpha of the overall Shape using its `alpha` property.","name":"strokeAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Line","___s":true},{"meta":{"filename":"Line.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"description":"The width (or thickness) of the line.\nSee the setLineWidth method for extra details on changing this on WebGL.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#lineWidth","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Shape#lineWidth","___s":true},{"meta":{"filename":"Line.js","lineno":111,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"description":"Sets the width of the line.\n\nWhen using the WebGL renderer you can have different start and end widths.\nWhen using the Canvas renderer only the `startWidth` value is used. The `endWidth` is ignored.\n\nThis call can be chained.","kind":"function","name":"setLineWidth","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The start width of the line.","name":"startWidth"},{"type":{"names":["number"]},"optional":true,"description":"The end width of the line. Only used in WebGL.","name":"endWidth"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setLineWidth","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"description":"Sets the start and end coordinates of this Line.","kind":"function","name":"setTo","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the start of the line.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the start of the line.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the end of the line.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the end of the line.","name":"y2"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Line object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setTo","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"LineCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"name":"LineStyleCanvas","longname":"LineStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"LineFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LineFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"description":"Creates a new Line Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Line Game Object has been built into Phaser.\n\nThe Line Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports only stroke colors and cannot be filled.\n\nA Line Shape allows you to draw a line between two points in your game. You can control the\nstroke color and thickness of the line. In WebGL only you can also specify a different\nthickness for the start and end of the line, allowing you to render lines that taper-off.\n\nIf you need to draw multiple lines in a sequence you may wish to use the Polygon Shape instead.","kind":"function","name":"line","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the start of the line.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the start of the line.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The horizontal position of the end of the line.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the end of the line.","name":"y2"},{"type":{"names":["number"]},"optional":true,"description":"The color the line will be drawn in, i.e. 0xff0000 for red.","name":"strokeColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the line will be drawn in. You can also set the alpha of the overall Shape using its `alpha` property.","name":"strokeAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#line","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"LineRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"LineWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,222],"filename":"Polygon.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"name":"PolygonRender","longname":"PolygonRender","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Polygon.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"classdesc":"The Polygon Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nThe Polygon Shape is created by providing a list of points, which are then used to create an\ninternal Polygon geometry object. The points can be set from a variety of formats:\n\n- A string containing paired values separated by a single space: `'40 0 40 20 100 20 100 80 40 80 40 100 0 50'`\n- An array of Point or Vector2 objects: `[new Phaser.Math.Vector2(x1, y1), ...]`\n- An array of objects with public x/y properties: `[obj1, obj2, ...]`\n- An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\n- An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\n\nBy default the `x` and `y` coordinates of this Shape refer to the center of it. However, depending\non the coordinates of the points provided, the final shape may be rendered offset from its origin.","kind":"class","name":"Polygon","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["any"]},"optional":true,"description":"The points that make up the polygon.","name":"points"},{"type":{"names":["number"]},"optional":true,"description":"The color the polygon will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the polygon will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Polygon","___s":true},{"meta":{"filename":"Polygon.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"description":"Smooths the polygon over the number of iterations specified.\nThe base polygon data will be updated and replaced with the smoothed values.\nThis call can be chained.","kind":"function","name":"smooth","since":"3.13.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The number of times to apply the polygon smoothing.","name":"iterations"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#smooth","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"PolygonCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"PolygonFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PolygonFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"description":"Creates a new Polygon Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Polygon Game Object has been built into Phaser.\n\nThe Polygon Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nThe Polygon Shape is created by providing a list of points, which are then used to create an\ninternal Polygon geometry object. The points can be set from a variety of formats:\n\n- An array of Point or Vector2 objects: `[new Phaser.Math.Vector2(x1, y1), ...]`\n- An array of objects with public x/y properties: `[obj1, obj2, ...]`\n- An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\n- An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\n\nBy default the `x` and `y` coordinates of this Shape refer to the center of it. However, depending\non the coordinates of the points provided, the final shape may be rendered offset from its origin.","kind":"function","name":"polygon","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["any"]},"optional":true,"description":"The points that make up the polygon.","name":"points"},{"type":{"names":["number"]},"optional":true,"description":"The color the polygon will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the polygon will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#polygon","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"PolygonRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"PolygonWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon"},"name":"FillPathWebGL","longname":"FillPathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"Rectangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Rectangle.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"classdesc":"The Rectangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nYou can change the size of the rectangle by changing the `width` and `height` properties.","kind":"class","name":"Rectangle","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the rectangle.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The color the rectangle will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the rectangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Rectangle","___s":true},{"meta":{"range":[180,227],"filename":"RectangleCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"RectangleFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RectangleFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"description":"Creates a new Rectangle Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Rectangle Game Object has been built into Phaser.\n\nThe Rectangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nYou can change the size of the rectangle by changing the `width` and `height` properties.","kind":"function","name":"rectangle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The height of the rectangle.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The color the rectangle will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the rectangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#rectangle","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"RectangleRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,227],"filename":"RectangleWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle"},"name":"StrokePathWebGL","longname":"StrokePathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"Star.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"name":"StarRender","longname":"StarRender","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Star.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"classdesc":"The Star Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nAs the name implies, the Star shape will display a star in your game. You can control several\naspects of it including the number of points that constitute the star. The default is 5. If\nyou change it to 4 it will render as a diamond. If you increase them, you'll get a more spiky\nstar shape.\n\nYou can also control the inner and outer radius, which is how 'long' each point of the star is.\nModify these values to create more interesting shapes.","kind":"class","name":"Star","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":5,"description":"The number of points on the star.","name":"points"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The inner radius of the star.","name":"innerRadius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The outer radius of the star.","name":"outerRadius"},{"type":{"names":["number"]},"optional":true,"description":"The color the star will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the star will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Star","___s":true},{"meta":{"filename":"Star.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"Sets the number of points that make up the Star shape.\nThis call can be chained.","kind":"function","name":"setPoints","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The amount of points the Star will have.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setPoints","scope":"instance","___s":true},{"meta":{"filename":"Star.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"Sets the inner radius of the Star shape.\nThis call can be chained.","kind":"function","name":"setInnerRadius","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The amount to set the inner radius to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setInnerRadius","scope":"instance","___s":true},{"meta":{"filename":"Star.js","lineno":145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"Sets the outer radius of the Star shape.\nThis call can be chained.","kind":"function","name":"setOuterRadius","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The amount to set the outer radius to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setOuterRadius","scope":"instance","___s":true},{"meta":{"filename":"Star.js","lineno":163,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"The number of points that make up the Star shape.","name":"points","type":{"names":["integer"]},"defaultvalue":"5","since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#points","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Star.js","lineno":187,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"The inner radius of the Star shape.","name":"innerRadius","type":{"names":["number"]},"defaultvalue":"32","since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#innerRadius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Star.js","lineno":211,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"The outer radius of the Star shape.","name":"outerRadius","type":{"names":["number"]},"defaultvalue":"64","since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#outerRadius","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,227],"filename":"StarCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,204],"filename":"StarFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"name":"Star","longname":"Star","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"StarFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"description":"Creates a new Star Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Star Game Object has been built into Phaser.\n\nThe Star Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nAs the name implies, the Star shape will display a star in your game. You can control several\naspects of it including the number of points that constitute the star. The default is 5. If\nyou change it to 4 it will render as a diamond. If you increase them, you'll get a more spiky\nstar shape.\n\nYou can also control the inner and outer radius, which is how 'long' each point of the star is.\nModify these values to create more interesting shapes.","kind":"function","name":"star","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":5,"description":"The number of points on the star.","name":"points"},{"type":{"names":["number"]},"optional":true,"defaultvalue":32,"description":"The inner radius of the star.","name":"innerRadius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The outer radius of the star.","name":"outerRadius"},{"type":{"names":["number"]},"optional":true,"description":"The color the star will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the star will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#star","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"StarRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"StarWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star"},"name":"FillPathWebGL","longname":"FillPathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,219],"filename":"Triangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Triangle.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"classdesc":"The Triangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nThe Triangle consists of 3 lines, joining up to form a triangular shape. You can control the\nposition of each point of these lines. The triangle is always closed and cannot have an open\nface. If you require that, consider using a Polygon instead.","kind":"class","name":"Triangle","augments":["Phaser.GameObjects.Shape"],"memberof":"Phaser.GameObjects","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the first point in the triangle.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The vertical position of the first point in the triangle.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The horizontal position of the second point in the triangle.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the second point in the triangle.","name":"y2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The horizontal position of the third point in the triangle.","name":"x3"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The vertical position of the third point in the triangle.","name":"y3"},{"type":{"names":["number"]},"optional":true,"description":"The color the triangle will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the triangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"scope":"static","longname":"Phaser.GameObjects.Triangle","___s":true},{"meta":{"filename":"Triangle.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"description":"Sets the data for the lines that make up this Triangle shape.","kind":"function","name":"setTo","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the first point in the triangle.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the first point in the triangle.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the second point in the triangle.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the second point in the triangle.","name":"y2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the third point in the triangle.","name":"x3"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the third point in the triangle.","name":"y3"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setTo","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"TriangleCanvasRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"name":"FillStyleCanvas","longname":"FillStyleCanvas","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,234],"filename":"TriangleFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TriangleFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"description":"Creates a new Triangle Shape Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Triangle Game Object has been built into Phaser.\n\nThe Triangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\ntreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\nit for input or physics. It provides a quick and easy way for you to render this shape in your\ngame without using a texture, while still taking advantage of being fully batched in WebGL.\n\nThis shape supports both fill and stroke colors.\n\nThe Triangle consists of 3 lines, joining up to form a triangular shape. You can control the\nposition of each point of these lines. The triangle is always closed and cannot have an open\nface. If you require that, consider using a Polygon instead.","kind":"function","name":"triangle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the first point in the triangle.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The vertical position of the first point in the triangle.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The horizontal position of the second point in the triangle.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the second point in the triangle.","name":"y2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The horizontal position of the third point in the triangle.","name":"x3"},{"type":{"names":["number"]},"optional":true,"defaultvalue":128,"description":"The vertical position of the third point in the triangle.","name":"y3"},{"type":{"names":["number"]},"optional":true,"description":"The color the triangle will be filled with, i.e. 0xff0000 for red.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The alpha the triangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.","name":"fillAlpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#triangle","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"TriangleRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,227],"filename":"TriangleWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle"},"name":"StrokePathWebGL","longname":"StrokePathWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"Sprite.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Sprite.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"classdesc":"A Sprite Game Object.\n\nA Sprite Game Object is used for the display of both static and animated images in your game.\nSprites can have input events and physics bodies. They can also be tweened, tinted, scrolled\nand animated.\n\nThe main difference between a Sprite and an Image Game Object is that you cannot animate Images.\nAs such, Sprites take a fraction longer to process and have a larger API footprint due to the Animation\nComponent. If you do not require animation then you can safely use Images to replace Sprites in all cases.","kind":"class","name":"Sprite","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.TextureCrop","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.GameObjects.Sprite","___s":true},{"meta":{"filename":"Sprite.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"The Animation Controller of this Sprite.","name":"anims","type":{"names":["Phaser.GameObjects.Components.Animation"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#anims","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Sprite.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Start playing the given animation.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If an animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#play","scope":"instance","___s":true},{"meta":{"filename":"Sprite.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Build a JSON representation of this Sprite.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#toJSON","scope":"instance","overrides":"Phaser.GameObjects.GameObject#toJSON","___s":true},{"meta":{"range":[180,227],"filename":"SpriteCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SpriteCreator.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Creates a new Sprite Game Object and returns it.\n\nNote: This method will only be available if the Sprite Game Object has been built into Phaser.","kind":"function","name":"sprite","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Sprite.SpriteConfig"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#sprite","scope":"instance","___s":true},{"meta":{"range":[180,231],"filename":"SpriteFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SpriteFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Creates a new Sprite Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Sprite Game Object has been built into Phaser.","kind":"function","name":"sprite","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#sprite","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"SpriteRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SpriteConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/typedefs"},"kind":"typedef","name":"SpriteConfig","type":{"names":["object"]},"augments":["Phaser.Types.GameObjects.GameObjectConfig"],"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["number","string"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"memberof":"Phaser.Types.GameObjects.Sprite","longname":"Phaser.Types.GameObjects.Sprite.SpriteConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/typedefs"},"kind":"namespace","name":"Sprite","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.Sprite","scope":"static","___s":true},{"meta":{"filename":"GetTextSize.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Returns an object containing dimensions of the Text object.","kind":"function","name":"GetTextSize","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The Text object to calculate the size from.","name":"text"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextMetrics"]},"description":"The Text metrics to use when calculating the size.","name":"size"},{"type":{"names":["array"]},"description":"The lines of text to calculate the size from.","name":"lines"}],"returns":[{"type":{"names":["object"]},"description":"An object containing dimensions of the Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text.GetTextSize","scope":"static","___s":true},{"meta":{"range":[180,235],"filename":"MeasureText.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MeasureText.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Calculates the ascent, descent and fontSize of a given font style.","kind":"function","name":"MeasureText","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.TextStyle"]},"description":"The TextStyle object to measure.","name":"textStyle"}],"returns":[{"type":{"names":["Phaser.Types.GameObjects.Text.TextMetrics"]},"description":"An object containing the ascent, descent and fontSize of the TextStyle."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text.MeasureText","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"TextStyle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextStyle.js","lineno":43,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"classdesc":"A TextStyle class manages all of the style settings for a Text object.\n\nText Game Objects create a TextStyle instance automatically, which is\naccessed via the `Text.style` property. You do not normally need to\ninstantiate one yourself.","kind":"class","name":"TextStyle","memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The Text object that this TextStyle is styling.","name":"text"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextStyle"]},"description":"The style settings to set.","name":"style"}],"scope":"static","longname":"Phaser.GameObjects.TextStyle","___s":true},{"meta":{"filename":"TextStyle.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The Text object that this TextStyle is styling.","name":"parent","type":{"names":["Phaser.GameObjects.Text"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The font family.","name":"fontFamily","type":{"names":["string"]},"defaultvalue":"'Courier'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#fontFamily","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The font size.","name":"fontSize","type":{"names":["string"]},"defaultvalue":"'16px'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#fontSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The font style.","name":"fontStyle","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#fontStyle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The background color.","name":"backgroundColor","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#backgroundColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The text fill color.","name":"color","type":{"names":["string"]},"defaultvalue":"'#fff'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#color","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The text stroke color.","name":"stroke","type":{"names":["string"]},"defaultvalue":"'#fff'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#stroke","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The text stroke thickness.","name":"strokeThickness","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#strokeThickness","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The horizontal shadow offset.","name":"shadowOffsetX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#shadowOffsetX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The vertical shadow offset.","name":"shadowOffsetY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#shadowOffsetY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":162,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The shadow color.","name":"shadowColor","type":{"names":["string"]},"defaultvalue":"'#000'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#shadowColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":172,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The shadow blur radius.","name":"shadowBlur","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#shadowBlur","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":182,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Whether shadow stroke is enabled or not.","name":"shadowStroke","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#shadowStroke","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Whether shadow fill is enabled or not.","name":"shadowFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#shadowFill","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":202,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The text alignment.","name":"align","type":{"names":["string"]},"defaultvalue":"'left'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#align","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":212,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The maximum number of lines to draw.","name":"maxLines","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#maxLines","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":222,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The fixed width of the text.\n\n`0` means no fixed with.","name":"fixedWidth","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#fixedWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":234,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The fixed height of the text.\n\n`0` means no fixed height.","name":"fixedHeight","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#fixedHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":246,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The resolution the text is rendered to its internal canvas at.\nThe default is 0, which means it will use the resolution set in the Game Config.","name":"resolution","type":{"names":["number"]},"defaultvalue":"0","since":"3.12.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#resolution","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":257,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Whether the text should render right to left.","name":"rtl","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#rtl","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":267,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The test string to use when measuring the font.","name":"testString","type":{"names":["string"]},"defaultvalue":"'|MÉqgy'","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#testString","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":277,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The amount of horizontal padding added to the width of the text when calculating the font metrics.","name":"baselineX","type":{"names":["number"]},"defaultvalue":"1.2","since":"3.3.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#baselineX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":287,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"The amount of vertical padding added to the height of the text when calculating the font metrics.","name":"baselineY","type":{"names":["number"]},"defaultvalue":"1.4","since":"3.3.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#baselineY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextStyle.js","lineno":328,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the text style.","examples":["text.setStyle({\n fontSize: '64px',\n fontFamily: 'Arial',\n color: '#ffffff',\n align: 'center',\n backgroundColor: '#ff00ff'\n});"],"kind":"function","name":"setStyle","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Text.TextStyle"]},"description":"The style settings to set.","name":"style"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to update the text immediately.","name":"updateText"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use the default values is not set, or the local values.","name":"setDefaults"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setStyle","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":403,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Synchronize the font settings to the given Canvas Rendering Context.","kind":"function","name":"syncFont","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas Element.","name":"canvas"},{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context.","name":"context"}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#syncFont","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":417,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Synchronize the text style settings to the given Canvas Rendering Context.","kind":"function","name":"syncStyle","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas Element.","name":"canvas"},{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context.","name":"context"}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#syncStyle","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":438,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Synchronize the shadow settings to the given Canvas Rendering Context.","kind":"function","name":"syncShadow","since":"3.0.0","params":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context.","name":"context"},{"type":{"names":["boolean"]},"description":"Whether shadows are enabled or not.","name":"enabled"}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#syncShadow","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Update the style settings for the parent Text object.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether to recalculate font and text metrics.","name":"recalculateMetrics"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#update","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":487,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the font.\n\nIf a string is given, the font family is set.\n\nIf an object is given, the `fontFamily`, `fontSize` and `fontStyle`\nproperties of that object are set.","kind":"function","name":"setFont","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The font family or font settings to set.","name":"font"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to update the text immediately.","name":"updateText"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setFont","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":543,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the font family.","kind":"function","name":"setFontFamily","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The font family.","name":"family"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setFontFamily","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":565,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the font style.","kind":"function","name":"setFontStyle","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The font style.","name":"style"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setFontStyle","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the font size.","kind":"function","name":"setFontSize","since":"3.0.0","params":[{"type":{"names":["number","string"]},"description":"The font size.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setFontSize","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":614,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the test string to use when measuring the font.","kind":"function","name":"setTestString","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The test string to use when measuring the font.","name":"string"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setTestString","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":631,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set a fixed width and height for the text.\n\nPass in `0` for either of these parameters to disable fixed width or height respectively.","kind":"function","name":"setFixedSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The fixed width to set.","name":"width"},{"type":{"names":["number"]},"description":"The fixed height to set.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setFixedSize","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":662,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the background color.","kind":"function","name":"setBackgroundColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The background color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setBackgroundColor","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":679,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the text fill color.","kind":"function","name":"setFill","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text fill color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setFill","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":696,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the text fill color.","kind":"function","name":"setColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text fill color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setColor","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":713,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the resolution used by the Text object.\n\nBy default it will be set to match the resolution set in the Game Config,\nbut you can override it via this method. It allows for much clearer text on High DPI devices,\nat the cost of memory because it uses larger internal Canvas textures for the Text.\n\nPlease use with caution, as the more high res Text you have, the more memory it uses up.","kind":"function","name":"setResolution","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The resolution for this Text object to use.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setResolution","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":736,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the stroke settings.","kind":"function","name":"setStroke","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The stroke color.","name":"color"},{"type":{"names":["number"]},"description":"The stroke thickness.","name":"thickness"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setStroke","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":769,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the shadow settings.\n\nCalling this method always re-measures the parent Text object,\nso only call it when you actually change the shadow settings.","kind":"function","name":"setShadow","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal shadow offset.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical shadow offset.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#000'","description":"The shadow color.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The shadow blur radius.","name":"blur"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to stroke the shadow.","name":"shadowStroke"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to fill the shadow.","name":"shadowFill"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setShadow","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":806,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the shadow offset.","kind":"function","name":"setShadowOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal shadow offset.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical shadow offset.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setShadowOffset","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":828,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the shadow color.","kind":"function","name":"setShadowColor","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#000'","description":"The shadow color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setShadowColor","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":847,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the shadow blur radius.","kind":"function","name":"setShadowBlur","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The shadow blur radius.","name":"blur"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setShadowBlur","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":866,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Enable or disable shadow stroke.","kind":"function","name":"setShadowStroke","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether shadow stroke is enabled or not.","name":"enabled"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setShadowStroke","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":883,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Enable or disable shadow fill.","kind":"function","name":"setShadowFill","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether shadow fill is enabled or not.","name":"enabled"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setShadowFill","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":900,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the width (in pixels) to use for wrapping lines.\n\nPass in null to remove wrapping by width.","kind":"function","name":"setWordWrapWidth","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The maximum width of a line in pixels. Set to null to remove wrapping.","name":"width"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether or not to use the advanced wrapping\nalgorithm. If true, spaces are collapsed and whitespace is trimmed from lines. If false,\nspaces and whitespace are left as is.","name":"useAdvancedWrap"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setWordWrapWidth","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":925,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set a custom callback for wrapping lines.\n\nPass in null to remove wrapping by callback.","kind":"function","name":"setWordWrapCallback","since":"3.0.0","params":[{"type":{"names":["TextStyleWordWrapCallback"]},"description":"A custom function that will be responsible for wrapping the\ntext. It will receive two arguments: text (the string to wrap), textObject (this Text\ninstance). It should return the wrapped lines either as an array of lines or as a string with\nnewline characters in place to indicate where breaks should happen.","name":"callback"},{"type":{"names":["object"]},"optional":true,"defaultvalue":null,"description":"The scope that will be applied when the callback is invoked.","name":"scope"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setWordWrapCallback","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":951,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the alignment of the text in this Text object.\n\nThe argument can be one of: `left`, `right`, `center` or `justify`.\n\nAlignment only works if the Text object has more than one line of text.","kind":"function","name":"setAlign","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'left'","description":"The text alignment for multi-line text.","name":"align"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setAlign","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":974,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Set the maximum number of lines to draw.","kind":"function","name":"setMaxLines","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The maximum number of lines to draw.","name":"max"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The parent Text object."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#setMaxLines","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":993,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Get the current text metrics.","kind":"function","name":"getTextMetrics","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.Text.TextMetrics"]},"description":"The text metrics."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#getTextMetrics","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":1012,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Build a JSON representation of this Text Style.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"A JSON representation of this Text Style."}],"memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#toJSON","scope":"instance","___s":true},{"meta":{"filename":"TextStyle.js","lineno":1034,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text"},"description":"Destroy this Text Style.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.GameObjects.TextStyle","longname":"Phaser.GameObjects.TextStyle#destroy","scope":"instance","___s":true},{"meta":{"range":[180,223],"filename":"Text.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"name":"AddToDOM","longname":"AddToDOM","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Text.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"classdesc":"A Text Game Object.\n\nText objects work by creating their own internal hidden Canvas and then renders text to it using\nthe standard Canvas `fillText` API. It then creates a texture from this canvas which is rendered\nto your game during the render pass.\n\nBecause it uses the Canvas API you can take advantage of all the features this offers, such as\napplying gradient fills to the text, or strokes, shadows and more. You can also use custom fonts\nloaded externally, such as Google or TypeKit Web fonts.\n\n**Important:** If the font you wish to use has a space or digit in its name, such as\n'Press Start 2P' or 'Roboto Condensed', then you _must_ put the font name in quotes, either\nwhen creating the Text object, or when setting the font via `setFont` or `setFontFamily`. I.e.:\n\n```javascript\nthis.add.text(0, 0, 'Hello World', { fontFamily: '\"Roboto Condensed\"' });\n```\n\nEqually, if you wish to provide a list of fallback fonts, then you should ensure they are all\nquoted properly, too:\n\n```javascript\nthis.add.text(0, 0, 'Hello World', { fontFamily: 'Verdana, \"Times New Roman\", Tahoma, serif' });\n```\n\nYou can only display fonts that are currently loaded and available to the browser: therefore fonts must\nbe pre-loaded. Phaser does not do ths for you, so you will require the use of a 3rd party font loader,\nor have the fonts ready available in the CSS on the page in which your Phaser game resides.\n\nSee {@link http://www.jordanm.co.uk/tinytype this compatibility table} for the available default fonts\nacross mobile browsers.\n\nA note on performance: Every time the contents of a Text object changes, i.e. changing the text being\ndisplayed, or the style of the text, it needs to remake the Text canvas, and if on WebGL, re-upload the\nnew texture to the GPU. This can be an expensive operation if used often, or with large quantities of\nText objects in your game. If you run into performance issues you would be better off using Bitmap Text\ninstead, as it benefits from batching and avoids expensive Canvas API calls.","kind":"class","name":"Text","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Crop","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string","Array."]},"description":"The text this Text object will display.","name":"text"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextStyle"]},"description":"The text style configuration object.","name":"style"}],"scope":"static","longname":"Phaser.GameObjects.Text","___s":true},{"meta":{"filename":"Text.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The renderer in use by this Text object.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.12.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The canvas element that the text is rendered to.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":139,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The context of the canvas element that the text is rendered to.","name":"context","type":{"names":["CanvasRenderingContext2D"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The Text Style object.\n\nManages the style of this Text object.","name":"style","type":{"names":["Phaser.GameObjects.TextStyle"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#style","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Whether to automatically round line positions.","name":"autoRound","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#autoRound","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":169,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The Regular Expression that is used to split the text up into lines, in\nmulti-line text. By default this is `/(?:\\r\\n|\\r|\\n)/`.\nYou can change this RegExp to be anything else that you may need.","name":"splitRegExp","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#splitRegExp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":190,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Specify a padding value which is added to the line width and height when calculating the Text size.\nAllows you to add extra spacing if the browser is unable to accurately determine the true font dimensions.","name":"padding","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#padding","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":200,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The width of this Text object.","name":"width","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#width","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.ComputedSize#width","___s":true},{"meta":{"filename":"Text.js","lineno":210,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The height of this Text object.","name":"height","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#height","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.ComputedSize#height","___s":true},{"meta":{"filename":"Text.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The line spacing value.\nThis value is added to the font height to calculate the overall line height.\nOnly has an effect if this Text object contains multiple lines of text.\n\nIf you update this property directly, instead of using the `setLineSpacing` method, then\nbe sure to call `updateText` after, or you won't see the change reflected in the Text object.","name":"lineSpacing","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#lineSpacing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":234,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Whether the text or its settings have changed and need updating.","name":"dirty","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Initialize right to left text.","kind":"function","name":"initRTL","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#initRTL","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":329,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Greedy wrapping algorithm that will wrap words as the line grows longer than its horizontal\nbounds.","kind":"function","name":"runWordWrap","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text to perform word wrap detection against.","name":"text"}],"returns":[{"type":{"names":["string"]},"description":"The text after wrapping has been applied."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#runWordWrap","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Advanced wrapping algorithm that will wrap words as the line grows longer than its horizontal\nbounds. Consecutive spaces will be collapsed and replaced with a single space. Lines will be\ntrimmed of white space before processing. Throws an error if wordWrapWidth is less than a\nsingle character.","kind":"function","name":"advancedWordWrap","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text to perform word wrap detection against.","name":"text"},{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context.","name":"context"},{"type":{"names":["number"]},"description":"The word wrap width.","name":"wordWrapWidth"}],"returns":[{"type":{"names":["string"]},"description":"The wrapped text."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#advancedWordWrap","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Greedy wrapping algorithm that will wrap words as the line grows longer than its horizontal\nbounds. Spaces are not collapsed and whitespace is not trimmed.","kind":"function","name":"basicWordWrap","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text to perform word wrap detection against.","name":"text"},{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context.","name":"context"},{"type":{"names":["number"]},"description":"The word wrap width.","name":"wordWrapWidth"}],"returns":[{"type":{"names":["string"]},"description":"The wrapped text."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#basicWordWrap","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":559,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Runs the given text through this Text objects word wrapping and returns the results as an\narray, where each element of the array corresponds to a wrapped line of text.","kind":"function","name":"getWrappedText","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text for which the wrapping will be calculated. If unspecified, the Text objects current text will be used.","name":"text"}],"returns":[{"type":{"names":["Array."]},"description":"An array of strings with the pieces of wrapped text."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getWrappedText","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":581,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the text to display.\n\nAn array of strings will be joined with `\\n` line breaks.","kind":"function","name":"setText","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The string, or array of strings, to be set as the content of this Text object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setText","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":615,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the text style.","examples":["text.setStyle({\n fontSize: '64px',\n fontFamily: 'Arial',\n color: '#ffffff',\n align: 'center',\n backgroundColor: '#ff00ff'\n});"],"kind":"function","name":"setStyle","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The style settings to set.","name":"style"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setStyle","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":639,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the font.\n\nIf a string is given, the font family is set.\n\nIf an object is given, the `fontFamily`, `fontSize` and `fontStyle`\nproperties of that object are set.\n\n**Important:** If the font you wish to use has a space or digit in its name, such as\n'Press Start 2P' or 'Roboto Condensed', then you _must_ put the font name in quotes:\n\n```javascript\nText.setFont('\"Roboto Condensed\"');\n```\n\nEqually, if you wish to provide a list of fallback fonts, then you should ensure they are all\nquoted properly, too:\n\n```javascript\nText.setFont('Verdana, \"Times New Roman\", Tahoma, serif');\n```","kind":"function","name":"setFont","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The font family or font settings to set.","name":"font"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFont","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":673,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the font family.\n\n**Important:** If the font you wish to use has a space or digit in its name, such as\n'Press Start 2P' or 'Roboto Condensed', then you _must_ put the font name in quotes:\n\n```javascript\nText.setFont('\"Roboto Condensed\"');\n```\n\nEqually, if you wish to provide a list of fallback fonts, then you should ensure they are all\nquoted properly, too:\n\n```javascript\nText.setFont('Verdana, \"Times New Roman\", Tahoma, serif');\n```","kind":"function","name":"setFontFamily","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The font family.","name":"family"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFontFamily","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":702,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the font size.","kind":"function","name":"setFontSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The font size.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFontSize","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the font style.","kind":"function","name":"setFontStyle","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The font style.","name":"style"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFontStyle","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":732,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set a fixed width and height for the text.\n\nPass in `0` for either of these parameters to disable fixed width or height respectively.","kind":"function","name":"setFixedSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The fixed width to set. `0` disables fixed width.","name":"width"},{"type":{"names":["number"]},"description":"The fixed height to set. `0` disables fixed height.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFixedSize","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":750,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the background color.","kind":"function","name":"setBackgroundColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The background color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setBackgroundColor","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":765,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the fill style to be used by the Text object.\n\nThis can be any valid CanvasRenderingContext2D fillStyle value, such as\na color (in hex, rgb, rgba, hsl or named values), a gradient or a pattern.\n\nSee the [MDN fillStyle docs](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/fillStyle) for more details.","kind":"function","name":"setFill","since":"3.0.0","params":[{"type":{"names":["string","any"]},"description":"The text fill style. Can be any valid CanvasRenderingContext `fillStyle` value.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFill","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":785,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the text fill color.","kind":"function","name":"setColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The text fill color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setColor","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":800,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the stroke settings.","kind":"function","name":"setStroke","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The stroke color.","name":"color"},{"type":{"names":["number"]},"description":"The stroke thickness.","name":"thickness"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setStroke","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":816,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the shadow settings.","kind":"function","name":"setShadow","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal shadow offset.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical shadow offset.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#000'","description":"The shadow color.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The shadow blur radius.","name":"blur"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to stroke the shadow.","name":"shadowStroke"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to fill the shadow.","name":"shadowFill"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setShadow","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":836,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the shadow offset.","kind":"function","name":"setShadowOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal shadow offset.","name":"x"},{"type":{"names":["number"]},"description":"The vertical shadow offset.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setShadowOffset","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":852,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the shadow color.","kind":"function","name":"setShadowColor","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The shadow color.","name":"color"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setShadowColor","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":867,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the shadow blur radius.","kind":"function","name":"setShadowBlur","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The shadow blur radius.","name":"blur"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setShadowBlur","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":882,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Enable or disable shadow stroke.","kind":"function","name":"setShadowStroke","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether shadow stroke is enabled or not.","name":"enabled"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setShadowStroke","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":897,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Enable or disable shadow fill.","kind":"function","name":"setShadowFill","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether shadow fill is enabled or not.","name":"enabled"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setShadowFill","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":912,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the width (in pixels) to use for wrapping lines. Pass in null to remove wrapping by width.","kind":"function","name":"setWordWrapWidth","since":"3.0.0","params":[{"type":{"names":["number"]},"nullable":true,"description":"The maximum width of a line in pixels. Set to null to remove wrapping.","name":"width"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether or not to use the advanced wrapping\nalgorithm. If true, spaces are collapsed and whitespace is trimmed from lines. If false,\nspaces and whitespace are left as is.","name":"useAdvancedWrap"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setWordWrapWidth","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":930,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set a custom callback for wrapping lines. Pass in null to remove wrapping by callback.","kind":"function","name":"setWordWrapCallback","since":"3.0.0","params":[{"type":{"names":["TextStyleWordWrapCallback"]},"description":"A custom function that will be responsible for wrapping the\ntext. It will receive two arguments: text (the string to wrap), textObject (this Text\ninstance). It should return the wrapped lines either as an array of lines or as a string with\nnewline characters in place to indicate where breaks should happen.","name":"callback"},{"type":{"names":["object"]},"optional":true,"defaultvalue":null,"description":"The scope that will be applied when the callback is invoked.","name":"scope"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setWordWrapCallback","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":949,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the alignment of the text in this Text object.\n\nThe argument can be one of: `left`, `right`, `center` or `justify`.\n\nAlignment only works if the Text object has more than one line of text.","kind":"function","name":"setAlign","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'left'","description":"The text alignment for multi-line text.","name":"align"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setAlign","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":968,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the resolution used by this Text object.\n\nBy default it will be set to match the resolution set in the Game Config,\nbut you can override it via this method, or by specifying it in the Text style configuration object.\n\nIt allows for much clearer text on High DPI devices, at the cost of memory because it uses larger\ninternal Canvas textures for the Text.\n\nTherefore, please use with caution, as the more high res Text you have, the more memory it uses.","kind":"function","name":"setResolution","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The resolution for this Text object to use.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setResolution","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":991,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Sets the line spacing value.\n\nThis value is _added_ to the height of the font when calculating the overall line height.\nThis only has an effect if this Text object consists of multiple lines of text.","kind":"function","name":"setLineSpacing","since":"3.13.0","params":[{"type":{"names":["number"]},"description":"The amount to add to the font height to achieve the overall line height.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setLineSpacing","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":1011,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the text padding.\n\n'left' can be an object.\n\nIf only 'left' and 'top' are given they are treated as 'x' and 'y'.","kind":"function","name":"setPadding","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Types.GameObjects.Text.TextPadding"]},"description":"The left padding value, or a padding config object.","name":"left"},{"type":{"names":["number"]},"description":"The top padding value.","name":"top"},{"type":{"names":["number"]},"description":"The right padding value.","name":"right"},{"type":{"names":["number"]},"description":"The bottom padding value.","name":"bottom"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setPadding","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":1077,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Set the maximum number of lines to draw.","kind":"function","name":"setMaxLines","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The maximum number of lines to draw.","name":"max"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setMaxLines","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":1092,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Update the displayed text.","kind":"function","name":"updateText","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#updateText","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":1293,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Get the current text metrics.","kind":"function","name":"getTextMetrics","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"The text metrics."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getTextMetrics","scope":"instance","___s":true},{"meta":{"filename":"Text.js","lineno":1306,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"The text string being rendered by this Text Game Object.","name":"text","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#text","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Text.js","lineno":1327,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Build a JSON representation of the Text object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Text object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#toJSON","scope":"instance","overrides":"Phaser.GameObjects.GameObject#toJSON","___s":true},{"meta":{"range":[180,230],"filename":"TextCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Creates a new Text Game Object and returns it.\n\nNote: This method will only be available if the Text Game Object has been built into Phaser.","kind":"function","name":"text","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#text","scope":"instance","___s":true},{"meta":{"range":[180,204],"filename":"TextFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"name":"Text","longname":"Text","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"description":"Creates a new Text Game Object and adds it to the Scene.\n\nA Text Game Object.\n\nText objects work by creating their own internal hidden Canvas and then renders text to it using\nthe standard Canvas `fillText` API. It then creates a texture from this canvas which is rendered\nto your game during the render pass.\n\nBecause it uses the Canvas API you can take advantage of all the features this offers, such as\napplying gradient fills to the text, or strokes, shadows and more. You can also use custom fonts\nloaded externally, such as Google or TypeKit Web fonts.\n\nYou can only display fonts that are currently loaded and available to the browser: therefore fonts must\nbe pre-loaded. Phaser does not do ths for you, so you will require the use of a 3rd party font loader,\nor have the fonts ready available in the CSS on the page in which your Phaser game resides.\n\nSee {@link http://www.jordanm.co.uk/tinytype this compatibility table} for the available default fonts\nacross mobile browsers.\n\nA note on performance: Every time the contents of a Text object changes, i.e. changing the text being\ndisplayed, or the style of the text, it needs to remake the Text canvas, and if on WebGL, re-upload the\nnew texture to the GPU. This can be an expensive operation if used often, or with large quantities of\nText objects in your game. If you run into performance issues you would be better off using Bitmap Text\ninstead, as it benefits from batching and avoids expensive Canvas API calls.\n\nNote: This method will only be available if the Text Game Object has been built into Phaser.","kind":"function","name":"text","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string","Array."]},"description":"The text this Text object will display.","name":"text"},{"type":{"names":["object"]},"optional":true,"description":"The Text style configuration object.","name":"style"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#text","scope":"instance","___s":true},{"meta":{"range":[180,224],"filename":"TextRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"TextWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextMetrics.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"description":"Font metrics for a Text Style object.","kind":"typedef","name":"TextMetrics","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The ascent of the font.","name":"ascent"},{"type":{"names":["number"]},"description":"The descent of the font.","name":"descent"},{"type":{"names":["number"]},"description":"The size of the font.","name":"fontSize"}],"memberof":"Phaser.Types.GameObjects.Text","longname":"Phaser.Types.GameObjects.Text.TextMetrics","scope":"static","___s":true},{"meta":{"filename":"TextPadding.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"description":"A Text Padding configuration object as used by the Text Style.","kind":"typedef","name":"TextPadding","type":{"names":["object"]},"since":"3.18.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"If set this value is used for both the left and right padding.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"If set this value is used for both the top and bottom padding.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The amount of padding added to the left of the Text object.","name":"left"},{"type":{"names":["number"]},"optional":true,"description":"The amount of padding added to the right of the Text object.","name":"right"},{"type":{"names":["number"]},"optional":true,"description":"The amount of padding added to the top of the Text object.","name":"top"},{"type":{"names":["number"]},"optional":true,"description":"The amount of padding added to the bottom of the Text object.","name":"bottom"}],"memberof":"Phaser.Types.GameObjects.Text","longname":"Phaser.Types.GameObjects.Text.TextPadding","scope":"static","___s":true},{"meta":{"filename":"TextShadow.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"description":"A Text Shadow configuration object as used by the Text Style.","kind":"typedef","name":"TextShadow","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal offset of the shadow.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical offset of the shadow.","name":"offsetY"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#000'","description":"The color of the shadow, given as a CSS string value.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The amount of blur applied to the shadow. Leave as zero for a hard shadow.","name":"blur"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Apply the shadow to the stroke effect on the Text object?","name":"stroke"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Apply the shadow to the fill effect on the Text object?","name":"fill"}],"memberof":"Phaser.Types.GameObjects.Text","longname":"Phaser.Types.GameObjects.Text.TextShadow","scope":"static","___s":true},{"meta":{"filename":"TextStyle.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"description":"A Text Style configuration object as used by the Text Game Object.","kind":"typedef","name":"TextStyle","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'Courier'","description":"The font the Text object will render with. This is a Canvas style font string.","name":"fontFamily"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'16px'","description":"The font size, as a CSS size string.","name":"fontSize"},{"type":{"names":["string"]},"optional":true,"description":"Any addition font styles, such as 'strong'.","name":"fontStyle"},{"type":{"names":["string"]},"optional":true,"description":"A solid fill color that is rendered behind the Text object. Given as a CSS string color such as `#ff0`.","name":"backgroundColor"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#fff'","description":"The color the Text is drawn in. Given as a CSS string color such as `#fff` or `rgb()`.","name":"color"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'#fff'","description":"The color used to stroke the Text if the `strokeThickness` property is greater than zero.","name":"stroke"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The thickness of the stroke around the Text. Set to zero for no stroke.","name":"strokeThickness"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextShadow"]},"optional":true,"description":"The Text shadow configuration object.","name":"shadow"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextPadding"]},"optional":true,"description":"A Text Padding object.","name":"padding"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'left'","description":"The alignment of the Text. This only impacts multi-line text. Either `left`, `right`, `center` or `justify`.","name":"align"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The maximum number of lines to display within the Text object.","name":"maxLines"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Force the Text object to have the exact width specified in this property. Leave as zero for it to change accordingly to content.","name":"fixedWidth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Force the Text object to have the exact height specified in this property. Leave as zero for it to change accordingly to content.","name":"fixedHeight"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets the resolution (DPI setting) of the Text object. Leave at zero for it to use the game resolution.","name":"resolution"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Set to `true` if this Text object should render from right-to-left.","name":"rtl"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'|MÉqgy'","description":"This is the string used to aid Canvas in calculating the height of the font.","name":"testString"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1.2,"description":"The amount of horizontal padding added to the width of the text when calculating the font metrics.","name":"baselineX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1.4,"description":"The amount of vertical padding added to the height of the text when calculating the font metrics.","name":"baselineY"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextWordWrap"]},"optional":true,"description":"The Text Word wrap configuration object.","name":"wordWrap"},{"type":{"names":["Phaser.Types.GameObjects.Text.TextMetrics"]},"optional":true,"description":"A Text Metrics object. Use this to avoid expensive font size calculations in text heavy games.","name":"metrics"}],"memberof":"Phaser.Types.GameObjects.Text","longname":"Phaser.Types.GameObjects.Text.TextStyle","scope":"static","___s":true},{"meta":{"filename":"TextWordWrap.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"description":"A Text Word Wrap configuration object as used by the Text Style configuration.","kind":"typedef","name":"TextWordWrap","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"The width at which text should be considered for word-wrapping.","name":"width"},{"type":{"names":["TextStyleWordWrapCallback"]},"optional":true,"description":"Provide a custom callback when word wrapping is enabled.","name":"callback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the word wrap callback is invoked.","name":"callbackScope"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use basic or advanced word wrapping?","name":"useAdvancedWrap"}],"memberof":"Phaser.Types.GameObjects.Text","longname":"Phaser.Types.GameObjects.Text.TextWordWrap","scope":"static","___s":true},{"meta":{"filename":"TextWordWrap.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"description":"A custom function that will be responsible for wrapping the text.","kind":"typedef","name":"TextStyleWordWrapCallback","type":{"names":["function"]},"params":[{"type":{"names":["string"]},"description":"The string to wrap.","name":"text"},{"type":{"names":["Phaser.GameObjects.Text"]},"description":"The Text instance.","name":"textObject"}],"returns":[{"type":{"names":["string","Array."]},"description":"Should return the wrapped lines either as an array of lines or as a string with\nnewline characters in place to indicate where breaks should happen."}],"longname":"TextStyleWordWrapCallback","scope":"global","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs"},"kind":"namespace","name":"Text","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.Text","scope":"static","___s":true},{"meta":{"range":[180,235],"filename":"TileSprite.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TileSprite.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"classdesc":"A TileSprite is a Sprite that has a repeating texture.\n\nThe texture can be scrolled and scaled independently of the TileSprite itself. Textures will automatically wrap and\nare designed so that you can create game backdrops using seamless textures as a source.\n\nYou shouldn't ever create a TileSprite any larger than your actual canvas size. If you want to create a large repeating background\nthat scrolls across the whole map of your game, then you create a TileSprite that fits the canvas size and then use the `tilePosition`\nproperty to scroll the texture as the player moves. If you create a TileSprite that is thousands of pixels in size then it will \nconsume huge amounts of memory and cause performance issues. Remember: use `tilePosition` to scroll your texture and `tileScale` to\nadjust the scale of the texture - don't resize the sprite itself or make it larger than it needs.\n\nAn important note about Tile Sprites and NPOT textures: Internally, TileSprite textures use GL_REPEAT to provide\nseamless repeating of the textures. This, combined with the way in which the textures are handled in WebGL, means\nthey need to be POT (power-of-two) sizes in order to wrap. If you provide a NPOT (non power-of-two) texture to a\nTileSprite it will generate a POT sized canvas and draw your texture to it, scaled up to the POT size. It's then\nscaled back down again during rendering to the original dimensions. While this works, in that it allows you to use\nany size texture for a Tile Sprite, it does mean that NPOT textures are going to appear anti-aliased when rendered,\ndue to the interpolation that took place when it was resized into a POT texture. This is especially visible in\npixel art graphics. If you notice it and it becomes an issue, the only way to avoid it is to ensure that you\nprovide POT textures for Tile Sprites.","kind":"class","name":"TileSprite","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Crop","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the Game Object. If zero it will use the size of the texture frame.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the Game Object. If zero it will use the size of the texture frame.","name":"height"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"textureKey"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frameKey"}],"scope":"static","longname":"Phaser.GameObjects.TileSprite","___s":true},{"meta":{"filename":"TileSprite.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Whether the Tile Sprite has changed in some way, requiring an re-render of its tile texture.\n\nSuch changes include the texture frame and scroll position of the Tile Sprite.","name":"dirty","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The renderer in use by this Tile Sprite.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The Canvas element that the TileSprite renders its fill pattern in to.\nOnly used in Canvas mode.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"nullable":true,"since":"3.12.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The Context of the Canvas element that the TileSprite renders its fill pattern in to.\nOnly used in Canvas mode.","name":"context","type":{"names":["CanvasRenderingContext2D"]},"since":"3.12.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":207,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#texture","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Crop#texture","___s":true},{"meta":{"filename":"TileSprite.js","lineno":216,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#frame","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Crop#frame","___s":true},{"meta":{"filename":"TileSprite.js","lineno":225,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The next power of two value from the width of the Fill Pattern frame.","name":"potWidth","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#potWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":234,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The next power of two value from the height of the Fill Pattern frame.","name":"potHeight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#potHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":243,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The Canvas that the TileSprites texture is rendered to.\nThis is used to create a WebGL texture from.","name":"fillCanvas","type":{"names":["HTMLCanvasElement"]},"since":"3.12.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#fillCanvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":253,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The Canvas Context used to render the TileSprites texture.","name":"fillContext","type":{"names":["CanvasRenderingContext2D"]},"since":"3.12.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#fillContext","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":262,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The texture that the Tile Sprite is rendered to, which is then rendered to a Scene.\nIn WebGL this is a WebGLTexture. In Canvas it's a Canvas Fill Pattern.","name":"fillPattern","type":{"names":["WebGLTexture","CanvasPattern"]},"nullable":true,"since":"3.12.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#fillPattern","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":289,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setTexture","scope":"instance","___s":true},{"meta":{"filename":"TileSprite.js","lineno":309,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setFrame","scope":"instance","___s":true},{"meta":{"filename":"TileSprite.js","lineno":351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Sets {@link Phaser.GameObjects.TileSprite#tilePositionX} and {@link Phaser.GameObjects.TileSprite#tilePositionY}.","kind":"function","name":"setTilePosition","since":"3.3.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x position of this sprite's tiling texture.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y position of this sprite's tiling texture.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Tile Sprite instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setTilePosition","scope":"instance","___s":true},{"meta":{"filename":"TileSprite.js","lineno":377,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Sets {@link Phaser.GameObjects.TileSprite#tileScaleX} and {@link Phaser.GameObjects.TileSprite#tileScaleY}.","kind":"function","name":"setTileScale","since":"3.12.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The horizontal scale of the tiling texture. If not given it will use the current `tileScaleX` value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of the tiling texture. If not given it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Tile Sprite instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setTileScale","scope":"instance","___s":true},{"meta":{"filename":"TileSprite.js","lineno":552,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The horizontal scroll position of the Tile Sprite.","name":"tilePositionX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tilePositionX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":575,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The vertical scroll position of the Tile Sprite.","name":"tilePositionY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tilePositionY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":598,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The horizontal scale of the Tile Sprite texture.","name":"tileScaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.11.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tileScaleX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TileSprite.js","lineno":621,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"The vertical scale of the Tile Sprite texture.","name":"tileScaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.11.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tileScaleY","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,227],"filename":"TileSpriteCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TileSpriteCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Creates a new TileSprite Game Object and returns it.\n\nNote: This method will only be available if the TileSprite Game Object has been built into Phaser.","kind":"function","name":"tileSprite","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.TileSprite.TileSpriteConfig"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#tileSprite","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"TileSpriteFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"name":"TileSprite","longname":"TileSprite","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TileSpriteFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"description":"Creates a new TileSprite Game Object and adds it to the Scene.\n\nNote: This method will only be available if the TileSprite Game Object has been built into Phaser.","kind":"function","name":"tileSprite","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the Game Object. If zero it will use the size of the texture frame.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the Game Object. If zero it will use the size of the texture frame.","name":"height"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#tileSprite","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"TileSpriteRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"TileSpriteWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TileSpriteConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/typedefs"},"kind":"typedef","name":"TileSpriteConfig","type":{"names":["object"]},"augments":["Phaser.Types.GameObjects.GameObjectConfig"],"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the Tile Sprite.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the Tile Sprite.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":512,"description":"The width of the Tile Sprite. If zero it will use the size of the texture frame.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":512,"description":"The height of the Tile Sprite. If zero it will use the size of the texture frame.","name":"height"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The key of the Texture this Tile Sprite will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"An optional frame from the Texture this Tile Sprite is rendering with.","name":"frame"}],"memberof":"Phaser.Types.GameObjects.TileSprite","longname":"Phaser.Types.GameObjects.TileSprite.TileSpriteConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/typedefs"},"kind":"namespace","name":"TileSprite","memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.TileSprite","scope":"static","___s":true},{"meta":{"filename":"GameObjectConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/typedefs"},"kind":"typedef","name":"GameObjectConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the Game Object.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The depth of the GameObject.","name":"depth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The horizontally flipped state of the Game Object.","name":"flipX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The vertically flipped state of the Game Object.","name":"flipY"},{"type":{"names":["number","object"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"The scale of the GameObject.","name":"scale"},{"type":{"names":["number","object"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"The scroll factor of the GameObject.","name":"scrollFactor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation angle of the Game Object, in radians.","name":"rotation"},{"type":{"names":["number"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"The rotation angle of the Game Object, in degrees.","name":"angle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha (opacity) of the Game Object.","name":"alpha"},{"type":{"names":["number","object"]},"optional":true,"nullable":true,"defaultvalue":null,"description":"The origin of the Game Object.","name":"origin"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"ScaleModes.DEFAULT","description":"The scale mode of the GameObject.","name":"scaleMode"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"BlendModes.DEFAULT","description":"The blend mode of the GameObject.","name":"blendMode"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The visible state of the Game Object.","name":"visible"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Add the GameObject to the scene.","name":"add"}],"memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.GameObjectConfig","scope":"static","___s":true},{"meta":{"filename":"JSONGameObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/typedefs"},"kind":"typedef","name":"JSONGameObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The name of this Game Object.","name":"name"},{"type":{"names":["string"]},"description":"A textual representation of this Game Object, i.e. `sprite`.","name":"type"},{"type":{"names":["number"]},"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"description":"The y position of this Game Object.","name":"y"},{"type":{"names":["object"]},"description":"The scale of this Game Object","name":"scale"},{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"scale.x"},{"type":{"names":["number"]},"description":"The vertical scale of this Game Object.","name":"scale.y"},{"type":{"names":["object"]},"description":"The origin of this Game Object.","name":"origin"},{"type":{"names":["number"]},"description":"The horizontal origin of this Game Object.","name":"origin.x"},{"type":{"names":["number"]},"description":"The vertical origin of this Game Object.","name":"origin.y"},{"type":{"names":["boolean"]},"description":"The horizontally flipped state of the Game Object.","name":"flipX"},{"type":{"names":["boolean"]},"description":"The vertically flipped state of the Game Object.","name":"flipY"},{"type":{"names":["number"]},"description":"The angle of this Game Object in radians.","name":"rotation"},{"type":{"names":["number"]},"description":"The alpha value of the Game Object.","name":"alpha"},{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"visible"},{"type":{"names":["integer"]},"description":"The Scale Mode being used by this Game Object.","name":"scaleMode"},{"type":{"names":["integer","string"]},"description":"Sets the Blend Mode being used by this Game Object.","name":"blendMode"},{"type":{"names":["string"]},"description":"The texture key of this Game Object.","name":"textureKey"},{"type":{"names":["string"]},"description":"The frame key of this Game Object.","name":"frameKey"},{"type":{"names":["object"]},"description":"The data of this Game Object.","name":"data"}],"memberof":"Phaser.Types.GameObjects","longname":"Phaser.Types.GameObjects.JSONGameObject","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/typedefs"},"kind":"namespace","name":"GameObjects","memberof":"Phaser.Types","longname":"Phaser.Types.GameObjects","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Video.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Video.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"classdesc":"A Video Game Object.\n\nThis Game Object is capable of handling playback of a previously loaded video from the Phaser Video Cache,\nor playing a video based on a given URL. Videos can be either local, or streamed.\n\n```javascript\npreload () {\n this.load.video('pixar', 'nemo.mp4');\n}\n\ncreate () {\n this.add.video(400, 300, 'pixar');\n}\n```\n\nTo all intents and purposes, a video is a standard Game Object, just like a Sprite. And as such, you can do\nall the usual things to it, such as scaling, rotating, cropping, tinting, making interactive, giving a\nphysics body, etc.\n\nTransparent videos are also possible via the WebM file format. Providing the video file has was encoded with\nan alpha channel, and providing the browser supports WebM playback (not all of them do), then it will render\nin-game with full transparency.\n\n### Autoplaying Videos\n\nVideos can only autoplay if the browser has been unlocked with an interaction, or satisfies the MEI settings.\nThe policies that control autoplaying are vast and vary between browser.\nYou can, ahd should, read more about it here: https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide\n\nIf your video doesn't contain any audio, then set the `noAudio` parameter to `true` when the video is _loaded_,\nand it will often allow the video to play immediately:\n\n```javascript\npreload () {\n this.load.video('pixar', 'nemo.mp4', 'loadeddata', false, true);\n}\n```\n\nThe 5th parameter in the load call tells Phaser that the video doesn't contain any audio tracks. Video without\naudio can autoplay without requiring a user interaction. Video with audio cannot do this unless it satisfies\nthe browsers MEI settings. See the MDN Autoplay Guide for further details.\n\nNote that due to a bug in IE11 you cannot play a video texture to a Sprite in WebGL. For IE11 force Canvas mode.\n\nMore details about video playback and the supported media formats can be found on MDN:\n\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement\nhttps://developer.mozilla.org/en-US/docs/Web/Media/Formats","kind":"class","name":"Video","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Mask","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.TextureCrop","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.20.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"description":"Optional key of the Video this Game Object will play, as stored in the Video Cache.","name":"key"}],"scope":"static","longname":"Phaser.GameObjects.Video","___s":true},{"meta":{"filename":"Video.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"A reference to the HTML Video Element this Video Game Object is playing.\nWill be `null` until a video is loaded for playback.","name":"video","type":{"names":["HTMLVideoElement"]},"nullable":true,"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#video","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"The Phaser Texture this Game Object is using to render the video to.\nWill be `null` until a video is loaded for playback.","name":"videoTexture","type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#videoTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":143,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"A reference to the TextureSource belong to the `videoTexture` Texture object.\nWill be `null` until a video is loaded for playback.","name":"videoTextureSource","type":{"names":["Phaser.Textures.TextureSource"]},"nullable":true,"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#videoTextureSource","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":153,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"A Phaser CanvasTexture instance that holds the most recent snapshot taken from the video.\nThis will only be set if `snapshot` or `snapshotArea` have been called, and will be `null` until that point.","name":"snapshotTexture","type":{"names":["Phaser.Textures.CanvasTexture"]},"nullable":true,"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#snapshotTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":163,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"If you have saved this video to a texture via the `saveTexture` method, this controls if the video\nis rendered with `flipY` in WebGL or not. You often need to set this if you wish to use the video texture\nas the input source for a shader. If you find your video is appearing upside down within a shader or\ncustom pipeline, flip this property.","name":"flipY","type":{"names":["boolean"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#flipY","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Video.js","lineno":185,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"An internal flag holding the current state of the video lock, should document interaction be required\nbefore playback can begin.","name":"touchLocked","type":{"names":["boolean"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#touchLocked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":195,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Should the video auto play when document interaction is required and happens?","name":"playWhenUnlocked","type":{"names":["boolean"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#playWhenUnlocked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":204,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"When starting playback of a video Phaser will monitor its `readyState` using a `setTimeout` call.\nThe `setTimeout` happens once every `Video.retryInterval` ms. It will carry on monitoring the video\nstate in this manner until the `retryLimit` is reached and then abort.","name":"retryLimit","type":{"names":["integer"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#retryLimit","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"The current retry attempt.","name":"retry","type":{"names":["integer"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#retry","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":224,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"The number of ms between each retry while monitoring the ready state of a downloading video.","name":"retryInterval","type":{"names":["integer"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#retryInterval","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":310,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"An object containing in and out markers for sequence playback.","name":"markers","type":{"names":["any"]},"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#markers","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":369,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Should the Video element that this Video is using, be removed from the DOM\nwhen this Video is destroyed?","name":"removeVideoElementOnDestroy","type":{"names":["boolean"]},"since":"3.21.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#removeVideoElementOnDestroy","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Video.js","lineno":400,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Starts this video playing.\n\nIf the video is already playing, or has been queued to play with `changeSource` then this method just returns.\n\nVideos can only autoplay if the browser has been unlocked. This happens if you have interacted with the browser, i.e.\nby clicking on it or pressing a key, or due to server settings. The policies that control autoplaying are vast and\nvary between browser. You can read more here: https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide\n\nIf your video doesn't contain any audio, then set the `noAudio` parameter to `true` when the video is loaded,\nand it will often allow the video to play immediately:\n\n```javascript\npreload () {\n this.load.video('pixar', 'nemo.mp4', 'loadeddata', false, true);\n}\n```\n\nThe 5th parameter in the load call tells Phaser that the video doesn't contain any audio tracks. Video without\naudio can autoplay without requiring a user interaction. Video with audio cannot do this unless it satisfies\nthe browsers MEI settings. See the MDN Autoplay Guide for details.\n\nIf you need audio in your videos, then you'll have to consider the fact that the video cannot start playing until the\nuser has interacted with the browser, into your game flow.","kind":"function","name":"play","since":"3.20.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the video loop automatically when it reaches the end? Please note that not all browsers support _seamless_ video looping for all encoding formats.","name":"loop"},{"type":{"names":["integer"]},"optional":true,"description":"Optional in marker time, in seconds, for playback of a sequence of the video.","name":"markerIn"},{"type":{"names":["integer"]},"optional":true,"description":"Optional out marker time, in seconds, for playback of a sequence of the video.","name":"markerOut"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#play","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":503,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"This method allows you to change the source of the current video element. It works by first stopping the\ncurrent video, if playing. Then deleting the video texture, if one has been created. Finally, it makes a\nnew video texture and starts playback of the new source through the existing video element.\n\nThe reason you may wish to do this is because videos that require interaction to unlock, remain in an unlocked\nstate, even if you change the source of the video. By changing the source to a new video you avoid having to\ngo through the unlock process again.","kind":"function","name":"changeSource","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"The key of the Video this Game Object will swap to playing, as stored in the Video Cache.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the video start playing immediately, once the swap is complete?","name":"autoplay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the video loop automatically when it reaches the end? Please note that not all browsers support _seamless_ video looping for all encoding formats.","name":"loop"},{"type":{"names":["integer"]},"optional":true,"description":"Optional in marker time, in seconds, for playback of a sequence of the video.","name":"markerIn"},{"type":{"names":["integer"]},"optional":true,"description":"Optional out marker time, in seconds, for playback of a sequence of the video.","name":"markerOut"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#changeSource","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":581,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Adds a sequence marker to this video.\n\nMarkers allow you to split a video up into sequences, delineated by a start and end time, given in seconds.\n\nYou can then play back specific markers via the `playMarker` method.\n\nNote that marker timing is _not_ frame-perfect. You should construct your videos in such a way that you allow for\nplenty of extra padding before and after each sequence to allow for discrepancies in browser seek and currentTime accuracy.\n\nSee https://github.com/w3c/media-and-entertainment/issues/4 for more details about this issue.","kind":"function","name":"addMarker","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"A unique name to give this marker.","name":"key"},{"type":{"names":["integer"]},"description":"The time, in seconds, representing the start of this marker.","name":"markerIn"},{"type":{"names":["integer"]},"description":"The time, in seconds, representing the end of this marker.","name":"markerOut"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#addMarker","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":612,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Plays a pre-defined sequence in this video.\n\nMarkers allow you to split a video up into sequences, delineated by a start and end time, given in seconds and\nspecified via the `addMarker` method.\n\nNote that marker timing is _not_ frame-perfect. You should construct your videos in such a way that you allow for\nplenty of extra padding before and after each sequence to allow for discrepancies in browser seek and currentTime accuracy.\n\nSee https://github.com/w3c/media-and-entertainment/issues/4 for more details about this issue.","kind":"function","name":"playMarker","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"The name of the marker sequence to play.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the video loop automatically when it reaches the end? Please note that not all browsers support _seamless_ video looping for all encoding formats.","name":"loop"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#playMarker","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":643,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Removes a previously set marker from this video.\n\nIf the marker is currently playing it will _not_ stop playback.","kind":"function","name":"removeMarker","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"The name of the marker to remove.","name":"key"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#removeMarker","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":662,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Takes a snapshot of the current frame of the video and renders it to a CanvasTexture object,\nwhich is then returned. You can optionally resize the grab by passing a width and height.\n\nThis method returns a reference to the `Video.snapshotTexture` object. Calling this method\nmultiple times will overwrite the previous snapshot with the most recent one.","kind":"function","name":"snapshot","since":"3.20.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The width of the resulting CanvasTexture.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the resulting CanvasTexture.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]}}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#snapshot","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":685,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Takes a snapshot of the specified area of the current frame of the video and renders it to a CanvasTexture object,\nwhich is then returned. You can optionally resize the grab by passing a different `destWidth` and `destHeight`.\n\nThis method returns a reference to the `Video.snapshotTexture` object. Calling this method\nmultiple times will overwrite the previous snapshot with the most recent one.","kind":"function","name":"snapshotArea","since":"3.20.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The horizontal location of the top-left of the area to grab from.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The vertical location of the top-left of the area to grab from.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of area to grab from the video. If not given it will grab the full video dimensions.","name":"srcWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The height of area to grab from the video. If not given it will grab the full video dimensions.","name":"srcHeight"},{"type":{"names":["integer"]},"optional":true,"description":"The destination width of the grab, allowing you to resize it.","name":"destWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The destination height of the grab, allowing you to resize it.","name":"destHeight"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]}}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#snapshotArea","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":740,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Stores a copy of this Videos `snapshotTexture` in the Texture Manager using the given key.\n\nThis texture is created when the `snapshot` or `snapshotArea` methods are called.\n\nAfter doing this, any texture based Game Object, such as a Sprite, can use the contents of the\nsnapshot by using the texture key:\n\n```javascript\nvar vid = this.add.video(0, 0, 'intro');\n\nvid.snapshot();\n\nvid.saveSnapshotTexture('doodle');\n\nthis.add.image(400, 300, 'doodle');\n```\n\nUpdating the contents of the `snapshotTexture`, for example by calling `snapshot` again,\nwill automatically update _any_ Game Object that is using it as a texture.\nCalling `saveSnapshotTexture` again will not save another copy of the same texture,\nit will just rename the existing one.\n\nBy default it will create a single base texture. You can add frames to the texture\nby using the `Texture.add` method. After doing this, you can then allow Game Objects\nto use a specific frame.","kind":"function","name":"saveSnapshotTexture","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"The unique key to store the texture as within the global Texture Manager.","name":"key"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"The Texture that was saved."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#saveSnapshotTexture","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":788,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Loads a Video from the given URL, ready for playback with the `Video.play` method.\n\nYou can control at what point the browser determines the video as being ready for playback via\nthe `loadEvent` parameter. See https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement\nfor more details.","kind":"function","name":"loadURL","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"The URL of the video to load or be streamed.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'loadeddata'","description":"The load event to listen for. Either `loadeddata`, `canplay` or `canplaythrough`.","name":"loadEvent"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Does the video have an audio track? If not you can enable auto-playing on it.","name":"noAudio"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#loadURL","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":885,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Called when the video emits a `playing` event during load.\n\nThis is only listened for if the browser doesn't support Promises.","kind":"function","name":"playHandler","fires":["Phaser.GameObjects.Events#event:VIDEO_PLAY"],"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#playHandler","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":949,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Called when the video completes playback, i.e. reaches an `ended` state.\n\nThis will never happen if the video is coming from a live stream, where the duration is `Infinity`.","kind":"function","name":"completeHandler","fires":["Phaser.GameObjects.Events#event:VIDEO_COMPLETE"],"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#completeHandler","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":963,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Called when the video emits a `timeUpdate` event during playback.\n\nThis event is too slow and irregular to be used for actual video timing or texture updating,\nbut we can use it to determine if a video has looped.","kind":"function","name":"timeUpdateHandler","fires":["Phaser.GameObjects.Events#event:VIDEO_LOOP"],"since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#timeUpdateHandler","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1058,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Internal method that is called when enough video data has been received in order to create a texture\nfrom it. The texture is assigned to the `Video.videoTexture` property and given a base frame that\nencompases the whole video size.","kind":"function","name":"updateTexture","since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#updateTexture","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns the key of the currently played video, as stored in the Video Cache.\nIf the video did not come from the cache this will return an empty string.","kind":"function","name":"getVideoKey","since":"3.20.0","returns":[{"type":{"names":["string"]},"description":"The key of the video being played from the Video Cache, if any."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getVideoKey","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Seeks to a given point in the video. The value is given as a float between 0 and 1,\nwhere 0 represents the start of the video and 1 represents the end.\n\nSeeking only works if the video has a duration, so will not work for live streams.\n\nWhen seeking begins, this video will emit a `seeking` event. When the video completes\nseeking (i.e. reaches its designated timestamp) it will emit a `seeked` event.\n\nIf you wish to seek based on time instead, use the `Video.setCurrentTime` method.","kind":"function","name":"seekTo","since":"3.20.0","params":[{"type":{"names":["number"]},"description":"The point in the video to seek to. A value between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#seekTo","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1151,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"A double-precision floating-point value indicating the current playback time in seconds.\nIf the media has not started to play and has not been seeked, this value is the media's initial playback time.","kind":"function","name":"getCurrentTime","since":"3.20.0","returns":[{"type":{"names":["number"]},"description":"A double-precision floating-point value indicating the current playback time in seconds."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getCurrentTime","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1165,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Seeks to a given playback time in the video. The value is given in _seconds_ or as a string.\n\nSeeking only works if the video has a duration, so will not work for live streams.\n\nWhen seeking begins, this video will emit a `seeking` event. When the video completes\nseeking (i.e. reaches its designated timestamp) it will emit a `seeked` event.\n\nYou can provide a string prefixed with either a `+` or a `-`, such as `+2.5` or `-2.5`.\nIn this case it will seek to +/- the value given, relative to the _current time_.\n\nIf you wish to seek based on a duration percentage instead, use the `Video.seekTo` method.","kind":"function","name":"setCurrentTime","since":"3.20.0","params":[{"type":{"names":["string","number"]},"description":"The playback time to seek to in seconds. Can be expressed as a string, such as `+2` to seek 2 seconds ahead from the current time.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setCurrentTime","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1214,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a boolean indicating if this Video is currently seeking, or not.","kind":"function","name":"isSeeking","since":"3.20.0","returns":[{"type":{"names":["boolean"]},"description":"A boolean indicating if this Video is currently seeking, or not."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#isSeeking","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1264,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns the current progress of the video. Progress is defined as a value between 0 (the start)\nand 1 (the end).\n\nProgress can only be returned if the video has a duration, otherwise it will always return zero.","kind":"function","name":"getProgress","since":"3.20.0","returns":[{"type":{"names":["number"]},"description":"The current progress of playback. If the video has no duration, will always return zero."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getProgress","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1293,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"A double-precision floating-point value which indicates the duration (total length) of the media in seconds,\non the media's timeline. If no media is present on the element, or the media is not valid, the returned value is NaN.\n\nIf the media has no known end (such as for live streams of unknown duration, web radio, media incoming from WebRTC,\nand so forth), this value is +Infinity.","kind":"function","name":"getDuration","since":"3.20.0","returns":[{"type":{"names":["number"]},"description":"A double-precision floating-point value indicating the duration of the media in seconds."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getDuration","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Sets the muted state of the currently playing video, if one is loaded.","kind":"function","name":"setMute","since":"3.20.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The mute value. `true` if the video should be muted, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setMute","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1336,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a boolean indicating if this Video is currently muted.","kind":"function","name":"isMuted","since":"3.20.0","returns":[{"type":{"names":["boolean"]},"description":"A boolean indicating if this Video is currently muted, or not."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#isMuted","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1405,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Sets the paused state of the currently loaded video.\n\nIf the video is playing, calling this method with `true` will pause playback.\nIf the video is paused, calling this method with `false` will resume playback.\n\nIf no video is loaded, this method does nothing.","kind":"function","name":"setPaused","since":"3.20.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The paused value. `true` if the video should be paused, `false` to resume it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setPaused","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).","kind":"function","name":"getVolume","since":"3.20.0","returns":[{"type":{"names":["number"]},"description":"A double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest)."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getVolume","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1462,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Sets the volume of the currently playing video.\n\nThe value given is a double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).","kind":"function","name":"setVolume","since":"3.20.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setVolume","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1486,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a double that indicates the rate at which the media is being played back.","kind":"function","name":"getPlaybackRate","since":"3.20.0","returns":[{"type":{"names":["number"]},"description":"A double that indicates the rate at which the media is being played back."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getPlaybackRate","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1499,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Sets the playback rate of the current video.\n\nThe value given is a double that indicates the rate at which the media is being played back.","kind":"function","name":"setPlaybackRate","since":"3.20.0","params":[{"type":{"names":["number"]},"optional":true,"description":"A double that indicates the rate at which the media is being played back.","name":"rate"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setPlaybackRate","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1521,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a boolean which indicates whether the media element should start over when it reaches the end.","kind":"function","name":"getLoop","since":"3.20.0","returns":[{"type":{"names":["boolean"]},"description":"A boolean which indicates whether the media element will start over when it reaches the end."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getLoop","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1534,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Sets the loop state of the current video.\n\nThe value given is a boolean which indicates whether the media element will start over when it reaches the end.\n\nNot all videos can loop, for example live streams.\n\nPlease note that not all browsers support _seamless_ video looping for all encoding formats.","kind":"function","name":"setLoop","since":"3.20.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"A boolean which indicates whether the media element will start over when it reaches the end.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setLoop","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1562,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a boolean which indicates whether the video is currently playing.","kind":"function","name":"isPlaying","since":"3.20.0","returns":[{"type":{"names":["boolean"]},"description":"A boolean which indicates whether the video is playing, or not."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#isPlaying","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1575,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Returns a boolean which indicates whether the video is currently paused.","kind":"function","name":"isPaused","since":"3.20.0","returns":[{"type":{"names":["boolean"]},"description":"A boolean which indicates whether the video is paused, or not."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#isPaused","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1588,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Stores this Video in the Texture Manager using the given key as a dynamic texture,\nwhich any texture-based Game Object, such as a Sprite, can use as its texture:\n\n```javascript\nvar vid = this.add.video(0, 0, 'intro');\n\nvid.play();\n\nvid.saveTexture('doodle');\n\nthis.add.image(400, 300, 'doodle');\n```\n\nThe saved texture is automatically updated as the video plays. If you pause this video,\nor change its source, then the saved texture updates instantly.\n\nCalling `saveTexture` again will not save another copy of the same texture, it will just rename the existing one.\n\nBy default it will create a single base texture. You can add frames to the texture\nby using the `Texture.add` method. After doing this, you can then allow Game Objects\nto use a specific frame.\n\nIf you intend to save the texture so you can use it as the input for a Shader, you may need to set the\n`flipY` parameter to `true` if you find the video renders upside down in your shader.","kind":"function","name":"saveTexture","since":"3.20.0","params":[{"type":{"names":["string"]},"description":"The unique key to store the texture as within the global Texture Manager.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y` during upload?","name":"flipY"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"The Texture that was saved."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#saveTexture","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1643,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Stops the video playing and clears all internal event listeners.\n\nIf you only wish to pause playback of the video, and resume it a later time, use the `Video.pause` method instead.\n\nIf the video hasn't finished downloading, calling this method will not abort the download. To do that you need to\ncall `destroy` instead.","kind":"function","name":"stop","fires":["Phaser.GameObjects.Events#event:VIDEO_STOP"],"since":"3.20.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Video Game Object for method chaining."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#stop","scope":"instance","___s":true},{"meta":{"filename":"Video.js","lineno":1683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Removes the Video element from the DOM by calling parentNode.removeChild on itself.\n\nAlso removes the autoplay and src attributes and nulls the Video reference.\n\nYou should not call this method if you were playing a video from the Video Cache that\nyou wish to play again in your game, or if another Video object is also using the same\nvideo.\n\nIf you loaded an external video via `Video.loadURL` then you should call this function\nto clear up once you are done with the instance.","kind":"function","name":"removeVideoElement","since":"3.20.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#removeVideoElement","scope":"instance","___s":true},{"meta":{"range":[180,227],"filename":"VideoCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"name":"BuildGameObject","longname":"BuildGameObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"VideoCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Creates a new Video Game Object and returns it.\n\nNote: This method will only be available if the Video Game Object has been built into Phaser.","kind":"function","name":"video","since":"3.20.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"},{"type":{"names":["boolean"]},"optional":true,"description":"Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#video","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"VideoFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"name":"Video","longname":"Video","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"VideoFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"description":"Creates a new Image Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Image Game Object has been built into Phaser.","kind":"function","name":"video","since":"3.20.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#video","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"VideoRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/video"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,229],"filename":"Zone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"name":"BlendModes","longname":"BlendModes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Zone.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"classdesc":"A Zone Game Object.\n\nA Zone is a non-rendering rectangular Game Object that has a position and size.\nIt has no texture and never displays, but does live on the display list and\ncan be moved, scaled and rotated like any other Game Object.\n\nIts primary use is for creating Drop Zones and Input Hit Areas and it has a couple of helper methods\nspecifically for this. It is also useful for object overlap checks, or as a base for your own\nnon-displaying Game Objects.\nThe default origin is 0.5, the center of the Zone, the same as with Game Objects.","kind":"class","name":"Zone","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.GameObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The width of the Game Object.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The height of the Game Object.","name":"height"}],"scope":"static","longname":"Phaser.GameObjects.Zone","___s":true},{"meta":{"filename":"Zone.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"The native (un-scaled) width of this Game Object.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zone.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"The native (un-scaled) height of this Game Object.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zone.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"The Blend Mode of the Game Object.\nAlthough a Zone never renders, it still has a blend mode to allow it to fit seamlessly into\ndisplay lists without causing a batch flush.","name":"blendMode","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#blendMode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zone.js","lineno":105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"The displayed width of this Game Object.\nThis value takes into account the scale factor.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#displayWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zone.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"The displayed height of this Game Object.\nThis value takes into account the scale factor.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#displayHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Zone.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Sets the size of this Game Object.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If this Zone has a Rectangle for a hit area this argument will resize the hit area as well.","name":"resizeInput"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setSize","scope":"instance","___s":true},{"meta":{"filename":"Zone.js","lineno":181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Sets the display size of this Game Object.\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setDisplaySize","scope":"instance","___s":true},{"meta":{"filename":"Zone.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Sets this Zone to be a Circular Drop Zone.\nThe circle is centered on this Zones `x` and `y` coordinates.","kind":"function","name":"setCircleDropZone","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the Circle that will form the Drop Zone.","name":"radius"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setCircleDropZone","scope":"instance","___s":true},{"meta":{"filename":"Zone.js","lineno":217,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Sets this Zone to be a Rectangle Drop Zone.\nThe rectangle is centered on this Zones `x` and `y` coordinates.","kind":"function","name":"setRectangleDropZone","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the rectangle drop zone.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle drop zone.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setRectangleDropZone","scope":"instance","___s":true},{"meta":{"filename":"Zone.js","lineno":234,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Allows you to define your own Geometry shape to be used as a Drop Zone.","kind":"function","name":"setDropZone","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"A Geometry shape instance, such as Phaser.Geom.Ellipse, or your own custom shape.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"A function that will return `true` if the given x/y coords it is sent are within the shape.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setDropZone","scope":"instance","___s":true},{"meta":{"range":[180,231],"filename":"ZoneCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"name":"GameObjectCreator","longname":"GameObjectCreator","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ZoneCreator.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Creates a new Zone Game Object and returns it.\n\nNote: This method will only be available if the Zone Game Object has been built into Phaser.","kind":"function","name":"zone","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object this Game Object will use to create itself.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#zone","scope":"instance","___s":true},{"meta":{"range":[180,204],"filename":"ZoneFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"name":"Zone","longname":"Zone","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ZoneFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/zone"},"description":"Creates a new Zone Game Object and adds it to the Scene.\n\nNote: This method will only be available if the Zone Game Object has been built into Phaser.","kind":"function","name":"zone","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["number"]},"description":"The width of the Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of the Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"The Game Object that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#zone","scope":"instance","___s":true},{"meta":{"filename":"Area.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Calculates the area of the circle.","kind":"function","name":"Area","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get the area of.","name":"circle"}],"returns":[{"type":{"names":["number"]},"description":"The area of the Circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Area","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Circle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Circle.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"classdesc":"A Circle object.\n\nThis is a geometry object, containing numerical values and related methods to inspect and modify them.\nIt is not a Game Object, in that you cannot add it to the display list, and it has no texture.\nTo render a Circle you should look at the capabilities of the Graphics class.","kind":"class","name":"Circle","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the center of the circle.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the center of the circle.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The radius of the circle.","name":"radius"}],"scope":"static","longname":"Phaser.Geom.Circle","___s":true},{"meta":{"filename":"Circle.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The geometry constant type of this object: `GEOM_CONST.CIRCLE`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The x position of the center of the circle.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The y position of the center of the circle.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Check to see if the Circle contains the given x / y coordinates.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to check within the circle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to check within the circle.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the coordinates are within the circle, otherwise false."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#contains","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns a Point object containing the coordinates of a point on the circumference of the Circle\nbased on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\nat 180 degrees around the circle.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the circle.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An object to store the return values in. If not given a Point object will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point, or point-like object, containing the coordinates of the point around the circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#getPoint","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns an array of Point objects containing the coordinates of the points around the circumference of the Circle,\nbased on the given quantity or stepRate values.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Sets the quantity by getting the circumference of the circle and dividing it by the stepRate.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to insert the points in to. If not provided a new array will be created.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Point objects pertaining to the points around the circumference of the circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns a uniformly distributed random point from anywhere within the Circle.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"A Point or point-like object to set the random `x` and `y` values in.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object with the random values set in the `x` and `y` properties."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Sets the x, y and radius of this circle.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the center of the circle.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the center of the circle.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The radius of the circle.","name":"radius"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"This Circle object."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#setTo","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Sets this Circle to be empty with a radius of zero.\nDoes not change its position.","kind":"function","name":"setEmpty","since":"3.0.0","returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"This Circle object."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#setEmpty","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":205,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Sets the position of this Circle.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the center of the circle.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the center of the circle.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"This Circle object."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":226,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Checks to see if the Circle is empty: has a radius of zero.","kind":"function","name":"isEmpty","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if the Circle is empty, otherwise false."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#isEmpty","scope":"instance","___s":true},{"meta":{"filename":"Circle.js","lineno":239,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The radius of the Circle.","name":"radius","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#radius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":261,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The diameter of the Circle.","name":"diameter","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#diameter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":283,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The left position of the Circle.","name":"left","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":304,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The right position of the Circle.","name":"right","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":325,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The top position of the Circle.","name":"top","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circle.js","lineno":346,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"The bottom position of the Circle.","name":"bottom","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Circumference.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns the circumference of the given Circle.","kind":"function","name":"Circumference","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get the circumference of.","name":"circle"}],"returns":[{"type":{"names":["number"]},"description":"The circumference of the Circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Circumference","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"CircumferencePoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CircumferencePoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns a Point object containing the coordinates of a point on the circumference of the Circle based on the given angle.","kind":"function","name":"CircumferencePoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get the circumference point on.","name":"circle"},{"type":{"names":["number"]},"description":"The angle from the center of the Circle to the circumference to return the point from. Given in radians.","name":"angle"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"A Point, or point-like object, to store the results in. If not given a Point will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object where the `x` and `y` properties are the point on the circumference."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.CircumferencePoint","scope":"static","___s":true},{"meta":{"range":[180,208],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Circle","longname":"Circle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Creates a new Circle instance based on the values contained in the given source.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle","object"]},"description":"The Circle to be cloned. Can be an instance of a Circle or a circle-like object, with x, y and radius properties.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"A clone of the source Circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Clone","scope":"static","___s":true},{"meta":{"filename":"Contains.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Check to see if the Circle contains the given x / y coordinates.","kind":"function","name":"Contains","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to check.","name":"circle"},{"type":{"names":["number"]},"description":"The x coordinate to check within the circle.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to check within the circle.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the coordinates are within the circle, otherwise false."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Contains","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Check to see if the Circle contains the given Point object.","kind":"function","name":"ContainsPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to check.","name":"circle"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The Point object to check if it's within the Circle or not.","name":"point"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Point coordinates are within the circle, otherwise false."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.ContainsPoint","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsRect.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsRect.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Check to see if the Circle contains all four points of the given Rectangle object.","kind":"function","name":"ContainsRect","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to check.","name":"circle"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The Rectangle object to check if it's within the Circle or not.","name":"rect"}],"returns":[{"type":{"names":["boolean"]},"description":"True if all of the Rectangle coordinates are within the circle, otherwise false."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.ContainsRect","scope":"static","___s":true},{"meta":{"filename":"CopyFrom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Copies the `x`, `y` and `radius` properties from the `source` Circle\ninto the given `dest` Circle, then returns the `dest` Circle.","kind":"function","name":"CopyFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The source Circle to copy the values from.","name":"source"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The destination Circle to copy the values to.","name":"dest"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The destination Circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.CopyFrom","scope":"static","___s":true},{"meta":{"filename":"Equals.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Compares the `x`, `y` and `radius` properties of the two given Circles.\nReturns `true` if they all match, otherwise returns `false`.","kind":"function","name":"Equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The first Circle to compare.","name":"circle"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The second Circle to compare.","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two Circles equal each other, otherwise `false`."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Equals","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"GetBounds.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetBounds.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns the bounds of the Circle object.","kind":"function","name":"GetBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get the bounds from.","name":"circle"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"A Rectangle, or rectangle-like object, to store the circle bounds in. If not given a new Rectangle will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The Rectangle object containing the Circles bounds."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.GetBounds","scope":"static","___s":true},{"meta":{"range":[180,232],"filename":"GetPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"CircumferencePoint","longname":"CircumferencePoint","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoint.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns a Point object containing the coordinates of a point on the circumference of the Circle\nbased on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\nat 180 degrees around the circle.","kind":"function","name":"GetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get the circumference point on.","name":"circle"},{"type":{"names":["number"]},"description":"A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the circle.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An object to store the return values in. If not given a Point object will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point, or point-like object, containing the coordinates of the point around the circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.GetPoint","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"GetPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Circumference","longname":"Circumference","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoints.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns an array of Point objects containing the coordinates of the points around the circumference of the Circle,\nbased on the given quantity or stepRate values.","kind":"function","name":"GetPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get the points from.","name":"circle"},{"type":{"names":["integer"]},"description":"The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Sets the quantity by getting the circumference of the circle and dividing it by the stepRate.","name":"stepRate"},{"type":{"names":["array"]},"optional":true,"description":"An array to insert the points in to. If not provided a new array will be created.","name":"output"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Point objects pertaining to the points around the circumference of the circle."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.GetPoints","scope":"static","___s":true},{"meta":{"filename":"Offset.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Offsets the Circle by the values given.","kind":"function","name":"Offset","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to be offset (translated.)","name":"circle"},{"type":{"names":["number"]},"description":"The amount to horizontally offset the Circle by.","name":"x"},{"type":{"names":["number"]},"description":"The amount to vertically offset the Circle by.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle that was offset."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Offset","scope":"static","___s":true},{"meta":{"filename":"OffsetPoint.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Offsets the Circle by the values given in the `x` and `y` properties of the Point object.","kind":"function","name":"OffsetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to be offset (translated.)","name":"circle"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The Point object containing the values to offset the Circle by.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle that was offset."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.OffsetPoint","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Random.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Random.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"description":"Returns a uniformly distributed random point from anywhere within the given Circle.","kind":"function","name":"Random","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to get a random point from.","name":"circle"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"A Point or point-like object to set the random `x` and `y` values in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object with the random values set in the `x` and `y` properties."}],"memberof":"Phaser.Geom.Circle","longname":"Phaser.Geom.Circle.Random","scope":"static","___s":true},{"meta":{"range":[180,208],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/circle"},"name":"Circle","longname":"Circle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,1287],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"name":"GEOM_CONST","longname":"GEOM_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"A Circle Geometry object type.","name":"CIRCLE","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.CIRCLE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"An Ellipse Geometry object type.","name":"ELLIPSE","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.ELLIPSE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"A Line Geometry object type.","name":"LINE","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.LINE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"A Point Geometry object type.","name":"POINT","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.POINT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"A Polygon Geometry object type.","name":"POLYGON","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.POLYGON","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"A Rectangle Geometry object type.","name":"RECTANGLE","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.RECTANGLE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"description":"A Triangle Geometry object type.","name":"TRIANGLE","type":{"names":["integer"]},"since":"3.19.0","memberof":"Phaser.Geom","longname":"Phaser.Geom.TRIANGLE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"Area.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Calculates the area of the Ellipse.","kind":"function","name":"Area","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get the area of.","name":"ellipse"}],"returns":[{"type":{"names":["number"]},"description":"The area of the Ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Area","scope":"static","___s":true},{"meta":{"filename":"Circumference.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns the circumference of the given Ellipse.","kind":"function","name":"Circumference","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get the circumference of.","name":"ellipse"}],"returns":[{"type":{"names":["number"]},"description":"The circumference of th Ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Circumference","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"CircumferencePoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CircumferencePoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns a Point object containing the coordinates of a point on the circumference of the Ellipse based on the given angle.","kind":"function","name":"CircumferencePoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get the circumference point on.","name":"ellipse"},{"type":{"names":["number"]},"description":"The angle from the center of the Ellipse to the circumference to return the point from. Given in radians.","name":"angle"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"A Point, or point-like object, to store the results in. If not given a Point will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object where the `x` and `y` properties are the point on the circumference."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.CircumferencePoint","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Ellipse","longname":"Ellipse","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Creates a new Ellipse instance based on the values contained in the given source.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to be cloned. Can be an instance of an Ellipse or a ellipse-like object, with x, y, width and height properties.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"A clone of the source Ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Clone","scope":"static","___s":true},{"meta":{"filename":"Contains.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Check to see if the Ellipse contains the given x / y coordinates.","kind":"function","name":"Contains","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to check.","name":"ellipse"},{"type":{"names":["number"]},"description":"The x coordinate to check within the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to check within the ellipse.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the coordinates are within the ellipse, otherwise false."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Contains","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Check to see if the Ellipse contains the given Point object.","kind":"function","name":"ContainsPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to check.","name":"ellipse"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The Point object to check if it's within the Circle or not.","name":"point"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Point coordinates are within the circle, otherwise false."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.ContainsPoint","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsRect.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsRect.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Check to see if the Ellipse contains all four points of the given Rectangle object.","kind":"function","name":"ContainsRect","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to check.","name":"ellipse"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The Rectangle object to check if it's within the Ellipse or not.","name":"rect"}],"returns":[{"type":{"names":["boolean"]},"description":"True if all of the Rectangle coordinates are within the ellipse, otherwise false."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.ContainsRect","scope":"static","___s":true},{"meta":{"filename":"CopyFrom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Copies the `x`, `y`, `width` and `height` properties from the `source` Ellipse\ninto the given `dest` Ellipse, then returns the `dest` Ellipse.","kind":"function","name":"CopyFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The source Ellipse to copy the values from.","name":"source"},{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The destination Ellipse to copy the values to.","name":"dest"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The destination Ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.CopyFrom","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Ellipse.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Ellipse.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"classdesc":"An Ellipse object.\n\nThis is a geometry object, containing numerical values and related methods to inspect and modify them.\nIt is not a Game Object, in that you cannot add it to the display list, and it has no texture.\nTo render an Ellipse you should look at the capabilities of the Graphics class.","kind":"class","name":"Ellipse","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the center of the ellipse.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the center of the ellipse.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The height of the ellipse.","name":"height"}],"scope":"static","longname":"Phaser.Geom.Ellipse","___s":true},{"meta":{"filename":"Ellipse.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The geometry constant type of this object: `GEOM_CONST.ELLIPSE`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The x position of the center of the ellipse.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The y position of the center of the ellipse.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The width of the ellipse.","name":"width","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The height of the ellipse.","name":"height","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":95,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Check to see if the Ellipse contains the given x / y coordinates.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to check within the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to check within the ellipse.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the coordinates are within the ellipse, otherwise false."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#contains","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":111,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns a Point object containing the coordinates of a point on the circumference of the Ellipse\nbased on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\nat 180 degrees around the circle.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the ellipse.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An object to store the return values in. If not given a Point object will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point, or point-like object, containing the coordinates of the point around the ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#getPoint","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns an array of Point objects containing the coordinates of the points around the circumference of the Ellipse,\nbased on the given quantity or stepRate values.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Sets the quantity by getting the circumference of the ellipse and dividing it by the stepRate.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to insert the points in to. If not provided a new array will be created.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Point objects pertaining to the points around the circumference of the ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":151,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns a uniformly distributed random point from anywhere within the given Ellipse.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"A Point or point-like object to set the random `x` and `y` values in.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object with the random values set in the `x` and `y` properties."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":168,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Sets the x, y, width and height of this ellipse.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the center of the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the center of the ellipse.","name":"y"},{"type":{"names":["number"]},"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"description":"The height of the ellipse.","name":"height"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"This Ellipse object."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#setTo","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Sets this Ellipse to be empty with a width and height of zero.\nDoes not change its position.","kind":"function","name":"setEmpty","since":"3.0.0","returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"This Ellipse object."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#setEmpty","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Sets the position of this Ellipse.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position of the center of the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The y position of the center of the ellipse.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"This Ellipse object."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Sets the size of this Ellipse.\nDoes not change its position.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height of the ellipse.","name":"height"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"This Ellipse object."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#setSize","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":251,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Checks to see if the Ellipse is empty: has a width or height equal to zero.","kind":"function","name":"isEmpty","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if the Ellipse is empty, otherwise false."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#isEmpty","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":264,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns the minor radius of the ellipse. Also known as the Semi Minor Axis.","kind":"function","name":"getMinorRadius","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The minor radius."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#getMinorRadius","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":277,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns the major radius of the ellipse. Also known as the Semi Major Axis.","kind":"function","name":"getMajorRadius","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The major radius."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#getMajorRadius","scope":"instance","___s":true},{"meta":{"filename":"Ellipse.js","lineno":290,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The left position of the Ellipse.","name":"left","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":311,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The right position of the Ellipse.","name":"right","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The top position of the Ellipse.","name":"top","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Ellipse.js","lineno":353,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"The bottom position of the Ellipse.","name":"bottom","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Equals.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Compares the `x`, `y`, `width` and `height` properties of the two given Ellipses.\nReturns `true` if they all match, otherwise returns `false`.","kind":"function","name":"Equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The first Ellipse to compare.","name":"ellipse"},{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The second Ellipse to compare.","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two Ellipse equal each other, otherwise `false`."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Equals","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"GetBounds.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetBounds.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns the bounds of the Ellipse object.","kind":"function","name":"GetBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get the bounds from.","name":"ellipse"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"A Rectangle, or rectangle-like object, to store the ellipse bounds in. If not given a new Rectangle will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The Rectangle object containing the Ellipse bounds."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.GetBounds","scope":"static","___s":true},{"meta":{"range":[180,232],"filename":"GetPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"CircumferencePoint","longname":"CircumferencePoint","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoint.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns a Point object containing the coordinates of a point on the circumference of the Ellipse\nbased on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\nat 180 degrees around the circle.","kind":"function","name":"GetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get the circumference point on.","name":"ellipse"},{"type":{"names":["number"]},"description":"A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the ellipse.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An object to store the return values in. If not given a Point object will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point, or point-like object, containing the coordinates of the point around the ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.GetPoint","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"GetPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Circumference","longname":"Circumference","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoints.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns an array of Point objects containing the coordinates of the points around the circumference of the Ellipse,\nbased on the given quantity or stepRate values.","kind":"function","name":"GetPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get the points from.","name":"ellipse"},{"type":{"names":["integer"]},"description":"The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Sets the quantity by getting the circumference of the ellipse and dividing it by the stepRate.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to insert the points in to. If not provided a new array will be created.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Point objects pertaining to the points around the circumference of the ellipse."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.GetPoints","scope":"static","___s":true},{"meta":{"filename":"Offset.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Offsets the Ellipse by the values given.","kind":"function","name":"Offset","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to be offset (translated.)","name":"ellipse"},{"type":{"names":["number"]},"description":"The amount to horizontally offset the Ellipse by.","name":"x"},{"type":{"names":["number"]},"description":"The amount to vertically offset the Ellipse by.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse that was offset."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Offset","scope":"static","___s":true},{"meta":{"filename":"OffsetPoint.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Offsets the Ellipse by the values given in the `x` and `y` properties of the Point object.","kind":"function","name":"OffsetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to be offset (translated.)","name":"ellipse"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The Point object containing the values to offset the Ellipse by.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse that was offset."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.OffsetPoint","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Random.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Random.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"description":"Returns a uniformly distributed random point from anywhere within the given Ellipse.","kind":"function","name":"Random","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Ellipse"]},"description":"The Ellipse to get a random point from.","name":"ellipse"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"A Point or point-like object to set the random `x` and `y` values in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object with the random values set in the `x` and `y` properties."}],"memberof":"Phaser.Geom.Ellipse","longname":"Phaser.Geom.Ellipse.Random","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/ellipse"},"name":"Ellipse","longname":"Ellipse","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom"},"kind":"namespace","name":"Geom","memberof":"Phaser","longname":"Phaser.Geom","scope":"static","___s":true},{"meta":{"range":[180,244],"filename":"CircleToCircle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"DistanceBetween","longname":"DistanceBetween","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CircleToCircle.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Circles intersect.","kind":"function","name":"CircleToCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The first Circle to check for intersection.","name":"circleA"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The second Circle to check for intersection.","name":"circleB"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two Circles intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.CircleToCircle","scope":"static","___s":true},{"meta":{"filename":"CircleToRectangle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between a circle and a rectangle.","kind":"function","name":"CircleToRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The circle to be checked.","name":"circle"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle to be checked.","name":"rect"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two objects intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.CircleToRectangle","scope":"static","___s":true},{"meta":{"range":[192,225],"filename":"GetCircleToCircle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetCircleToCircle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Circles intersect and returns the intersection points as a Point object array.","kind":"function","name":"GetCircleToCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The first Circle to check for intersection.","name":"circleA"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The second Circle to check for intersection.","name":"circleB"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetCircleToCircle","scope":"static","___s":true},{"meta":{"range":[192,238],"filename":"GetCircleToRectangle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"GetLineToCircle","longname":"GetLineToCircle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetCircleToRectangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between a circle and a rectangle,\nand returns the intersection points as a Point object array.","kind":"function","name":"GetCircleToRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The circle to be checked.","name":"circle"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle to be checked.","name":"rect"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetCircleToRectangle","scope":"static","___s":true},{"meta":{"range":[192,225],"filename":"GetLineToCircle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetLineToCircle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between the line segment and circle,\nand returns the intersection points as a Point object array.","kind":"function","name":"GetLineToCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line segment to check.","name":"line"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The circle to check against the line.","name":"circle"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetLineToCircle","scope":"static","___s":true},{"meta":{"range":[192,225],"filename":"GetLineToRectangle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetLineToRectangle.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between the Line and a Rectangle shape,\nand returns the intersection points as a Point object array.","kind":"function","name":"GetLineToRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to check for intersection.","name":"line"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The Rectangle to check for intersection.","name":"rect"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetLineToRectangle","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"GetRectangleIntersection.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetRectangleIntersection.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Rectangle shapes intersect and returns the area of this intersection as Rectangle object.\n\nIf optional `output` parameter is omitted, new Rectangle object is created and returned. If there is intersection, it will contain intersection area. If there is no intersection, it wil be empty Rectangle (all values set to zero).\n\nIf Rectangle object is passed as `output` and there is intersection, then intersection area data will be loaded into it and it will be returned. If there is no intersection, it will be returned without any change.","kind":"function","name":"GetRectangleIntersection","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle object.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle object.","name":"rectB"},{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"Optional Rectangle object. If given, the intersection data will be loaded into it (in case of no intersection, it will be left unchanged). Otherwise, new Rectangle object will be created and returned with either intersection data or empty (all values set to zero), if there is no intersection.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A rectangle object with intersection data."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetRectangleIntersection","scope":"static","___s":true},{"meta":{"range":[192,244],"filename":"GetRectangleToRectangle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"GetLineToRectangle","longname":"GetLineToRectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetRectangleToRectangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Rectangles intersect and returns the intersection points as a Point object array.\n\nA Rectangle intersects another Rectangle if any part of its bounds is within the other Rectangle's bounds. As such, the two Rectangles are considered \"solid\". A Rectangle with no width or no height will never intersect another Rectangle.","kind":"function","name":"GetRectangleToRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle to check for intersection.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle to check for intersection.","name":"rectB"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetRectangleToRectangle","scope":"static","___s":true},{"meta":{"range":[192,246],"filename":"GetRectangleToTriangle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"RectangleToTriangle","longname":"RectangleToTriangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetRectangleToTriangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between Rectangle shape and Triangle shape,\nand returns the intersection points as a Point object array.","kind":"function","name":"GetRectangleToTriangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Rectangle object to test.","name":"rect"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"Triangle object to test.","name":"triangle"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetRectangleToTriangle","scope":"static","___s":true},{"meta":{"range":[192,238],"filename":"GetTriangleToCircle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"GetLineToCircle","longname":"GetLineToCircle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetTriangleToCircle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if a Triangle and a Circle intersect, and returns the intersection points as a Point object array.\n\nA Circle intersects a Triangle if its center is located within it or if any of the Triangle's sides intersect the Circle. As such, the Triangle and the Circle are considered \"solid\" for the intersection.","kind":"function","name":"GetTriangleToCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to check for intersection.","name":"triangle"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to check for intersection.","name":"circle"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetTriangleToCircle","scope":"static","___s":true},{"meta":{"range":[192,225],"filename":"GetTriangleToLine.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetTriangleToLine.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if a Triangle and a Line intersect, and returns the intersection points as a Point object array.\n\nThe Line intersects the Triangle if it starts inside of it, ends inside of it, or crosses any of the Triangle's sides. Thus, the Triangle is considered \"solid\".","kind":"function","name":"GetTriangleToLine","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to check with.","name":"triangle"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to check with.","name":"line"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetTriangleToLine","scope":"static","___s":true},{"meta":{"range":[192,244],"filename":"GetTriangleToTriangle.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"TriangleToTriangle","longname":"TriangleToTriangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetTriangleToTriangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Triangles intersect, and returns the intersection points as a Point object array.\n\nA Triangle intersects another Triangle if any pair of their lines intersects or if any point of one Triangle is within the other Triangle. Thus, the Triangles are considered \"solid\".","kind":"function","name":"GetTriangleToTriangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The first Triangle to check for intersection.","name":"triangleA"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The second Triangle to check for intersection.","name":"triangleB"},{"type":{"names":["array"]},"optional":true,"description":"An optional array in which to store the points of intersection.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array with the points of intersection if objects intersect, otherwise an empty array."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.GetTriangleToTriangle","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"LineToCircle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LineToCircle.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between the line segment and circle.\n\nBased on code by [Matt DesLauriers](https://github.com/mattdesl/line-circle-collision/blob/master/LICENSE.md).","kind":"function","name":"LineToCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line segment to check.","name":"line"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The circle to check against the line.","name":"circle"},{"type":{"names":["Phaser.Geom.Point","any"]},"optional":true,"description":"An optional Point-like object. If given the closest point on the Line where the circle intersects will be stored in this object.","name":"nearest"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two objects intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.LineToCircle","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"LineToLine.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LineToLine.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Lines intersect. If the Lines are identical, they will be treated as parallel and thus non-intersecting.","kind":"function","name":"LineToLine","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The first Line to check.","name":"line1"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The second Line to check.","name":"line2"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"A Point in which to optionally store the point of intersection.","name":"out"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two Lines intersect, and the `out` object will be populated, if given. Otherwise, `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.LineToLine","scope":"static","___s":true},{"meta":{"filename":"LineToRectangle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between the Line and a Rectangle shape, or a rectangle-like\nobject, with public `x`, `y`, `right` and `bottom` properties, such as a Sprite or Body.\n\nAn intersection is considered valid if:\n\nThe line starts within, or ends within, the Rectangle.\nThe line segment intersects one of the 4 rectangle edges.\n\nThe for the purposes of this function rectangles are considered 'solid'.","kind":"function","name":"LineToRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to check for intersection.","name":"line"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The Rectangle to check for intersection.","name":"rect"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Line and the Rectangle intersect, `false` otherwise."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.LineToRectangle","scope":"static","___s":true},{"meta":{"filename":"PointToLine.js","lineno":8,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if the a Point falls between the two end-points of a Line, based on the given line thickness.\n\nAssumes that the line end points are circular, not square.","kind":"function","name":"PointToLine","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","any"]},"description":"The point, or point-like object to check.","name":"point"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The line segment to test for intersection on.","name":"line"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The line thickness. Assumes that the line end points are circular.","name":"lineThickness"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Point falls on the Line, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.PointToLine","scope":"static","___s":true},{"meta":{"range":[180,218],"filename":"PointToLineSegment.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"PointToLine","longname":"PointToLine","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PointToLineSegment.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if a Point is located on the given line segment.","kind":"function","name":"PointToLineSegment","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to check for intersection.","name":"point"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The line segment to check for intersection.","name":"line"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Point is on the given line segment, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.PointToLineSegment","scope":"static","___s":true},{"meta":{"filename":"RectangleToRectangle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Rectangles intersect.\n\nA Rectangle intersects another Rectangle if any part of its bounds is within the other Rectangle's bounds.\nAs such, the two Rectangles are considered \"solid\".\nA Rectangle with no width or no height will never intersect another Rectangle.","kind":"function","name":"RectangleToRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle to check for intersection.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle to check for intersection.","name":"rectB"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two Rectangles intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.RectangleToRectangle","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"RectangleToTriangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"LineToLine","longname":"LineToLine","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RectangleToTriangle.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks for intersection between Rectangle shape and Triangle shape.","kind":"function","name":"RectangleToTriangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Rectangle object to test.","name":"rect"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"Triangle object to test.","name":"triangle"}],"returns":[{"type":{"names":["boolean"]},"description":"A value of `true` if objects intersect; otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.RectangleToTriangle","scope":"static","___s":true},{"meta":{"filename":"RectangleToValues.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Check if rectangle intersects with values.","kind":"function","name":"RectangleToValues","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle object","name":"rect"},{"type":{"names":["number"]},"description":"The x coordinate of the left of the Rectangle.","name":"left"},{"type":{"names":["number"]},"description":"The x coordinate of the right of the Rectangle.","name":"right"},{"type":{"names":["number"]},"description":"The y coordinate of the top of the Rectangle.","name":"top"},{"type":{"names":["number"]},"description":"The y coordinate of the bottom of the Rectangle.","name":"bottom"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Tolerance allowed in the calculation, expressed in pixels.","name":"tolerance"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns true if there is an intersection."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.RectangleToValues","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"TriangleToCircle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"LineToCircle","longname":"LineToCircle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TriangleToCircle.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if a Triangle and a Circle intersect.\n\nA Circle intersects a Triangle if its center is located within it or if any of the Triangle's sides intersect the Circle. As such, the Triangle and the Circle are considered \"solid\" for the intersection.","kind":"function","name":"TriangleToCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to check for intersection.","name":"triangle"},{"type":{"names":["Phaser.Geom.Circle"]},"description":"The Circle to check for intersection.","name":"circle"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Triangle and the `Circle` intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.TriangleToCircle","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"TriangleToLine.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TriangleToLine.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if a Triangle and a Line intersect.\n\nThe Line intersects the Triangle if it starts inside of it, ends inside of it, or crosses any of the Triangle's sides. Thus, the Triangle is considered \"solid\".","kind":"function","name":"TriangleToLine","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to check with.","name":"triangle"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to check with.","name":"line"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Triangle and the Line intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.TriangleToLine","scope":"static","___s":true},{"meta":{"range":[180,232],"filename":"TriangleToTriangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"name":"ContainsArray","longname":"ContainsArray","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TriangleToTriangle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"description":"Checks if two Triangles intersect.\n\nA Triangle intersects another Triangle if any pair of their lines intersects or if any point of one Triangle is within the other Triangle. Thus, the Triangles are considered \"solid\".","kind":"function","name":"TriangleToTriangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The first Triangle to check for intersection.","name":"triangleA"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The second Triangle to check for intersection.","name":"triangleB"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Triangles intersect, otherwise `false`."}],"memberof":"Phaser.Geom.Intersects","longname":"Phaser.Geom.Intersects.TriangleToTriangle","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/intersects"},"kind":"namespace","name":"Intersects","memberof":"Phaser.Geom","longname":"Phaser.Geom.Intersects","scope":"static","___s":true},{"meta":{"filename":"Angle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the angle of the line in radians.","kind":"function","name":"Angle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the angle of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The angle of the line, in radians."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Angle","scope":"static","___s":true},{"meta":{"filename":"BresenhamPoints.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Using Bresenham's line algorithm this will return an array of all coordinates on this line.\n\nThe `start` and `end` points are rounded before this runs as the algorithm works on integers.","kind":"function","name":"BresenhamPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line.","name":"line"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The optional step rate for the points on the line.","name":"stepRate"},{"type":{"names":["Array."]},"optional":true,"description":"An optional array to push the resulting coordinates into.","name":"results"}],"returns":[{"type":{"names":["Array."]},"description":"The array of coordinates on the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.BresenhamPoints","scope":"static","___s":true},{"meta":{"filename":"CenterOn.js","lineno":8,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Center a line on the given coordinates.","kind":"function","name":"CenterOn","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to center.","name":"line"},{"type":{"names":["number"]},"description":"The horizontal coordinate to center the line on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to center the line on.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The centered line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.CenterOn","scope":"static","___s":true},{"meta":{"range":[180,204],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Line","longname":"Line","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Clone the given line.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The source line to clone.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The cloned line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Clone","scope":"static","___s":true},{"meta":{"filename":"CopyFrom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Copy the values of one line to a destination line.","kind":"function","name":"CopyFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The source line to copy the values from.","name":"source"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The destination line to copy the values to.","name":"dest"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The destination line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.CopyFrom","scope":"static","___s":true},{"meta":{"filename":"Equals.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Compare two lines for strict equality.","kind":"function","name":"Equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The first line to compare.","name":"line"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The second line to compare.","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the two lines are equal."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Equals","scope":"static","___s":true},{"meta":{"range":[180,208],"filename":"Extend.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Length","longname":"Length","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Extend.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Extends the start and end points of a Line by the given amounts.\n\nThe amounts can be positive or negative. Positive points will increase the length of the line,\nwhile negative ones will decrease it.\n\nIf no `right` value is provided it will extend the length of the line equally in both directions.\n\nPass a value of zero to leave the start or end point unchanged.","kind":"function","name":"Extend","since":"3.16.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line instance to extend.","name":"line"},{"type":{"names":["number"]},"description":"The amount to extend the start of the line by.","name":"left"},{"type":{"names":["number"]},"optional":true,"description":"The amount to extend the end of the line by. If not given it will be set to the `left` value.","name":"right"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The modified Line instance."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Extend","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"GetMidPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetMidPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get the midpoint of the given line.","kind":"function","name":"GetMidPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to get the midpoint of.","name":"line"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An optional point object to store the midpoint in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The midpoint of the Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.GetMidPoint","scope":"static","___s":true},{"meta":{"range":[213,246],"filename":"GetNearestPoint.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetNearestPoint.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get the nearest point on a line perpendicular to the given point.","kind":"function","name":"GetNearestPoint","since":"3.16.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to get the nearest point on.","name":"line"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point to get the nearest point to.","name":"point"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An optional point, or point-like object, to store the coordinates of the nearest point on the line.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The nearest point on the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.GetNearestPoint","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"GetNormal.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetNormal.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the normal of the given line.\n\nThe normal of a line is a vector that points perpendicular from it.","kind":"function","name":"GetNormal","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the normal of.","name":"line"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An optional point object to store the normal in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The normal of the Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.GetNormal","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"GetPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get a point on a line that's a given percentage along its length.","kind":"function","name":"GetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line.","name":"line"},{"type":{"names":["number"]},"description":"A value between 0 and 1, where 0 is the start, 0.5 is the middle and 1 is the end of the line.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An optional point, or point-like object, to store the coordinates of the point on the line.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point on the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.GetPoint","scope":"static","___s":true},{"meta":{"range":[180,208],"filename":"GetPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Length","longname":"Length","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoints.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get a number of points along a line's length.\n\nProvide a `quantity` to get an exact number of points along the line.\n\nProvide a `stepRate` to ensure a specific distance between each point on the line. Set `quantity` to `0` when\nproviding a `stepRate`.","kind":"function","name":"GetPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line.","name":"line"},{"type":{"names":["integer"]},"description":"The number of points to place on the line. Set to `0` to use `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"The distance between each point on the line. When set, `quantity` is implied and should be set to `0`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array of Points, or point-like objects, to store the coordinates of the points on the line.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points, or point-like objects, containing the coordinates of the points on the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.GetPoints","scope":"static","___s":true},{"meta":{"filename":"GetShortestDistance.js","lineno":8,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get the shortest distance from a Line to the given Point.","kind":"function","name":"GetShortestDistance","since":"3.16.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to get the distance from.","name":"line"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point to get the shortest distance to.","name":"point"}],"returns":[{"type":{"names":["number"]},"description":"The shortest distance from the line to the point."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.GetShortestDistance","scope":"static","___s":true},{"meta":{"filename":"Height.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the height of the given line.","kind":"function","name":"Height","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the height of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The height of the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Height","scope":"static","___s":true},{"meta":{"filename":"Length.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the length of the given line.","kind":"function","name":"Length","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the length of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The length of the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Length","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Line.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Line.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"classdesc":"Defines a Line segment, a part of a line between two endpoints.","kind":"class","name":"Line","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the lines starting point.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the lines starting point.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the lines ending point.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the lines ending point.","name":"y2"}],"scope":"static","longname":"Phaser.Geom.Line","___s":true},{"meta":{"filename":"Line.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The geometry constant type of this object: `GEOM_CONST.LINE`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The x coordinate of the lines starting point.","name":"x1","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#x1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The y coordinate of the lines starting point.","name":"y1","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#y1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The x coordinate of the lines ending point.","name":"x2","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#x2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The y coordinate of the lines ending point.","name":"y2","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#y2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get a point on a line that's a given percentage along its length.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1, where 0 is the start, 0.5 is the middle and 1 is the end of the line.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An optional point, or point-like object, to store the coordinates of the point on the line.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point, or point-like object, containing the coordinates of the point on the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#getPoint","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get a number of points along a line's length.\n\nProvide a `quantity` to get an exact number of points along the line.\n\nProvide a `stepRate` to ensure a specific distance between each point on the line. Set `quantity` to `0` when\nproviding a `stepRate`.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The number of points to place on the line. Set to `0` to use `stepRate` instead.","name":"quantity"},{"type":{"names":["integer"]},"optional":true,"description":"The distance between each point on the line. When set, `quantity` is implied and should be set to `0`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array of Points, or point-like objects, to store the coordinates of the points on the line.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points, or point-like objects, containing the coordinates of the points on the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get a random Point on the Line.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An instance of a Point to be modified.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"A random Point on the Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":146,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Set new coordinates for the line endpoints.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the lines starting point.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the lines starting point.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the lines ending point.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the lines ending point.","name":"y2"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"This Line object."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#setTo","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Returns a Vector2 object that corresponds to the start of this Line.","kind":"function","name":"getPointA","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to set the results in. If `undefined` a new Vector2 will be created.","name":"vec2"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector2 object that corresponds to the start of this Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#getPointA","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":196,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Returns a Vector2 object that corresponds to the end of this Line.","kind":"function","name":"getPointB","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 object to set the results in. If `undefined` a new Vector2 will be created.","name":"vec2"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector2 object that corresponds to the end of this Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#getPointB","scope":"instance","___s":true},{"meta":{"filename":"Line.js","lineno":217,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The left position of the Line.","name":"left","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The right position of the Line.","name":"right","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The top position of the Line.","name":"top","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Line.js","lineno":301,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The bottom position of the Line.","name":"bottom","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,220],"filename":"NormalAngle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NormalAngle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Get the angle of the normal of the given line in radians.","kind":"function","name":"NormalAngle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the angle of the normal of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The angle of the normal of the line in radians."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.NormalAngle","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"NormalX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NormalX.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"[description]","kind":"function","name":"NormalX","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line object to get the normal value from.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.NormalX","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"NormalY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NormalY.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"The Y value of the normal of the given line.\nThe normal of a line is a vector that points perpendicular from it.","kind":"function","name":"NormalY","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the normal of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The Y value of the normal of the Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.NormalY","scope":"static","___s":true},{"meta":{"filename":"Offset.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Offset a line by the given amount.","kind":"function","name":"Offset","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to offset.","name":"line"},{"type":{"names":["number"]},"description":"The horizontal offset to add to the line.","name":"x"},{"type":{"names":["number"]},"description":"The vertical offset to add to the line.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The offset line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Offset","scope":"static","___s":true},{"meta":{"filename":"PerpSlope.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the perpendicular slope of the given line.","kind":"function","name":"PerpSlope","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the perpendicular slope of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The perpendicular slope of the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.PerpSlope","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Random.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Random.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Returns a random point on a given Line.","kind":"function","name":"Random","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The Line to calculate the random Point on.","name":"line"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An instance of a Point to be modified.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A random Point on the Line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Random","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"ReflectAngle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Angle","longname":"Angle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ReflectAngle.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the reflected angle between two lines.\n\nThis is the outgoing angle based on the angle of Line 1 and the normalAngle of Line 2.","kind":"function","name":"ReflectAngle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The first line.","name":"lineA"},{"type":{"names":["Phaser.Geom.Line"]},"description":"The second line.","name":"lineB"}],"returns":[{"type":{"names":["number"]},"description":"The reflected angle between each line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.ReflectAngle","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"Rotate.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"RotateAroundXY","longname":"RotateAroundXY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Rotate.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Rotate a line around its midpoint by the given angle in radians.","kind":"function","name":"Rotate","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to rotate.","name":"line"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The rotated line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Rotate","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"RotateAroundPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"RotateAroundXY","longname":"RotateAroundXY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateAroundPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Rotate a line around a point by the given angle in radians.","kind":"function","name":"RotateAroundPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to rotate.","name":"line"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point to rotate the line around.","name":"point"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The rotated line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.RotateAroundPoint","scope":"static","___s":true},{"meta":{"filename":"RotateAroundXY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Rotate a line around the given coordinates by the given angle in radians.","kind":"function","name":"RotateAroundXY","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to rotate.","name":"line"},{"type":{"names":["number"]},"description":"The horizontal coordinate to rotate the line around.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to rotate the line around.","name":"y"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The rotated line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.RotateAroundXY","scope":"static","___s":true},{"meta":{"filename":"SetToAngle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Set a line to a given position, angle and length.","kind":"function","name":"SetToAngle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to set.","name":"line"},{"type":{"names":["number"]},"description":"The horizontal start position of the line.","name":"x"},{"type":{"names":["number"]},"description":"The vertical start position of the line.","name":"y"},{"type":{"names":["number"]},"description":"The angle of the line in radians.","name":"angle"},{"type":{"names":["number"]},"description":"The length of the line.","name":"length"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The updated line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.SetToAngle","scope":"static","___s":true},{"meta":{"filename":"Slope.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the slope of the given line.","kind":"function","name":"Slope","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the slope of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The slope of the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Slope","scope":"static","___s":true},{"meta":{"filename":"Width.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"description":"Calculate the width of the given line.","kind":"function","name":"Width","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"description":"The line to calculate the width of.","name":"line"}],"returns":[{"type":{"names":["number"]},"description":"The width of the line."}],"memberof":"Phaser.Geom.Line","longname":"Phaser.Geom.Line.Width","scope":"static","___s":true},{"meta":{"range":[180,204],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/line"},"name":"Line","longname":"Line","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Ceil.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Apply `Math.ceil()` to each coordinate of the given Point.","kind":"function","name":"Ceil","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to ceil.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point with `Math.ceil()` applied to its coordinates."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Ceil","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Clone the given Point.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The source Point to clone.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The cloned Point."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Clone","scope":"static","___s":true},{"meta":{"filename":"CopyFrom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Copy the values of one Point to a destination Point.","kind":"function","name":"CopyFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The source Point to copy the values from.","name":"source"},{"type":{"names":["Phaser.Geom.Point"]},"description":"The destination Point to copy the values to.","name":"dest"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The destination Point."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.CopyFrom","scope":"static","___s":true},{"meta":{"filename":"Equals.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"A comparison of two `Point` objects to see if they are equal.","kind":"function","name":"Equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The original `Point` to compare against.","name":"point"},{"type":{"names":["Phaser.Geom.Point"]},"description":"The second `Point` to compare.","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns true if the both `Point` objects are equal."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Equals","scope":"static","___s":true},{"meta":{"filename":"Floor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Apply `Math.ceil()` to each coordinate of the given Point.","kind":"function","name":"Floor","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to floor.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point with `Math.floor()` applied to its coordinates."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Floor","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"GetCentroid.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetCentroid.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Get the centroid or geometric center of a plane figure (the arithmetic mean position of all the points in the figure).\nInformally, it is the point at which a cutout of the shape could be perfectly balanced on the tip of a pin.","kind":"function","name":"GetCentroid","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"[description]","name":"points"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]"}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.GetCentroid","scope":"static","___s":true},{"meta":{"filename":"GetMagnitude.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Calculate the magnitude of the point, which equivalent to the length of the line from the origin to this point.","kind":"function","name":"GetMagnitude","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The point to calculate the magnitude for","name":"point"}],"returns":[{"type":{"names":["number"]},"description":"The resulting magnitude"}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.GetMagnitude","scope":"static","___s":true},{"meta":{"filename":"GetMagnitudeSq.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Calculates the square of magnitude of given point.(Can be used for fast magnitude calculation of point)","kind":"function","name":"GetMagnitudeSq","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"Returns square of the magnitude/length of given point.","name":"point"}],"returns":[{"type":{"names":["number"]},"description":"Returns square of the magnitude of given point."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.GetMagnitudeSq","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"GetRectangleFromPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetRectangleFromPoints.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Calculates the Axis Aligned Bounding Box (or aabb) from an array of points.","kind":"function","name":"GetRectangleFromPoints","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"[description]","name":"points"},{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"[description]"}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.GetRectangleFromPoints","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"Interpolate.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Interpolate.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"[description]","kind":"function","name":"Interpolate","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The starting `Point` for the interpolation.","name":"pointA"},{"type":{"names":["Phaser.Geom.Point"]},"description":"The target `Point` for the interpolation.","name":"pointB"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The amount to interpolate between the two points. Generally, a value between 0 (returns the starting `Point`) and 1 (returns the target `Point`). If omitted, 0 is used.","name":"t"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An optional `Point` object whose `x` and `y` values will be set to the result of the interpolation (can also be any object with `x` and `y` properties). If omitted, a new `Point` created and returned.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"Either the object from the `out` argument with the properties `x` and `y` set to the result of the interpolation or a newly created `Point` object."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Interpolate","scope":"static","___s":true},{"meta":{"filename":"Invert.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Swaps the X and the Y coordinate of a point.","kind":"function","name":"Invert","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to modify.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The modified `point`."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Invert","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"Negative.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Negative.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Inverts a Point's coordinates.","kind":"function","name":"Negative","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to invert.","name":"point"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"The Point to return the inverted coordinates in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The modified `out` Point, or a new Point if none was provided."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Negative","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Point.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Point.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"classdesc":"Defines a Point in 2D space, with an x and y component.","kind":"class","name":"Point","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of this Point.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y coordinate of this Point.","name":"y"}],"scope":"static","longname":"Phaser.Geom.Point","___s":true},{"meta":{"filename":"Point.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"The geometry constant type of this object: `GEOM_CONST.POINT`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Point.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"The x coordinate of this Point.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Point.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"The y coordinate of this Point.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Point.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Set the x and y coordinates of the point to the given values.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of this Point.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y coordinate of this Point.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"This Point object."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point#setTo","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"Project.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Project.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"[description]","kind":"function","name":"Project","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]","name":"pointA"},{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]","name":"pointB"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]"}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.Project","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"ProjectUnit.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ProjectUnit.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"[description]","kind":"function","name":"ProjectUnit","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]","name":"pointA"},{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]","name":"pointB"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]"}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.ProjectUnit","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"SetMagnitude.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"GetMagnitude","longname":"GetMagnitude","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetMagnitude.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"description":"Changes the magnitude (length) of a two-dimensional vector without changing its direction.","kind":"function","name":"SetMagnitude","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to treat as the end point of the vector.","name":"point"},{"type":{"names":["number"]},"description":"The new magnitude of the vector.","name":"magnitude"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The modified Point."}],"memberof":"Phaser.Geom.Point","longname":"Phaser.Geom.Point.SetMagnitude","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/point"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,210],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Polygon","longname":"Polygon","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Create a new polygon which is a copy of the specified polygon","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The polygon to create a clone of","name":"polygon"}],"returns":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"A new separate Polygon cloned from the specified polygon, based on the same points."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.Clone","scope":"static","___s":true},{"meta":{"filename":"Contains.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Checks if a point is within the bounds of a Polygon.","kind":"function","name":"Contains","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The Polygon to check against.","name":"polygon"},{"type":{"names":["number"]},"description":"The X coordinate of the point to check.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the point to check.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the point is within the bounds of the Polygon, otherwise `false`."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.Contains","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"[description]","kind":"function","name":"ContainsPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"[description]","name":"polygon"},{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]","name":"point"}],"returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.ContainsPoint","scope":"static","___s":true},{"meta":{"range":[180,225],"filename":"GetAABB.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetAABB.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Calculates the bounding AABB rectangle of a polygon.","kind":"function","name":"GetAABB","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The polygon that should be calculated.","name":"polygon"},{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"The rectangle or object that has x, y, width, and height properties to store the result. Optional.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The resulting rectangle or object that is passed in with position and dimensions of the polygon's AABB."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.GetAABB","scope":"static","___s":true},{"meta":{"filename":"GetNumberArray.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Stores all of the points of a Polygon into a flat array of numbers following the sequence [ x,y, x,y, x,y ],\ni.e. each point of the Polygon, in the order it's defined, corresponds to two elements of the resultant\narray for the point's X and Y coordinate.","kind":"function","name":"GetNumberArray","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The Polygon whose points to export.","name":"polygon"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to which the points' coordinates should be appended.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"The modified `output` array, or a new array if none was given."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.GetNumberArray","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"GetPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Length","longname":"Length","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoints.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Returns an array of Point objects containing the coordinates of the points around the perimeter of the Polygon,\nbased on the given quantity or stepRate values.","kind":"function","name":"GetPoints","since":"3.12.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The Polygon to get the points from.","name":"polygon"},{"type":{"names":["integer"]},"description":"The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Sets the quantity by getting the perimeter of the Polygon and dividing it by the stepRate.","name":"stepRate"},{"type":{"names":["array"]},"optional":true,"description":"An array to insert the points in to. If not provided a new array will be created.","name":"output"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Point objects pertaining to the points around the perimeter of the Polygon."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.GetPoints","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Perimeter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Length","longname":"Length","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Perimeter.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Returns the perimeter of the given Polygon.","kind":"function","name":"Perimeter","since":"3.12.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The Polygon to get the perimeter of.","name":"polygon"}],"returns":[{"type":{"names":["number"]},"description":"The perimeter of the Polygon."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.Perimeter","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Polygon.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Polygon.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"classdesc":"A Polygon object\n\nThe polygon is a closed shape consists of a series of connected straight lines defined by list of ordered points.\nSeveral formats are supported to define the list of points, check the setTo method for details. \nThis is a geometry object allowing you to define and inspect the shape.\nIt is not a Game Object, in that you cannot add it to the display list, and it has no texture.\nTo render a Polygon you should look at the capabilities of the Graphics class.","kind":"class","name":"Polygon","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["Array."]},"optional":true,"description":"List of points defining the perimeter of this Polygon. Several formats are supported: \n- A string containing paired x y values separated by a single space: `'40 0 40 20 100 20 100 80 40 80 40 100 0 50'`\n- An array of Point objects: `[new Phaser.Point(x1, y1), ...]`\n- An array of objects with public x y properties: `[obj1, obj2, ...]`\n- An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\n- An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`","name":"points"}],"scope":"static","longname":"Phaser.Geom.Polygon","___s":true},{"meta":{"filename":"Polygon.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"The geometry constant type of this object: `GEOM_CONST.POLYGON`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Polygon.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"The area of this Polygon.","name":"area","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#area","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Polygon.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"An array of number pair objects that make up this polygon. I.e. [ {x,y}, {x,y}, {x,y} ]","name":"points","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#points","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Polygon.js","lineno":76,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Check to see if the Polygon contains the given x / y coordinates.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to check within the polygon.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to check within the polygon.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the coordinates are within the polygon, otherwise `false`."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#contains","scope":"instance","___s":true},{"meta":{"filename":"Polygon.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Sets this Polygon to the given points.\n\nThe points can be set from a variety of formats:\n\n- A string containing paired values separated by a single space: `'40 0 40 20 100 20 100 80 40 80 40 100 0 50'`\n- An array of Point objects: `[new Phaser.Point(x1, y1), ...]`\n- An array of objects with public x/y properties: `[obj1, obj2, ...]`\n- An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\n- An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\n\n`setTo` may also be called without any arguments to remove all points.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"Points defining the perimeter of this polygon. Please check function description above for the different supported formats.","name":"points"}],"returns":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"This Polygon object."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#setTo","scope":"instance","___s":true},{"meta":{"filename":"Polygon.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Calculates the area of the Polygon. This is available in the property Polygon.area","kind":"function","name":"calculateArea","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The area of the polygon."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#calculateArea","scope":"instance","___s":true},{"meta":{"filename":"Polygon.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Returns an array of Point objects containing the coordinates of the points around the perimeter of the Polygon,\nbased on the given quantity or stepRate values.","kind":"function","name":"getPoints","since":"3.12.0","params":[{"type":{"names":["integer"]},"description":"The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Sets the quantity by getting the perimeter of the Polygon and dividing it by the stepRate.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to insert the points in to. If not provided a new array will be created.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Point objects pertaining to the points around the perimeter of the Polygon."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Reverse.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Reverses the order of the points of a Polygon.","kind":"function","name":"Reverse","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The Polygon to modify.","name":"polygon"}],"returns":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The modified Polygon."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.Reverse","scope":"static","___s":true},{"meta":{"range":[260,345],"filename":"Smooth.js","lineno":11,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"ignore":true,"name":"copy","longname":"copy","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"filename":"Smooth.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"description":"Takes a Polygon object and applies Chaikin's smoothing algorithm on its points.","kind":"function","name":"Smooth","since":"3.13.0","params":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The polygon to be smoothed. The polygon will be modified in-place and returned.","name":"polygon"}],"returns":[{"type":{"names":["Phaser.Geom.Polygon"]},"description":"The input polygon."}],"memberof":"Phaser.Geom.Polygon","longname":"Phaser.Geom.Polygon.Smooth","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/polygon"},"name":"Polygon","longname":"Polygon","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Area.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Calculates the area of the given Rectangle object.","kind":"function","name":"Area","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle to calculate the area of.","name":"rect"}],"returns":[{"type":{"names":["number"]},"description":"The area of the Rectangle object."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Area","scope":"static","___s":true},{"meta":{"filename":"Ceil.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Rounds a Rectangle's position up to the smallest integer greater than or equal to each current coordinate.","kind":"function","name":"Ceil","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to adjust.","name":"rect"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The adjusted Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Ceil","scope":"static","___s":true},{"meta":{"filename":"CeilAll.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Rounds a Rectangle's position and size up to the smallest integer greater than or equal to each respective value.","kind":"function","name":"CeilAll","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to modify.","name":"rect"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.CeilAll","scope":"static","___s":true},{"meta":{"filename":"CenterOn.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Moves the top-left corner of a Rectangle so that its center is at the given coordinates.","kind":"function","name":"CenterOn","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to be centered.","name":"rect"},{"type":{"names":["number"]},"description":"The X coordinate of the Rectangle's center.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the Rectangle's center.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The centered rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.CenterOn","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Creates a new Rectangle which is identical to the given one.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to clone.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The newly created Rectangle, which is separate from the given one."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Clone","scope":"static","___s":true},{"meta":{"filename":"Contains.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Checks if a given point is inside a Rectangle's bounds.","kind":"function","name":"Contains","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to check.","name":"rect"},{"type":{"names":["number"]},"description":"The X coordinate of the point to check.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the point to check.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the point is within the Rectangle's bounds, otherwise `false`."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Contains","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Determines whether the specified point is contained within the rectangular region defined by this Rectangle object.","kind":"function","name":"ContainsPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle object.","name":"rect"},{"type":{"names":["Phaser.Geom.Point"]},"description":"The point object to be checked. Can be a Phaser Point object or any object with x and y values.","name":"point"}],"returns":[{"type":{"names":["boolean"]},"description":"A value of true if the Rectangle object contains the specified point, otherwise false."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.ContainsPoint","scope":"static","___s":true},{"meta":{"filename":"ContainsRect.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Tests if one rectangle fully contains another.","kind":"function","name":"ContainsRect","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first rectangle.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second rectangle.","name":"rectB"}],"returns":[{"type":{"names":["boolean"]},"description":"True only if rectA fully contains rectB."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.ContainsRect","scope":"static","___s":true},{"meta":{"filename":"CopyFrom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Copy the values of one Rectangle to a destination Rectangle.","kind":"function","name":"CopyFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The source Rectangle to copy the values from.","name":"source"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The destination Rectangle to copy the values to.","name":"dest"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The destination Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.CopyFrom","scope":"static","___s":true},{"meta":{"filename":"Decompose.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Create an array of points for each corner of a Rectangle\nIf an array is specified, each point object will be added to the end of the array, otherwise a new array will be created.","kind":"function","name":"Decompose","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle object to be decomposed.","name":"rect"},{"type":{"names":["array"]},"optional":true,"description":"If provided, each point will be added to this array.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"Will return the array you specified or a new array containing the points of the Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Decompose","scope":"static","___s":true},{"meta":{"filename":"Equals.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Compares the `x`, `y`, `width` and `height` properties of two rectangles.","kind":"function","name":"Equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Rectangle A","name":"rect"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Rectangle B","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the rectangles' properties are an exact match, otherwise `false`."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Equals","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"FitInside.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"GetAspectRatio","longname":"GetAspectRatio","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FitInside.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Adjusts the target rectangle, changing its width, height and position,\nso that it fits inside the area of the source rectangle, while maintaining its original\naspect ratio.\n\nUnlike the `FitOutside` function, there may be some space inside the source area not covered.","kind":"function","name":"FitInside","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The target rectangle to adjust.","name":"target"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The source rectangle to envelop the target in.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified target rectangle instance."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.FitInside","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"FitOutside.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"GetAspectRatio","longname":"GetAspectRatio","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FitOutside.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Adjusts the target rectangle, changing its width, height and position,\nso that it fully covers the area of the source rectangle, while maintaining its original\naspect ratio.\n\nUnlike the `FitInside` function, the target rectangle may extend further out than the source.","kind":"function","name":"FitOutside","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The target rectangle to adjust.","name":"target"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The source rectangle to envelope the target in.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified target rectangle instance."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.FitOutside","scope":"static","___s":true},{"meta":{"filename":"Floor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Rounds down (floors) the top left X and Y coordinates of the given Rectangle to the largest integer less than or equal to them","kind":"function","name":"Floor","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle to floor the top left X and Y coordinates of","name":"rect"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle that was passed to this function with its coordinates floored."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Floor","scope":"static","___s":true},{"meta":{"filename":"FloorAll.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Rounds a Rectangle's position and size down to the largest integer less than or equal to each current coordinate or dimension.","kind":"function","name":"FloorAll","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to adjust.","name":"rect"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The adjusted Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.FloorAll","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"FromPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FromPoints.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Constructs new Rectangle or repositions and resizes an existing Rectangle so that all of the given points are on or within its bounds.","kind":"function","name":"FromPoints","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"An array of points (either arrays with two elements corresponding to the X and Y coordinate or an object with public `x` and `y` properties) which should be surrounded by the Rectangle.","name":"points"},{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"Optional Rectangle to adjust.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The adjusted `out` Rectangle, or a new Rectangle if none was provided."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.FromPoints","scope":"static","___s":true},{"meta":{"filename":"GetAspectRatio.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Calculates the width/height ratio of a rectangle.","kind":"function","name":"GetAspectRatio","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle.","name":"rect"}],"returns":[{"type":{"names":["number"]},"description":"The width/height ratio of the rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.GetAspectRatio","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"GetCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetCenter.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns the center of a Rectangle as a Point.","kind":"function","name":"GetCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to get the center of.","name":"rect"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"Optional point-like object to update with the center coordinates.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The modified `out` object, or a new Point if none was provided."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.GetCenter","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"GetPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Perimeter","longname":"Perimeter","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoint.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Position is a value between 0 and 1 where 0 = the top-left of the rectangle and 0.5 = the bottom right.","kind":"function","name":"GetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"[description]","name":"rectangle"},{"type":{"names":["number"]},"description":"[description]","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]"}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.GetPoint","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"GetPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"GetPoint","longname":"GetPoint","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoints.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Return an array of points from the perimeter of the rectangle, each spaced out based on the quantity or step required.","kind":"function","name":"GetPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle object to get the points from.","name":"rectangle"},{"type":{"names":["number"]},"description":"Step between points. Used to calculate the number of points to return when quantity is falsey. Ignored if quantity is positive.","name":"step"},{"type":{"names":["integer"]},"description":"The number of evenly spaced points from the rectangles perimeter to return. If falsey, step param will be used to calculate the number of points.","name":"quantity"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the perimeter of the rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.GetPoints","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"GetSize.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetSize.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The size of the Rectangle object, expressed as a Point object\n with the values of the width and height properties.","kind":"function","name":"GetSize","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"[description]","name":"rect"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"[description]"}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.GetSize","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"Inflate.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"CenterOn","longname":"CenterOn","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Inflate.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Increases the size of a Rectangle by a specified amount.\n\nThe center of the Rectangle stays the same. The amounts are added to each side, so the actual increase in width or height is two times bigger than the respective argument.","kind":"function","name":"Inflate","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to inflate.","name":"rect"},{"type":{"names":["number"]},"description":"How many pixels the left and the right side should be moved by horizontally.","name":"x"},{"type":{"names":["number"]},"description":"How many pixels the top and the bottom side should be moved by vertically.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The inflated Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Inflate","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Intersection.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Intersection.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Takes two Rectangles and first checks to see if they intersect.\nIf they intersect it will return the area of intersection in the `out` Rectangle.\nIf they do not intersect, the `out` Rectangle will have a width and height of zero.","kind":"function","name":"Intersection","since":"3.11.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle to get the intersection from.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle to get the intersection from.","name":"rectB"},{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"A Rectangle to store the intersection results in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The intersection result. If the width and height are zero, no intersection occurred."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Intersection","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"MarchingAnts.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Perimeter","longname":"Perimeter","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MarchingAnts.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Return an array of points from the perimeter of the rectangle\n each spaced out based on the quantity or step required","kind":"function","name":"MarchingAnts","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"[description]","name":"rect"},{"type":{"names":["number"]},"description":"[description]","name":"step"},{"type":{"names":["integer"]},"description":"[description]","name":"quantity"},{"type":{"names":["array","Array."]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"[description]"}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.MarchingAnts","scope":"static","___s":true},{"meta":{"filename":"MergePoints.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Merges a Rectangle with a list of points by repositioning and/or resizing it such that all points are located on or within its bounds.","kind":"function","name":"MergePoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle which should be merged.","name":"target"},{"type":{"names":["Array."]},"description":"An array of Points (or any object with public `x` and `y` properties) which should be merged with the Rectangle.","name":"points"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.MergePoints","scope":"static","___s":true},{"meta":{"filename":"MergeRect.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Merges the source rectangle into the target rectangle and returns the target.\nNeither rectangle should have a negative width or height.","kind":"function","name":"MergeRect","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Target rectangle. Will be modified to include source rectangle.","name":"target"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Rectangle that will be merged into target rectangle.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"Modified target rectangle that contains source rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.MergeRect","scope":"static","___s":true},{"meta":{"filename":"MergeXY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Merges a Rectangle with a point by repositioning and/or resizing it so that the point is on or within its bounds.","kind":"function","name":"MergeXY","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle which should be merged and modified.","name":"target"},{"type":{"names":["number"]},"description":"The X coordinate of the point which should be merged.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the point which should be merged.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified `target` Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.MergeXY","scope":"static","___s":true},{"meta":{"filename":"Offset.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Nudges (translates) the top left corner of a Rectangle by a given offset.","kind":"function","name":"Offset","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to adjust.","name":"rect"},{"type":{"names":["number"]},"description":"The distance to move the Rectangle horizontally.","name":"x"},{"type":{"names":["number"]},"description":"The distance to move the Rectangle vertically.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The adjusted Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Offset","scope":"static","___s":true},{"meta":{"filename":"OffsetPoint.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Nudges (translates) the top-left corner of a Rectangle by the coordinates of a point (translation vector).","kind":"function","name":"OffsetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to adjust.","name":"rect"},{"type":{"names":["Phaser.Geom.Point","Phaser.Math.Vector2"]},"description":"The point whose coordinates should be used as an offset.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The adjusted Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.OffsetPoint","scope":"static","___s":true},{"meta":{"filename":"Overlaps.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Checks if two Rectangles overlap. If a Rectangle is within another Rectangle, the two will be considered overlapping. Thus, the Rectangles are treated as \"solid\".","kind":"function","name":"Overlaps","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle to check.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle to check.","name":"rectB"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two Rectangles overlap, `false` otherwise."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Overlaps","scope":"static","___s":true},{"meta":{"filename":"Perimeter.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Calculates the perimeter of a Rectangle.","kind":"function","name":"Perimeter","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to use.","name":"rect"}],"returns":[{"type":{"names":["number"]},"description":"The perimeter of the Rectangle, equal to `(width * 2) + (height * 2)`."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Perimeter","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"PerimeterPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PerimeterPoint.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"[description]","kind":"function","name":"PerimeterPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"[description]","name":"rectangle"},{"type":{"names":["integer"]},"description":"[description]","name":"angle"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]"}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.PerimeterPoint","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Random.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Random.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns a random point within a Rectangle.","kind":"function","name":"Random","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The Rectangle to return a point from.","name":"rect"},{"type":{"names":["Phaser.Geom.Point"]},"description":"The object to update with the point's coordinates.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The modified `out` object, or a new Point if none was provided."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Random","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"RandomOutside.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Between","longname":"Between","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomOutside.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Calculates a random point that lies within the `outer` Rectangle, but outside of the `inner` Rectangle.\nThe inner Rectangle must be fully contained within the outer rectangle.","kind":"function","name":"RandomOutside","since":"3.10.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The outer Rectangle to get the random point within.","name":"outer"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The inner Rectangle to exclude from the returned point.","name":"inner"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"A Point, or Point-like object to store the result in. If not specified, a new Point will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"A Point object containing the random values in its `x` and `y` properties."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.RandomOutside","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Rectangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Rectangle.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"classdesc":"Encapsulates a 2D rectangle defined by its corner point in the top-left and its extends in x (width) and y (height)","kind":"class","name":"Rectangle","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The X coordinate of the top left corner of the Rectangle.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The Y coordinate of the top left corner of the Rectangle.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The width of the Rectangle.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The height of the Rectangle.","name":"height"}],"scope":"static","longname":"Phaser.Geom.Rectangle","___s":true},{"meta":{"filename":"Rectangle.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The geometry constant type of this object: `GEOM_CONST.RECTANGLE`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The X coordinate of the top left corner of the Rectangle.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The Y coordinate of the top left corner of the Rectangle.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The width of the Rectangle, i.e. the distance between its left side (defined by `x`) and its right side.","name":"width","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The height of the Rectangle, i.e. the distance between its top side (defined by `y`) and its bottom side.","name":"height","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Checks if the given point is inside the Rectangle's bounds.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the point to check.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the point to check.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the point is within the Rectangle's bounds, otherwise `false`."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#contains","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Calculates the coordinates of a point at a certain `position` on the Rectangle's perimeter.\n\nThe `position` is a fraction between 0 and 1 which defines how far into the perimeter the point is.\n\nA value of 0 or 1 returns the point at the top left corner of the rectangle, while a value of 0.5 returns the point at the bottom right corner of the rectangle. Values between 0 and 0.5 are on the top or the right side and values between 0.5 and 1 are on the bottom or the left side.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The normalized distance into the Rectangle's perimeter to return.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An object to update with the `x` and `y` coordinates of the point.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The updated `output` object, or a new Point if no `output` object was given."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getPoint","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":130,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns an array of points from the perimeter of the Rectangle, each spaced out based on the quantity or step required.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The number of points to return. Set to `false` or 0 to return an arbitrary number of points (`perimeter / stepRate`) evenly spaced around the Rectangle based on the `stepRate`.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"If `quantity` is 0, determines the normalized distance between each returned point.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to which to append the points.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"The modified `output` array, or a new array if none was provided."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns a random point within the Rectangle's bounds.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"The object in which to store the `x` and `y` coordinates of the point.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The updated `point`, or a new Point if none was provided."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Sets the position, width, and height of the Rectangle.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the top left corner of the Rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the top left corner of the Rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the Rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the Rectangle.","name":"height"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"This Rectangle object."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#setTo","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Resets the position, width, and height of the Rectangle to 0.","kind":"function","name":"setEmpty","since":"3.0.0","returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"This Rectangle object."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#setEmpty","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Sets the position of the Rectangle.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the top left corner of the Rectangle.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The Y coordinate of the top left corner of the Rectangle.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"This Rectangle object."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Sets the width and height of the Rectangle.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width to set the Rectangle to.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height to set the Rectangle to.","name":"height"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"This Rectangle object."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#setSize","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":244,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Determines if the Rectangle is empty. A Rectangle is empty if its width or height is less than or equal to 0.","kind":"function","name":"isEmpty","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Rectangle is empty. A Rectangle object is empty if its width or height is less than or equal to 0."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#isEmpty","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns a Line object that corresponds to the top of this Rectangle.","kind":"function","name":"getLineA","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to the top of this Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getLineA","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns a Line object that corresponds to the right of this Rectangle.","kind":"function","name":"getLineB","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to the right of this Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getLineB","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":299,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns a Line object that corresponds to the bottom of this Rectangle.","kind":"function","name":"getLineC","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to the bottom of this Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getLineC","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":320,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Returns a Line object that corresponds to the left of this Rectangle.","kind":"function","name":"getLineD","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to the left of this Rectangle."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#getLineD","scope":"instance","___s":true},{"meta":{"filename":"Rectangle.js","lineno":341,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The x coordinate of the left of the Rectangle.\nChanging the left property of a Rectangle object has no effect on the y and height properties. However it does affect the width property, whereas changing the x value does not affect the width property.","name":"left","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The sum of the x and width properties.\nChanging the right property of a Rectangle object has no effect on the x, y and height properties, however it does affect the width property.","name":"right","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":401,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The y coordinate of the top of the Rectangle. Changing the top property of a Rectangle object has no effect on the x and width properties.\nHowever it does affect the height property, whereas changing the y value does not affect the height property.","name":"top","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The sum of the y and height properties.\nChanging the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.","name":"bottom","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":461,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The x coordinate of the center of the Rectangle.","name":"centerX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#centerX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Rectangle.js","lineno":482,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"The y coordinate of the center of the Rectangle.","name":"centerY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle#centerY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SameDimensions.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Determines if the two objects (either Rectangles or Rectangle-like) have the same width and height values under strict equality.","kind":"function","name":"SameDimensions","since":"3.15.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle object.","name":"rect"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle object.","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the objects have equivalent values for the `width` and `height` properties, otherwise `false`."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.SameDimensions","scope":"static","___s":true},{"meta":{"filename":"Scale.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Scales the width and height of this Rectangle by the given amounts.","kind":"function","name":"Scale","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The `Rectangle` object that will be scaled by the specified amount(s).","name":"rect"},{"type":{"names":["number"]},"description":"The factor by which to scale the rectangle horizontally.","name":"x"},{"type":{"names":["number"]},"description":"The amount by which to scale the rectangle vertically. If this is not specified, the rectangle will be scaled by the factor `x` in both directions.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The rectangle object with updated `width` and `height` properties as calculated from the scaling factor(s)."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Scale","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Union.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Union.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"description":"Creates a new Rectangle or repositions and/or resizes an existing Rectangle so that it encompasses the two given Rectangles, i.e. calculates their union.","kind":"function","name":"Union","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The first Rectangle to use.","name":"rectA"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The second Rectangle to use.","name":"rectB"},{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the union in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"The modified `out` Rectangle, or a new Rectangle if none was provided."}],"memberof":"Phaser.Geom.Rectangle","longname":"Phaser.Geom.Rectangle.Union","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/rectangle"},"name":"Rectangle","longname":"Rectangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Area.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns the area of a Triangle.","kind":"function","name":"Area","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to use.","name":"triangle"}],"returns":[{"type":{"names":["number"]},"description":"The area of the Triangle, always non-negative."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Area","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"BuildEquilateral.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Triangle","longname":"Triangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BuildEquilateral.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Builds an equilateral triangle. In the equilateral triangle, all the sides are the same length (congruent) and all the angles are the same size (congruent).\nThe x/y specifies the top-middle of the triangle (x1/y1) and length is the length of each side.","kind":"function","name":"BuildEquilateral","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"x coordinate of the top point of the triangle.","name":"x"},{"type":{"names":["number"]},"description":"y coordinate of the top point of the triangle.","name":"y"},{"type":{"names":["number"]},"description":"Length of each side of the triangle.","name":"length"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle object of the given size."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.BuildEquilateral","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"BuildFromPolygon.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"EarCut","longname":"EarCut","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BuildFromPolygon.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"[description]","kind":"function","name":"BuildFromPolygon","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"A flat array of vertex coordinates like [x0,y0, x1,y1, x2,y2, ...]","name":"data"},{"type":{"names":["array"]},"optional":true,"defaultvalue":null,"description":"An array of hole indices if any (e.g. [5, 8] for a 12-vertex input would mean one hole with vertices 5–7 and another with 8–11).","name":"holes"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"[description]","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"[description]","name":"scaleY"},{"type":{"names":["array","Array."]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"[description]"}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.BuildFromPolygon","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"BuildRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Triangle","longname":"Triangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BuildRight.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Builds a right triangle, i.e. one which has a 90-degree angle and two acute angles.","kind":"function","name":"BuildRight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the right angle, which will also be the first X coordinate of the constructed Triangle.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the right angle, which will also be the first Y coordinate of the constructed Triangle.","name":"y"},{"type":{"names":["number"]},"description":"The length of the side which is to the left or to the right of the right angle.","name":"width"},{"type":{"names":["number"]},"description":"The length of the side which is above or below the right angle.","name":"height"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The constructed right Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.BuildRight","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"CenterOn.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Centroid","longname":"Centroid","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CenterOn.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"kind":"typedef","name":"CenterFunction","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to return the center coordinates of.","name":"triangle"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The center point of the Triangle according to the function."}],"longname":"CenterFunction","scope":"global","___s":true},{"meta":{"filename":"CenterOn.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Positions the Triangle so that it is centered on the given coordinates.","kind":"function","name":"CenterOn","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The triangle to be positioned.","name":"triangle"},{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"},{"type":{"names":["CenterFunction"]},"optional":true,"description":"The function used to center the triangle. Defaults to Centroid centering.","name":"centerFunc"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle that was centered."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.CenterOn","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Centroid.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Centroid.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Calculates the position of a Triangle's centroid, which is also its center of mass (center of gravity).\n\nThe centroid is the point in a Triangle at which its three medians (the lines drawn from the vertices to the bisectors of the opposite sides) meet. It divides each one in a 2:1 ratio.","kind":"function","name":"Centroid","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to use.","name":"triangle"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An object to store the coordinates in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The `out` object with modified `x` and `y` properties, or a new Point if none was provided."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Centroid","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"CircumCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Vector2","longname":"Vector2","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CircumCenter.js","lineno":30,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Computes the circumcentre of a triangle. The circumcentre is the centre of\nthe circumcircle, the smallest circle which encloses the triangle. It is also\nthe common intersection point of the perpendicular bisectors of the sides of\nthe triangle, and is the only point which has equal distance to all three\nvertices of the triangle.","kind":"function","name":"CircumCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"[description]","name":"triangle"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"[description]"}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.CircumCenter","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"CircumCircle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Circle","longname":"Circle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CircumCircle.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Finds the circumscribed circle (circumcircle) of a Triangle object. The circumcircle is the circle which touches all of the triangle's vertices.","kind":"function","name":"CircumCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to use as input.","name":"triangle"},{"type":{"names":["Phaser.Geom.Circle"]},"optional":true,"description":"An optional Circle to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Circle"]},"description":"The updated `out` Circle, or a new Circle if none was provided."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.CircumCircle","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"Clone.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Triangle","longname":"Triangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clone.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Clones a Triangle object.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to clone.","name":"source"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"A new Triangle identical to the given one but separate from it."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Clone","scope":"static","___s":true},{"meta":{"filename":"Contains.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Checks if a point (as a pair of coordinates) is inside a Triangle's bounds.","kind":"function","name":"Contains","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to check.","name":"triangle"},{"type":{"names":["number"]},"description":"The X coordinate of the point to check.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the point to check.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the point is inside the Triangle, otherwise `false`."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Contains","scope":"static","___s":true},{"meta":{"filename":"ContainsArray.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Filters an array of point-like objects to only those contained within a triangle.\nIf `returnFirst` is true, will return an array containing only the first point in the provided array that is within the triangle (or an empty array if there are no such points).","kind":"function","name":"ContainsArray","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The triangle that the points are being checked in.","name":"triangle"},{"type":{"names":["Array."]},"description":"An array of point-like objects (objects that have an `x` and `y` property)","name":"points"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true`, return an array containing only the first point found that is within the triangle.","name":"returnFirst"},{"type":{"names":["array"]},"optional":true,"description":"If provided, the points that are within the triangle will be appended to this array instead of being added to a new array. If `returnFirst` is true, only the first point found within the triangle will be appended. This array will also be returned by this function.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing all the points from `points` that are within the triangle, if an array was provided as `out`, points will be appended to that array and it will also be returned here."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.ContainsArray","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"ContainsPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Contains","longname":"Contains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ContainsPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Tests if a triangle contains a point.","kind":"function","name":"ContainsPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The triangle.","name":"triangle"},{"type":{"names":["Phaser.Geom.Point","Phaser.Math.Vector2","any"]},"description":"The point to test, or any point-like object with public `x` and `y` properties.","name":"point"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the point is within the triangle, otherwise `false`."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.ContainsPoint","scope":"static","___s":true},{"meta":{"filename":"CopyFrom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Copy the values of one Triangle to a destination Triangle.","kind":"function","name":"CopyFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The source Triangle to copy the values from.","name":"source"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The destination Triangle to copy the values to.","name":"dest"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The destination Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.CopyFrom","scope":"static","___s":true},{"meta":{"filename":"Decompose.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Decomposes a Triangle into an array of its points.","kind":"function","name":"Decompose","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to decompose.","name":"triangle"},{"type":{"names":["array"]},"optional":true,"description":"An array to store the points into.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"The provided `out` array, or a new array if none was provided, with three objects with `x` and `y` properties representing each point of the Triangle appended to it."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Decompose","scope":"static","___s":true},{"meta":{"filename":"Equals.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns true if two triangles have the same coordinates.","kind":"function","name":"Equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The first triangle to check.","name":"triangle"},{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The second triangle to check.","name":"toCompare"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two given triangles have the exact same coordinates, otherwise `false`."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Equals","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"GetPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoint.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns a Point from around the perimeter of a Triangle.","kind":"function","name":"GetPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to get the point on its perimeter from.","name":"triangle"},{"type":{"names":["number"]},"description":"The position along the perimeter of the triangle. A value between 0 and 1.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"An option Point, or Point-like object to store the value in. If not given a new Point will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"A Point object containing the given position from the perimeter of the triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.GetPoint","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"GetPoints.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Length","longname":"Length","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPoints.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns an array of evenly spaced points on the perimeter of a Triangle.","kind":"function","name":"GetPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to get the points from.","name":"triangle"},{"type":{"names":["integer"]},"description":"The number of evenly spaced points to return. Set to 0 to return an arbitrary number of points based on the `stepRate`.","name":"quantity"},{"type":{"names":["number"]},"description":"If `quantity` is 0, the distance between each returned point.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An array to which the points should be appended.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"The modified `out` array, or a new array if none was provided."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.GetPoints","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"InCenter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"InCenter.js","lineno":21,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Calculates the position of the incenter of a Triangle object. This is the point where its three angle bisectors meet and it's also the center of the incircle, which is the circle inscribed in the triangle.","kind":"function","name":"InCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to find the incenter of.","name":"triangle"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"An optional Point in which to store the coordinates.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"Point (x, y) of the center pixel of the triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.InCenter","scope":"static","___s":true},{"meta":{"filename":"Offset.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Moves each point (vertex) of a Triangle by a given offset, thus moving the entire Triangle by that offset.","kind":"function","name":"Offset","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to move.","name":"triangle"},{"type":{"names":["number"]},"description":"The horizontal offset (distance) by which to move each point. Can be positive or negative.","name":"x"},{"type":{"names":["number"]},"description":"The vertical offset (distance) by which to move each point. Can be positive or negative.","name":"y"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The modified Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Offset","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Perimeter.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Length","longname":"Length","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Perimeter.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Gets the length of the perimeter of the given triangle.","kind":"function","name":"Perimeter","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"[description]","name":"triangle"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Perimeter","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Random.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Point","longname":"Point","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Random.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"[description]","kind":"function","name":"Random","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"[description]","name":"triangle"},{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"[description]","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"[description]"}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Random","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"Rotate.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"RotateAroundXY","longname":"RotateAroundXY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Rotate.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Rotates a Triangle about its incenter, which is the point at which its three angle bisectors meet.","kind":"function","name":"Rotate","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to rotate.","name":"triangle"},{"type":{"names":["number"]},"description":"The angle by which to rotate the Triangle, in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The rotated Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.Rotate","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"RotateAroundPoint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"RotateAroundXY","longname":"RotateAroundXY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateAroundPoint.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Rotates a Triangle at a certain angle about a given Point or object with public `x` and `y` properties.","kind":"function","name":"RotateAroundPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to rotate.","name":"triangle"},{"type":{"names":["Phaser.Geom.Point"]},"description":"The Point to rotate the Triangle about.","name":"point"},{"type":{"names":["number"]},"description":"The angle by which to rotate the Triangle, in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The rotated Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.RotateAroundPoint","scope":"static","___s":true},{"meta":{"filename":"RotateAroundXY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Rotates an entire Triangle at a given angle about a specific point.","kind":"function","name":"RotateAroundXY","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The Triangle to rotate.","name":"triangle"},{"type":{"names":["number"]},"description":"The X coordinate of the point to rotate the Triangle about.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the point to rotate the Triangle about.","name":"y"},{"type":{"names":["number"]},"description":"The angle by which to rotate the Triangle, in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"The rotated Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle.RotateAroundXY","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Triangle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Triangle.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"classdesc":"A triangle is a plane created by connecting three points.\nThe first two arguments specify the first point, the middle two arguments\nspecify the second point, and the last two arguments specify the third point.","kind":"class","name":"Triangle","memberof":"Phaser.Geom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`x` coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`y` coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`x` coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`y` coordinate of the second point.","name":"y2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`x` coordinate of the third point.","name":"x3"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`y` coordinate of the third point.","name":"y3"}],"scope":"static","longname":"Phaser.Geom.Triangle","___s":true},{"meta":{"filename":"Triangle.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"The geometry constant type of this object: `GEOM_CONST.TRIANGLE`.\nUsed for fast type comparisons.","name":"type","type":{"names":["integer"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"`x` coordinate of the first point.","name":"x1","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#x1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"`y` coordinate of the first point.","name":"y1","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#y1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"`x` coordinate of the second point.","name":"x2","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#x2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"`y` coordinate of the second point.","name":"y2","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#y2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"`x` coordinate of the third point.","name":"x3","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#x3","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"`y` coordinate of the third point.","name":"y3","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#y3","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":118,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Checks whether a given points lies within the triangle.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the point to check.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the point to check.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the coordinate pair is within the triangle, otherwise `false`."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#contains","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns a specific point on the triangle.","kind":"function","name":"getPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Position as float within `0` and `1`. `0` equals the first point.","name":"position"},{"type":{"names":["Phaser.Geom.Point","object"]},"optional":true,"description":"Optional Point, or point-like object, that the calculated point will be written to.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"Calculated `Point` that represents the requested position. It is the same as `output` when this parameter has been given."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#getPoint","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Calculates a list of evenly distributed points on the triangle. It is either possible to pass an amount of points to be generated (`quantity`) or the distance between two points (`stepRate`).","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"Number of points to be generated. Can be falsey when `stepRate` should be used. All points have the same distance along the triangle.","name":"quantity"},{"type":{"names":["number"]},"optional":true,"description":"Distance between two points. Will only be used when `quantity` is falsey.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"Optional Array for writing the calculated points into. Otherwise a new array will be created.","name":"output"}],"returns":[{"type":{"names":["array","Array."]},"description":"Returns a list of calculated `Point` instances or the filled array passed as parameter `output`."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#getPoints","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":171,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns a random point along the triangle.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point"]},"optional":true,"description":"Optional `Point` that should be modified. Otherwise a new one will be created.","name":"point"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"Random `Point`. When parameter `point` has been provided it will be returned."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#getRandomPoint","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Sets all three points of the triangle. Leaving out any coordinate sets it to be `0`.","kind":"function","name":"setTo","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`x` coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`y` coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`x` coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`y` coordinate of the second point.","name":"y2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`x` coordinate of the third point.","name":"x3"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"`y` coordinate of the third point.","name":"y3"}],"returns":[{"type":{"names":["Phaser.Geom.Triangle"]},"description":"This Triangle object."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#setTo","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":224,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns a Line object that corresponds to Line A of this Triangle.","kind":"function","name":"getLineA","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to line A of this Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#getLineA","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns a Line object that corresponds to Line B of this Triangle.","kind":"function","name":"getLineB","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to line B of this Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#getLineB","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":266,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Returns a Line object that corresponds to Line C of this Triangle.","kind":"function","name":"getLineC","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Line"]},"optional":true,"description":"A Line object to set the results in. If `undefined` a new Line will be created.","name":"line"}],"returns":[{"type":{"names":["Phaser.Geom.Line"]},"description":"A Line object that corresponds to line C of this Triangle."}],"memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#getLineC","scope":"instance","___s":true},{"meta":{"filename":"Triangle.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Left most X coordinate of the triangle. Setting it moves the triangle on the X axis accordingly.","name":"left","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":325,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Right most X coordinate of the triangle. Setting it moves the triangle on the X axis accordingly.","name":"right","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":363,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Top most Y coordinate of the triangle. Setting it moves the triangle on the Y axis accordingly.","name":"top","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Triangle.js","lineno":401,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"description":"Bottom most Y coordinate of the triangle. Setting it moves the triangle on the Y axis accordingly.","name":"bottom","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Geom.Triangle","longname":"Phaser.Geom.Triangle#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,212],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/geom/triangle"},"name":"Triangle","longname":"Triangle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CreateInteractiveObject.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Creates a new Interactive Object.\n\nThis is called automatically by the Input Manager when you enable a Game Object for input.\n\nThe resulting Interactive Object is mapped to the Game Object's `input` property.","kind":"function","name":"CreateInteractiveObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to which this Interactive Object is bound.","name":"gameObject"},{"type":{"names":["any"]},"description":"The hit area for this Interactive Object. Typically a geometry shape, like a Rectangle or Circle.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"The 'contains' check callback that the hit area shape will use for all hit tests.","name":"hitAreaCallback"}],"returns":[{"type":{"names":["Phaser.Types.Input.InteractiveObject"]},"description":"The new Interactive Object."}],"memberof":"Phaser.Input","longname":"Phaser.Input.CreateInteractiveObject","scope":"static","___s":true},{"meta":{"filename":"CreatePixelPerfectHandler.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Creates a new Pixel Perfect Handler function.\n\nAccess via `InputPlugin.makePixelPerfect` rather than calling it directly.","kind":"function","name":"CreatePixelPerfectHandler","since":"3.10.0","params":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"A reference to the Texture Manager.","name":"textureManager"},{"type":{"names":["integer"]},"description":"The alpha level that the pixel should be above to be included as a successful interaction.","name":"alphaTolerance"}],"returns":[{"type":{"names":["function"]},"description":"The new Pixel Perfect Handler function."}],"memberof":"Phaser.Input","longname":"Phaser.Input.CreatePixelPerfectHandler","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"InputManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"InputManager.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"classdesc":"The Input Manager is responsible for handling the pointer related systems in a single Phaser Game instance.\n\nBased on the Game Config it will create handlers for mouse and touch support.\n\nKeyboard and Gamepad are plugins, handled directly by the InputPlugin class.\n\nIt then manages the events, pointer creation and general hit test related operations.\n\nYou rarely need to interact with the Input Manager directly, and as such, all of its properties and methods\nshould be considered private. Instead, you should use the Input Plugin, which is a Scene level system, responsible\nfor dealing with all input events for a Scene.","kind":"class","name":"InputManager","memberof":"Phaser.Input","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Game instance that owns the Input Manager.","name":"game"},{"type":{"names":["object"]},"description":"The Input Configuration object, as set in the Game Config.","name":"config"}],"scope":"static","longname":"Phaser.Input.InputManager","___s":true},{"meta":{"filename":"InputManager.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The Game instance that owns the Input Manager.\nA Game only maintains on instance of the Input Manager at any time.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the global Game Scale Manager.\nUsed for all bounds checks and pointer scaling.","name":"scaleManager","type":{"names":["Phaser.Scale.ScaleManager"]},"since":"3.16.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#scaleManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The Canvas that is used for all DOM event input listeners.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The Game Configuration object, as set during the game boot.","name":"config","type":{"names":["Phaser.Core.Config"]},"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If set, the Input Manager will run its update loop every frame.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The Event Emitter instance that the Input Manager uses to emit events from.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Are any mouse or touch pointers currently over the game canvas?\nThis is updated automatically by the canvas over and out handlers.","name":"isOver","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#isOver","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The default CSS cursor to be used when interacting with your game.\n\nSee the `setDefaultCursor` method for more details.","name":"defaultCursor","type":{"names":["string"]},"since":"3.10.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#defaultCursor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Keyboard Manager class, if enabled via the `input.keyboard` Game Config property.","name":"keyboard","type":{"names":["Phaser.Input.Keyboard.KeyboardManager"]},"nullable":true,"since":"3.16.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#keyboard","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Mouse Manager class, if enabled via the `input.mouse` Game Config property.","name":"mouse","type":{"names":["Phaser.Input.Mouse.MouseManager"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#mouse","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":145,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Touch Manager class, if enabled via the `input.touch` Game Config property.","name":"touch","type":{"names":["Phaser.Input.Touch.TouchManager"]},"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#touch","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":154,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"An array of Pointers that have been added to the game.\nThe first entry is reserved for the Mouse Pointer, the rest are Touch Pointers.\n\nBy default there is 1 touch pointer enabled. If you need more use the `addPointer` method to start them,\nor set the `input.activePointers` property in the Game Config.","name":"pointers","type":{"names":["Array."]},"since":"3.10.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#pointers","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The number of touch objects activated and being processed each update.\n\nYou can change this by either calling `addPointer` at run-time, or by\nsetting the `input.activePointers` property in the Game Config.","name":"pointersTotal","type":{"names":["integer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#pointersTotal","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":194,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The mouse has its own unique Pointer object, which you can reference directly if making a _desktop specific game_.\nIf you are supporting both desktop and touch devices then do not use this property, instead use `activePointer`\nwhich will always map to the most recently interacted pointer.","name":"mousePointer","type":{"names":["Phaser.Input.Pointer"]},"nullable":true,"since":"3.10.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#mousePointer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The most recently active Pointer object.\n\nIf you've only 1 Pointer in your game then this will accurately be either the first finger touched, or the mouse.\n\nIf your game doesn't need to support multi-touch then you can safely use this property in all of your game\ncode and it will adapt to be either the mouse or the touch, based on device.","name":"activePointer","type":{"names":["Phaser.Input.Pointer"]},"since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#activePointer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":219,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the top-most Scene in the Scene List receives an input it will stop input from\npropagating any lower down the scene list, i.e. if you have a UI Scene at the top\nand click something on it, that click will not then be passed down to any other\nScene below. Disable this to have input events passed through all Scenes, all the time.","name":"globalTopOnly","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#globalTopOnly","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":232,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The time this Input Manager was last updated.\nThis value is populated by the Game Step each frame.","name":"time","type":{"names":["number"]},"readonly":true,"since":"3.16.2","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#time","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputManager.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Tells the Input system to set a custom cursor.\n\nThis cursor will be the default cursor used when interacting with the game canvas.\n\nIf an Interactive Object also sets a custom cursor, this is the cursor that is reset after its use.\n\nAny valid CSS cursor value is allowed, including paths to image files, i.e.:\n\n```javascript\nthis.input.setDefaultCursor('url(assets/cursors/sword.cur), pointer');\n```\n\nPlease read about the differences between browsers when it comes to the file formats and sizes they support:\n\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/cursor\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/CSS_User_Interface/Using_URL_values_for_the_cursor_property\n\nIt's up to you to pick a suitable cursor format that works across the range of browsers you need to support.","kind":"function","name":"setDefaultCursor","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"The CSS to be used when setting the default cursor.","name":"cursor"}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#setDefaultCursor","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":467,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Adds new Pointer objects to the Input Manager.\n\nBy default Phaser creates 2 pointer objects: `mousePointer` and `pointer1`.\n\nYou can create more either by calling this method, or by setting the `input.activePointers` property\nin the Game Config, up to a maximum of 10 pointers.\n\nThe first 10 pointers are available via the `InputPlugin.pointerX` properties, once they have been added\nvia this method.","kind":"function","name":"addPointer","since":"3.10.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The number of new Pointers to create. A maximum of 10 is allowed in total.","name":"quantity"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing all of the new Pointer objects that were created."}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#addPointer","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":514,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Internal method that gets a list of all the active Input Plugins in the game\nand updates each of them in turn, in reverse order (top to bottom), to allow\nfor DOM top-level event handling simulation.","kind":"function","name":"updateInputPlugins","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The type of event to process.","name":"type"},{"type":{"names":["Array."]},"description":"An array of Pointers on which the event occurred.","name":"pointers"}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#updateInputPlugins","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":838,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Performs a hit test using the given Pointer and camera, against an array of interactive Game Objects.\n\nThe Game Objects are culled against the camera, and then the coordinates are translated into the local camera space\nand used to determine if they fall within the remaining Game Objects hit areas or not.\n\nIf nothing is matched an empty array is returned.\n\nThis method is called automatically by InputPlugin.hitTestPointer and doesn't usually need to be invoked directly.","kind":"function","name":"hitTest","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer to test against.","name":"pointer"},{"type":{"names":["array"]},"description":"An array of interactive Game Objects to check.","name":"gameObjects"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera which is being tested against.","name":"camera"},{"type":{"names":["array"]},"optional":true,"description":"An array to store the results in. If not given, a new empty array is created.","name":"output"}],"returns":[{"type":{"names":["array"]},"description":"An array of the Game Objects that were hit during this hit test."}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#hitTest","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":923,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks if the given x and y coordinate are within the hit area of the Game Object.\n\nThis method assumes that the coordinate values have already been translated into the space of the Game Object.\n\nIf the coordinates are within the hit area they are set into the Game Objects Input `localX` and `localY` properties.","kind":"function","name":"pointWithinHitArea","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object to check against.","name":"gameObject"},{"type":{"names":["number"]},"description":"The translated x coordinate for the hit test.","name":"x"},{"type":{"names":["number"]},"description":"The translated y coordinate for the hit test.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the coordinates were inside the Game Objects hit area, otherwise `false`."}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#pointWithinHitArea","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":960,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks if the given x and y coordinate are within the hit area of the Interactive Object.\n\nThis method assumes that the coordinate values have already been translated into the space of the Interactive Object.\n\nIf the coordinates are within the hit area they are set into the Interactive Objects Input `localX` and `localY` properties.","kind":"function","name":"pointWithinInteractiveObject","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InteractiveObject"]},"description":"The Interactive Object to check against.","name":"object"},{"type":{"names":["number"]},"description":"The translated x coordinate for the hit test.","name":"x"},{"type":{"names":["number"]},"description":"The translated y coordinate for the hit test.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the coordinates were inside the Game Objects hit area, otherwise `false`."}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#pointWithinInteractiveObject","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":993,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Transforms the pageX and pageY values of a Pointer into the scaled coordinate space of the Input Manager.","kind":"function","name":"transformPointer","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer to transform the values for.","name":"pointer"},{"type":{"names":["number"]},"description":"The Page X value.","name":"pageX"},{"type":{"names":["number"]},"description":"The Page Y value.","name":"pageY"},{"type":{"names":["boolean"]},"description":"Are we transforming the Pointer from a move event, or an up / down event?","name":"wasMove"}],"memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#transformPointer","scope":"instance","___s":true},{"meta":{"filename":"InputManager.js","lineno":1033,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Destroys the Input Manager and all of its systems.\n\nThere is no way to recover from doing this.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Input.InputManager","longname":"Phaser.Input.InputManager#destroy","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"InputPlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"name":"Circle","longname":"Circle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"InputPlugin.js","lineno":29,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"classdesc":"The Input Plugin belongs to a Scene and handles all input related events and operations for it.\n\nYou can access it from within a Scene using `this.input`.\n\nIt emits events directly. For example, you can do:\n\n```javascript\nthis.input.on('pointerdown', callback, context);\n```\n\nTo listen for a pointer down event anywhere on the game canvas.\n\nGame Objects can be enabled for input by calling their `setInteractive` method. After which they\nwill directly emit input events:\n\n```javascript\nvar sprite = this.add.sprite(x, y, texture);\nsprite.setInteractive();\nsprite.on('pointerdown', callback, context);\n```\n\nThere are lots of game configuration options available relating to input.\nSee the [Input Config object]{@linkcode Phaser.Types.Core.InputConfig} for more details, including how to deal with Phaser\nlistening for input events outside of the canvas, how to set a default number of pointers, input\ncapture settings and more.\n\nPlease also see the Input examples and tutorials for further information.","kind":"class","name":"InputPlugin","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Input","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that this Input Plugin is responsible for.","name":"scene"}],"scope":"static","longname":"Phaser.Input.InputPlugin","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Scene that this Input Plugin is responsible for.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Scene Systems class.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Scene Systems Settings.","name":"settings","type":{"names":["Phaser.Types.Scenes.SettingsObject"]},"since":"3.5.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#settings","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Game Input Manager.","name":"manager","type":{"names":["Phaser.Input.InputManager"]},"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If `true` this Input Plugin will process DOM input events.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.5.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Scene Display List. This property is set during the `boot` method.","name":"displayList","type":{"names":["Phaser.GameObjects.DisplayList"]},"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#displayList","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Scene Cameras Manager. This property is set during the `boot` method.","name":"cameras","type":{"names":["Phaser.Cameras.Scene2D.CameraManager"]},"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#cameras","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":154,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Mouse Manager.\n\nThis property is only set if Mouse support has been enabled in your Game Configuration file.\n\nIf you just wish to get access to the mouse pointer, use the `mousePointer` property instead.","name":"mouse","type":{"names":["Phaser.Input.Mouse.MouseManager"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#mouse","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"When set to `true` (the default) the Input Plugin will emulate DOM behavior by only emitting events from\nthe top-most Game Objects in the Display List.\n\nIf set to `false` it will emit events from all Game Objects below a Pointer, not just the top one.","name":"topOnly","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#topOnly","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":180,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"How often should the Pointers be checked?\n\nThe value is a time, given in ms, and is the time that must have elapsed between game steps before\nthe Pointers will be polled again. When a pointer is polled it runs a hit test to see which Game\nObjects are currently below it, or being interacted with it.\n\nPointers will *always* be checked if they have been moved by the user, or press or released.\n\nThis property only controls how often they will be polled if they have not been updated.\nYou should set this if you want to have Game Objects constantly check against the pointers, even\nif the pointer didn't itself move.\n\nSet to 0 to poll constantly. Set to -1 to only poll on user movement.","name":"pollRate","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pollRate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":240,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The distance, in pixels, a pointer has to move while being held down, before it thinks it is being dragged.","name":"dragDistanceThreshold","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#dragDistanceThreshold","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":250,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The amount of time, in ms, a pointer has to be held down before it thinks it is dragging.\n\nThe default polling rate is to poll only on move so once the time threshold is reached the\ndrag event will not start until you move the mouse. If you want it to start immediately\nwhen the time threshold is reached, you must increase the polling rate by calling\n[setPollAlways]{@linkcode Phaser.Input.InputPlugin#setPollAlways} or\n[setPollRate]{@linkcode Phaser.Input.InputPlugin#setPollRate}.","name":"dragTimeThreshold","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#dragTimeThreshold","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":522,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if both this plugin and the Scene to which it belongs is active.","kind":"function","name":"isActive","since":"3.10.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the plugin and the Scene it belongs to is active."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#isActive","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":535,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"This is called automatically by the Input Manager.\nIt emits events for plugins to listen to and also handles polling updates, if enabled.","kind":"function","name":"updatePoll","since":"3.18.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the plugin and the Scene it belongs to is active."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#updatePoll","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":757,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Clears a Game Object so it no longer has an Interactive Object associated with it.\nThe Game Object is then queued for removal from the Input Plugin on the next update.","kind":"function","name":"clear","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will have its Interactive Object removed.","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip adding this Game Object into the removal queue?","name":"skipQueue"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that had its Interactive Object removed."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#clear","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":821,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Disables Input on a single Game Object.\n\nAn input disabled Game Object still retains its Interactive Object component and can be re-enabled\nat any time, by passing it to `InputPlugin.enable`.","kind":"function","name":"disable","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to have its input system disabled.","name":"gameObject"}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#disable","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":837,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Enable a Game Object for interaction.\n\nIf the Game Object already has an Interactive Object component, it is enabled and returned.\n\nOtherwise, a new Interactive Object component is created and assigned to the Game Object's `input` property.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"enable","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to be enabled for input.","name":"gameObject"},{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The 'contains' function to invoke to check if the pointer is within the hit area.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object a drop zone or not?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This Input Plugin."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#enable","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":887,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Takes the given Pointer and performs a hit test against it, to see which interactive Game Objects\nit is currently above.\n\nThe hit test is performed against which-ever Camera the Pointer is over. If it is over multiple\ncameras, it starts checking the camera at the top of the camera list, and if nothing is found, iterates down the list.","kind":"function","name":"hitTestPointer","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer to check against the Game Objects.","name":"pointer"}],"returns":[{"type":{"names":["Array."]},"description":"An array of all the interactive Game Objects the Pointer was above."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#hitTestPointer","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":1012,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Returns the drag state of the given Pointer for this Input Plugin.\n\nThe state will be one of the following:\n\n0 = Not dragging anything\n1 = Primary button down and objects below, so collect a draglist\n2 = Pointer being checked if meets drag criteria\n3 = Pointer meets criteria, notify the draglist\n4 = Pointer actively dragging the draglist and has moved\n5 = Pointer actively dragging but has been released, notify draglist","kind":"function","name":"getDragState","since":"3.16.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer to get the drag state for.","name":"pointer"}],"returns":[{"type":{"names":["integer"]},"description":"The drag state of the given Pointer."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#getDragState","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":1036,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the drag state of the given Pointer for this Input Plugin.\n\nThe state must be one of the following values:\n\n0 = Not dragging anything\n1 = Primary button down and objects below, so collect a draglist\n2 = Pointer being checked if meets drag criteria\n3 = Pointer meets criteria, notify the draglist\n4 = Pointer actively dragging the draglist and has moved\n5 = Pointer actively dragging but has been released, notify draglist","kind":"function","name":"setDragState","since":"3.16.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer to set the drag state for.","name":"pointer"},{"type":{"names":["integer"]},"description":"The drag state value. An integer between 0 and 5.","name":"state"}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setDragState","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2012,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the draggable state of the given array of Game Objects.\n\nThey can either be set to be draggable, or can have their draggable state removed by passing `false`.\n\nA Game Object will not fire drag events unless it has been specifically enabled for drag.","kind":"function","name":"setDraggable","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to change the draggable state on.","name":"gameObjects"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Set to `true` if the Game Objects should be made draggable, `false` if they should be unset.","name":"value"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setDraggable","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2057,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Creates a function that can be passed to `setInteractive`, `enable` or `setHitArea` that will handle\npixel-perfect input detection on an Image or Sprite based Game Object, or any custom class that extends them.\n\nThe following will create a sprite that is clickable on any pixel that has an alpha value >= 1.\n\n```javascript\nthis.add.sprite(x, y, key).setInteractive(this.input.makePixelPerfect());\n```\n\nThe following will create a sprite that is clickable on any pixel that has an alpha value >= 150.\n\n```javascript\nthis.add.sprite(x, y, key).setInteractive(this.input.makePixelPerfect(150));\n```\n\nOnce you have made an Interactive Object pixel perfect it impacts all input related events for it: down, up,\ndragstart, drag, etc.\n\nAs a pointer interacts with the Game Object it will constantly poll the texture, extracting a single pixel from\nthe given coordinates and checking its color values. This is an expensive process, so should only be enabled on\nGame Objects that really need it.\n\nYou cannot make non-texture based Game Objects pixel perfect. So this will not work on Graphics, BitmapText,\nRender Textures, Text, Tilemaps, Containers or Particles.","kind":"function","name":"makePixelPerfect","since":"3.10.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The alpha level that the pixel should be above to be included as a successful interaction.","name":"alphaTolerance"}],"returns":[{"type":{"names":["function"]},"description":"A Pixel Perfect Handler for use as a hitArea shape callback."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#makePixelPerfect","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2099,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the hit area for the given array of Game Objects.\n\nA hit area is typically one of the geometric shapes Phaser provides, such as a `Phaser.Geom.Rectangle`\nor `Phaser.Geom.Circle`. However, it can be any object as long as it works with the provided callback.\n\nIf no hit area is provided a Rectangle is created based on the size of the Game Object, if possible\nto calculate.\n\nThe hit area callback is the function that takes an `x` and `y` coordinate and returns a boolean if\nthose values fall within the area of the shape or not. All of the Phaser geometry objects provide this,\nsuch as `Phaser.Geom.Rectangle.Contains`.","kind":"function","name":"setHitArea","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to set the hit area on.","name":"gameObjects"},{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The 'contains' function to invoke to check if the pointer is within the hit area.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setHitArea","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2203,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Circle` shape, using\nthe given coordinates and radius to control its position and size.","kind":"function","name":"setHitAreaCircle","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to set as having a circle hit area.","name":"gameObjects"},{"type":{"names":["number"]},"description":"The center of the circle.","name":"x"},{"type":{"names":["number"]},"description":"The center of the circle.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The hit area callback. If undefined it uses Circle.Contains.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setHitAreaCircle","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Ellipse` shape, using\nthe given coordinates and dimensions to control its position and size.","kind":"function","name":"setHitAreaEllipse","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to set as having an ellipse hit area.","name":"gameObjects"},{"type":{"names":["number"]},"description":"The center of the ellipse.","name":"x"},{"type":{"names":["number"]},"description":"The center of the ellipse.","name":"y"},{"type":{"names":["number"]},"description":"The width of the ellipse.","name":"width"},{"type":{"names":["number"]},"description":"The height of the ellipse.","name":"height"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The hit area callback. If undefined it uses Ellipse.Contains.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setHitAreaEllipse","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Rectangle` shape, using\nthe Game Objects texture frame to define the position and size of the hit area.","kind":"function","name":"setHitAreaFromTexture","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to set as having an ellipse hit area.","name":"gameObjects"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The hit area callback. If undefined it uses Rectangle.Contains.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setHitAreaFromTexture","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Rectangle` shape, using\nthe given coordinates and dimensions to control its position and size.","kind":"function","name":"setHitAreaRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to set as having a rectangular hit area.","name":"gameObjects"},{"type":{"names":["number"]},"description":"The top-left of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"The top-left of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"The width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"The height of the rectangle.","name":"height"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The hit area callback. If undefined it uses Rectangle.Contains.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setHitAreaRectangle","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2335,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Triangle` shape, using\nthe given coordinates to control the position of its points.","kind":"function","name":"setHitAreaTriangle","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array."]},"description":"An array of Game Objects to set as having a triangular hit area.","name":"gameObjects"},{"type":{"names":["number"]},"description":"The x coordinate of the first point of the triangle.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point of the triangle.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point of the triangle.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point of the triangle.","name":"y2"},{"type":{"names":["number"]},"description":"The x coordinate of the third point of the triangle.","name":"x3"},{"type":{"names":["number"]},"description":"The y coordinate of the third point of the triangle.","name":"y3"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"The hit area callback. If undefined it uses Triangle.Contains.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setHitAreaTriangle","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2362,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Creates an Input Debug Shape for the given Game Object.\n\nThe Game Object must have _already_ been enabled for input prior to calling this method.\n\nThis is intended to assist you during development and debugging.\n\nDebug Shapes can only be created for Game Objects that are using standard Phaser Geometry for input,\nincluding: Circle, Ellipse, Line, Polygon, Rectangle and Triangle.\n\nGame Objects that are using their automatic hit areas are using Rectangles by default, so will also work.\n\nThe Debug Shape is created and added to the display list and is then kept in sync with the Game Object\nit is connected with. Should you need to modify it yourself, such as to hide it, you can access it via\nthe Game Object property: `GameObject.input.hitAreaDebug`.\n\nCalling this method on a Game Object that already has a Debug Shape will first destroy the old shape,\nbefore creating a new one. If you wish to remove the Debug Shape entirely, you should call the\nmethod `InputPlugin.removeDebug`.\n\nNote that the debug shape will only show the outline of the input area. If the input test is using a\npixel perfect check, for example, then this is not displayed. If you are using a custom shape, that\ndoesn't extend one of the base Phaser Geometry objects, as your hit area, then this method will not\nwork.","kind":"function","name":"enableDebug","since":"3.19.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to create the input debug shape for.","name":"gameObject"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x00ff00","description":"The outline color of the debug shape.","name":"color"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This Input Plugin."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#enableDebug","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2479,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Removes an Input Debug Shape from the given Game Object.\n\nThe shape is destroyed immediately and the `hitAreaDebug` property is set to `null`.","kind":"function","name":"removeDebug","since":"3.19.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to remove the input debug shape from.","name":"gameObject"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This Input Plugin."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#removeDebug","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2509,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the Pointers to always poll.\n\nWhen a pointer is polled it runs a hit test to see which Game Objects are currently below it,\nor being interacted with it, regardless if the Pointer has actually moved or not.\n\nYou should enable this if you want objects in your game to fire over / out events, and the objects\nare constantly moving, but the pointer may not have. Polling every frame has additional computation\ncosts, especially if there are a large number of interactive objects in your game.","kind":"function","name":"setPollAlways","since":"3.0.0","returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setPollAlways","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the Pointers to only poll when they are moved or updated.\n\nWhen a pointer is polled it runs a hit test to see which Game Objects are currently below it,\nor being interacted with it.","kind":"function","name":"setPollOnMove","since":"3.0.0","returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setPollOnMove","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Sets the poll rate value. This is the amount of time that should have elapsed before a pointer\nwill be polled again. See the `setPollAlways` and `setPollOnMove` methods.","kind":"function","name":"setPollRate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of time, in ms, that should elapsed before re-polling the pointers.","name":"value"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setPollRate","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2564,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"When set to `true` the global Input Manager will emulate DOM behavior by only emitting events from\nthe top-most Scene in the Scene List. By default, if a Scene receives an input event it will then stop the event\nfrom flowing down to any Scenes below it in the Scene list. To disable this behavior call this method with `false`.","kind":"function","name":"setGlobalTopOnly","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` to stop processing input events on the Scene that receives it, or `false` to let the event continue down the Scene list.","name":"value"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setGlobalTopOnly","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2583,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"When set to `true` this Input Plugin will emulate DOM behavior by only emitting events from\nthe top-most Game Objects in the Display List.\n\nIf set to `false` it will emit events from all Game Objects below a Pointer, not just the top one.","kind":"function","name":"setTopOnly","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to only include the top-most Game Object, or `false` to include all Game Objects in a hit test.","name":"value"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setTopOnly","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2603,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Given an array of Game Objects, sort the array and return it, so that the objects are in depth index order\nwith the lowest at the bottom.","kind":"function","name":"sortGameObjects","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of Game Objects to be sorted.","name":"gameObjects"}],"returns":[{"type":{"names":["Array."]},"description":"The sorted array of Game Objects."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#sortGameObjects","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2690,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"This method should be called from within an input event handler, such as `pointerdown`.\n\nWhen called, it stops the Input Manager from allowing _this specific event_ to be processed by any other Scene\nnot yet handled in the scene list.","kind":"function","name":"stopPropagation","since":"3.0.0","returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This InputPlugin object."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#stopPropagation","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2708,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Adds new Pointer objects to the Input Manager.\n\nBy default Phaser creates 2 pointer objects: `mousePointer` and `pointer1`.\n\nYou can create more either by calling this method, or by setting the `input.activePointers` property\nin the Game Config, up to a maximum of 10 pointers.\n\nThe first 10 pointers are available via the `InputPlugin.pointerX` properties, once they have been added\nvia this method.","kind":"function","name":"addPointer","since":"3.10.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The number of new Pointers to create. A maximum of 10 is allowed in total.","name":"quantity"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing all of the new Pointer objects that were created."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#addPointer","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2731,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Tells the Input system to set a custom cursor.\n\nThis cursor will be the default cursor used when interacting with the game canvas.\n\nIf an Interactive Object also sets a custom cursor, this is the cursor that is reset after its use.\n\nAny valid CSS cursor value is allowed, including paths to image files, i.e.:\n\n```javascript\nthis.input.setDefaultCursor('url(assets/cursors/sword.cur), pointer');\n```\n\nPlease read about the differences between browsers when it comes to the file formats and sizes they support:\n\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/cursor\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/CSS_User_Interface/Using_URL_values_for_the_cursor_property\n\nIt's up to you to pick a suitable cursor format that works across the range of browsers you need to support.","kind":"function","name":"setDefaultCursor","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"The CSS to be used when setting the default cursor.","name":"cursor"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"This Input instance."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#setDefaultCursor","scope":"instance","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2873,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The x coordinates of the ActivePointer based on the first camera in the camera list.\nThis is only safe to use if your game has just 1 non-transformed camera and doesn't use multi-touch.","name":"x","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2891,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The y coordinates of the ActivePointer based on the first camera in the camera list.\nThis is only safe to use if your game has just 1 non-transformed camera and doesn't use multi-touch.","name":"y","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2909,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Are any mouse or touch pointers currently over the game canvas?","name":"isOver","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#isOver","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2926,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The mouse has its own unique Pointer object, which you can reference directly if making a _desktop specific game_.\nIf you are supporting both desktop and touch devices then do not use this property, instead use `activePointer`\nwhich will always map to the most recently interacted pointer.","name":"mousePointer","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#mousePointer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2945,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The current active input Pointer.","name":"activePointer","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#activePointer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2962,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer1","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2980,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer2","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":2998,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer3","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer3","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3016,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer4","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer4","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3034,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer5","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer5","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3052,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer6","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer6","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3070,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer7","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer7","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer8","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer8","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer9","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer9","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"InputPlugin.js","lineno":3124,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch-based Pointer object.\nThis will be `undefined` by default unless you add a new Pointer using `addPointer`.","name":"pointer10","type":{"names":["Phaser.Input.Pointer"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#pointer10","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,226],"filename":"InputPluginCache.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"name":"GetValue","longname":"GetValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"InputPluginCache.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"kind":"namespace","name":"InputPluginCache","memberof":"Phaser.Input","longname":"Phaser.Input.InputPluginCache","scope":"static","___s":true},{"meta":{"filename":"InputPluginCache.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Static method called directly by the Core internal Plugins.\nKey is a reference used to get the plugin from the plugins object (i.e. InputPlugin)\nPlugin is the object to instantiate to create the plugin\nMapping is what the plugin is injected into the Scene.Systems as (i.e. input)","kind":"function","name":"register","scope":"static","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"A reference used to get this plugin from the plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"The plugin to be stored. Should be the core object, not instantiated.","name":"plugin"},{"type":{"names":["string"]},"description":"If this plugin is to be injected into the Input Plugin, this is the property key used.","name":"mapping"},{"type":{"names":["string"]},"description":"The key in the Scene Settings to check to see if this plugin should install or not.","name":"settingsKey"},{"type":{"names":["string"]},"description":"The key in the Game Config to check to see if this plugin should install or not.","name":"configKey"}],"memberof":"Phaser.Input.InputPluginCache","longname":"Phaser.Input.InputPluginCache.register","___s":true},{"meta":{"filename":"InputPluginCache.js","lineno":40,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Returns the input plugin object from the cache based on the given key.","kind":"function","name":"getCore","scope":"static","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"The key of the input plugin to get.","name":"key"}],"returns":[{"type":{"names":["Phaser.Types.Input.InputPluginContainer"]},"description":"The input plugin object."}],"memberof":"Phaser.Input.InputPluginCache","longname":"Phaser.Input.InputPluginCache.getCore","___s":true},{"meta":{"filename":"InputPluginCache.js","lineno":56,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Installs all of the registered Input Plugins into the given target.","kind":"function","name":"install","scope":"static","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"The target InputPlugin to install the plugins into.","name":"target"}],"memberof":"Phaser.Input.InputPluginCache","longname":"Phaser.Input.InputPluginCache.install","___s":true},{"meta":{"filename":"InputPluginCache.js","lineno":85,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Removes an input plugin based on the given key.","kind":"function","name":"remove","scope":"static","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"The key of the input plugin to remove.","name":"key"}],"memberof":"Phaser.Input.InputPluginCache","longname":"Phaser.Input.InputPluginCache.remove","___s":true},{"meta":{"range":[180,220],"filename":"Pointer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"name":"Angle","longname":"Angle","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Pointer.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"classdesc":"A Pointer object encapsulates both mouse and touch input within Phaser.\n\nBy default, Phaser will create 2 pointers for your game to use. If you require more, i.e. for a multi-touch\ngame, then use the `InputPlugin.addPointer` method to do so, rather than instantiating this class directly,\notherwise it won't be managed by the input system.\n\nYou can reference the current active pointer via `InputPlugin.activePointer`. You can also use the properties\n`InputPlugin.pointer1` through to `pointer10`, for each pointer you have enabled in your game.\n\nThe properties of this object are set by the Input Plugin during processing. This object is then sent in all\ninput related events that the Input Plugin emits, so you can reference properties from it directly in your\ncallbacks.","kind":"class","name":"Pointer","memberof":"Phaser.Input","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.InputManager"]},"description":"A reference to the Input Manager.","name":"manager"},{"type":{"names":["integer"]},"description":"The internal ID of this Pointer.","name":"id"}],"scope":"static","longname":"Phaser.Input.Pointer","___s":true},{"meta":{"filename":"Pointer.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A reference to the Input Manager.","name":"manager","type":{"names":["Phaser.Input.InputManager"]},"since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The internal ID of this Pointer.","name":"id","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#id","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The most recent native DOM Event this Pointer has processed.","name":"event","type":{"names":["TouchEvent","MouseEvent"]},"since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#event","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The DOM element the Pointer was pressed down on, taken from the DOM event.\nIn a default set-up this will be the Canvas that Phaser is rendering to, or the Window element.","name":"downElement","type":{"names":["any"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#downElement","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The DOM element the Pointer was released on, taken from the DOM event.\nIn a default set-up this will be the Canvas that Phaser is rendering to, or the Window element.","name":"upElement","type":{"names":["any"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#upElement","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The camera the Pointer interacted with during its last update.\n\nA Pointer can only ever interact with one camera at once, which will be the top-most camera\nin the list should multiple cameras be positioned on-top of each other.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A read-only property that indicates which button was pressed, or released, on the pointer\nduring the most recent event. It is only set during `up` and `down` events.\n\nOn Touch devices the value is always 0.\n\nUsers may change the configuration of buttons on their pointing device so that if an event's button property\nis zero, it may not have been caused by the button that is physically left–most on the pointing device;\nhowever, it should behave as if the left button was clicked in the standard button layout.","name":"button","type":{"names":["integer"]},"readonly":true,"defaultvalue":"0","since":"3.18.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#button","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"0: No button or un-initialized\n1: Left button\n2: Right button\n4: Wheel button or middle button\n8: 4th button (typically the \"Browser Back\" button)\n16: 5th button (typically the \"Browser Forward\" button)\n\nFor a mouse configured for left-handed use, the button actions are reversed.\nIn this case, the values are read from right to left.","name":"buttons","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#buttons","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The position of the Pointer in screen space.","name":"position","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#position","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The previous position of the Pointer in screen space.\n\nThe old x and y values are stored in here during the InputManager.transformPointer call.\n\nUse the properties `velocity`, `angle` and `distance` to create your own gesture recognition.","name":"prevPosition","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#prevPosition","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":176,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The current velocity of the Pointer, based on its current and previous positions.\n\nThis value is smoothed out each frame, according to the `motionFactor` property.\n\nThis property is updated whenever the Pointer moves, regardless of any button states. In other words,\nit changes based on movement alone - a button doesn't have to be pressed first.","name":"velocity","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#velocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":191,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The current angle the Pointer is moving, in radians, based on its previous and current position.\n\nThe angle is based on the old position facing to the current position.\n\nThis property is updated whenever the Pointer moves, regardless of any button states. In other words,\nit changes based on movement alone - a button doesn't have to be pressed first.","name":"angle","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":206,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The distance the Pointer has moved, based on its previous and current position.\n\nThis value is smoothed out each frame, according to the `motionFactor` property.\n\nThis property is updated whenever the Pointer moves, regardless of any button states. In other words,\nit changes based on movement alone - a button doesn't have to be pressed first.\n\nIf you need the total distance travelled since the primary buttons was pressed down,\nthen use the `Pointer.getDistance` method.","name":"distance","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#distance","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":224,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The smoothing factor to apply to the Pointer position.\n\nDue to their nature, pointer positions are inherently noisy. While this is fine for lots of games, if you need cleaner positions\nthen you can set this value to apply an automatic smoothing to the positions as they are recorded.\n\nThe default value of zero means 'no smoothing'.\nSet to a small value, such as 0.2, to apply an average level of smoothing between positions. You can do this by changing this\nvalue directly, or by setting the `input.smoothFactor` property in the Game Config.\n\nPositions are only smoothed when the pointer moves. If the primary button on this Pointer enters an Up or Down state, then the position\nis always precise, and not smoothed.","name":"smoothFactor","type":{"names":["number"]},"defaultvalue":"0","since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#smoothFactor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":244,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The factor applied to the motion smoothing each frame.\n\nThis value is passed to the Smooth Step Interpolation that is used to calculate the velocity,\nangle and distance of the Pointer. It's applied every frame, until the midPoint reaches the current\nposition of the Pointer. 0.2 provides a good average but can be increased if you need a\nquicker update and are working in a high performance environment. Never set this value to\nzero.","name":"motionFactor","type":{"names":["number"]},"defaultvalue":"0.2","since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#motionFactor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":260,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The x position of this Pointer, translated into the coordinate space of the most recent Camera it interacted with.\n\nIf you wish to use this value _outside_ of an input event handler then you should update it first by calling\nthe `Pointer.updateWorldPoint` method.","name":"worldX","type":{"names":["number"]},"defaultvalue":"0","since":"3.10.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#worldX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The y position of this Pointer, translated into the coordinate space of the most recent Camera it interacted with.\n\nIf you wish to use this value _outside_ of an input event handler then you should update it first by calling\nthe `Pointer.updateWorldPoint` method.","name":"worldY","type":{"names":["number"]},"defaultvalue":"0","since":"3.10.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#worldY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":286,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Time when this Pointer was most recently moved (regardless of the state of its buttons, if any)","name":"moveTime","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#moveTime","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":296,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"X coordinate of the Pointer when Button 1 (left button), or Touch, was pressed, used for dragging objects.","name":"downX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#downX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":306,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Y coordinate of the Pointer when Button 1 (left button), or Touch, was pressed, used for dragging objects.","name":"downY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#downY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":316,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Time when Button 1 (left button), or Touch, was pressed, used for dragging objects.","name":"downTime","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#downTime","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":326,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"X coordinate of the Pointer when Button 1 (left button), or Touch, was released, used for dragging objects.","name":"upX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#upX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":336,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Y coordinate of the Pointer when Button 1 (left button), or Touch, was released, used for dragging objects.","name":"upY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#upY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":346,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Time when Button 1 (left button), or Touch, was released, used for dragging objects.","name":"upTime","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#upTime","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":356,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Is the primary button down? (usually button 0, the left mouse button)","name":"primaryDown","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#primaryDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":366,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Is _any_ button on this pointer considered as being down?","name":"isDown","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#isDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":376,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Did the previous input event come from a Touch input (true) or Mouse? (false)","name":"wasTouch","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#wasTouch","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":386,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Did this Pointer get canceled by a touchcancel event?\n\nNote: \"canceled\" is the American-English spelling of \"cancelled\". Please don't submit PRs correcting it!","name":"wasCanceled","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.15.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#wasCanceled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":398,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the mouse is locked, the horizontal relative movement of the Pointer in pixels since last frame.","name":"movementX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#movementX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":408,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the mouse is locked, the vertical relative movement of the Pointer in pixels since last frame.","name":"movementY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#movementY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":418,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The identifier property of the Pointer as set by the DOM event when this Pointer is started.","name":"identifier","type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#identifier","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":427,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The pointerId property of the Pointer as set by the DOM event when this Pointer is started.\nThe browser can and will recycle this value.","name":"pointerId","type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#pointerId","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":437,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"An active Pointer is one that is currently pressed down on the display.\nA Mouse is always considered as active.","name":"active","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":447,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Is this pointer Pointer Locked?\n\nOnly a mouse pointer can be locked and it only becomes locked when requested via\nthe browsers Pointer Lock API.\n\nYou can request this by calling the `this.input.mouse.requestPointerLock()` method from\na `pointerdown` or `pointerup` event handler.","name":"locked","readonly":true,"type":{"names":["boolean"]},"since":"3.19.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#locked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":463,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaX","type":{"names":["number"]},"defaultvalue":"0","since":"3.18.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#deltaX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":473,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The vertical scroll amount that occurred due to the user moving a mouse wheel or similar input device.\nThis value will typically be less than 0 if the user scrolls up and greater than zero if scrolling down.","name":"deltaY","type":{"names":["number"]},"defaultvalue":"0","since":"3.18.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#deltaY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":484,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The z-axis scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaZ","type":{"names":["number"]},"defaultvalue":"0","since":"3.18.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#deltaZ","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":495,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Takes a Camera and updates this Pointer's `worldX` and `worldY` values so they are\nthe result of a translation through the given Camera.\n\nNote that the values will be automatically replaced the moment the Pointer is\nupdated by an input event, such as a mouse move, so should be used immediately.","kind":"function","name":"updateWorldPoint","since":"3.19.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera which is being tested against.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"This Pointer object."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#updateWorldPoint","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Takes a Camera and returns a Vector2 containing the translated position of this Pointer\nwithin that Camera. This can be used to convert this Pointers position into camera space.","kind":"function","name":"positionToCamera","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to use for the translation.","name":"camera"},{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"A Vector2-like object in which to store the translated position.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"A Vector2 containing the translated coordinates of this Pointer, based on the given camera."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#positionToCamera","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":870,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if any buttons are being held down on this Pointer.","kind":"function","name":"noButtonDown","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if no buttons are being held down."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#noButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":883,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the left button is being held down on this Pointer.","kind":"function","name":"leftButtonDown","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the left button is being held down."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#leftButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":896,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the right button is being held down on this Pointer.","kind":"function","name":"rightButtonDown","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the right button is being held down."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#rightButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":909,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the middle button is being held down on this Pointer.","kind":"function","name":"middleButtonDown","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the middle button is being held down."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#middleButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":922,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the back button is being held down on this Pointer.","kind":"function","name":"backButtonDown","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the back button is being held down."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#backButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":935,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the forward button is being held down on this Pointer.","kind":"function","name":"forwardButtonDown","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the forward button is being held down."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#forwardButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":948,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the left button was just released on this Pointer.","kind":"function","name":"leftButtonReleased","since":"3.18.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the left button was just released."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#leftButtonReleased","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":961,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the right button was just released on this Pointer.","kind":"function","name":"rightButtonReleased","since":"3.18.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the right button was just released."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#rightButtonReleased","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":974,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the middle button was just released on this Pointer.","kind":"function","name":"middleButtonReleased","since":"3.18.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the middle button was just released."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#middleButtonReleased","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":987,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the back button was just released on this Pointer.","kind":"function","name":"backButtonReleased","since":"3.18.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the back button was just released."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#backButtonReleased","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1000,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Checks to see if the forward button was just released on this Pointer.","kind":"function","name":"forwardButtonReleased","since":"3.18.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the forward button was just released."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#forwardButtonReleased","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1013,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the Pointer has a button pressed down at the time this method is called, it will return the\ndistance between the Pointer's `downX` and `downY` values and the current position.\n\nIf no button is held down, it will return the last recorded distance, based on where\nthe Pointer was when the button was released.\n\nIf you wish to get the distance being travelled currently, based on the velocity of the Pointer,\nthen see the `Pointer.distance` property.","kind":"function","name":"getDistance","since":"3.13.0","returns":[{"type":{"names":["number"]},"description":"The distance the Pointer moved."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#getDistance","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1040,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the Pointer has a button pressed down at the time this method is called, it will return the\nhorizontal distance between the Pointer's `downX` and `downY` values and the current position.\n\nIf no button is held down, it will return the last recorded horizontal distance, based on where\nthe Pointer was when the button was released.","kind":"function","name":"getDistanceX","since":"3.16.0","returns":[{"type":{"names":["number"]},"description":"The horizontal distance the Pointer moved."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#getDistanceX","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1064,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the Pointer has a button pressed down at the time this method is called, it will return the\nvertical distance between the Pointer's `downX` and `downY` values and the current position.\n\nIf no button is held down, it will return the last recorded vertical distance, based on where\nthe Pointer was when the button was released.","kind":"function","name":"getDistanceY","since":"3.16.0","returns":[{"type":{"names":["number"]},"description":"The vertical distance the Pointer moved."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#getDistanceY","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the Pointer has a button pressed down at the time this method is called, it will return the\nduration since the button was pressed down.\n\nIf no button is held down, it will return the last recorded duration, based on the time\nthe Pointer button was released.","kind":"function","name":"getDuration","since":"3.16.0","returns":[{"type":{"names":["number"]},"description":"The duration the Pointer was held down for in milliseconds."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#getDuration","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1112,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"If the Pointer has a button pressed down at the time this method is called, it will return the\nangle between the Pointer's `downX` and `downY` values and the current position.\n\nIf no button is held down, it will return the last recorded angle, based on where\nthe Pointer was when the button was released.\n\nThe angle is based on the old position facing to the current position.\n\nIf you wish to get the current angle, based on the velocity of the Pointer, then\nsee the `Pointer.angle` property.","kind":"function","name":"getAngle","since":"3.16.0","returns":[{"type":{"names":["number"]},"description":"The angle between the Pointer's coordinates in radians."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#getAngle","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1141,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Takes the previous and current Pointer positions and then generates an array of interpolated values between\nthe two. The array will be populated up to the size of the `steps` argument.\n\n```javaScript\nvar points = pointer.getInterpolatedPosition(4);\n\n// points[0] = { x: 0, y: 0 }\n// points[1] = { x: 2, y: 1 }\n// points[2] = { x: 3, y: 2 }\n// points[3] = { x: 6, y: 3 }\n```\n\nUse this if you need to get smoothed values between the previous and current pointer positions. DOM pointer\nevents can often fire faster than the main browser loop, and this will help you avoid janky movement\nespecially if you have an object following a Pointer.\n\nNote that if you provide an output array it will only be populated up to the number of steps provided.\nIt will not clear any previous data that may have existed beyond the range of the steps count.\n\nInternally it uses the Smooth Step interpolation calculation.","kind":"function","name":"getInterpolatedPosition","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The number of interpolation steps to use.","name":"steps"},{"type":{"names":["array"]},"optional":true,"description":"An array to store the results in. If not provided a new one will be created.","name":"out"}],"returns":[{"type":{"names":["array"]},"description":"An array of interpolated values."}],"memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#getInterpolatedPosition","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1192,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Destroys this Pointer instance and resets its external references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#destroy","scope":"instance","___s":true},{"meta":{"filename":"Pointer.js","lineno":1205,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The x position of this Pointer.\nThe value is in screen space.\nSee `worldX` to get a camera converted position.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":1228,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The y position of this Pointer.\nThe value is in screen space.\nSee `worldY` to get a camera converted position.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Pointer.js","lineno":1251,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"Time when this Pointer was most recently updated by a DOM Event.\nThis comes directly from the `event.timeStamp` property.\nIf no event has yet taken place, it will return zero.","name":"time","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Input.Pointer","longname":"Phaser.Input.Pointer#time","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,1721],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"name":"INPUT_CONST","longname":"INPUT_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The mouse pointer is being held down.","name":"MOUSE_DOWN","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.MOUSE_DOWN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The mouse pointer is being moved.","name":"MOUSE_MOVE","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.MOUSE_MOVE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The mouse pointer is released.","name":"MOUSE_UP","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.MOUSE_UP","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch pointer has been started.","name":"TOUCH_START","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.TOUCH_START","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch pointer has been started.","name":"TOUCH_MOVE","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.TOUCH_MOVE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch pointer has been started.","name":"TOUCH_END","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.TOUCH_END","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The pointer lock has changed.","name":"POINTER_LOCK_CHANGE","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input","longname":"Phaser.Input.POINTER_LOCK_CHANGE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"A touch pointer has been been cancelled by the browser.","name":"TOUCH_CANCEL","type":{"names":["integer"]},"since":"3.15.0","memberof":"Phaser.Input","longname":"Phaser.Input.TOUCH_CANCEL","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"description":"The mouse wheel changes.","name":"MOUSE_WHEEL","type":{"names":["integer"]},"since":"3.18.0","memberof":"Phaser.Input","longname":"Phaser.Input.MOUSE_WHEEL","scope":"static","kind":"member","___s":true},{"meta":{"filename":"BOOT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Boot Event.\n\nThis internal event is dispatched by the Input Plugin when it boots, signalling to all of its systems to create themselves.","kind":"event","name":"BOOT","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:BOOT","scope":"instance","___s":true},{"meta":{"filename":"DESTROY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Destroy Event.\n\nThis internal event is dispatched by the Input Plugin when it is destroyed, signalling to all of its systems to destroy themselves.","kind":"event","name":"DESTROY","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DESTROY","scope":"instance","___s":true},{"meta":{"filename":"DRAG_END_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drag End Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer stops dragging a Game Object.\n\nListen to this event from within a Scene using: `this.input.on('dragend', listener)`.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_END]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_END} event instead.","kind":"event","name":"DRAG_END","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer stopped dragging.","name":"gameObject"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DRAG_END","scope":"instance","___s":true},{"meta":{"filename":"DRAG_ENTER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drag Enter Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object into a Drag Target.\n\nListen to this event from within a Scene using: `this.input.on('dragenter', listener)`.\n\nA Pointer can only drag a single Game Object at once.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_ENTER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_ENTER} event instead.","kind":"event","name":"DRAG_ENTER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer is dragging.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The drag target that this pointer has moved into.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DRAG_ENTER","scope":"instance","___s":true},{"meta":{"filename":"DRAG_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drag Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves while dragging a Game Object.\n\nListen to this event from within a Scene using: `this.input.on('drag', listener)`.\n\nA Pointer can only drag a single Game Object at once.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG} event instead.","kind":"event","name":"DRAG","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer is dragging.","name":"gameObject"},{"type":{"names":["number"]},"description":"The x coordinate where the Pointer is currently dragging the Game Object, in world space.","name":"dragX"},{"type":{"names":["number"]},"description":"The y coordinate where the Pointer is currently dragging the Game Object, in world space.","name":"dragY"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DRAG","scope":"instance","___s":true},{"meta":{"filename":"DRAG_LEAVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drag Leave Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object out of a Drag Target.\n\nListen to this event from within a Scene using: `this.input.on('dragleave', listener)`.\n\nA Pointer can only drag a single Game Object at once.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_LEAVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_LEAVE} event instead.","kind":"event","name":"DRAG_LEAVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer is dragging.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The drag target that this pointer has left.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DRAG_LEAVE","scope":"instance","___s":true},{"meta":{"filename":"DRAG_OVER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drag Over Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object over a Drag Target.\n\nWhen the Game Object first enters the drag target it will emit a `dragenter` event. If it then moves while within\nthe drag target, it will emit this event instead.\n\nListen to this event from within a Scene using: `this.input.on('dragover', listener)`.\n\nA Pointer can only drag a single Game Object at once.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_OVER} event instead.","kind":"event","name":"DRAG_OVER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer is dragging.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The drag target that this pointer has moved over.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DRAG_OVER","scope":"instance","___s":true},{"meta":{"filename":"DRAG_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drag Start Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer starts to drag any Game Object.\n\nListen to this event from within a Scene using: `this.input.on('dragstart', listener)`.\n\nA Pointer can only drag a single Game Object at once.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_START]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_START} event instead.","kind":"event","name":"DRAG_START","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer is dragging.","name":"gameObject"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DRAG_START","scope":"instance","___s":true},{"meta":{"filename":"DROP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Drop Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer drops a Game Object on a Drag Target.\n\nListen to this event from within a Scene using: `this.input.on('drop', listener)`.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DROP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DROP} event instead.","kind":"event","name":"DROP","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The interactive Game Object that this pointer was dragging.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Drag Target the `gameObject` has been dropped on.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:DROP","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Down Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down on _any_ interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('gameobjectdown', listener)`.\n\nTo receive this event, the Game Objects must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN} event instead.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\n2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\n3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_DOWN","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the pointer was pressed down on.","name":"gameObject"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DOWN","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DRAG_END_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drag End Event.\n\nThis event is dispatched by an interactive Game Object if a pointer stops dragging it.\n\nListen to this event from a Game Object using: `gameObject.on('dragend', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive](Phaser.GameObjects.GameObject#setInteractive) for more details.","kind":"event","name":"GAMEOBJECT_DRAG_END","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate where the Pointer stopped dragging the Game Object, in world space.","name":"dragX"},{"type":{"names":["number"]},"description":"The y coordinate where the Pointer stopped dragging the Game Object, in world space.","name":"dragY"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DRAG_END","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DRAG_ENTER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drag Enter Event.\n\nThis event is dispatched by an interactive Game Object if a pointer drags it into a drag target.\n\nListen to this event from a Game Object using: `gameObject.on('dragenter', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.","kind":"event","name":"GAMEOBJECT_DRAG_ENTER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The drag target that this pointer has moved into.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DRAG_ENTER","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DRAG_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drag Event.\n\nThis event is dispatched by an interactive Game Object if a pointer moves while dragging it.\n\nListen to this event from a Game Object using: `gameObject.on('drag', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.","kind":"event","name":"GAMEOBJECT_DRAG","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate where the Pointer is currently dragging the Game Object, in world space.","name":"dragX"},{"type":{"names":["number"]},"description":"The y coordinate where the Pointer is currently dragging the Game Object, in world space.","name":"dragY"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DRAG","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DRAG_LEAVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drag Leave Event.\n\nThis event is dispatched by an interactive Game Object if a pointer drags it out of a drag target.\n\nListen to this event from a Game Object using: `gameObject.on('dragleave', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.","kind":"event","name":"GAMEOBJECT_DRAG_LEAVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The drag target that this pointer has left.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DRAG_LEAVE","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DRAG_OVER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drag Over Event.\n\nThis event is dispatched by an interactive Game Object if a pointer drags it over a drag target.\n\nWhen the Game Object first enters the drag target it will emit a `dragenter` event. If it then moves while within\nthe drag target, it will emit this event instead.\n\nListen to this event from a Game Object using: `gameObject.on('dragover', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.","kind":"event","name":"GAMEOBJECT_DRAG_OVER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The drag target that this pointer has moved over.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DRAG_OVER","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DRAG_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drag Start Event.\n\nThis event is dispatched by an interactive Game Object if a pointer starts to drag it.\n\nListen to this event from a Game Object using: `gameObject.on('dragstart', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThere are lots of useful drag related properties that are set within the Game Object when dragging occurs.\nFor example, `gameObject.input.dragStartX`, `dragStartY` and so on.","kind":"event","name":"GAMEOBJECT_DRAG_START","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate where the Pointer is currently dragging the Game Object, in world space.","name":"dragX"},{"type":{"names":["number"]},"description":"The y coordinate where the Pointer is currently dragging the Game Object, in world space.","name":"dragY"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DRAG_START","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_DROP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Drop Event.\n\nThis event is dispatched by an interactive Game Object if a pointer drops it on a Drag Target.\n\nListen to this event from a Game Object using: `gameObject.on('drop', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive and enabled for drag.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.","kind":"event","name":"GAMEOBJECT_DROP","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Drag Target the `gameObject` has been dropped on.","name":"target"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_DROP","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_MOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Move Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is moved across _any_ interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('gameobjectmove', listener)`.\n\nTo receive this event, the Game Objects must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE} event instead.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE}\n2. [GAMEOBJECT_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_MOVE}\n3. [POINTER_MOVE]{@linkcode Phaser.Input.Events#event:POINTER_MOVE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_MOVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the pointer was moved on.","name":"gameObject"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_MOVE","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_OUT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Out Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves out of _any_ interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('gameobjectout', listener)`.\n\nTo receive this event, the Game Objects must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT} event instead.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT}\n2. [GAMEOBJECT_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OUT}\n3. [POINTER_OUT]{@linkcode Phaser.Input.Events#event:POINTER_OUT}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_OUT","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the pointer moved out of.","name":"gameObject"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_OUT","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_OVER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Over Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves over _any_ interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('gameobjectover', listener)`.\n\nTo receive this event, the Game Objects must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER} event instead.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER}\n2. [GAMEOBJECT_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OVER}\n3. [POINTER_OVER]{@linkcode Phaser.Input.Events#event:POINTER_OVER}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_OVER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the pointer moved over.","name":"gameObject"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_OVER","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_POINTER_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Pointer Down Event.\n\nThis event is dispatched by an interactive Game Object if a pointer is pressed down on it.\n\nListen to this event from a Game Object using: `gameObject.on('pointerdown', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\n2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\n3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_POINTER_DOWN","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localX"},{"type":{"names":["number"]},"description":"The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localY"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_POINTER_MOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Pointer Move Event.\n\nThis event is dispatched by an interactive Game Object if a pointer is moved while over it.\n\nListen to this event from a Game Object using: `gameObject.on('pointermove', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE}\n2. [GAMEOBJECT_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_MOVE}\n3. [POINTER_MOVE]{@linkcode Phaser.Input.Events#event:POINTER_MOVE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_POINTER_MOVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localX"},{"type":{"names":["number"]},"description":"The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localY"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_POINTER_OUT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Pointer Out Event.\n\nThis event is dispatched by an interactive Game Object if a pointer moves out of it.\n\nListen to this event from a Game Object using: `gameObject.on('pointerout', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT}\n2. [GAMEOBJECT_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OUT}\n3. [POINTER_OUT]{@linkcode Phaser.Input.Events#event:POINTER_OUT}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_POINTER_OUT","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_POINTER_OVER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Pointer Over Event.\n\nThis event is dispatched by an interactive Game Object if a pointer moves over it.\n\nListen to this event from a Game Object using: `gameObject.on('pointerover', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER}\n2. [GAMEOBJECT_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OVER}\n3. [POINTER_OVER]{@linkcode Phaser.Input.Events#event:POINTER_OVER}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_POINTER_OVER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localX"},{"type":{"names":["number"]},"description":"The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localY"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_POINTER_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Pointer Up Event.\n\nThis event is dispatched by an interactive Game Object if a pointer is released while over it.\n\nListen to this event from a Game Object using: `gameObject.on('pointerup', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\n2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\n3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_POINTER_UP","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localX"},{"type":{"names":["number"]},"description":"The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localY"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_POINTER_WHEEL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Pointer Wheel Event.\n\nThis event is dispatched by an interactive Game Object if a pointer has its wheel moved while over it.\n\nListen to this event from a Game Object using: `gameObject.on('wheel', listener)`.\nNote that the scope of the listener is automatically set to be the Game Object instance itself.\n\nTo receive this event, the Game Object must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL}\n2. [GAMEOBJECT_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_WHEEL}\n3. [POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:POINTER_WHEEL}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_POINTER_WHEEL","since":"3.18.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["number"]},"description":"The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaX"},{"type":{"names":["number"]},"description":"The vertical scroll amount that occurred due to the user moving a mouse wheel or similar input device. This value will typically be less than 0 if the user scrolls up and greater than zero if scrolling down.","name":"deltaY"},{"type":{"names":["number"]},"description":"The z-axis scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaZ"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Up Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is released while over _any_ interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('gameobjectup', listener)`.\n\nTo receive this event, the Game Objects must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP} event instead.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\n2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\n3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_UP","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the pointer was over when released.","name":"gameObject"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_UP","scope":"instance","___s":true},{"meta":{"filename":"GAMEOBJECT_WHEEL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Game Object Wheel Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer has its wheel moved while over _any_ interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('gameobjectwheel', listener)`.\n\nTo receive this event, the Game Objects must have been set as interactive.\nSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\n\nTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL} event instead.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL}\n2. [GAMEOBJECT_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_WHEEL}\n3. [POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:POINTER_WHEEL}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"GAMEOBJECT_WHEEL","since":"3.18.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the pointer was over when the wheel changed.","name":"gameObject"},{"type":{"names":["number"]},"description":"The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaX"},{"type":{"names":["number"]},"description":"The vertical scroll amount that occurred due to the user moving a mouse wheel or similar input device. This value will typically be less than 0 if the user scrolls up and greater than zero if scrolling down.","name":"deltaY"},{"type":{"names":["number"]},"description":"The z-axis scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaZ"},{"type":{"names":["Phaser.Types.Input.EventData"]},"description":"The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAMEOBJECT_WHEEL","scope":"instance","___s":true},{"meta":{"filename":"GAME_OUT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Game Out Event.\n\nThis event is dispatched by the Input Plugin if the active pointer leaves the game canvas and is now\noutside of it, elsewhere on the web page.\n\nListen to this event from within a Scene using: `this.input.on('gameout', listener)`.","kind":"event","name":"GAME_OUT","since":"3.16.1","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["MouseEvent","TouchEvent"]},"description":"The DOM Event that triggered the canvas out.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAME_OUT","scope":"instance","___s":true},{"meta":{"filename":"GAME_OVER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Game Over Event.\n\nThis event is dispatched by the Input Plugin if the active pointer enters the game canvas and is now\nover of it, having previously been elsewhere on the web page.\n\nListen to this event from within a Scene using: `this.input.on('gameover', listener)`.","kind":"event","name":"GAME_OVER","since":"3.16.1","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["MouseEvent","TouchEvent"]},"description":"The DOM Event that triggered the canvas over.","name":"event"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:GAME_OVER","scope":"instance","___s":true},{"meta":{"filename":"MANAGER_BOOT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Manager Boot Event.\n\nThis internal event is dispatched by the Input Manager when it boots.","kind":"event","name":"MANAGER_BOOT","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:MANAGER_BOOT","scope":"instance","___s":true},{"meta":{"filename":"MANAGER_PROCESS_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Manager Process Event.\n\nThis internal event is dispatched by the Input Manager when not using the legacy queue system,\nand it wants the Input Plugins to update themselves.","kind":"event","name":"MANAGER_PROCESS","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:MANAGER_PROCESS","scope":"instance","___s":true},{"meta":{"filename":"MANAGER_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Manager Update Event.\n\nThis internal event is dispatched by the Input Manager as part of its update step.","kind":"event","name":"MANAGER_UPDATE","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:MANAGER_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"POINTERLOCK_CHANGE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Manager Pointer Lock Change Event.\n\nThis event is dispatched by the Input Manager when it is processing a native Pointer Lock Change DOM Event.","kind":"event","name":"POINTERLOCK_CHANGE","since":"3.0.0","params":[{"type":{"names":["Event"]},"description":"The native DOM Event.","name":"event"},{"type":{"names":["boolean"]},"description":"The locked state of the Mouse Pointer.","name":"locked"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTERLOCK_CHANGE","scope":"instance","___s":true},{"meta":{"filename":"POINTER_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Down Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down anywhere.\n\nListen to this event from within a Scene using: `this.input.on('pointerdown', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\n2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\n3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_DOWN","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Array."]},"description":"An array containing all interactive Game Objects that the pointer was over when the event was created.","name":"currentlyOver"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_DOWN","scope":"instance","___s":true},{"meta":{"filename":"POINTER_DOWN_OUTSIDE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Down Outside Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down anywhere outside of the game canvas.\n\nListen to this event from within a Scene using: `this.input.on('pointerdownoutside', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\n2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\n3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_DOWN_OUTSIDE","since":"3.16.1","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE","scope":"instance","___s":true},{"meta":{"filename":"POINTER_MOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Move Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is moved anywhere.\n\nListen to this event from within a Scene using: `this.input.on('pointermove', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE}\n2. [GAMEOBJECT_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_MOVE}\n3. [POINTER_MOVE]{@linkcode Phaser.Input.Events#event:POINTER_MOVE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_MOVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Array."]},"description":"An array containing all interactive Game Objects that the pointer was over when the event was created.","name":"currentlyOver"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_MOVE","scope":"instance","___s":true},{"meta":{"filename":"POINTER_OUT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Out Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves out of any interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('pointerout', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT}\n2. [GAMEOBJECT_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OUT}\n3. [POINTER_OUT]{@linkcode Phaser.Input.Events#event:POINTER_OUT}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_OUT","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Array."]},"description":"An array containing all interactive Game Objects that the pointer moved out of when the event was created.","name":"justOut"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_OUT","scope":"instance","___s":true},{"meta":{"filename":"POINTER_OVER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Over Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves over any interactive Game Object.\n\nListen to this event from within a Scene using: `this.input.on('pointerover', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER}\n2. [GAMEOBJECT_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OVER}\n3. [POINTER_OVER]{@linkcode Phaser.Input.Events#event:POINTER_OVER}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_OVER","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Array."]},"description":"An array containing all interactive Game Objects that the pointer moved over when the event was created.","name":"justOver"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_OVER","scope":"instance","___s":true},{"meta":{"filename":"POINTER_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Up Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is released anywhere.\n\nListen to this event from within a Scene using: `this.input.on('pointerup', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\n2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\n3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_UP","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Array."]},"description":"An array containing all interactive Game Objects that the pointer was over when the event was created.","name":"currentlyOver"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_UP","scope":"instance","___s":true},{"meta":{"filename":"POINTER_UP_OUTSIDE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Up Outside Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is released anywhere outside of the game canvas.\n\nListen to this event from within a Scene using: `this.input.on('pointerupoutside', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\n2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\n3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_UP_OUTSIDE","since":"3.16.1","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_UP_OUTSIDE","scope":"instance","___s":true},{"meta":{"filename":"POINTER_WHEEL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Pointer Wheel Input Event.\n\nThis event is dispatched by the Input Plugin belonging to a Scene if a pointer has its wheel updated.\n\nListen to this event from within a Scene using: `this.input.on('wheel', listener)`.\n\nThe event hierarchy is as follows:\n\n1. [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL}\n2. [GAMEOBJECT_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_WHEEL}\n3. [POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:POINTER_WHEEL}\n\nWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\nthe propagation of this event.","kind":"event","name":"POINTER_WHEEL","since":"3.18.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"The Pointer responsible for triggering this event.","name":"pointer"},{"type":{"names":["Array."]},"description":"An array containing all interactive Game Objects that the pointer was over when the event was created.","name":"currentlyOver"},{"type":{"names":["number"]},"description":"The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaX"},{"type":{"names":["number"]},"description":"The vertical scroll amount that occurred due to the user moving a mouse wheel or similar input device. This value will typically be less than 0 if the user scrolls up and greater than zero if scrolling down.","name":"deltaY"},{"type":{"names":["number"]},"description":"The z-axis scroll amount that occurred due to the user moving a mouse wheel or similar input device.","name":"deltaZ"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:POINTER_WHEEL","scope":"instance","___s":true},{"meta":{"filename":"PRE_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Pre-Update Event.\n\nThis internal event is dispatched by the Input Plugin at the start of its `preUpdate` method.\nThis hook is designed specifically for input plugins, but can also be listened to from user-land code.","kind":"event","name":"PRE_UPDATE","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:PRE_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"SHUTDOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Shutdown Event.\n\nThis internal event is dispatched by the Input Plugin when it shuts down, signalling to all of its systems to shut themselves down.","kind":"event","name":"SHUTDOWN","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:SHUTDOWN","scope":"instance","___s":true},{"meta":{"filename":"START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Start Event.\n\nThis internal event is dispatched by the Input Plugin when it has finished setting-up,\nsignalling to all of its internal systems to start.","kind":"event","name":"START","since":"3.0.0","memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:START","scope":"instance","___s":true},{"meta":{"filename":"UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"description":"The Input Plugin Update Event.\n\nThis internal event is dispatched by the Input Plugin at the start of its `update` method.\nThis hook is designed specifically for input plugins, but can also be listened to from user-land code.","kind":"event","name":"UPDATE","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Input.Events","longname":"Phaser.Input.Events#event:UPDATE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Input","longname":"Phaser.Input.Events","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Axis.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Axis.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"classdesc":"Contains information about a specific Gamepad Axis.\nAxis objects are created automatically by the Gamepad as they are needed.","kind":"class","name":"Axis","memberof":"Phaser.Input.Gamepad","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"A reference to the Gamepad that this Axis belongs to.","name":"pad"},{"type":{"names":["integer"]},"description":"The index of this Axis.","name":"index"}],"scope":"static","longname":"Phaser.Input.Gamepad.Axis","___s":true},{"meta":{"filename":"Axis.js","lineno":28,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the Gamepad that this Axis belongs to.","name":"pad","type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#pad","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Axis.js","lineno":37,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An event emitter to use to emit the axis events.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Axis.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"The index of this Axis.","name":"index","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#index","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Axis.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"The raw axis value, between -1 and 1 with 0 being dead center.\nUse the method `getValue` to get a normalized value with the threshold applied.","name":"value","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#value","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Axis.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Movement tolerance threshold below which axis values are ignored in `getValue`.","name":"threshold","type":{"names":["number"]},"defaultvalue":"0.1","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#threshold","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Axis.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Applies the `threshold` value to the axis and returns it.","kind":"function","name":"getValue","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The axis value, adjusted for the movement threshold."}],"memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#getValue","scope":"instance","___s":true},{"meta":{"filename":"Axis.js","lineno":105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Destroys this Axis instance and releases external references it holds.","kind":"function","name":"destroy","since":"3.10.0","memberof":"Phaser.Input.Gamepad.Axis","longname":"Phaser.Input.Gamepad.Axis#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"Button.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Button.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"classdesc":"Contains information about a specific button on a Gamepad.\nButton objects are created automatically by the Gamepad as they are needed.","kind":"class","name":"Button","memberof":"Phaser.Input.Gamepad","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"A reference to the Gamepad that this Button belongs to.","name":"pad"},{"type":{"names":["integer"]},"description":"The index of this Button.","name":"index"}],"scope":"static","longname":"Phaser.Input.Gamepad.Button","___s":true},{"meta":{"filename":"Button.js","lineno":29,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the Gamepad that this Button belongs to.","name":"pad","type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#pad","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Button.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An event emitter to use to emit the button events.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Button.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"The index of this Button.","name":"index","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#index","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Button.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Between 0 and 1.","name":"value","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#value","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Button.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Can be set for analogue buttons to enable a 'pressure' threshold,\nbefore a button is considered as being 'pressed'.","name":"threshold","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#threshold","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Button.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Button being pressed down or not?","name":"pressed","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#pressed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Button.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Destroys this Button instance and releases external references it holds.","kind":"function","name":"destroy","since":"3.10.0","memberof":"Phaser.Input.Gamepad.Button","longname":"Phaser.Input.Gamepad.Button#destroy","scope":"instance","___s":true},{"meta":{"range":[180,204],"filename":"Gamepad.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"name":"Axis","longname":"Axis","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Gamepad.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"classdesc":"A single Gamepad.\n\nThese are created, updated and managed by the Gamepad Plugin.","kind":"class","name":"Gamepad","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Input.Gamepad","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"A reference to the Gamepad Plugin.","name":"manager"},{"type":{"names":["Phaser.Types.Input.Gamepad.Pad"]},"description":"The Gamepad object, as extracted from GamepadEvent.","name":"pad"}],"scope":"static","longname":"Phaser.Input.Gamepad.Gamepad","___s":true},{"meta":{"filename":"Gamepad.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the Gamepad Plugin.","name":"manager","type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the native Gamepad object that is connected to the browser.","name":"pad","type":{"names":["any"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#pad","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A string containing some information about the controller.\n\nThis is not strictly specified, but in Firefox it will contain three pieces of information\nseparated by dashes (-): two 4-digit hexadecimal strings containing the USB vendor and\nproduct id of the controller, and the name of the controller as provided by the driver.\nIn Chrome it will contain the name of the controller as provided by the driver,\nfollowed by vendor and product 4-digit hexadecimal strings.","name":"id","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#id","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An integer that is unique for each Gamepad currently connected to the system.\nThis can be used to distinguish multiple controllers.\nNote that disconnecting a device and then connecting a new device may reuse the previous index.","name":"index","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#index","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An array of Gamepad Button objects, corresponding to the different buttons available on the Gamepad.","name":"buttons","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#buttons","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An array of Gamepad Axis objects, corresponding to the different axes available on the Gamepad, if any.","name":"axes","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#axes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"The Gamepad's Haptic Actuator (Vibration / Rumble support).\nThis is highly experimental and only set if both present on the device,\nand exposed by both the hardware and browser.","name":"vibration","type":{"names":["GamepadHapticActuator"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#vibration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":291,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A Vector2 containing the most recent values from the Gamepad's left axis stick.\nThis is updated automatically as part of the Gamepad.update cycle.\nThe H Axis is mapped to the `Vector2.x` property, and the V Axis to the `Vector2.y` property.\nThe values are based on the Axis thresholds.\nIf the Gamepad does not have a left axis stick, the values will always be zero.","name":"leftStick","type":{"names":["Phaser.Math.Vector2"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#leftStick","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":304,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A Vector2 containing the most recent values from the Gamepad's right axis stick.\nThis is updated automatically as part of the Gamepad.update cycle.\nThe H Axis is mapped to the `Vector2.x` property, and the V Axis to the `Vector2.y` property.\nThe values are based on the Axis thresholds.\nIf the Gamepad does not have a right axis stick, the values will always be zero.","name":"rightStick","type":{"names":["Phaser.Math.Vector2"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#rightStick","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Gets the total number of axis this Gamepad claims to support.","kind":"function","name":"getAxisTotal","since":"3.10.0","returns":[{"type":{"names":["integer"]},"description":"The total number of axes this Gamepad claims to support."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#getAxisTotal","scope":"instance","___s":true},{"meta":{"filename":"Gamepad.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Gets the value of an axis based on the given index.\nThe index must be valid within the range of axes supported by this Gamepad.\nThe return value will be a float between 0 and 1.","kind":"function","name":"getAxisValue","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The index of the axes to get the value for.","name":"index"}],"returns":[{"type":{"names":["number"]},"description":"The value of the axis, between 0 and 1."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#getAxisValue","scope":"instance","___s":true},{"meta":{"filename":"Gamepad.js","lineno":348,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Sets the threshold value of all axis on this Gamepad.\nThe value is a float between 0 and 1 and is the amount below which the axis is considered as not having been moved.","kind":"function","name":"setAxisThreshold","since":"3.10.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1.","name":"value"}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#setAxisThreshold","scope":"instance","___s":true},{"meta":{"filename":"Gamepad.js","lineno":365,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Gets the total number of buttons this Gamepad claims to have.","kind":"function","name":"getButtonTotal","since":"3.10.0","returns":[{"type":{"names":["integer"]},"description":"The total number of buttons this Gamepad claims to have."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#getButtonTotal","scope":"instance","___s":true},{"meta":{"filename":"Gamepad.js","lineno":378,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Gets the value of a button based on the given index.\nThe index must be valid within the range of buttons supported by this Gamepad.\n\nThe return value will be either 0 or 1 for an analogue button, or a float between 0 and 1\nfor a pressure-sensitive digital button, such as the shoulder buttons on a Dual Shock.","kind":"function","name":"getButtonValue","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The index of the button to get the value for.","name":"index"}],"returns":[{"type":{"names":["number"]},"description":"The value of the button, between 0 and 1."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#getButtonValue","scope":"instance","___s":true},{"meta":{"filename":"Gamepad.js","lineno":397,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Returns if the button is pressed down or not.\nThe index must be valid within the range of buttons supported by this Gamepad.","kind":"function","name":"isButtonDown","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The index of the button to get the value for.","name":"index"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the button is considered as being pressed down, otherwise `false`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#isButtonDown","scope":"instance","___s":true},{"meta":{"filename":"Gamepad.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Destroys this Gamepad instance, its buttons and axes, and releases external references it holds.","kind":"function","name":"destroy","since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"Gamepad.js","lineno":489,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is this Gamepad currently connected or not?","name":"connected","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#connected","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":506,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A timestamp containing the most recent time this Gamepad was updated.","name":"timestamp","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#timestamp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":522,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's Left button being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nThis is the d-pad left button under standard Gamepad mapping.","name":"left","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":540,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's Right button being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nThis is the d-pad right button under standard Gamepad mapping.","name":"right","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":558,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's Up button being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nThis is the d-pad up button under standard Gamepad mapping.","name":"up","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#up","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":576,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's Down button being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nThis is the d-pad down button under standard Gamepad mapping.","name":"down","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#down","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":594,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's bottom button in the right button cluster being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nOn a Dual Shock controller it's the X button.\nOn an XBox controller it's the A button.","name":"A","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#A","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":613,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's top button in the right button cluster being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nOn a Dual Shock controller it's the Triangle button.\nOn an XBox controller it's the Y button.","name":"Y","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#Y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's left button in the right button cluster being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nOn a Dual Shock controller it's the Square button.\nOn an XBox controller it's the X button.","name":"X","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#X","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":651,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Is the Gamepad's right button in the right button cluster being pressed?\nIf the Gamepad doesn't have this button it will always return false.\nOn a Dual Shock controller it's the Circle button.\nOn an XBox controller it's the B button.","name":"B","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#B","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":670,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Returns the value of the Gamepad's top left shoulder button.\nIf the Gamepad doesn't have this button it will always return zero.\nThe value is a float between 0 and 1, corresponding to how depressed the button is.\nOn a Dual Shock controller it's the L1 button.\nOn an XBox controller it's the LB button.","name":"L1","type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#L1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":690,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Returns the value of the Gamepad's bottom left shoulder button.\nIf the Gamepad doesn't have this button it will always return zero.\nThe value is a float between 0 and 1, corresponding to how depressed the button is.\nOn a Dual Shock controller it's the L2 button.\nOn an XBox controller it's the LT button.","name":"L2","type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#L2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":710,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Returns the value of the Gamepad's top right shoulder button.\nIf the Gamepad doesn't have this button it will always return zero.\nThe value is a float between 0 and 1, corresponding to how depressed the button is.\nOn a Dual Shock controller it's the R1 button.\nOn an XBox controller it's the RB button.","name":"R1","type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#R1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Gamepad.js","lineno":730,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Returns the value of the Gamepad's bottom right shoulder button.\nIf the Gamepad doesn't have this button it will always return zero.\nThe value is a float between 0 and 1, corresponding to how depressed the button is.\nOn a Dual Shock controller it's the R2 button.\nOn an XBox controller it's the RT button.","name":"R2","type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#R2","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"GamepadPlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"classdesc":"The Gamepad Plugin is an input plugin that belongs to the Scene-owned Input system.\n\nIts role is to listen for native DOM Gamepad Events and then process them.\n\nYou do not need to create this class directly, the Input system will create an instance of it automatically.\n\nYou can access it from within a Scene using `this.input.gamepad`.\n\nTo listen for a gamepad being connected:\n\n```javascript\nthis.input.gamepad.once('connected', function (pad) {\n // 'pad' is a reference to the gamepad that was just connected\n});\n```\n\nNote that the browser may require you to press a button on a gamepad before it will allow you to access it,\nthis is for security reasons. However, it may also trust the page already, in which case you won't get the\n'connected' event and instead should check `GamepadPlugin.total` to see if it thinks there are any gamepads\nalready connected.\n\nOnce you have received the connected event, or polled the gamepads and found them enabled, you can access\nthem via the built-in properties `GamepadPlugin.pad1` to `pad4`, for up to 4 game pads. With a reference\nto the gamepads you can poll its buttons and axis sticks. See the properties and methods available on\nthe `Gamepad` class for more details.\n\nFor more information about Gamepad support in browsers see the following resources:\n\nhttps://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API\nhttps://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API/Using_the_Gamepad_API\nhttps://www.smashingmagazine.com/2015/11/gamepad-api-in-web-games/\nhttp://html5gamepad.com/","kind":"class","name":"GamepadPlugin","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Input.Gamepad","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"A reference to the Scene Input Plugin that the KeyboardPlugin belongs to.","name":"sceneInputPlugin"}],"scope":"static","longname":"Phaser.Input.Gamepad.GamepadPlugin","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the Scene that this Input Plugin is responsible for.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the Scene Systems Settings.","name":"settings","type":{"names":["Phaser.Types.Scenes.SettingsObject"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#settings","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the Scene Input Plugin that created this Keyboard Plugin.","name":"sceneInputPlugin","type":{"names":["Phaser.Input.InputPlugin"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#sceneInputPlugin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A boolean that controls if the Gamepad Manager is enabled or not.\nCan be toggled on the fly.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"The Gamepad Event target, as defined in the Game Config.\nTypically the browser window, but can be any interactive DOM element.","name":"target","type":{"names":["any"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#target","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An array of the connected Gamepads.","name":"gamepads","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#gamepads","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Checks to see if both this plugin and the Scene to which it belongs is active.","kind":"function","name":"isActive","since":"3.10.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the plugin and the Scene it belongs to is active."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#isActive","scope":"instance","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Disconnects all current Gamepads.","kind":"function","name":"disconnectAll","since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#disconnectAll","scope":"instance","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":387,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Returns an array of all currently connected Gamepads.","kind":"function","name":"getAll","since":"3.10.0","returns":[{"type":{"names":["Array."]},"description":"An array of all currently connected Gamepads."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#getAll","scope":"instance","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"Looks-up a single Gamepad based on the given index value.","kind":"function","name":"getPad","since":"3.10.0","params":[{"type":{"names":["number"]},"description":"The index of the Gamepad to get.","name":"index"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"The Gamepad matching the given index, or undefined if none were found."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#getPad","scope":"instance","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":524,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"The total number of connected game pads.","name":"total","type":{"names":["integer"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#total","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":540,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the first connected Gamepad.\n\nThis will be undefined if either no pads are connected, or the browser\nhas not yet issued a gamepadconnect, which can happen even if a Gamepad\nis plugged in, but hasn't yet had any buttons pressed on it.","name":"pad1","type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#pad1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":560,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the second connected Gamepad.\n\nThis will be undefined if either no pads are connected, or the browser\nhas not yet issued a gamepadconnect, which can happen even if a Gamepad\nis plugged in, but hasn't yet had any buttons pressed on it.","name":"pad2","type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#pad2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":580,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the third connected Gamepad.\n\nThis will be undefined if either no pads are connected, or the browser\nhas not yet issued a gamepadconnect, which can happen even if a Gamepad\nis plugged in, but hasn't yet had any buttons pressed on it.","name":"pad3","type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#pad3","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":600,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"A reference to the fourth connected Gamepad.\n\nThis will be undefined if either no pads are connected, or the browser\nhas not yet issued a gamepadconnect, which can happen even if a Gamepad\nis plugged in, but hasn't yet had any buttons pressed on it.","name":"pad4","type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"since":"3.10.0","memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#pad4","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"GamepadPlugin.js","lineno":622,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"description":"An instance of the Gamepad Plugin class, if enabled via the `input.gamepad` Scene or Game Config property.\nUse this to create access Gamepads connected to the browser and respond to gamepad buttons.","name":"gamepad","type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"nullable":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#gamepad","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SNES_USB_Controller.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs"},"description":"Tatar SNES USB Controller Gamepad Configuration.\nUSB Gamepad (STANDARD GAMEPAD Vendor: 0079 Product: 0011)","name":"SNES_USB","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Configs","longname":"Phaser.Input.Gamepad.Configs.SNES_USB","scope":"static","kind":"member","___s":true},{"meta":{"filename":"Sony_PlayStation_DualShock_4.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs"},"description":"PlayStation DualShock 4 Gamepad Configuration.\nSony PlayStation DualShock 4 (v2) wireless controller","name":"DUALSHOCK_4","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Configs","longname":"Phaser.Input.Gamepad.Configs.DUALSHOCK_4","scope":"static","kind":"member","___s":true},{"meta":{"filename":"XBox360_Controller.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs"},"description":"XBox 360 Gamepad Configuration.","name":"XBOX_360","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Input.Gamepad.Configs","longname":"Phaser.Input.Gamepad.Configs.XBOX_360","scope":"static","kind":"member","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs"},"kind":"namespace","name":"Configs","memberof":"Phaser.Input.Gamepad","longname":"Phaser.Input.Gamepad.Configs","scope":"static","___s":true},{"meta":{"filename":"BUTTON_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"description":"The Gamepad Button Down Event.\n\nThis event is dispatched by the Gamepad Plugin when a button has been pressed on any active Gamepad.\n\nListen to this event from within a Scene using: `this.input.gamepad.on('down', listener)`.\n\nYou can also listen for a DOWN event from a Gamepad instance. See the [GAMEPAD_BUTTON_DOWN]{@linkcode Phaser.Input.Gamepad.Events#event:GAMEPAD_BUTTON_DOWN} event for details.","kind":"event","name":"BUTTON_DOWN","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.Gamepad"]},"description":"A reference to the Gamepad on which the button was pressed.","name":"pad"},{"type":{"names":["Phaser.Input.Gamepad.Button"]},"description":"A reference to the Button which was pressed.","name":"button"},{"type":{"names":["number"]},"description":"The value of the button at the time it was pressed. Between 0 and 1. Some Gamepads have pressure-sensitive buttons.","name":"value"}],"memberof":"Phaser.Input.Gamepad.Events","longname":"Phaser.Input.Gamepad.Events#event:BUTTON_DOWN","scope":"instance","___s":true},{"meta":{"filename":"BUTTON_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"description":"The Gamepad Button Up Event.\n\nThis event is dispatched by the Gamepad Plugin when a button has been released on any active Gamepad.\n\nListen to this event from within a Scene using: `this.input.gamepad.on('up', listener)`.\n\nYou can also listen for an UP event from a Gamepad instance. See the [GAMEPAD_BUTTON_UP]{@linkcode Phaser.Input.Gamepad.Events#event:GAMEPAD_BUTTON_UP} event for details.","kind":"event","name":"BUTTON_UP","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.Gamepad"]},"description":"A reference to the Gamepad on which the button was released.","name":"pad"},{"type":{"names":["Phaser.Input.Gamepad.Button"]},"description":"A reference to the Button which was released.","name":"button"},{"type":{"names":["number"]},"description":"The value of the button at the time it was released. Between 0 and 1. Some Gamepads have pressure-sensitive buttons.","name":"value"}],"memberof":"Phaser.Input.Gamepad.Events","longname":"Phaser.Input.Gamepad.Events#event:BUTTON_UP","scope":"instance","___s":true},{"meta":{"filename":"CONNECTED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"description":"The Gamepad Connected Event.\n\nThis event is dispatched by the Gamepad Plugin when a Gamepad has been connected.\n\nListen to this event from within a Scene using: `this.input.gamepad.once('connected', listener)`.\n\nNote that the browser may require you to press a button on a gamepad before it will allow you to access it,\nthis is for security reasons. However, it may also trust the page already, in which case you won't get the\n'connected' event and instead should check `GamepadPlugin.total` to see if it thinks there are any gamepads\nalready connected.","kind":"event","name":"CONNECTED","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Gamepad"]},"description":"A reference to the Gamepad which was connected.","name":"pad"},{"type":{"names":["Event"]},"description":"The native DOM Event that triggered the connection.","name":"event"}],"memberof":"Phaser.Input.Gamepad.Events","longname":"Phaser.Input.Gamepad.Events#event:CONNECTED","scope":"instance","___s":true},{"meta":{"filename":"DISCONNECTED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"description":"The Gamepad Disconnected Event.\n\nThis event is dispatched by the Gamepad Plugin when a Gamepad has been disconnected.\n\nListen to this event from within a Scene using: `this.input.gamepad.once('disconnected', listener)`.","kind":"event","name":"DISCONNECTED","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Gamepad"]},"description":"A reference to the Gamepad which was disconnected.","name":"pad"},{"type":{"names":["Event"]},"description":"The native DOM Event that triggered the disconnection.","name":"event"}],"memberof":"Phaser.Input.Gamepad.Events","longname":"Phaser.Input.Gamepad.Events#event:DISCONNECTED","scope":"instance","___s":true},{"meta":{"filename":"GAMEPAD_BUTTON_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"description":"The Gamepad Button Down Event.\n\nThis event is dispatched by a Gamepad instance when a button has been pressed on it.\n\nListen to this event from a Gamepad instance. Once way to get this is from the `pad1`, `pad2`, etc properties on the Gamepad Plugin:\n`this.input.gamepad.pad1.on('down', listener)`.\n\nNote that you will not receive any Gamepad button events until the browser considers the Gamepad as being 'connected'.\n\nYou can also listen for a DOWN event from the Gamepad Plugin. See the [BUTTON_DOWN]{@linkcode Phaser.Input.Gamepad.Events#event:BUTTON_DOWN} event for details.","kind":"event","name":"GAMEPAD_BUTTON_DOWN","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The index of the button that was pressed.","name":"index"},{"type":{"names":["number"]},"description":"The value of the button at the time it was pressed. Between 0 and 1. Some Gamepads have pressure-sensitive buttons.","name":"value"},{"type":{"names":["Phaser.Input.Gamepad.Button"]},"description":"A reference to the Button which was pressed.","name":"button"}],"memberof":"Phaser.Input.Gamepad.Events","longname":"Phaser.Input.Gamepad.Events#event:GAMEPAD_BUTTON_DOWN","scope":"instance","___s":true},{"meta":{"filename":"GAMEPAD_BUTTON_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"description":"The Gamepad Button Up Event.\n\nThis event is dispatched by a Gamepad instance when a button has been released on it.\n\nListen to this event from a Gamepad instance. Once way to get this is from the `pad1`, `pad2`, etc properties on the Gamepad Plugin:\n`this.input.gamepad.pad1.on('up', listener)`.\n\nNote that you will not receive any Gamepad button events until the browser considers the Gamepad as being 'connected'.\n\nYou can also listen for an UP event from the Gamepad Plugin. See the [BUTTON_UP]{@linkcode Phaser.Input.Gamepad.Events#event:BUTTON_UP} event for details.","kind":"event","name":"GAMEPAD_BUTTON_UP","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The index of the button that was released.","name":"index"},{"type":{"names":["number"]},"description":"The value of the button at the time it was released. Between 0 and 1. Some Gamepads have pressure-sensitive buttons.","name":"value"},{"type":{"names":["Phaser.Input.Gamepad.Button"]},"description":"A reference to the Button which was released.","name":"button"}],"memberof":"Phaser.Input.Gamepad.Events","longname":"Phaser.Input.Gamepad.Events#event:GAMEPAD_BUTTON_UP","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Input.Gamepad","longname":"Phaser.Input.Gamepad.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad"},"kind":"namespace","name":"Gamepad","memberof":"Phaser.Input","longname":"Phaser.Input.Gamepad","scope":"static","___s":true},{"meta":{"filename":"Pad.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/typedefs"},"description":"The Gamepad object, as extracted from GamepadEvent.","kind":"typedef","name":"Pad","type":{"names":["object"]},"since":"3.10.0","properties":[{"type":{"names":["string"]},"description":"The ID of the Gamepad.","name":"id"},{"type":{"names":["integer"]},"description":"The index of the Gamepad.","name":"index"}],"memberof":"Phaser.Types.Input.Gamepad","longname":"Phaser.Types.Input.Gamepad.Pad","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/gamepad/typedefs"},"kind":"namespace","name":"Gamepad","memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.Gamepad","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input"},"kind":"namespace","name":"Input","memberof":"Phaser","longname":"Phaser.Input","scope":"static","___s":true},{"meta":{"range":[180,229],"filename":"KeyboardManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"name":"ArrayRemove","longname":"ArrayRemove","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"classdesc":"The Keyboard Manager is a helper class that belongs to the global Input Manager.\n\nIts role is to listen for native DOM Keyboard Events and then store them for further processing by the Keyboard Plugin.\n\nYou do not need to create this class directly, the Input Manager will create an instance of it automatically if keyboard\ninput has been enabled in the Game Config.","kind":"class","name":"KeyboardManager","memberof":"Phaser.Input.Keyboard","since":"3.16.0","params":[{"type":{"names":["Phaser.Input.InputManager"]},"description":"A reference to the Input Manager.","name":"inputManager"}],"scope":"static","longname":"Phaser.Input.Keyboard.KeyboardManager","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A reference to the Input Manager.","name":"manager","type":{"names":["Phaser.Input.InputManager"]},"since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A flag that controls if the non-modified keys, matching those stored in the `captures` array,\nhave `preventDefault` called on them or not.\n\nA non-modified key is one that doesn't have a modifier key held down with it. The modifier keys are\nshift, control, alt and the meta key (Command on a Mac, the Windows Key on Windows).\nTherefore, if the user presses shift + r, it won't prevent this combination, because of the modifier.\nHowever, if the user presses just the r key on its own, it will have its event prevented.\n\nIf you wish to stop capturing the keys, for example switching out to a DOM based element, then\nyou can toggle this property at run-time.","name":"preventDefault","type":{"names":["boolean"]},"since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#preventDefault","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"An array of Key Code values that will automatically have `preventDefault` called on them,\nas long as the `KeyboardManager.preventDefault` boolean is set to `true`.\n\nBy default the array is empty.\n\nThe key must be non-modified when pressed in order to be captured.\n\nA non-modified key is one that doesn't have a modifier key held down with it. The modifier keys are\nshift, control, alt and the meta key (Command on a Mac, the Windows Key on Windows).\nTherefore, if the user presses shift + r, it won't prevent this combination, because of the modifier.\nHowever, if the user presses just the r key on its own, it will have its event prevented.\n\nIf you wish to stop capturing the keys, for example switching out to a DOM based element, then\nyou can toggle the `KeyboardManager.preventDefault` boolean at run-time.\n\nIf you need more specific control, you can create Key objects and set the flag on each of those instead.\n\nThis array can be populated via the Game Config by setting the `input.keyboard.capture` array, or you\ncan call the `addCapture` method. See also `removeCapture` and `clearCaptures`.","name":"captures","type":{"names":["Array."]},"since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#captures","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":100,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A boolean that controls if the Keyboard Manager is enabled or not.\nCan be toggled on the fly.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"The Keyboard Event target, as defined in the Game Config.\nTypically the window in which the game is rendering, but can be any interactive DOM element.","name":"target","type":{"names":["any"]},"since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#target","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"The Key Down Event handler.\nThis function is sent the native DOM KeyEvent.\nInitially empty and bound in the `startListeners` method.","name":"onKeyDown","type":{"names":["function"]},"since":"3.16.00","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#onKeyDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"The Key Up Event handler.\nThis function is sent the native DOM KeyEvent.\nInitially empty and bound in the `startListeners` method.","name":"onKeyUp","type":{"names":["function"]},"since":"3.16.00","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#onKeyUp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Starts the Keyboard Event listeners running.\nThis is called automatically and does not need to be manually invoked.","kind":"function","name":"startListeners","since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#startListeners","scope":"instance","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":243,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Stops the Key Event listeners.\nThis is called automatically and does not need to be manually invoked.","kind":"function","name":"stopListeners","since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#stopListeners","scope":"instance","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"By default when a key is pressed Phaser will not stop the event from propagating up to the browser.\nThere are some keys this can be annoying for, like the arrow keys or space bar, which make the browser window scroll.\n\nThis `addCapture` method enables consuming keyboard event for specific keys so it doesn't bubble up to the the browser\nand cause the default browser behavior.\n\nPlease note that keyboard captures are global. This means that if you call this method from within a Scene, to say prevent\nthe SPACE BAR from triggering a page scroll, then it will prevent it for any Scene in your game, not just the calling one.\n\nYou can pass in a single key code value, or an array of key codes, or a string:\n\n```javascript\nthis.input.keyboard.addCapture(62);\n```\n\nAn array of key codes:\n\n```javascript\nthis.input.keyboard.addCapture([ 62, 63, 64 ]);\n```\n\nOr a string:\n\n```javascript\nthis.input.keyboard.addCapture('W,S,A,D');\n```\n\nTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\n\nYou can also provide an array mixing both strings and key code integers.\n\nIf there are active captures after calling this method, the `preventDefault` property is set to `true`.","kind":"function","name":"addCapture","since":"3.16.0","params":[{"type":{"names":["string","integer","Array.","Array."]},"description":"The Key Codes to enable capture for, preventing them reaching the browser.","name":"keycode"}],"memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#addCapture","scope":"instance","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":344,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Removes an existing key capture.\n\nPlease note that keyboard captures are global. This means that if you call this method from within a Scene, to remove\nthe capture of a key, then it will remove it for any Scene in your game, not just the calling one.\n\nYou can pass in a single key code value, or an array of key codes, or a string:\n\n```javascript\nthis.input.keyboard.removeCapture(62);\n```\n\nAn array of key codes:\n\n```javascript\nthis.input.keyboard.removeCapture([ 62, 63, 64 ]);\n```\n\nOr a string:\n\n```javascript\nthis.input.keyboard.removeCapture('W,S,A,D');\n```\n\nTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\n\nYou can also provide an array mixing both strings and key code integers.\n\nIf there are no captures left after calling this method, the `preventDefault` property is set to `false`.","kind":"function","name":"removeCapture","since":"3.16.0","params":[{"type":{"names":["string","integer","Array.","Array."]},"description":"The Key Codes to disable capture for, allowing them reaching the browser again.","name":"keycode"}],"memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#removeCapture","scope":"instance","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":408,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Removes all keyboard captures and sets the `preventDefault` property to `false`.","kind":"function","name":"clearCaptures","since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#clearCaptures","scope":"instance","___s":true},{"meta":{"filename":"KeyboardManager.js","lineno":421,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Destroys this Keyboard Manager instance.","kind":"function","name":"destroy","since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardManager","longname":"Phaser.Input.Keyboard.KeyboardManager#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"KeyboardPlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"classdesc":"The Keyboard Plugin is an input plugin that belongs to the Scene-owned Input system.\n\nIts role is to listen for native DOM Keyboard Events and then process them.\n\nYou do not need to create this class directly, the Input system will create an instance of it automatically.\n\nYou can access it from within a Scene using `this.input.keyboard`. For example, you can do:\n\n```javascript\nthis.input.keyboard.on('keydown', callback, context);\n```\n\nOr, to listen for a specific key:\n\n```javascript\nthis.input.keyboard.on('keydown-A', callback, context);\n```\n\nYou can also create Key objects, which you can then poll in your game loop:\n\n```javascript\nvar spaceBar = this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.SPACE);\n```\n\nIf you have multiple parallel Scenes, each trying to get keyboard input, be sure to disable capture on them to stop them from\nstealing input from another Scene in the list. You can do this with `this.input.keyboard.enabled = false` within the\nScene to stop all input, or `this.input.keyboard.preventDefault = false` to stop a Scene halting input on another Scene.\n\n_Note_: Many keyboards are unable to process certain combinations of keys due to hardware limitations known as ghosting.\nSee http://www.html5gamedevs.com/topic/4876-impossible-to-use-more-than-2-keyboard-input-buttons-at-the-same-time/ for more details.\n\nAlso please be aware that certain browser extensions can disable or override Phaser keyboard handling.\nFor example the Chrome extension vimium is known to disable Phaser from using the D key, while EverNote disables the backtick key.\nAnd there are others. So, please check your extensions before opening Phaser issues about keys that don't work.","kind":"class","name":"KeyboardPlugin","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Input.Keyboard","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"A reference to the Scene Input Plugin that the KeyboardPlugin belongs to.","name":"sceneInputPlugin"}],"scope":"static","longname":"Phaser.Input.Keyboard.KeyboardPlugin","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A reference to the core game, so we can listen for visibility events.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A reference to the Scene that this Input Plugin is responsible for.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.10.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A reference to the Scene Systems Settings.","name":"settings","type":{"names":["Phaser.Types.Scenes.SettingsObject"]},"since":"3.10.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#settings","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A reference to the Scene Input Plugin that created this Keyboard Plugin.","name":"sceneInputPlugin","type":{"names":["Phaser.Input.InputPlugin"]},"since":"3.10.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#sceneInputPlugin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A reference to the global Keyboard Manager.","name":"manager","type":{"names":["Phaser.Input.InputPlugin"]},"since":"3.16.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A boolean that controls if this Keyboard Plugin is enabled or not.\nCan be toggled on the fly.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.10.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"An array of Key objects to process.","name":"keys","type":{"names":["Array."]},"since":"3.10.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#keys","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":140,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"An array of KeyCombo objects to process.","name":"combos","type":{"names":["Array."]},"since":"3.10.0","memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#combos","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Checks to see if both this plugin and the Scene to which it belongs is active.","kind":"function","name":"isActive","since":"3.10.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the plugin and the Scene it belongs to is active."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#isActive","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"By default when a key is pressed Phaser will not stop the event from propagating up to the browser.\nThere are some keys this can be annoying for, like the arrow keys or space bar, which make the browser window scroll.\n\nThis `addCapture` method enables consuming keyboard events for specific keys, so they don't bubble up the browser\nand cause the default behaviors.\n\nPlease note that keyboard captures are global. This means that if you call this method from within a Scene, to say prevent\nthe SPACE BAR from triggering a page scroll, then it will prevent it for any Scene in your game, not just the calling one.\n\nYou can pass a single key code value:\n\n```javascript\nthis.input.keyboard.addCapture(62);\n```\n\nAn array of key codes:\n\n```javascript\nthis.input.keyboard.addCapture([ 62, 63, 64 ]);\n```\n\nOr, a comma-delimited string:\n\n```javascript\nthis.input.keyboard.addCapture('W,S,A,D');\n```\n\nTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\n\nYou can also provide an array mixing both strings and key code integers.","kind":"function","name":"addCapture","since":"3.16.0","params":[{"type":{"names":["string","integer","Array.","Array."]},"description":"The Key Codes to enable event capture for.","name":"keycode"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#addCapture","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":261,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Removes an existing key capture.\n\nPlease note that keyboard captures are global. This means that if you call this method from within a Scene, to remove\nthe capture of a key, then it will remove it for any Scene in your game, not just the calling one.\n\nYou can pass a single key code value:\n\n```javascript\nthis.input.keyboard.removeCapture(62);\n```\n\nAn array of key codes:\n\n```javascript\nthis.input.keyboard.removeCapture([ 62, 63, 64 ]);\n```\n\nOr, a comma-delimited string:\n\n```javascript\nthis.input.keyboard.removeCapture('W,S,A,D');\n```\n\nTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\n\nYou can also provide an array mixing both strings and key code integers.","kind":"function","name":"removeCapture","since":"3.16.0","params":[{"type":{"names":["string","integer","Array.","Array."]},"description":"The Key Codes to disable event capture for.","name":"keycode"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#removeCapture","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":303,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Returns an array that contains all of the keyboard captures currently enabled.","kind":"function","name":"getCaptures","since":"3.16.0","returns":[{"type":{"names":["Array."]},"description":"An array of all the currently capturing key codes."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#getCaptures","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":316,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Allows Phaser to prevent any key captures you may have defined from bubbling up the browser.\nYou can use this to re-enable event capturing if you had paused it via `disableGlobalCapture`.","kind":"function","name":"enableGlobalCapture","since":"3.16.0","returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#enableGlobalCapture","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Disables Phaser from preventing any key captures you may have defined, without actually removing them.\nYou can use this to temporarily disable event capturing if, for example, you swap to a DOM element.","kind":"function","name":"disableGlobalCapture","since":"3.16.0","returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#disableGlobalCapture","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":348,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Removes all keyboard captures.\n\nNote that this is a global change. It will clear all event captures across your game, not just for this specific Scene.","kind":"function","name":"clearCaptures","since":"3.16.0","returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#clearCaptures","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":365,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Creates and returns an object containing 4 hotkeys for Up, Down, Left and Right, and also Space Bar and shift.","kind":"function","name":"createCursorKeys","since":"3.10.0","returns":[{"type":{"names":["Phaser.Types.Input.Keyboard.CursorKeys"]},"description":"An object containing the properties: `up`, `down`, `left`, `right`, `space` and `shift`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#createCursorKeys","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"A practical way to create an object containing user selected hotkeys.\n\nFor example:\n\n```javascript\nthis.input.keyboard.addKeys({ 'up': Phaser.Input.Keyboard.KeyCodes.W, 'down': Phaser.Input.Keyboard.KeyCodes.S });\n```\n\nwould return an object containing the properties (`up` and `down`) mapped to W and S {@link Phaser.Input.Keyboard.Key} objects.\n\nYou can also pass in a comma-separated string:\n\n```javascript\nthis.input.keyboard.addKeys('W,S,A,D');\n```\n\nWhich will return an object with the properties W, S, A and D mapped to the relevant Key objects.\n\nTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.","kind":"function","name":"addKeys","since":"3.10.0","params":[{"type":{"names":["object","string"]},"description":"An object containing Key Codes, or a comma-separated string.","name":"keys"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Automatically call `preventDefault` on the native DOM browser event for the key codes being added.","name":"enableCapture"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Controls if the Key will continuously emit a 'down' event while being held down (true), or emit the event just once (false, the default).","name":"emitOnRepeat"}],"returns":[{"type":{"names":["object"]},"description":"An object containing Key objects mapped to the input properties."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#addKeys","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":447,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Adds a Key object to this Keyboard Plugin.\n\nThe given argument can be either an existing Key object, a string, such as `A` or `SPACE`, or a key code value.\n\nIf a Key object is given, and one already exists matching the same key code, the existing one is replaced with the new one.","kind":"function","name":"addKey","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key","string","integer"]},"description":"Either a Key object, a string, such as `A` or `SPACE`, or a key code value.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Automatically call `preventDefault` on the native DOM browser event for the key codes being added.","name":"enableCapture"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Controls if the Key will continuously emit a 'down' event while being held down (true), or emit the event just once (false, the default).","name":"emitOnRepeat"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The newly created Key object, or a reference to it if it already existed in the keys array."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#addKey","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Removes a Key object from this Keyboard Plugin.\n\nThe given argument can be either a Key object, a string, such as `A` or `SPACE`, or a key code value.","kind":"function","name":"removeKey","since":"3.10.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key","string","integer"]},"description":"Either a Key object, a string, such as `A` or `SPACE`, or a key code value.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Call `Key.destroy` on the removed Key object?","name":"destroy"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#removeKey","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":569,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Creates a new KeyCombo.\n\nA KeyCombo will listen for a specific string of keys from the Keyboard, and when it receives them\nit will emit a `keycombomatch` event from this Keyboard Plugin.\n\nThe keys to be listened for can be defined as:\n\nA string (i.e. 'ATARI')\nAn array of either integers (key codes) or strings, or a mixture of both\nAn array of objects (such as Key objects) with a public 'keyCode' property\n\nFor example, to listen for the Konami code (up, up, down, down, left, right, left, right, b, a, enter)\nyou could pass the following array of key codes:\n\n```javascript\nthis.input.keyboard.createCombo([ 38, 38, 40, 40, 37, 39, 37, 39, 66, 65, 13 ], { resetOnMatch: true });\n\nthis.input.keyboard.on('keycombomatch', function (event) {\n console.log('Konami Code entered!');\n});\n```\n\nOr, to listen for the user entering the word PHASER:\n\n```javascript\nthis.input.keyboard.createCombo('PHASER');\n```","kind":"function","name":"createCombo","since":"3.10.0","params":[{"type":{"names":["string","Array.","Array."]},"description":"The keys that comprise this combo.","name":"keys"},{"type":{"names":["Phaser.Types.Input.Keyboard.KeyComboConfig"]},"optional":true,"description":"A Key Combo configuration object.","name":"config"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyCombo"]},"description":"The new KeyCombo object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#createCombo","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":611,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Checks if the given Key object is currently being held down.\n\nThe difference between this method and checking the `Key.isDown` property directly is that you can provide\na duration to this method. For example, if you wanted a key press to fire a bullet, but you only wanted\nit to be able to fire every 100ms, then you can call this method with a `duration` of 100 and it\nwill only return `true` every 100ms.\n\nIf the Keyboard Plugin has been disabled, this method will always return `false`.","kind":"function","name":"checkDown","since":"3.11.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"A Key object.","name":"key"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The duration which must have elapsed before this Key is considered as being down.","name":"duration"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Key is down within the duration specified, otherwise `false`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#checkDown","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":759,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"Resets all Key objects created by _this_ Keyboard Plugin back to their default un-pressed states.\nThis can only reset keys created via the `addKey`, `addKeys` or `createCursorKeys` methods.\nIf you have created a Key object directly you'll need to reset it yourself.\n\nThis method is called automatically when the Keyboard Plugin shuts down, but can be\ninvoked directly at any time you require.","kind":"function","name":"resetKeys","since":"3.15.0","returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"This KeyboardPlugin object."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#resetKeys","scope":"instance","___s":true},{"meta":{"filename":"KeyboardPlugin.js","lineno":870,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"description":"An instance of the Keyboard Plugin class, if enabled via the `input.keyboard` Scene or Game Config property.\nUse this to create Key objects and listen for keyboard specific events.","name":"keyboard","type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"nullable":true,"since":"3.10.0","memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#keyboard","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,219],"filename":"KeyCombo.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"KeyCombo.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"classdesc":"A KeyCombo will listen for a specific string of keys from the Keyboard, and when it receives them\nit will emit a `keycombomatch` event from the Keyboard Manager.\n\nThe keys to be listened for can be defined as:\n\nA string (i.e. 'ATARI')\nAn array of either integers (key codes) or strings, or a mixture of both\nAn array of objects (such as Key objects) with a public 'keyCode' property\n\nFor example, to listen for the Konami code (up, up, down, down, left, right, left, right, b, a, enter)\nyou could pass the following array of key codes:\n\n```javascript\nthis.input.keyboard.createCombo([ 38, 38, 40, 40, 37, 39, 37, 39, 66, 65, 13 ], { resetOnMatch: true });\n\nthis.input.keyboard.on('keycombomatch', function (event) {\n console.log('Konami Code entered!');\n});\n```\n\nOr, to listen for the user entering the word PHASER:\n\n```javascript\nthis.input.keyboard.createCombo('PHASER');\n```","kind":"class","name":"KeyCombo","memberof":"Phaser.Input.Keyboard","listens":["Phaser.Input.Keyboard.Events#event:ANY_KEY_DOWN"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"A reference to the Keyboard Plugin.","name":"keyboardPlugin"},{"type":{"names":["string","Array.","Array."]},"description":"The keys that comprise this combo.","name":"keys"},{"type":{"names":["Phaser.Types.Input.Keyboard.KeyComboConfig"]},"optional":true,"description":"A Key Combo configuration object.","name":"config"}],"scope":"static","longname":"Phaser.Input.Keyboard.KeyCombo","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"A reference to the Keyboard Manager","name":"manager","type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"A flag that controls if this Key Combo is actively processing keys or not.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"An array of the keycodes that comprise this combo.","name":"keyCodes","type":{"names":["array"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#keyCodes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"The current keyCode the combo is waiting for.","name":"current","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#current","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"The current index of the key being waited for in the 'keys' string.","name":"index","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#index","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"The length of this combo (in keycodes)","name":"size","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#size","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"The time the previous key in the combo was matched.","name":"timeLastMatched","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#timeLastMatched","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"Has this Key Combo been matched yet?","name":"matched","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#matched","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":162,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"The time the entire combo was matched.","name":"timeMatched","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#timeMatched","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":172,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"If they press the wrong key do we reset the combo?","name":"resetOnWrongKey","type":{"names":["boolean"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#resetOnWrongKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":182,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"The max delay in ms between each key press. Above this the combo is reset. 0 means disabled.","name":"maxKeyDelay","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#maxKeyDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"If previously matched and they press the first key of the combo again, will it reset?","name":"resetOnMatch","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#resetOnMatch","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":202,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"If the combo matches, will it delete itself?","name":"deleteOnMatch","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#deleteOnMatch","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"How far complete is this combo? A value between 0 and 1.","name":"progress","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"KeyCombo.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"description":"Destroys this Key Combo and all of its references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCombo","longname":"Phaser.Input.Keyboard.KeyCombo#destroy","scope":"instance","___s":true},{"meta":{"range":[180,226],"filename":"ProcessKeyCombo.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo"},"name":"AdvanceKeyCombo","longname":"AdvanceKeyCombo","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ANY_KEY_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Global Key Down Event.\n\nThis event is dispatched by the Keyboard Plugin when any key on the keyboard is pressed down.\n\nListen to this event from within a Scene using: `this.input.keyboard.on('keydown', listener)`.\n\nYou can also listen for a specific key being pressed. See [Keyboard.Events.KEY_DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:KEY_DOWN} for details.\n\nFinally, you can create Key objects, which you can also listen for events from. See [Keyboard.Events.DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:DOWN} for details.\n\n_Note_: Many keyboards are unable to process certain combinations of keys due to hardware limitations known as ghosting.\nRead [this article on ghosting]{@link http://www.html5gamedevs.com/topic/4876-impossible-to-use-more-than-2-keyboard-input-buttons-at-the-same-time/} for details.\n\nAlso, please be aware that some browser extensions can disable or override Phaser keyboard handling.\nFor example, the Chrome extension vimium is known to disable Phaser from using the D key, while EverNote disables the backtick key.\nThere are others. So, please check your extensions if you find you have specific keys that don't work.","kind":"event","name":"ANY_KEY_DOWN","since":"3.0.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event. You can inspect this to learn more about the key that was pressed, any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:ANY_KEY_DOWN","scope":"instance","___s":true},{"meta":{"filename":"ANY_KEY_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Global Key Up Event.\n\nThis event is dispatched by the Keyboard Plugin when any key on the keyboard is released.\n\nListen to this event from within a Scene using: `this.input.keyboard.on('keyup', listener)`.\n\nYou can also listen for a specific key being released. See [Keyboard.Events.KEY_UP]{@linkcode Phaser.Input.Keyboard.Events#event:KEY_UP} for details.\n\nFinally, you can create Key objects, which you can also listen for events from. See [Keyboard.Events.UP]{@linkcode Phaser.Input.Keyboard.Events#event:UP} for details.","kind":"event","name":"ANY_KEY_UP","since":"3.0.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event. You can inspect this to learn more about the key that was released, any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:ANY_KEY_UP","scope":"instance","___s":true},{"meta":{"filename":"COMBO_MATCH_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Key Combo Match Event.\n\nThis event is dispatched by the Keyboard Plugin when a [Key Combo]{@link Phaser.Input.Keyboard.KeyCombo} is matched.\n\nListen for this event from the Key Plugin after a combo has been created:\n\n```javascript\nthis.input.keyboard.createCombo([ 38, 38, 40, 40, 37, 39, 37, 39, 66, 65, 13 ], { resetOnMatch: true });\n\nthis.input.keyboard.on('keycombomatch', function (event) {\n console.log('Konami Code entered!');\n});\n```","kind":"event","name":"COMBO_MATCH","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.KeyCombo"]},"description":"The Key Combo object that was matched.","name":"keycombo"},{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event of the final key in the combo. You can inspect this to learn more about any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:COMBO_MATCH","scope":"instance","___s":true},{"meta":{"filename":"DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Key Down Event.\n\nThis event is dispatched by a [Key]{@link Phaser.Input.Keyboard.Key} object when it is pressed.\n\nListen for this event from the Key object instance directly:\n\n```javascript\nvar spaceBar = this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.SPACE);\n\nspaceBar.on('down', listener)\n```\n\nYou can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_DOWN} for details.","kind":"event","name":"DOWN","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The Key object that was pressed.","name":"key"},{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event. You can inspect this to learn more about any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:DOWN","scope":"instance","___s":true},{"meta":{"filename":"KEY_DOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Key Down Event.\n\nThis event is dispatched by the Keyboard Plugin when any key on the keyboard is pressed down.\n\nUnlike the `ANY_KEY_DOWN` event, this one has a special dynamic event name. For example, to listen for the `A` key being pressed\nuse the following from within a Scene: `this.input.keyboard.on('keydown-A', listener)`. You can replace the `-A` part of the event\nname with any valid [Key Code string]{@link Phaser.Input.Keyboard.KeyCodes}. For example, this will listen for the space bar: \n`this.input.keyboard.on('keydown-SPACE', listener)`.\n\nYou can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_DOWN} for details.\n\nFinally, you can create Key objects, which you can also listen for events from. See [Keyboard.Events.DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:DOWN} for details.\n\n_Note_: Many keyboards are unable to process certain combinations of keys due to hardware limitations known as ghosting.\nRead [this article on ghosting]{@link http://www.html5gamedevs.com/topic/4876-impossible-to-use-more-than-2-keyboard-input-buttons-at-the-same-time/} for details.\n\nAlso, please be aware that some browser extensions can disable or override Phaser keyboard handling.\nFor example, the Chrome extension vimium is known to disable Phaser from using the D key, while EverNote disables the backtick key.\nThere are others. So, please check your extensions if you find you have specific keys that don't work.","kind":"event","name":"KEY_DOWN","since":"3.0.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event. You can inspect this to learn more about the key that was pressed, any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:KEY_DOWN","scope":"instance","___s":true},{"meta":{"filename":"KEY_UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Key Up Event.\n\nThis event is dispatched by the Keyboard Plugin when any key on the keyboard is released.\n\nUnlike the `ANY_KEY_UP` event, this one has a special dynamic event name. For example, to listen for the `A` key being released\nuse the following from within a Scene: `this.input.keyboard.on('keyup-A', listener)`. You can replace the `-A` part of the event\nname with any valid [Key Code string]{@link Phaser.Input.Keyboard.KeyCodes}. For example, this will listen for the space bar: \n`this.input.keyboard.on('keyup-SPACE', listener)`.\n\nYou can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_UP]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_UP} for details.\n\nFinally, you can create Key objects, which you can also listen for events from. See [Keyboard.Events.UP]{@linkcode Phaser.Input.Keyboard.Events#event:UP} for details.","kind":"event","name":"KEY_UP","since":"3.0.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event. You can inspect this to learn more about the key that was released, any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:KEY_UP","scope":"instance","___s":true},{"meta":{"filename":"UP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"description":"The Key Up Event.\n\nThis event is dispatched by a [Key]{@link Phaser.Input.Keyboard.Key} object when it is released.\n\nListen for this event from the Key object instance directly:\n\n```javascript\nvar spaceBar = this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.SPACE);\n\nspaceBar.on('up', listener)\n```\n\nYou can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_UP]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_UP} for details.","kind":"event","name":"UP","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The Key object that was released.","name":"key"},{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard Event. You can inspect this to learn more about any modifiers, etc.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Events","longname":"Phaser.Input.Keyboard.Events#event:UP","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Input.Keyboard","longname":"Phaser.Input.Keyboard.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard"},"kind":"namespace","name":"Keyboard","memberof":"Phaser.Input","longname":"Phaser.Input.Keyboard","scope":"static","___s":true},{"meta":{"filename":"DownDuration.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Returns `true` if the Key was pressed down within the `duration` value given, based on the current\ngame clock time. Or `false` if it either isn't down, or was pressed down longer ago than the given duration.","kind":"function","name":"DownDuration","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The Key object to test.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":50,"description":"The duration, in ms, within which the key must have been pressed down.","name":"duration"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Key was pressed down within `duration` ms ago, otherwise `false`."}],"memberof":"Phaser.Input.Keyboard","longname":"Phaser.Input.Keyboard.DownDuration","scope":"static","___s":true},{"meta":{"filename":"JustDown.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The justDown value allows you to test if this Key has just been pressed down or not.\n\nWhen you check this value it will return `true` if the Key is down, otherwise `false`.\n\nYou can only call justDown once per key press. It will only return `true` once, until the Key is released and pressed down again.\nThis allows you to use it in situations where you want to check if this key is down without using an event, such as in a core game loop.","kind":"function","name":"JustDown","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The Key to check to see if it's just down or not.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Key was just pressed, otherwise `false`."}],"memberof":"Phaser.Input.Keyboard","longname":"Phaser.Input.Keyboard.JustDown","scope":"static","___s":true},{"meta":{"filename":"JustUp.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The justUp value allows you to test if this Key has just been released or not.\n\nWhen you check this value it will return `true` if the Key is up, otherwise `false`.\n\nYou can only call JustUp once per key release. It will only return `true` once, until the Key is pressed down and released again.\nThis allows you to use it in situations where you want to check if this key is up without using an event, such as in a core game loop.","kind":"function","name":"JustUp","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The Key to check to see if it's just up or not.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Key was just released, otherwise `false`."}],"memberof":"Phaser.Input.Keyboard","longname":"Phaser.Input.Keyboard.JustUp","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"Key.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Key.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"classdesc":"A generic Key object which can be passed to the Process functions (and so on)\nkeycode must be an integer","kind":"class","name":"Key","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Input.Keyboard","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"The Keyboard Plugin instance that owns this Key object.","name":"plugin"},{"type":{"names":["integer"]},"description":"The keycode of this key.","name":"keyCode"}],"scope":"static","longname":"Phaser.Input.Keyboard.Key","___s":true},{"meta":{"filename":"Key.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The Keyboard Plugin instance that owns this Key object.","name":"plugin","type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"since":"3.17.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#plugin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The keycode of this key.","name":"keyCode","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#keyCode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The original DOM event.","name":"originalEvent","type":{"names":["KeyboardEvent"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#originalEvent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Can this Key be processed?","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The \"down\" state of the key. This will remain `true` for as long as the keyboard thinks this key is held down.","name":"isDown","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#isDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The \"up\" state of the key. This will remain `true` for as long as the keyboard thinks this key is up.","name":"isUp","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#isUp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The down state of the ALT key, if pressed at the same time as this key.","name":"altKey","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#altKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The down state of the CTRL key, if pressed at the same time as this key.","name":"ctrlKey","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#ctrlKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The down state of the SHIFT key, if pressed at the same time as this key.","name":"shiftKey","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#shiftKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The down state of the Meta key, if pressed at the same time as this key.\nOn a Mac the Meta Key is the Command key. On Windows keyboards, it's the Windows key.","name":"metaKey","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.16.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#metaKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The location of the modifier key. 0 for standard (or unknown), 1 for left, 2 for right, 3 for numpad.","name":"location","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#location","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":143,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The timestamp when the key was last pressed down.","name":"timeDown","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#timeDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":153,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The number of milliseconds this key was held down for in the previous down - up sequence.\nThis value isn't updated every game step, only when the Key changes state.\nTo get the current duration use the `getDuration` method.","name":"duration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The timestamp when the key was last released.","name":"timeUp","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#timeUp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":175,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"When a key is held down should it continuously fire the `down` event each time it repeats?\n\nBy default it will emit the `down` event just once, but if you wish to receive the event\nfor each repeat as well, enable this property.","name":"emitOnRepeat","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.16.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#emitOnRepeat","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":188,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"If a key is held down this holds down the number of times the key has 'repeated'.","name":"repeats","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#repeats","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Key.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Controls if this Key will continuously emit a `down` event while being held down (true),\nor emit the event just once, on first press, and then skip future events (false).","kind":"function","name":"setEmitOnRepeat","since":"3.16.0","params":[{"type":{"names":["boolean"]},"description":"Emit `down` events on repeated key down actions, or just once?","name":"value"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"This Key instance."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#setEmitOnRepeat","scope":"instance","___s":true},{"meta":{"filename":"Key.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Processes the Key Down action for this Key.\nCalled automatically by the Keyboard Plugin.","kind":"function","name":"onDown","fires":["Phaser.Input.Keyboard.Events#event:DOWN"],"since":"3.16.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard event.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#onDown","scope":"instance","___s":true},{"meta":{"filename":"Key.js","lineno":293,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Processes the Key Up action for this Key.\nCalled automatically by the Keyboard Plugin.","kind":"function","name":"onUp","fires":["Phaser.Input.Keyboard.Events#event:UP"],"since":"3.16.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The native DOM Keyboard event.","name":"event"}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#onUp","scope":"instance","___s":true},{"meta":{"filename":"Key.js","lineno":325,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Resets this Key object back to its default un-pressed state.","kind":"function","name":"reset","since":"3.6.0","returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"This Key instance."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#reset","scope":"instance","___s":true},{"meta":{"filename":"Key.js","lineno":354,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Returns the duration, in ms, that the Key has been held down for.\n\nIf the key is not currently down it will return zero.\n\nThe get the duration the Key was held down for in the previous up-down cycle,\nuse the `Key.duration` property value instead.","kind":"function","name":"getDuration","since":"3.17.0","returns":[{"type":{"names":["number"]},"description":"The duration, in ms, that the Key has been held down for if currently down."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#getDuration","scope":"instance","___s":true},{"meta":{"filename":"Key.js","lineno":379,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Removes any bound event handlers and removes local references.","kind":"function","name":"destroy","since":"3.16.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Keyboard Codes.","kind":"namespace","name":"KeyCodes","memberof":"Phaser.Input.Keyboard","since":"3.0.0","longname":"Phaser.Input.Keyboard.KeyCodes","scope":"static","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The BACKSPACE key.","name":"BACKSPACE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.BACKSPACE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":26,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The TAB key.","name":"TAB","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.TAB","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The ENTER key.","name":"ENTER","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.ENTER","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The SHIFT key.","name":"SHIFT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.SHIFT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The CTRL key.","name":"CTRL","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.CTRL","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":62,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The ALT key.","name":"ALT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.ALT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The PAUSE key.","name":"PAUSE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.PAUSE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The CAPS_LOCK key.","name":"CAPS_LOCK","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.CAPS_LOCK","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":89,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The ESC key.","name":"ESC","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.ESC","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The SPACE key.","name":"SPACE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.SPACE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The PAGE_UP key.","name":"PAGE_UP","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.PAGE_UP","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":116,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The PAGE_DOWN key.","name":"PAGE_DOWN","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.PAGE_DOWN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The END key.","name":"END","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.END","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The HOME key.","name":"HOME","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.HOME","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":143,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The LEFT key.","name":"LEFT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.LEFT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The UP key.","name":"UP","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.UP","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":161,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The RIGHT key.","name":"RIGHT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.RIGHT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The DOWN key.","name":"DOWN","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.DOWN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":179,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The PRINT_SCREEN key.","name":"PRINT_SCREEN","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.PRINT_SCREEN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The INSERT key.","name":"INSERT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.INSERT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The DELETE key.","name":"DELETE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.DELETE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The ZERO key.","name":"ZERO","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.ZERO","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The ONE key.","name":"ONE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.ONE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":224,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The TWO key.","name":"TWO","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.TWO","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":233,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The THREE key.","name":"THREE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.THREE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The FOUR key.","name":"FOUR","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.FOUR","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":251,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The FIVE key.","name":"FIVE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.FIVE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The SIX key.","name":"SIX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.SIX","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The SEVEN key.","name":"SEVEN","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.SEVEN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The EIGHT key.","name":"EIGHT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.EIGHT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NINE key.","name":"NINE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NINE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":296,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_ZERO key.","name":"NUMPAD_ZERO","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_ZERO","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":305,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_ONE key.","name":"NUMPAD_ONE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_ONE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_TWO key.","name":"NUMPAD_TWO","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_TWO","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":323,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_THREE key.","name":"NUMPAD_THREE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_THREE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_FOUR key.","name":"NUMPAD_FOUR","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_FOUR","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":341,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_FIVE key.","name":"NUMPAD_FIVE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_FIVE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_SIX key.","name":"NUMPAD_SIX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_SIX","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_SEVEN key.","name":"NUMPAD_SEVEN","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_SEVEN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":368,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_EIGHT key.","name":"NUMPAD_EIGHT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_EIGHT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":377,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The NUMPAD_NINE key.","name":"NUMPAD_NINE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_NINE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":386,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The Numpad Addition (+) key.","name":"NUMPAD_ADD","type":{"names":["integer"]},"since":"3.21.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_ADD","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":395,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The Numpad Subtraction (-) key.","name":"NUMPAD_SUBTRACT","type":{"names":["integer"]},"since":"3.21.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.NUMPAD_SUBTRACT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":404,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The A key.","name":"A","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.A","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":413,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The B key.","name":"B","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.B","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":422,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The C key.","name":"C","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.C","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The D key.","name":"D","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.D","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":440,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The E key.","name":"E","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.E","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F key.","name":"F","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":458,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The G key.","name":"G","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.G","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":467,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The H key.","name":"H","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.H","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The I key.","name":"I","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.I","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The J key.","name":"J","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.J","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The K key.","name":"K","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.K","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":503,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The L key.","name":"L","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.L","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":512,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The M key.","name":"M","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.M","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":521,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The N key.","name":"N","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.N","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":530,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The O key.","name":"O","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.O","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":539,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The P key.","name":"P","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.P","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":548,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The Q key.","name":"Q","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.Q","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":557,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The R key.","name":"R","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.R","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":566,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The S key.","name":"S","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.S","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":575,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The T key.","name":"T","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.T","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":584,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The U key.","name":"U","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.U","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":593,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The V key.","name":"V","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.V","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":602,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The W key.","name":"W","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.W","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":611,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The X key.","name":"X","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.X","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":620,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The Y key.","name":"Y","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.Y","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":629,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The Z key.","name":"Z","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.Z","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":638,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F1 key.","name":"F1","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F1","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":647,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F2 key.","name":"F2","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F2","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":656,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F3 key.","name":"F3","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F3","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":665,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F4 key.","name":"F4","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F4","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":674,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F5 key.","name":"F5","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F5","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F6 key.","name":"F6","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F6","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":692,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F7 key.","name":"F7","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F7","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":701,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F8 key.","name":"F8","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F8","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":710,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F9 key.","name":"F9","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F9","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":719,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F10 key.","name":"F10","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F10","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":728,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F11 key.","name":"F11","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F11","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":737,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The F12 key.","name":"F12","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.F12","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":746,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The SEMICOLON key.","name":"SEMICOLON","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.SEMICOLON","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":755,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The PLUS key.","name":"PLUS","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.PLUS","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":764,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The COMMA key.","name":"COMMA","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.COMMA","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":773,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The MINUS key.","name":"MINUS","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.MINUS","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":782,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The PERIOD key.","name":"PERIOD","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.PERIOD","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":791,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The FORWARD_SLASH key.","name":"FORWARD_SLASH","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.FORWARD_SLASH","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":800,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The BACK_SLASH key.","name":"BACK_SLASH","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.BACK_SLASH","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":809,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The QUOTES key.","name":"QUOTES","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.QUOTES","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":818,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The BACKTICK key.","name":"BACKTICK","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.BACKTICK","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":827,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The OPEN_BRACKET key.","name":"OPEN_BRACKET","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.OPEN_BRACKET","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":836,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The CLOSED_BRACKET key.","name":"CLOSED_BRACKET","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.CLOSED_BRACKET","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":845,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The SEMICOLON_FIREFOX key.","name":"SEMICOLON_FIREFOX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.SEMICOLON_FIREFOX","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":854,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The COLON key.","name":"COLON","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.COLON","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":863,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The COMMA_FIREFOX_WINDOWS key.","name":"COMMA_FIREFOX_WINDOWS","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.COMMA_FIREFOX_WINDOWS","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":872,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The COMMA_FIREFOX key.","name":"COMMA_FIREFOX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.COMMA_FIREFOX","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":881,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The BRACKET_RIGHT_FIREFOX key.","name":"BRACKET_RIGHT_FIREFOX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.BRACKET_RIGHT_FIREFOX","scope":"static","kind":"member","___s":true},{"meta":{"filename":"KeyCodes.js","lineno":890,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"The BRACKET_LEFT_FIREFOX key.","name":"BRACKET_LEFT_FIREFOX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Input.Keyboard.KeyCodes","longname":"Phaser.Input.Keyboard.KeyCodes.BRACKET_LEFT_FIREFOX","scope":"static","kind":"member","___s":true},{"meta":{"range":[180,212],"filename":"KeyMap.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"name":"KeyCodes","longname":"KeyCodes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"UpDuration.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys"},"description":"Returns `true` if the Key was released within the `duration` value given, based on the current\ngame clock time. Or returns `false` if it either isn't up, or was released longer ago than the given duration.","kind":"function","name":"UpDuration","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"The Key object to test.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":50,"description":"The duration, in ms, within which the key must have been released.","name":"duration"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Key was released within `duration` ms ago, otherwise `false`."}],"memberof":"Phaser.Input.Keyboard","longname":"Phaser.Input.Keyboard.UpDuration","scope":"static","___s":true},{"meta":{"filename":"CursorKeys.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs"},"kind":"typedef","name":"CursorKeys","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"A Key object mapping to the UP arrow key.","name":"up"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"A Key object mapping to the DOWN arrow key.","name":"down"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"A Key object mapping to the LEFT arrow key.","name":"left"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"A Key object mapping to the RIGHT arrow key.","name":"right"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"A Key object mapping to the SPACE BAR key.","name":"space"},{"type":{"names":["Phaser.Input.Keyboard.Key"]},"optional":true,"description":"A Key object mapping to the SHIFT key.","name":"shift"}],"memberof":"Phaser.Types.Input.Keyboard","longname":"Phaser.Types.Input.Keyboard.CursorKeys","scope":"static","___s":true},{"meta":{"filename":"KeyComboConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs"},"kind":"typedef","name":"KeyComboConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If they press the wrong key do we reset the combo?","name":"resetOnWrongKey"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The max delay in ms between each key press. Above this the combo is reset. 0 means disabled.","name":"maxKeyDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If previously matched and they press the first key of the combo again, will it reset?","name":"resetOnMatch"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If the combo matches, will it delete itself?","name":"deleteOnMatch"}],"memberof":"Phaser.Types.Input.Keyboard","longname":"Phaser.Types.Input.Keyboard.KeyComboConfig","scope":"static","___s":true},{"meta":{"filename":"KeyboardKeydownCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs"},"kind":"typedef","name":"KeyboardKeydownCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["KeyboardEvent"]},"description":"The Keyboard Event.","name":"event"}],"memberof":"Phaser.Types.Input.Keyboard","longname":"Phaser.Types.Input.Keyboard.KeyboardKeydownCallback","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs"},"kind":"namespace","name":"Keyboard","memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.Keyboard","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"MouseManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MouseManager.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"classdesc":"The Mouse Manager is a helper class that belongs to the Input Manager.\n\nIts role is to listen for native DOM Mouse Events and then pass them onto the Input Manager for further processing.\n\nYou do not need to create this class directly, the Input Manager will create an instance of it automatically.","kind":"class","name":"MouseManager","memberof":"Phaser.Input.Mouse","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.InputManager"]},"description":"A reference to the Input Manager.","name":"inputManager"}],"scope":"static","longname":"Phaser.Input.Mouse.MouseManager","___s":true},{"meta":{"filename":"MouseManager.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"A reference to the Input Manager.","name":"manager","type":{"names":["Phaser.Input.InputManager"]},"since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"If true the DOM mouse events will have event.preventDefault applied to them, if false they will propagate fully.","name":"capture","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#capture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"A boolean that controls if the Mouse Manager is enabled or not.\nCan be toggled on the fly.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse target, as defined in the Game Config.\nTypically the canvas to which the game is rendering, but can be any interactive DOM element.","name":"target","type":{"names":["any"]},"since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#target","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"If the mouse has been pointer locked successfully this will be set to true.","name":"locked","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#locked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Move Event handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseMove","type":{"names":["function"]},"since":"3.10.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseMove","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Down Event handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseDown","type":{"names":["function"]},"since":"3.10.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Up Event handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseUp","type":{"names":["function"]},"since":"3.10.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseUp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Down Event handler specifically for events on the Window.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseDownWindow","type":{"names":["function"]},"since":"3.17.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseDownWindow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Up Event handler specifically for events on the Window.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseUpWindow","type":{"names":["function"]},"since":"3.17.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseUpWindow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Over Event handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseOver","type":{"names":["function"]},"since":"3.16.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseOver","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Out Event handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseOut","type":{"names":["function"]},"since":"3.16.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseOut","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":163,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"The Mouse Wheel Event handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"onMouseWheel","type":{"names":["function"]},"since":"3.18.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#onMouseWheel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"Internal pointerLockChange handler.\nThis function is sent the native DOM MouseEvent.\nInitially empty and bound in the `startListeners` method.","name":"pointerLockChange","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#pointerLockChange","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MouseManager.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"Attempts to disable the context menu from appearing if you right-click on the browser.\n\nWorks by listening for the `contextmenu` event and prevent defaulting it.\n\nUse this if you need to enable right-button mouse support in your game, and the browser\nmenu keeps getting in the way.","kind":"function","name":"disableContextMenu","since":"3.0.0","returns":[{"type":{"names":["Phaser.Input.Mouse.MouseManager"]},"description":"This Mouse Manager instance."}],"memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#disableContextMenu","scope":"instance","___s":true},{"meta":{"filename":"MouseManager.js","lineno":247,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"If the browser supports it, you can request that the pointer be locked to the browser window.\n\nThis is classically known as 'FPS controls', where the pointer can't leave the browser until\nthe user presses an exit key.\n\nIf the browser successfully enters a locked state, a `POINTER_LOCK_CHANGE_EVENT` will be dispatched,\nfrom the games Input Manager, with an `isPointerLocked` property.\n\nIt is important to note that pointer lock can only be enabled after an 'engagement gesture',\nsee: https://w3c.github.io/pointerlock/#dfn-engagement-gesture.","kind":"function","name":"requestPointerLock","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#requestPointerLock","scope":"instance","___s":true},{"meta":{"filename":"MouseManager.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"If the browser supports pointer lock, this will request that the pointer lock is released. If\nthe browser successfully enters a locked state, a 'POINTER_LOCK_CHANGE_EVENT' will be\ndispatched - from the game's input manager - with an `isPointerLocked` property.","kind":"function","name":"releasePointerLock","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#releasePointerLock","scope":"instance","___s":true},{"meta":{"filename":"MouseManager.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"Starts the Mouse Event listeners running.\nThis is called automatically and does not need to be manually invoked.","kind":"function","name":"startListeners","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#startListeners","scope":"instance","___s":true},{"meta":{"filename":"MouseManager.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"Stops the Mouse Event listeners.\nThis is called automatically and does not need to be manually invoked.","kind":"function","name":"stopListeners","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#stopListeners","scope":"instance","___s":true},{"meta":{"filename":"MouseManager.js","lineno":463,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"description":"Destroys this Mouse Manager instance.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Input.Mouse.MouseManager","longname":"Phaser.Input.Mouse.MouseManager#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/mouse"},"kind":"namespace","name":"Mouse","memberof":"Phaser.Input","longname":"Phaser.Input.Mouse","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"TouchManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TouchManager.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"classdesc":"The Touch Manager is a helper class that belongs to the Input Manager.\n\nIts role is to listen for native DOM Touch Events and then pass them onto the Input Manager for further processing.\n\nYou do not need to create this class directly, the Input Manager will create an instance of it automatically.","kind":"class","name":"TouchManager","memberof":"Phaser.Input.Touch","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.InputManager"]},"description":"A reference to the Input Manager.","name":"inputManager"}],"scope":"static","longname":"Phaser.Input.Touch.TouchManager","___s":true},{"meta":{"filename":"TouchManager.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"A reference to the Input Manager.","name":"manager","type":{"names":["Phaser.Input.InputManager"]},"since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"If true the DOM events will have event.preventDefault applied to them, if false they will propagate fully.","name":"capture","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#capture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"A boolean that controls if the Touch Manager is enabled or not.\nCan be toggled on the fly.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Event target, as defined in the Game Config.\nTypically the canvas to which the game is rendering, but can be any interactive DOM element.","name":"target","type":{"names":["any"]},"since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#target","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Start event handler function.\nInitially empty and bound in the `startListeners` method.","name":"onTouchStart","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchStart","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Start event handler function specifically for events on the Window.\nInitially empty and bound in the `startListeners` method.","name":"onTouchStartWindow","type":{"names":["function"]},"since":"3.17.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchStartWindow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Move event handler function.\nInitially empty and bound in the `startListeners` method.","name":"onTouchMove","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchMove","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch End event handler function.\nInitially empty and bound in the `startListeners` method.","name":"onTouchEnd","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchEnd","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch End event handler function specifically for events on the Window.\nInitially empty and bound in the `startListeners` method.","name":"onTouchEndWindow","type":{"names":["function"]},"since":"3.17.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchEndWindow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Cancel event handler function.\nInitially empty and bound in the `startListeners` method.","name":"onTouchCancel","type":{"names":["function"]},"since":"3.15.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchCancel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Cancel event handler function specifically for events on the Window.\nInitially empty and bound in the `startListeners` method.","name":"onTouchCancelWindow","type":{"names":["function"]},"since":"3.18.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchCancelWindow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":146,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Over event handler function.\nInitially empty and bound in the `startListeners` method.","name":"onTouchOver","type":{"names":["function"]},"since":"3.16.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchOver","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"The Touch Out event handler function.\nInitially empty and bound in the `startListeners` method.","name":"onTouchOut","type":{"names":["function"]},"since":"3.16.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#onTouchOut","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TouchManager.js","lineno":200,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"Attempts to disable the context menu from appearing if you touch-hold on the browser.\n\nWorks by listening for the `contextmenu` event and prevent defaulting it.\n\nUse this if you need to disable the OS context menu on mobile.","kind":"function","name":"disableContextMenu","since":"3.20.0","returns":[{"type":{"names":["Phaser.Input.Touch.TouchManager"]},"description":"This Touch Manager instance."}],"memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#disableContextMenu","scope":"instance","___s":true},{"meta":{"filename":"TouchManager.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"Starts the Touch Event listeners running as long as an input target is set.\n\nThis method is called automatically if Touch Input is enabled in the game config,\nwhich it is by default. However, you can call it manually should you need to\ndelay input capturing until later in the game.","kind":"function","name":"startListeners","since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#startListeners","scope":"instance","___s":true},{"meta":{"filename":"TouchManager.js","lineno":365,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"Stops the Touch Event listeners.\nThis is called automatically and does not need to be manually invoked.","kind":"function","name":"stopListeners","since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#stopListeners","scope":"instance","___s":true},{"meta":{"filename":"TouchManager.js","lineno":390,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"description":"Destroys this Touch Manager instance.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Input.Touch.TouchManager","longname":"Phaser.Input.Touch.TouchManager#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/touch"},"kind":"namespace","name":"Touch","memberof":"Phaser.Input","longname":"Phaser.Input.Touch","scope":"static","___s":true},{"meta":{"filename":"EventData.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/typedefs"},"description":"A Phaser Input Event Data object.\n\nThis object is passed to the registered event listeners and allows you to stop any further propagation.","kind":"typedef","name":"EventData","type":{"names":["object"]},"since":"3.15.1","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The cancelled state of this Event.","name":"cancelled"},{"type":{"names":["function"]},"description":"Call this method to stop this event from passing any further down the event chain.","name":"stopPropagation"}],"memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.EventData","scope":"static","___s":true},{"meta":{"filename":"HitAreaCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/typedefs"},"kind":"typedef","name":"HitAreaCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["any"]},"description":"The hit area object.","name":"hitArea"},{"type":{"names":["number"]},"description":"The translated x coordinate of the hit test event.","name":"x"},{"type":{"names":["number"]},"description":"The translated y coordinate of the hit test event.","name":"y"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that invoked the hit test.","name":"gameObject"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the coordinates fall within the space of the hitArea, otherwise `false`."}],"memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.HitAreaCallback","scope":"static","___s":true},{"meta":{"filename":"InputConfiguration.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/typedefs"},"kind":"typedef","name":"InputConfiguration","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["any"]},"optional":true,"description":"The object / shape to use as the Hit Area. If not given it will try to create a Rectangle based on the texture frame.","name":"hitArea"},{"type":{"names":["function"]},"optional":true,"description":"The callback that determines if the pointer is within the Hit Area shape or not.","name":"hitAreaCallback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the Interactive Object will be set to be draggable and emit drag events.","name":"draggable"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the Interactive Object will be set to be a drop zone for draggable objects.","name":"dropZone"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the Interactive Object will set the `pointer` hand cursor when a pointer is over it. This is a short-cut for setting `cursor: 'pointer'`.","name":"useHandCursor"},{"type":{"names":["string"]},"optional":true,"description":"The CSS string to be used when the cursor is over this Interactive Object.","name":"cursor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the a pixel perfect function will be set for the hit area callback. Only works with texture based Game Objects.","name":"pixelPerfect"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"If `pixelPerfect` is set, this is the alpha tolerance threshold value used in the callback.","name":"alphaTolerance"}],"memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.InputConfiguration","scope":"static","___s":true},{"meta":{"filename":"InputPluginContainer.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/typedefs"},"kind":"typedef","name":"InputPluginContainer","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The unique name of this plugin in the input plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"The plugin to be stored. Should be the source object, not instantiated.","name":"plugin"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Input Plugin, this is the property key map used.","name":"mapping"}],"memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.InputPluginContainer","scope":"static","___s":true},{"meta":{"filename":"InteractiveObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/typedefs"},"kind":"typedef","name":"InteractiveObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to which this Interactive Object is bound.","name":"gameObject"},{"type":{"names":["boolean"]},"description":"Is this Interactive Object currently enabled for input events?","name":"enabled"},{"type":{"names":["boolean"]},"description":"An Interactive Object that is 'always enabled' will receive input even if the parent object is invisible or won't render.","name":"alwaysEnabled"},{"type":{"names":["boolean"]},"description":"Is this Interactive Object draggable? Enable with `InputPlugin.setDraggable`.","name":"draggable"},{"type":{"names":["boolean"]},"description":"Is this Interactive Object a drag-targets drop zone? Set when the object is created.","name":"dropZone"},{"type":{"names":["boolean","string"]},"description":"Should this Interactive Object change the cursor (via css) when over? (desktop only)","name":"cursor"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"description":"An optional drop target for a draggable Interactive Object.","name":"target"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The most recent Camera to be tested against this Interactive Object.","name":"camera"},{"type":{"names":["any"]},"description":"The hit area for this Interactive Object. Typically a geometry shape, like a Rectangle or Circle.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"The 'contains' check callback that the hit area shape will use for all hit tests.","name":"hitAreaCallback"},{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"If this Interactive Object has been enabled for debug, via `InputPlugin.enableDebug` then this property holds its debug shape.","name":"hitAreaDebug"},{"type":{"names":["boolean"]},"description":"Was the hitArea for this Interactive Object created based on texture size (false), or a custom shape? (true)","name":"customHitArea"},{"type":{"names":["number"]},"description":"The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localX"},{"type":{"names":["number"]},"description":"The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.","name":"localY"},{"type":{"names":["0","1","2"]},"description":"The current drag state of this Interactive Object. 0 = Not being dragged, 1 = being checked for drag, or 2 = being actively dragged.","name":"dragState"},{"type":{"names":["number"]},"description":"The x coordinate of the Game Object that owns this Interactive Object when the drag started.","name":"dragStartX"},{"type":{"names":["number"]},"description":"The y coordinate of the Game Object that owns this Interactive Object when the drag started.","name":"dragStartY"},{"type":{"names":["number"]},"description":"The x coordinate that the Pointer started dragging this Interactive Object from.","name":"dragStartXGlobal"},{"type":{"names":["number"]},"description":"The y coordinate that the Pointer started dragging this Interactive Object from.","name":"dragStartYGlobal"},{"type":{"names":["number"]},"description":"The x coordinate that this Interactive Object is currently being dragged to.","name":"dragX"},{"type":{"names":["number"]},"description":"The y coordinate that this Interactive Object is currently being dragged to.","name":"dragY"}],"memberof":"Phaser.Types.Input","longname":"Phaser.Types.Input.InteractiveObject","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/input/typedefs"},"kind":"namespace","name":"Input","memberof":"Phaser.Types","longname":"Phaser.Types.Input","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"File.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"File.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"classdesc":"The base File class used by all File Types that the Loader can support.\nYou shouldn't create an instance of a File directly, but should extend it with your own class, setting a custom type and processing methods.","kind":"class","name":"File","memberof":"Phaser.Loader","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader that is going to load this File.","name":"loader"},{"type":{"names":["Phaser.Types.Loader.FileConfig"]},"description":"The file configuration object, as created by the file type.","name":"fileConfig"}],"scope":"static","longname":"Phaser.Loader.File","___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#loader","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#cache","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#url","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#src","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#xhrSettings","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#xhrLoader","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#state","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#bytesTotal","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#bytesLoaded","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#percentComplete","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#crossOrigin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#multiFile","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#linkFile","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#setLink","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#resetXHR","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#load","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#onLoad","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#onError","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#onProgress","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Usually overridden by the FileTypes and is called by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data, for example a JSON file will parse itself during this stage.","kind":"function","name":"onProcess","since":"3.0.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#onProcess","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#onProcessComplete","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#onProcessError","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#hasCacheConflict","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#addToCache","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#pendingDestroy","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File#destroy","scope":"instance","___s":true},{"meta":{"filename":"File.js","lineno":483,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Static method for creating object URL using URL API and setting it as image 'src' attribute.\nIf URL API is not supported (usually on old browsers) it falls back to creating Base64 encoded url using FileReader.","kind":"function","name":"createObjectURL","scope":"static","since":"3.7.0","params":[{"type":{"names":["HTMLImageElement"]},"description":"Image object which 'src' attribute should be set to object URL.","name":"image"},{"type":{"names":["Blob"]},"description":"A Blob object to create an object URL for.","name":"blob"},{"type":{"names":["string"]},"description":"Default mime type used if blob type is not available.","name":"defaultType"}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File.createObjectURL","___s":true},{"meta":{"filename":"File.js","lineno":517,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Static method for releasing an existing object URL which was previously created\nby calling {@link File#createObjectURL} method.","kind":"function","name":"revokeObjectURL","scope":"static","since":"3.7.0","params":[{"type":{"names":["HTMLImageElement"]},"description":"Image object which 'src' attribute should be revoked.","name":"image"}],"memberof":"Phaser.Loader.File","longname":"Phaser.Loader.File.revokeObjectURL","___s":true},{"meta":{"range":[180,190],"filename":"FileTypesManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"types","longname":"types","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FileTypesManager.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"kind":"namespace","name":"FileTypesManager","memberof":"Phaser.Loader","longname":"Phaser.Loader.FileTypesManager","scope":"static","___s":true},{"meta":{"filename":"FileTypesManager.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Static method called when a LoaderPlugin is created.\n\nLoops through the local types object and injects all of them as\nproperties into the LoaderPlugin instance.","kind":"function","name":"install","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The LoaderPlugin to install the types into.","name":"loader"}],"memberof":"Phaser.Loader.FileTypesManager","longname":"Phaser.Loader.FileTypesManager.install","scope":"static","___s":true},{"meta":{"filename":"FileTypesManager.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Static method called directly by the File Types.\n\nThe key is a reference to the function used to load the files via the Loader, i.e. `image`.","kind":"function","name":"register","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key that will be used as the method name in the LoaderPlugin.","name":"key"},{"type":{"names":["function"]},"description":"The function that will be called when LoaderPlugin.key is invoked.","name":"factoryFunction"}],"memberof":"Phaser.Loader.FileTypesManager","longname":"Phaser.Loader.FileTypesManager.register","scope":"static","___s":true},{"meta":{"filename":"FileTypesManager.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Removed all associated file types.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Loader.FileTypesManager","longname":"Phaser.Loader.FileTypesManager.destroy","scope":"static","___s":true},{"meta":{"filename":"GetURL.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Given a File and a baseURL value this returns the URL the File will use to download from.","kind":"function","name":"GetURL","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File object.","name":"file"},{"type":{"names":["string"]},"description":"A default base URL.","name":"baseURL"}],"returns":[{"type":{"names":["string"]},"description":"The URL the File will use."}],"memberof":"Phaser.Loader","longname":"Phaser.Loader.GetURL","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"LoaderPlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"classdesc":"The Loader handles loading all external content such as Images, Sounds, Texture Atlases and data files.\nYou typically interact with it via `this.load` in your Scene. Scenes can have a `preload` method, which is always\ncalled before the Scenes `create` method, allowing you to preload assets that the Scene may need.\n\nIf you call any `this.load` methods from outside of `Scene.preload` then you need to start the Loader going\nyourself by calling `Loader.start()`. It's only automatically started during the Scene preload.\n\nThe Loader uses a combination of tag loading (eg. Audio elements) and XHR and provides progress and completion events.\nFiles are loaded in parallel by default. The amount of concurrent connections can be controlled in your Game Configuration.\n\nOnce the Loader has started loading you are still able to add files to it. These can be injected as a result of a loader\nevent, the type of file being loaded (such as a pack file) or other external events. As long as the Loader hasn't finished\nsimply adding a new file to it, while running, will ensure it's added into the current queue.\n\nEvery Scene has its own instance of the Loader and they are bound to the Scene in which they are created. However,\nassets loaded by the Loader are placed into global game-level caches. For example, loading an XML file will place that\nfile inside `Game.cache.xml`, which is accessible from every Scene in your game, no matter who was responsible\nfor loading it. The same is true of Textures. A texture loaded in one Scene is instantly available to all other Scenes\nin your game.\n\nThe Loader works by using custom File Types. These are stored in the FileTypesManager, which injects them into the Loader\nwhen it's instantiated. You can create your own custom file types by extending either the File or MultiFile classes.\nSee those files for more details.","kind":"class","name":"LoaderPlugin","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Loader","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene which owns this Loader instance.","name":"scene"}],"scope":"static","longname":"Phaser.Loader.LoaderPlugin","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Scene which owns this Loader instance.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Scene Systems.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the global Cache Manager.","name":"cacheManager","type":{"names":["Phaser.Cache.CacheManager"]},"since":"3.7.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#cacheManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the global Texture Manager.","name":"textureManager","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#textureManager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"An optional prefix that is automatically prepended to the start of every file key.\nIf prefix was `MENU.` and you load an image with the key 'Background' the resulting key would be `MENU.Background`.\nYou can set this directly, or call `Loader.setPrefix()`. It will then affect every file added to the Loader\nfrom that point on. It does _not_ change any file already in the load queue.","name":"prefix","type":{"names":["string"]},"defaultvalue":"''","since":"3.7.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#prefix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The value of `path`, if set, is placed before any _relative_ file path given. For example:\n\n```javascript\nthis.load.path = \"images/sprites/\";\nthis.load.image(\"ball\", \"ball.png\");\nthis.load.image(\"tree\", \"level1/oaktree.png\");\nthis.load.image(\"boom\", \"http://server.com/explode.png\");\n```\n\nWould load the `ball` file from `images/sprites/ball.png` and the tree from\n`images/sprites/level1/oaktree.png` but the file `boom` would load from the URL\ngiven as it's an absolute URL.\n\nPlease note that the path is added before the filename but *after* the baseURL (if set.)\n\nIf you set this property directly then it _must_ end with a \"/\". Alternatively, call `setPath()` and it'll do it for you.","name":"path","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#path","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":152,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If you want to append a URL before the path of any asset you can set this here.\n\nUseful if allowing the asset base url to be configured outside of the game code.\n\nIf you set this property directly then it _must_ end with a \"/\". Alternatively, call `setBaseURL()` and it'll do it for you.","name":"baseURL","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#baseURL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":172,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of concurrent / parallel resources to try and fetch at once.\n\nOld browsers limit 6 requests per domain; modern ones, especially those with HTTP/2 don't limit it at all.\n\nThe default is 32 but you can change this in your Game Config, or by changing this property before the Loader starts.","name":"maxParallelDownloads","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#maxParallelDownloads","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":185,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"xhr specific global settings (can be overridden on a per-file basis)","name":"xhr","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#xhr","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":200,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The crossOrigin value applied to loaded images. Very often this needs to be set to 'anonymous'.","name":"crossOrigin","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#crossOrigin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":209,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total number of files to load. It may not always be accurate because you may add to the Loader during the process\nof loading, especially if you load a Pack File. Therefore this value can change, but in most cases remains static.","name":"totalToLoad","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#totalToLoad","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The progress of the current load queue, as a float value between 0 and 1.\nThis is updated automatically as files complete loading.\nNote that it is possible for this value to go down again if you add content to the current load queue during a load.","name":"progress","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":232,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Files are placed in this Set when they're added to the Loader via `addFile`.\n\nThey are moved to the `inflight` Set when they start loading, and assuming a successful\nload, to the `queue` Set for further processing.\n\nBy the end of the load process this Set will be empty.","name":"list","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#list","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":246,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Files are stored in this Set while they're in the process of being loaded.\n\nUpon a successful load they are moved to the `queue` Set.\n\nBy the end of the load process this Set will be empty.","name":"inflight","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#inflight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":259,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Files are stored in this Set while they're being processed.\n\nIf the process is successful they are moved to their final destination, which could be\na Cache or the Texture Manager.\n\nAt the end of the load process this Set will be empty.","name":"queue","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#queue","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":284,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total number of files that failed to load during the most recent load.\nThis value is reset when you call `Loader.start`.","name":"totalFailed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#totalFailed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":295,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total number of files that successfully loaded during the most recent load.\nThis value is reset when you call `Loader.start`.","name":"totalComplete","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#totalComplete","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":306,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the Loader.","name":"state","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#state","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":357,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If you want to append a URL before the path of any asset you can set this here.\n\nUseful if allowing the asset base url to be configured outside of the game code.\n\nOnce a base URL is set it will affect every file loaded by the Loader from that point on. It does _not_ change any\nfile _already_ being loaded. To reset it, call this method with no arguments.","kind":"function","name":"setBaseURL","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The URL to use. Leave empty to reset.","name":"url"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"This Loader object."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#setBaseURL","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":386,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The value of `path`, if set, is placed before any _relative_ file path given. For example:\n\n```javascript\nthis.load.setPath(\"images/sprites/\");\nthis.load.image(\"ball\", \"ball.png\");\nthis.load.image(\"tree\", \"level1/oaktree.png\");\nthis.load.image(\"boom\", \"http://server.com/explode.png\");\n```\n\nWould load the `ball` file from `images/sprites/ball.png` and the tree from\n`images/sprites/level1/oaktree.png` but the file `boom` would load from the URL\ngiven as it's an absolute URL.\n\nPlease note that the path is added before the filename but *after* the baseURL (if set.)\n\nOnce a path is set it will then affect every file added to the Loader from that point on. It does _not_ change any\nfile _already_ in the load queue. To reset it, call this method with no arguments.","kind":"function","name":"setPath","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The path to use. Leave empty to reset.","name":"path"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"This Loader object."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#setPath","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"An optional prefix that is automatically prepended to the start of every file key.\n\nIf prefix was `MENU.` and you load an image with the key 'Background' the resulting key would be `MENU.Background`.\n\nOnce a prefix is set it will then affect every file added to the Loader from that point on. It does _not_ change any\nfile _already_ in the load queue. To reset it, call this method with no arguments.","kind":"function","name":"setPrefix","since":"3.7.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The prefix to use. Leave empty to reset.","name":"prefix"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"This Loader object."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#setPrefix","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":450,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Sets the Cross Origin Resource Sharing value used when loading files.\n\nFiles can override this value on a per-file basis by specifying an alternative `crossOrigin` value in their file config.\n\nOnce CORs is set it will then affect every file loaded by the Loader from that point on, as long as they don't have\ntheir own CORs setting. To reset it, call this method with no arguments.\n\nFor more details about CORs see https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS","kind":"function","name":"setCORS","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The value to use for the `crossOrigin` property in the load request.","name":"crossOrigin"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"This Loader object."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#setCORS","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":474,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds a file, or array of files, into the load queue.\n\nThe file must be an instance of `Phaser.Loader.File`, or a class that extends it. The Loader will check that the key\nused by the file won't conflict with any other key either in the loader, the inflight queue or the target cache.\nIf allowed it will then add the file into the pending list, read for the load to start. Or, if the load has already\nstarted, ready for the next batch of files to be pulled from the list to the inflight queue.\n\nYou should not normally call this method directly, but rather use one of the Loader methods like `image` or `atlas`,\nhowever you can call this as long as the file given to it is well formed.","kind":"function","name":"addFile","fires":["Phaser.Loader.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File","Array."]},"description":"The file, or array of files, to be added to the load queue.","name":"file"}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#addFile","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":519,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks the key and type of the given file to see if it will conflict with anything already\nin a Cache, the Texture Manager, or the list or inflight queues.","kind":"function","name":"keyExists","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to check the key of.","name":"file"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a cache or queue conflict, otherwise `false`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#keyExists","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":576,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Takes a well formed, fully parsed pack file object and adds its entries into the load queue. Usually you do not call\nthis method directly, but instead use `Loader.pack` and supply a path to a JSON file that holds the\npack data. However, if you've got the data prepared you can pass it to this method.\n\nYou can also provide an optional key. If you do then it will only add the entries from that part of the pack into\nto the load queue. If not specified it will add all entries it finds. For more details about the pack file format\nsee the `LoaderPlugin.pack` method.","kind":"function","name":"addPack","since":"3.7.0","params":[{"type":{"names":["any"]},"description":"The Pack File data to be parsed and each entry of it to added to the load queue.","name":"data"},{"type":{"names":["string"]},"optional":true,"description":"An optional key to use from the pack file data.","name":"packKey"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if any files were added to the queue, otherwise `false`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#addPack","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":648,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Is the Loader actively loading, or processing loaded files?","kind":"function","name":"isLoading","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Loader is busy loading or processing, otherwise `false`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#isLoading","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":661,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Is the Loader ready to start a new load?","kind":"function","name":"isReady","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Loader is ready to start a new load, otherwise `false`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#isReady","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":674,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Starts the Loader running. This will reset the progress and totals and then emit a `start` event.\nIf there is nothing in the queue the Loader will immediately complete, otherwise it will start\nloading the first batch of files.\n\nThe Loader is started automatically if the queue is populated within your Scenes `preload` method.\n\nHowever, outside of this, you need to call this method to start it.\n\nIf the Loader is already running this method will simply return.","kind":"function","name":"start","fires":["Phaser.Loader.Events#event:START"],"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#start","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called automatically during the load process.\nIt updates the `progress` value and then emits a progress event, which you can use to\ndisplay a loading bar in your game.","kind":"function","name":"updateProgress","fires":["Phaser.Loader.Events#event:PROGRESS"],"since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#updateProgress","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":739,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called automatically during the load process.","kind":"function","name":"update","since":"3.10.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#update","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":793,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"An internal method called automatically by the XHRLoader belong to a File.\n\nThis method will remove the given file from the inflight Set and update the load progress.\nIf the file was successful its `onProcess` method is called, otherwise it is added to the delete queue.","kind":"function","name":"nextFile","fires":["Phaser.Loader.Events#event:FILE_LOAD","Phaser.Loader.Events#event:FILE_LOAD_ERROR"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that just finished loading, or errored during load.","name":"file"},{"type":{"names":["boolean"]},"description":"`true` if the file loaded successfully, otherwise `false`.","name":"success"}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#nextFile","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":841,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"An internal method that is called automatically by the File when it has finished processing.\n\nIf the process was successful, and the File isn't part of a MultiFile, its `addToCache` method is called.\n\nIt this then removed from the queue. If there are no more files to load `loadComplete` is called.","kind":"function","name":"fileProcessComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file that has finished processing.","name":"file"}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#fileProcessComplete","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":897,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called at the end when the load queue is exhausted and all files have either loaded or errored.\nBy this point every loaded file will now be in its associated cache and ready for use.\n\nAlso clears down the Sets, puts progress to 1 and clears the deletion queue.","kind":"function","name":"loadComplete","fires":["Phaser.Loader.Events#event:COMPLETE","Phaser.Loader.Events#event:POST_PROCESS"],"since":"3.7.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#loadComplete","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":930,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds a File into the pending-deletion queue.","kind":"function","name":"flagForRemoval","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to be queued for deletion when the Loader completes.","name":"file"}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#flagForRemoval","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":943,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Converts the given JSON data into a file that the browser then prompts you to download so you can save it locally.\n\nThe data must be well formed JSON and ready-parsed, not a JavaScript object.","kind":"function","name":"saveJSON","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The JSON data, ready parsed.","name":"data"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"file.json","description":"The name to save the JSON file as.","name":"filename"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"This Loader plugin."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#saveJSON","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":961,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Causes the browser to save the given data as a file to its default Downloads folder.\n\nCreates a DOM level anchor link, assigns it as being a `download` anchor, sets the href\nto be an ObjectURL based on the given data, and then invokes a click event.","kind":"function","name":"save","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The data to be saved. Will be passed through URL.createObjectURL.","name":"data"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"file.json","description":"The filename to save the file as.","name":"filename"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"application/json","description":"The file type to use when saving the file. Defaults to JSON.","name":"filetype"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"This Loader plugin."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#save","scope":"instance","___s":true},{"meta":{"filename":"LoaderPlugin.js","lineno":995,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the Loader.\n\nThis will clear all lists and reset the base URL, path and prefix.\n\nWarning: If the Loader is currently downloading files, or has files in its queue, they will be aborted.","kind":"function","name":"reset","since":"3.0.0","memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#reset","scope":"instance","___s":true},{"meta":{"range":[180,222],"filename":"MergeXHRSettings.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"Extend","longname":"Extend","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MergeXHRSettings.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Takes two XHRSettings Objects and creates a new XHRSettings object from them.\n\nThe new object is seeded by the values given in the global settings, but any setting in\nthe local object overrides the global ones.","kind":"function","name":"MergeXHRSettings","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"description":"The global XHRSettings object.","name":"global"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"description":"The local XHRSettings object.","name":"local"}],"returns":[{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"description":"A newly formed XHRSettings object."}],"memberof":"Phaser.Loader","longname":"Phaser.Loader.MergeXHRSettings","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"MultiFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MultiFile.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"classdesc":"A MultiFile is a special kind of parent that contains two, or more, Files as children and looks after\nthe loading and processing of them all. It is commonly extended and used as a base class for file types such as AtlasJSON or BitmapFont.\n\nYou shouldn't create an instance of a MultiFile directly, but should extend it with your own class, setting a custom type and processing methods.","kind":"class","name":"MultiFile","memberof":"Phaser.Loader","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader that is going to load this File.","name":"loader"},{"type":{"names":["string"]},"description":"The file type string for sorting within the Loader.","name":"type"},{"type":{"names":["string"]},"description":"The key of the file within the loader.","name":"key"},{"type":{"names":["Array."]},"description":"An array of Files that make-up this MultiFile.","name":"files"}],"scope":"static","longname":"Phaser.Loader.MultiFile","___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#loader","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#files","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#complete","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#pending","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#failed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#baseURL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#path","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#prefix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#isReadyToProcess","scope":"instance","___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#addToMultiFile","scope":"instance","___s":true},{"meta":{"filename":"MultiFile.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#onFileComplete","scope":"instance","___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.MultiFile","longname":"Phaser.Loader.MultiFile#onFileFailed","scope":"instance","___s":true},{"meta":{"range":[180,228],"filename":"XHRLoader.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"MergeXHRSettings","longname":"MergeXHRSettings","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"XHRLoader.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Creates a new XMLHttpRequest (xhr) object based on the given File and XHRSettings\nand starts the download of it. It uses the Files own XHRSettings and merges them\nwith the global XHRSettings object to set the xhr values before download.","kind":"function","name":"XHRLoader","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to download.","name":"file"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"description":"The global XHRSettings object.","name":"globalXHRSettings"}],"returns":[{"type":{"names":["XMLHttpRequest"]},"description":"The XHR object."}],"memberof":"Phaser.Loader","longname":"Phaser.Loader.XHRLoader","scope":"static","___s":true},{"meta":{"filename":"XHRSettings.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Creates an XHRSettings Object with default values.","kind":"function","name":"XHRSettings","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequestResponseType"]},"optional":true,"defaultvalue":"''","description":"The responseType, such as 'text'.","name":"responseType"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the XHR request use async or not?","name":"async"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"Optional username for the XHR request.","name":"user"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"Optional password for the XHR request.","name":"password"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optional XHR timeout value.","name":"timeout"}],"returns":[{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"description":"The XHRSettings object as used by the Loader."}],"memberof":"Phaser.Loader","longname":"Phaser.Loader.XHRSettings","scope":"static","___s":true},{"meta":{"range":[180,2891],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"FILE_CONST","longname":"FILE_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Loader is idle.","name":"LOADER_IDLE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.LOADER_IDLE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Loader is actively loading.","name":"LOADER_LOADING","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.LOADER_LOADING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Loader is processing files is has loaded.","name":"LOADER_PROCESSING","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.LOADER_PROCESSING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Loader has completed loading and processing.","name":"LOADER_COMPLETE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.LOADER_COMPLETE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Loader is shutting down.","name":"LOADER_SHUTDOWN","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.LOADER_SHUTDOWN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The Loader has been destroyed.","name":"LOADER_DESTROYED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.LOADER_DESTROYED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File is in the load queue but not yet started","name":"FILE_PENDING","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_PENDING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File has been started to load by the loader (onLoad called)","name":"FILE_LOADING","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_LOADING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File has loaded successfully, awaiting processing","name":"FILE_LOADED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_LOADED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File failed to load","name":"FILE_FAILED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_FAILED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":99,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File is being processed (onProcess callback)","name":"FILE_PROCESSING","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_PROCESSING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The File has errored somehow during processing.","name":"FILE_ERRORED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_ERRORED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File has finished processing.","name":"FILE_COMPLETE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_COMPLETE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File has been destroyed","name":"FILE_DESTROYED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_DESTROYED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"File was populated from local data and doesn't need an HTTP request","name":"FILE_POPULATED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader","longname":"Phaser.Loader.FILE_POPULATED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"ADD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The Loader Plugin Add File Event.\n\nThis event is dispatched when a new file is successfully added to the Loader and placed into the load queue.\n\nListen to it from a Scene using: `this.load.on('addfile', listener)`.\n\nIf you add lots of files to a Loader from a `preload` method, it will dispatch this event for each one of them.","kind":"event","name":"ADD","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique key of the file that was added to the Loader.","name":"key"},{"type":{"names":["string"]},"description":"The [file type]{@link Phaser.Loader.File#type} string of the file that was added to the Loader, i.e. `image`.","name":"type"},{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader Plugin that dispatched this event.","name":"loader"},{"type":{"names":["Phaser.Loader.File"]},"description":"A reference to the File which was added to the Loader.","name":"file"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:ADD","scope":"instance","___s":true},{"meta":{"filename":"COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The Loader Plugin Complete Event.\n\nThis event is dispatched when the Loader has fully processed everything in the load queue.\nBy this point every loaded file will now be in its associated cache and ready for use.\n\nListen to it from a Scene using: `this.load.on('complete', listener)`.","kind":"event","name":"COMPLETE","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader Plugin that dispatched this event.","name":"loader"},{"type":{"names":["integer"]},"description":"The total number of files that successfully loaded.","name":"totalComplete"},{"type":{"names":["integer"]},"description":"The total number of files that failed to load.","name":"totalFailed"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"FILE_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The File Load Complete Event.\n\nThis event is dispatched by the Loader Plugin when any file in the queue finishes loading.\n\nListen to it from a Scene using: `this.load.on('filecomplete', listener)`.\n\nYou can also listen for the completion of a specific file. See the [FILE_KEY_COMPLETE]{@linkcode Phaser.Loader.Events#event:FILE_KEY_COMPLETE} event.","kind":"event","name":"FILE_COMPLETE","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the file that just loaded and finished processing.","name":"key"},{"type":{"names":["string"]},"description":"The [file type]{@link Phaser.Loader.File#type} of the file that just loaded, i.e. `image`.","name":"type"},{"type":{"names":["any"]},"description":"The raw data the file contained.","name":"data"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:FILE_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"FILE_KEY_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The File Load Complete Event.\n\nThis event is dispatched by the Loader Plugin when any file in the queue finishes loading.\n\nIt uses a special dynamic event name constructed from the key and type of the file.\n\nFor example, if you have loaded an `image` with a key of `monster`, you can listen for it\nusing the following:\n\n```javascript\nthis.load.on('filecomplete-image-monster', function (key, type, data) {\n // Your handler code\n});\n```\n\nOr, if you have loaded a texture `atlas` with a key of `Level1`:\n\n```javascript\nthis.load.on('filecomplete-atlas-Level1', function (key, type, data) {\n // Your handler code\n});\n```\n\nOr, if you have loaded a sprite sheet with a key of `Explosion` and a prefix of `GAMEOVER`:\n\n```javascript\nthis.load.on('filecomplete-spritesheet-GAMEOVERExplosion', function (key, type, data) {\n // Your handler code\n});\n```\n\nYou can also listen for the generic completion of files. See the [FILE_COMPLETE]{@linkcode Phaser.Loader.Events#event:FILE_COMPLETE} event.","kind":"event","name":"FILE_KEY_COMPLETE","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the file that just loaded and finished processing.","name":"key"},{"type":{"names":["string"]},"description":"The [file type]{@link Phaser.Loader.File#type} of the file that just loaded, i.e. `image`.","name":"type"},{"type":{"names":["any"]},"description":"The raw data the file contained.","name":"data"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:FILE_KEY_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"FILE_LOAD_ERROR_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The File Load Error Event.\n\nThis event is dispatched by the Loader Plugin when a file fails to load.\n\nListen to it from a Scene using: `this.load.on('loaderror', listener)`.","kind":"event","name":"FILE_LOAD_ERROR","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"A reference to the File which errored during load.","name":"file"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:FILE_LOAD_ERROR","scope":"instance","___s":true},{"meta":{"filename":"FILE_LOAD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The File Load Event.\n\nThis event is dispatched by the Loader Plugin when a file finishes loading,\nbut _before_ it is processed and added to the internal Phaser caches.\n\nListen to it from a Scene using: `this.load.on('load', listener)`.","kind":"event","name":"FILE_LOAD","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"A reference to the File which just finished loading.","name":"file"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:FILE_LOAD","scope":"instance","___s":true},{"meta":{"filename":"FILE_PROGRESS_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The File Load Progress Event.\n\nThis event is dispatched by the Loader Plugin during the load of a file, if the browser receives a DOM ProgressEvent and\nthe `lengthComputable` event property is true. Depending on the size of the file and browser in use, this may, or may not happen.\n\nListen to it from a Scene using: `this.load.on('fileprogress', listener)`.","kind":"event","name":"FILE_PROGRESS","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"A reference to the File which errored during load.","name":"file"},{"type":{"names":["number"]},"description":"A value between 0 and 1 indicating how 'complete' this file is.","name":"percentComplete"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:FILE_PROGRESS","scope":"instance","___s":true},{"meta":{"filename":"POST_PROCESS_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The Loader Plugin Post Process Event.\n\nThis event is dispatched by the Loader Plugin when the Loader has finished loading everything in the load queue.\nIt is dispatched before the internal lists are cleared and each File is destroyed.\n\nUse this hook to perform any last minute processing of files that can only happen once the\nLoader has completed, but prior to it emitting the `complete` event.\n\nListen to it from a Scene using: `this.load.on('postprocess', listener)`.","kind":"event","name":"POST_PROCESS","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader Plugin that dispatched this event.","name":"loader"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:POST_PROCESS","scope":"instance","___s":true},{"meta":{"filename":"PROGRESS_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The Loader Plugin Progress Event.\n\nThis event is dispatched when the Loader updates its load progress, typically as a result of a file having completed loading.\n\nListen to it from a Scene using: `this.load.on('progress', listener)`.","kind":"event","name":"PROGRESS","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current progress of the load. A value between 0 and 1.","name":"progress"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:PROGRESS","scope":"instance","___s":true},{"meta":{"filename":"START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"description":"The Loader Plugin Start Event.\n\nThis event is dispatched when the Loader starts running. At this point load progress is zero.\n\nThis event is dispatched even if there aren't any files in the load queue.\n\nListen to it from a Scene using: `this.load.on('start', listener)`.","kind":"event","name":"START","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader Plugin that dispatched this event.","name":"loader"}],"memberof":"Phaser.Loader.Events","longname":"Phaser.Loader.Events#event:START","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Loader","longname":"Phaser.Loader.Events","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"AnimationJSONFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AnimationJSONFile.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Animation JSON File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#animation method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#animation.","kind":"class","name":"AnimationJSONFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.JSONFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"When the JSON file loads only this property will be stored in the Cache.","name":"dataKey"}],"scope":"static","longname":"Phaser.Loader.FileTypes.AnimationJSONFile","___s":true},{"meta":{"filename":"AnimationJSONFile.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"AnimationJSONFile.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called at the end of the load process, after the Loader has finished all files in its queue.","kind":"function","name":"onLoadComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onLoadComplete","scope":"instance","___s":true},{"meta":{"filename":"AnimationJSONFile.js","lineno":79,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an Animation JSON Data file, or array of Animation JSON files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.animation('baddieAnims', 'files/BaddieAnims.json');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nThe key must be a unique String. It is used to add the file to the global JSON Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the JSON Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the JSON Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.animation({\n key: 'baddieAnims',\n url: 'files/BaddieAnims.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.JSONFileConfig` for more details.\n\nOnce the file has finished loading it will automatically be passed to the global Animation Managers `fromJSON` method.\nThis will parse all of the JSON data and create animation data from it. This process happens at the very end\nof the Loader, once every other file in the load queue has finished. The reason for this is to allow you to load\nboth animation data and the images it relies upon in the same load call.\n\nOnce the animation data has been parsed you will be able to play animations using that data.\nPlease see the Animation Manager `fromJSON` method for more details about the format and playback.\n\nYou can also access the raw animation data from its Cache using its key:\n\n```javascript\nthis.load.animation('baddieAnims', 'files/BaddieAnims.json');\n// and later in your game ...\nvar data = this.cache.json.get('baddieAnims');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Waves` the final key will be `LEVEL1.Waves` and\nthis is what you would use to retrieve the text from the JSON Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"data\"\nand no URL is given then the Loader will set the URL to be \"data.json\". It will always add `.json` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nYou can also optionally provide a `dataKey` to use. This allows you to extract only a part of the JSON and store it in the Cache,\nrather than the whole file. For example, if your JSON data had a structure like this:\n\n```json\n{\n \"level1\": {\n \"baddies\": {\n \"aliens\": {},\n \"boss\": {}\n }\n },\n \"level2\": {},\n \"level3\": {}\n}\n```\n\nAnd if you only wanted to create animations from the `boss` data, then you could pass `level1.baddies.boss`as the `dataKey`.\n\nNote: The ability to load this type of file will only be available if the JSON File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"animation","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.JSONFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["string"]},"optional":true,"description":"When the Animation JSON file loads only this property will be stored in the Cache and used to create animation data.","name":"dataKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#animation","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"AtlasJSONFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AtlasJSONFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single JSON based Texture Atlas File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#atlas method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#atlas.\n\nhttps://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?source=photonstorm","kind":"class","name":"AtlasJSONFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the texture image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas json data file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"atlasURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.AtlasJSONFile","___s":true},{"meta":{"filename":"AtlasJSONFile.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"AtlasJSONFile.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a JSON based Texture Atlas, or array of atlases, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.atlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.json');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nPhaser expects the atlas data to be provided in a JSON file, using either the JSON Hash or JSON Array format.\nThese files are created by software such as Texture Packer, Shoebox and Adobe Flash / Animate.\nIf you are using Texture Packer and have enabled multi-atlas support, then please use the Phaser Multi Atlas loader\ninstead of this one.\n\nPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.atlas({\n key: 'mainmenu',\n textureURL: 'images/MainMenu.png',\n atlasURL: 'images/MainMenu.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig` for more details.\n\nInstead of passing a URL for the atlas JSON data you can also pass in a well formed JSON object instead.\n\nOnce the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:\n\n```javascript\nthis.load.atlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.json');\n// and later in your game ...\nthis.add.image(x, y, 'mainmenu', 'background');\n```\n\nTo get a list of all available frames within an atlas please consult your Texture Atlas software.\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\nthen you can specify it by providing an array as the `url` where the second element is the normal map:\n\n```javascript\nthis.load.atlas('mainmenu', [ 'images/MainMenu.png', 'images/MainMenu-n.png' ], 'images/MainMenu.json');\n```\n\nOr, if you are using a config object use the `normalMap` property:\n\n```javascript\nthis.load.atlas({\n key: 'mainmenu',\n textureURL: 'images/MainMenu.png',\n normalMap: 'images/MainMenu-n.png',\n atlasURL: 'images/MainMenu.json'\n});\n```\n\nThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\nNormal maps are a WebGL only feature.\n\nNote: The ability to load this type of file will only be available if the Atlas JSON File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"atlas","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the texture image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas json data file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"atlasURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#atlas","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"AtlasXMLFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AtlasXMLFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single XML based Texture Atlas File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#atlasXML method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#atlasXML.","kind":"class","name":"AtlasXMLFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the texture image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas xml data file from. If undefined or `null` it will be set to `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".","name":"atlasURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas xml file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.AtlasXMLFile","___s":true},{"meta":{"filename":"AtlasXMLFile.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"AtlasXMLFile.js","lineno":109,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an XML based Texture Atlas, or array of atlases, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.atlasXML('mainmenu', 'images/MainMenu.png', 'images/MainMenu.xml');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nPhaser expects the atlas data to be provided in an XML file format.\nThese files are created by software such as Shoebox and Adobe Flash / Animate.\n\nPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.atlasXML({\n key: 'mainmenu',\n textureURL: 'images/MainMenu.png',\n atlasURL: 'images/MainMenu.xml'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig` for more details.\n\nOnce the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:\n\n```javascript\nthis.load.atlasXML('mainmenu', 'images/MainMenu.png', 'images/MainMenu.xml');\n// and later in your game ...\nthis.add.image(x, y, 'mainmenu', 'background');\n```\n\nTo get a list of all available frames within an atlas please consult your Texture Atlas software.\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\nthen you can specify it by providing an array as the `url` where the second element is the normal map:\n\n```javascript\nthis.load.atlasXML('mainmenu', [ 'images/MainMenu.png', 'images/MainMenu-n.png' ], 'images/MainMenu.xml');\n```\n\nOr, if you are using a config object use the `normalMap` property:\n\n```javascript\nthis.load.atlasXML({\n key: 'mainmenu',\n textureURL: 'images/MainMenu.png',\n normalMap: 'images/MainMenu-n.png',\n atlasURL: 'images/MainMenu.xml'\n});\n```\n\nThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\nNormal maps are a WebGL only feature.\n\nNote: The ability to load this type of file will only be available if the Atlas XML File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"atlasXML","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.7.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the texture image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas xml data file from. If undefined or `null` it will be set to `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".","name":"atlasURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas xml file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#atlasXML","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"AudioFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AudioFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Audio File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#audio method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#audio.","kind":"class","name":"AudioFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AudioFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["any"]},"optional":true,"description":"The absolute or relative URL to load this file from in a config object.","name":"urlConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["AudioContext"]},"optional":true,"description":"The AudioContext this file will use to process itself.","name":"audioContext"}],"scope":"static","longname":"Phaser.Loader.FileTypes.AudioFile","___s":true},{"meta":{"filename":"AudioFile.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"AudioFile.js","lineno":167,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an Audio or HTML5Audio file, or array of audio files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.audio('title', [ 'music/Title.ogg', 'music/Title.mp3', 'music/Title.m4a' ]);\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Audio Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Audio Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Audio Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.audio({\n key: 'title',\n url: [ 'music/Title.ogg', 'music/Title.mp3', 'music/Title.m4a' ]\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.AudioFileConfig` for more details.\n\nThe URLs can be relative or absolute. If the URLs are relative the `Loader.baseURL` and `Loader.path` values will be prepended to them.\n\nDue to different browsers supporting different audio file types you should usually provide your audio files in a variety of formats.\nogg, mp3 and m4a are the most common. If you provide an array of URLs then the Loader will determine which _one_ file to load based on\nbrowser support.\n\nIf audio has been disabled in your game, either via the game config, or lack of support from the device, then no audio will be loaded.\n\nNote: The ability to load this type of file will only be available if the Audio File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"audio","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AudioFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the audio files from.","name":"urls"},{"type":{"names":["any"]},"optional":true,"description":"An object containing an `instances` property for HTML5Audio. Defaults to 1.","name":"config"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#audio","scope":"instance","___s":true},{"meta":{"range":[180,217],"filename":"AudioSpriteFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"AudioFile","longname":"AudioFile","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AudioSpriteFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"An Audio Sprite File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#audioSprite method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#audioSprite.","kind":"class","name":"AudioSpriteFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"description":"The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.","name":"jsonURL"},{"type":{"names":["Object"]},"optional":true,"description":"The absolute or relative URL to load the audio file from. If empty it will be obtained by parsing the JSON file.","name":"audioURL"},{"type":{"names":["any"]},"optional":true,"description":"The audio configuration options.","name":"audioConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the audio file. Used in replacement of the Loaders default XHR Settings.","name":"audioXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the json file. Used in replacement of the Loaders default XHR Settings.","name":"jsonXhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.AudioSpriteFile","___s":true},{"meta":{"filename":"AudioSpriteFile.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#onFileComplete","scope":"instance","overrides":"Phaser.Loader.MultiFile#onFileComplete","___s":true},{"meta":{"filename":"AudioSpriteFile.js","lineno":121,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"AudioSpriteFile.js","lineno":143,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a JSON based Audio Sprite, or array of audio sprites, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.audioSprite('kyobi', 'kyobi.json', [\n 'kyobi.ogg',\n 'kyobi.mp3',\n 'kyobi.m4a'\n ]);\n}\n```\n\nAudio Sprites are a combination of audio files and a JSON configuration.\nThe JSON follows the format of that created by https://github.com/tonistiigi/audiosprite\n\nIf the JSON file includes a 'resource' object then you can let Phaser parse it and load the audio\nfiles automatically based on its content. To do this exclude the audio URLs from the load:\n\n```javascript\nfunction preload ()\n{\n this.load.audioSprite('kyobi', 'kyobi.json');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nThe key must be a unique String. It is used to add the file to the global Audio Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Audio Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Audio Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.audioSprite({\n key: 'kyobi',\n jsonURL: 'audio/Kyobi.json',\n audioURL: [\n 'audio/Kyobi.ogg',\n 'audio/Kyobi.mp3',\n 'audio/Kyobi.m4a'\n ]\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig` for more details.\n\nInstead of passing a URL for the audio JSON data you can also pass in a well formed JSON object instead.\n\nOnce the audio has finished loading you can use it create an Audio Sprite by referencing its key:\n\n```javascript\nthis.load.audioSprite('kyobi', 'kyobi.json');\n// and later in your game ...\nvar music = this.sound.addAudioSprite('kyobi');\nmusic.play('title');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nDue to different browsers supporting different audio file types you should usually provide your audio files in a variety of formats.\nogg, mp3 and m4a are the most common. If you provide an array of URLs then the Loader will determine which _one_ file to load based on\nbrowser support.\n\nIf audio has been disabled in your game, either via the game config, or lack of support from the device, then no audio will be loaded.\n\nNote: The ability to load this type of file will only be available if the Audio Sprite File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"audioSprite","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or an array of objects.","name":"key"},{"type":{"names":["string"]},"description":"The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.","name":"jsonURL"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the audio file from. If empty it will be obtained by parsing the JSON file.","name":"audioURL"},{"type":{"names":["any"]},"optional":true,"description":"The audio configuration options.","name":"audioConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the audio file. Used in replacement of the Loaders default XHR Settings.","name":"audioXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the json file. Used in replacement of the Loaders default XHR Settings.","name":"jsonXhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#audioSprite","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"BinaryFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BinaryFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Binary File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#binary method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#binary.","kind":"class","name":"BinaryFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.BinaryFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.bin`, i.e. if `key` was \"alien\" then the URL will be \"alien.bin\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["any"]},"optional":true,"description":"Optional type to cast the binary file to once loaded. For example, `Uint8Array`.","name":"dataType"}],"scope":"static","longname":"Phaser.Loader.FileTypes.BinaryFile","___s":true},{"meta":{"filename":"BinaryFile.js","lineno":69,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"BinaryFile.js","lineno":89,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Binary file, or array of Binary files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.binary('doom', 'files/Doom.wad');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Binary Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Binary Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Binary Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.binary({\n key: 'doom',\n url: 'files/Doom.wad',\n dataType: Uint8Array\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.BinaryFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.binary('doom', 'files/Doom.wad');\n// and later in your game ...\nvar data = this.cache.binary.get('doom');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Data` the final key will be `LEVEL1.Data` and\nthis is what you would use to retrieve the text from the Binary Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"doom\"\nand no URL is given then the Loader will set the URL to be \"doom.bin\". It will always add `.bin` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Binary File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"binary","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.BinaryFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.bin`, i.e. if `key` was \"alien\" then the URL will be \"alien.bin\".","name":"url"},{"type":{"names":["any"]},"optional":true,"description":"Optional type to cast the binary file to once loaded. For example, `Uint8Array`.","name":"dataType"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#binary","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"BitmapFontFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapFontFile.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Bitmap Font based File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#bitmapFont method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#bitmapFont.","kind":"class","name":"BitmapFontFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.BitmapFontFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the font image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the font xml data file from. If undefined or `null` it will be set to `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".","name":"fontDataURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the font image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the font data xml file. Used in replacement of the Loaders default XHR Settings.","name":"fontDataXhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.BitmapFontFile","___s":true},{"meta":{"filename":"BitmapFontFile.js","lineno":86,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"BitmapFontFile.js","lineno":110,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an XML based Bitmap Font, or array of fonts, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n```javascript\nfunction preload ()\n{\n this.load.bitmapFont('goldenFont', 'images/GoldFont.png', 'images/GoldFont.xml');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nPhaser expects the font data to be provided in an XML file format.\nThese files are created by software such as the [Angelcode Bitmap Font Generator](http://www.angelcode.com/products/bmfont/),\n[Littera](http://kvazars.com/littera/) or [Glyph Designer](https://71squared.com/glyphdesigner)\n\nPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.bitmapFont({\n key: 'goldenFont',\n textureURL: 'images/GoldFont.png',\n fontDataURL: 'images/GoldFont.xml'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.BitmapFontFileConfig` for more details.\n\nOnce the atlas has finished loading you can use key of it when creating a Bitmap Text Game Object:\n\n```javascript\nthis.load.bitmapFont('goldenFont', 'images/GoldFont.png', 'images/GoldFont.xml');\n// and later in your game ...\nthis.add.bitmapText(x, y, 'goldenFont', 'Hello World');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use when creating a Bitmap Text object.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\nthen you can specify it by providing an array as the `url` where the second element is the normal map:\n\n```javascript\nthis.load.bitmapFont('goldenFont', [ 'images/GoldFont.png', 'images/GoldFont-n.png' ], 'images/GoldFont.xml');\n```\n\nOr, if you are using a config object use the `normalMap` property:\n\n```javascript\nthis.load.bitmapFont({\n key: 'goldenFont',\n textureURL: 'images/GoldFont.png',\n normalMap: 'images/GoldFont-n.png',\n fontDataURL: 'images/GoldFont.xml'\n});\n```\n\nThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\nNormal maps are a WebGL only feature.\n\nNote: The ability to load this type of file will only be available if the Bitmap Font File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"bitmapFont","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.BitmapFontFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the font image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the font xml data file from. If undefined or `null` it will be set to `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".","name":"fontDataURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the font image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the font data xml file. Used in replacement of the Loaders default XHR Settings.","name":"fontDataXhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#bitmapFont","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"CSSFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CSSFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single CSS File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#css method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#css.","kind":"class","name":"CSSFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.17.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.CSSFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.CSSFile","___s":true},{"meta":{"filename":"CSSFile.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.17.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"CSSFile.js","lineno":88,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a CSS file, or array of CSS files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.css('headers', 'styles/headers.css');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String and not already in-use by another file in the Loader.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.css({\n key: 'headers',\n url: 'styles/headers.css'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.CSSFileConfig` for more details.\n\nOnce the file has finished loading it will automatically be converted into a style DOM element\nvia `document.createElement('style')`. It will have its `defer` property set to false and then the\nresulting element will be appended to `document.head`. The CSS styles are then applied to the current document.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.css\". It will always add `.css` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the CSS File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"css","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.17.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.CSSFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.css`, i.e. if `key` was \"alien\" then the URL will be \"alien.css\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#css","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"GLSLFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GLSLFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single GLSL File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#glsl method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#glsl.","kind":"class","name":"GLSLFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.GLSLFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'fragment'","description":"The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.","name":"shaderType"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.GLSLFile","___s":true},{"meta":{"filename":"GLSLFile.js","lineno":76,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"GLSLFile.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.17.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"GLSLFile.js","lineno":157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Returns the name of the shader from the header block.","kind":"function","name":"getShaderName","since":"3.17.0","params":[{"type":{"names":["Array."]},"description":"The header data.","name":"headerSource"}],"returns":[{"type":{"names":["string"]},"description":"The shader name."}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#getShaderName","scope":"instance","___s":true},{"meta":{"filename":"GLSLFile.js","lineno":182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Returns the type of the shader from the header block.","kind":"function","name":"getShaderType","since":"3.17.0","params":[{"type":{"names":["Array."]},"description":"The header data.","name":"headerSource"}],"returns":[{"type":{"names":["string"]},"description":"The shader type. Either 'fragment' or 'vertex'."}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#getShaderType","scope":"instance","___s":true},{"meta":{"filename":"GLSLFile.js","lineno":207,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Returns the shader uniforms from the header block.","kind":"function","name":"getShaderUniforms","since":"3.17.0","params":[{"type":{"names":["Array."]},"description":"The header data.","name":"headerSource"}],"returns":[{"type":{"names":["any"]},"description":"The shader uniforms object."}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#getShaderUniforms","scope":"instance","___s":true},{"meta":{"filename":"GLSLFile.js","lineno":317,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a GLSL file, or array of GLSL files, to the current load queue.\nIn Phaser 3 GLSL files are just plain Text files at the current moment in time.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.glsl('plasma', 'shaders/Plasma.glsl');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Shader Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Shader Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Shader Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.glsl({\n key: 'plasma',\n shaderType: 'fragment',\n url: 'shaders/Plasma.glsl'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.GLSLFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.glsl('plasma', 'shaders/Plasma.glsl');\n// and later in your game ...\nvar data = this.cache.shader.get('plasma');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `FX.` and the key was `Plasma` the final key will be `FX.Plasma` and\nthis is what you would use to retrieve the text from the Shader Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"plasma\"\nand no URL is given then the Loader will set the URL to be \"plasma.glsl\". It will always add `.glsl` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the GLSL File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"glsl","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.GLSLFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.glsl`, i.e. if `key` was \"alien\" then the URL will be \"alien.glsl\".","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'fragment'","description":"The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.","name":"shaderType"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#glsl","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"HTML5AudioFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HTML5AudioFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Audio File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#audio method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#audio.","kind":"class","name":"HTML5AudioFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.AudioFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from.","name":"urlConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.HTML5AudioFile","___s":true},{"meta":{"filename":"HTML5AudioFile.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called when the file finishes loading.","kind":"function","name":"onLoad","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#onLoad","scope":"instance","overrides":"Phaser.Loader.File#onLoad","___s":true},{"meta":{"filename":"HTML5AudioFile.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called if the file errors while loading.","kind":"function","name":"onError","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#onError","scope":"instance","overrides":"Phaser.Loader.File#onError","___s":true},{"meta":{"filename":"HTML5AudioFile.js","lineno":104,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#onProgress","scope":"instance","overrides":"Phaser.Loader.File#onProgress","___s":true},{"meta":{"filename":"HTML5AudioFile.js","lineno":130,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#load","scope":"instance","overrides":"Phaser.Loader.File#load","___s":true},{"meta":{"range":[180,216],"filename":"HTMLFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HTMLFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single HTML File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#html method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#html.","kind":"class","name":"HTMLFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.12.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.HTMLFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.html\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.HTMLFile","___s":true},{"meta":{"filename":"HTMLFile.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"HTMLFile.js","lineno":84,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an HTML file, or array of HTML files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.html('story', 'files/LoginForm.html');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global HTML Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the HTML Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the HTML Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.html({\n key: 'login',\n url: 'files/LoginForm.html'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.HTMLFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.html('login', 'files/LoginForm.html');\n// and later in your game ...\nvar data = this.cache.html.get('login');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Story` the final key will be `LEVEL1.Story` and\nthis is what you would use to retrieve the html from the HTML Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"story\"\nand no URL is given then the Loader will set the URL to be \"story.html\". It will always add `.html` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the HTML File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"html","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.12.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.HTMLFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.html`, i.e. if `key` was \"alien\" then the URL will be \"alien.html\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#html","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"HTMLTextureFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HTMLTextureFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single HTML File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#htmlTexture method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#htmlTexture.","kind":"class","name":"HTMLTextureFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.12.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"url"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the texture the HTML will be rendered to.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the texture the HTML will be rendered to.","name":"height"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.HTMLTextureFile","___s":true},{"meta":{"filename":"HTMLTextureFile.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"HTMLTextureFile.js","lineno":138,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"HTMLTextureFile.js","lineno":153,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an HTML File, or array of HTML Files, to the current load queue. When the files are loaded they\nwill be rendered to textures and stored in the Texture Manager.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.htmlTexture('instructions', 'content/intro.html', 256, 512);\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.htmlTexture({\n key: 'instructions',\n url: 'content/intro.html',\n width: 256,\n height: 512\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig` for more details.\n\nOnce the file has finished loading you can use it as a texture for a Game Object by referencing its key:\n\n```javascript\nthis.load.htmlTexture('instructions', 'content/intro.html', 256, 512);\n// and later in your game ...\nthis.add.image(x, y, 'instructions');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.html\". It will always add `.html` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nThe width and height are the size of the texture to which the HTML will be rendered. It's not possible to determine these\nautomatically, so you will need to provide them, either as arguments or in the file config object.\nWhen the HTML file has loaded a new SVG element is created with a size and viewbox set to the width and height given.\nThe SVG file has a body tag added to it, with the HTML file contents included. It then calls `window.Blob` on the SVG,\nand if successful is added to the Texture Manager, otherwise it fails processing. The overall quality of the rendered\nHTML depends on your browser, and some of them may not even support the svg / blob process used. Be aware that there are\nlimitations on what HTML can be inside an SVG. You can find out more details in this\n[Mozilla MDN entry](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API/Drawing_DOM_objects_into_a_canvas).\n\nNote: The ability to load this type of file will only be available if the HTMLTextureFile File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"htmlTexture","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.12.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.html`, i.e. if `key` was \"alien\" then the URL will be \"alien.html\".","name":"url"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":512,"description":"The width of the texture the HTML will be rendered to.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":512,"description":"The height of the texture the HTML will be rendered to.","name":"height"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#htmlTexture","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"ImageFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImageFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Image File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#image method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#image.","kind":"class","name":"ImageFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.ImageFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["Phaser.Types.Loader.FileTypes.ImageFrameConfig"]},"optional":true,"description":"The frame configuration object. Only provided for, and used by, Sprite Sheets.","name":"frameConfig"}],"scope":"static","longname":"Phaser.Loader.FileTypes.ImageFile","___s":true},{"meta":{"filename":"ImageFile.js","lineno":89,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"ImageFile.js","lineno":123,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"ImageFile.js","lineno":159,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an Image, or array of Images, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.image('logo', 'images/phaserLogo.png');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\nIf you try to load an animated gif only the first frame will be rendered. Browsers do not natively support playback\nof animated gifs to Canvas elements.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.image({\n key: 'logo',\n url: 'images/AtariLogo.png'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.ImageFileConfig` for more details.\n\nOnce the file has finished loading you can use it as a texture for a Game Object by referencing its key:\n\n```javascript\nthis.load.image('logo', 'images/AtariLogo.png');\n// and later in your game ...\nthis.add.image(x, y, 'logo');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\nthen you can specify it by providing an array as the `url` where the second element is the normal map:\n\n```javascript\nthis.load.image('logo', [ 'images/AtariLogo.png', 'images/AtariLogo-n.png' ]);\n```\n\nOr, if you are using a config object use the `normalMap` property:\n\n```javascript\nthis.load.image({\n key: 'logo',\n url: 'images/AtariLogo.png',\n normalMap: 'images/AtariLogo-n.png'\n});\n```\n\nThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\nNormal maps are a WebGL only feature.\n\nNote: The ability to load this type of file will only be available if the Image File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"image","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.ImageFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#image","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"JSONFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"JSONFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single JSON File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#json method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#json.","kind":"class","name":"JSONFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.JSONFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"When the JSON file loads only this property will be stored in the Cache.","name":"dataKey"}],"scope":"static","longname":"Phaser.Loader.FileTypes.JSONFile","___s":true},{"meta":{"filename":"JSONFile.js","lineno":88,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"JSONFile.js","lineno":120,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a JSON file, or array of JSON files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.json('wavedata', 'files/AlienWaveData.json');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global JSON Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the JSON Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the JSON Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.json({\n key: 'wavedata',\n url: 'files/AlienWaveData.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.JSONFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.json('wavedata', 'files/AlienWaveData.json');\n// and later in your game ...\nvar data = this.cache.json.get('wavedata');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Waves` the final key will be `LEVEL1.Waves` and\nthis is what you would use to retrieve the text from the JSON Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"data\"\nand no URL is given then the Loader will set the URL to be \"data.json\". It will always add `.json` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nYou can also optionally provide a `dataKey` to use. This allows you to extract only a part of the JSON and store it in the Cache,\nrather than the whole file. For example, if your JSON data had a structure like this:\n\n```json\n{\n \"level1\": {\n \"baddies\": {\n \"aliens\": {},\n \"boss\": {}\n }\n },\n \"level2\": {},\n \"level3\": {}\n}\n```\n\nAnd you only wanted to store the `boss` data in the Cache, then you could pass `level1.baddies.boss`as the `dataKey`.\n\nNote: The ability to load this type of file will only be available if the JSON File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"json","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.JSONFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["string"]},"optional":true,"description":"When the JSON file loads only this property will be stored in the Cache.","name":"dataKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#json","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"MultiAtlasFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MultiAtlasFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Multi Texture Atlas File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#multiatlas method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#multiatlas.","kind":"class","name":"MultiAtlasFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager. Or a config object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the multi atlas json file from.","name":"atlasURL"},{"type":{"names":["string"]},"optional":true,"description":"Optional path to use when loading the textures defined in the atlas data.","name":"path"},{"type":{"names":["string"]},"optional":true,"description":"Optional Base URL to use when loading the textures defined in the atlas data.","name":"baseURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the atlas json file.","name":"atlasXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the texture files.","name":"textureXhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.MultiAtlasFile","___s":true},{"meta":{"filename":"MultiAtlasFile.js","lineno":75,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#onFileComplete","scope":"instance","overrides":"Phaser.Loader.MultiFile#onFileComplete","___s":true},{"meta":{"filename":"MultiAtlasFile.js","lineno":148,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"MultiAtlasFile.js","lineno":217,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Multi Texture Atlas, or array of multi atlases, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.multiatlas('level1', 'images/Level1.json');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nPhaser expects the atlas data to be provided in a JSON file as exported from the application Texture Packer,\nversion 4.6.3 or above, where you have made sure to use the Phaser 3 Export option.\n\nThe way it works internally is that you provide a URL to the JSON file. Phaser then loads this JSON, parses it and\nextracts which texture files it also needs to load to complete the process. If the JSON also defines normal maps,\nPhaser will load those as well.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.multiatlas({\n key: 'level1',\n atlasURL: 'images/Level1.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig` for more details.\n\nInstead of passing a URL for the atlas JSON data you can also pass in a well formed JSON object instead.\n\nOnce the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:\n\n```javascript\nthis.load.multiatlas('level1', 'images/Level1.json');\n// and later in your game ...\nthis.add.image(x, y, 'level1', 'background');\n```\n\nTo get a list of all available frames within an atlas please consult your Texture Atlas software.\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Multi Atlas File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"multiatlas","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.7.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas json data file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"atlasURL"},{"type":{"names":["string"]},"optional":true,"description":"Optional path to use when loading the textures defined in the atlas data.","name":"path"},{"type":{"names":["string"]},"optional":true,"description":"Optional Base URL to use when loading the textures defined in the atlas data.","name":"baseURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#multiatlas","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"MultiScriptFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MultiScriptFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A Multi Script File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#scripts method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#scripts.","kind":"class","name":"MultiScriptFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.17.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.MultiScriptFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["Array."]},"optional":true,"description":"An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the script files. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.MultiScriptFile","___s":true},{"meta":{"filename":"MultiScriptFile.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.17.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"MultiScriptFile.js","lineno":109,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an array of Script files to the current load queue.\n\nThe difference between this and the `ScriptFile` file type is that you give an array of scripts to this method,\nand the scripts are then processed _exactly_ in that order. This allows you to load a bunch of scripts that\nmay have dependencies on each other without worrying about the async nature of traditional script loading.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.scripts('PostProcess', [\n 'libs/shaders/CopyShader.js',\n 'libs/postprocessing/EffectComposer.js',\n 'libs/postprocessing/RenderPass.js',\n 'libs/postprocessing/MaskPass.js',\n 'libs/postprocessing/ShaderPass.js',\n 'libs/postprocessing/AfterimagePass.js'\n ]);\n}\n```\n\nIn the code above the script files will all be loaded in parallel but only processed (i.e. invoked) in the exact\norder given in the array.\n\nThe files are **not** loaded right away. They are added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the files are queued\nit means you cannot use the files immediately after calling this method, but must wait for the files to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String and not already in-use by another file in the Loader.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.scripts({\n key: 'PostProcess',\n url: [\n 'libs/shaders/CopyShader.js',\n 'libs/postprocessing/EffectComposer.js',\n 'libs/postprocessing/RenderPass.js',\n 'libs/postprocessing/MaskPass.js',\n 'libs/postprocessing/ShaderPass.js',\n 'libs/postprocessing/AfterimagePass.js'\n ]\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.MultiScriptFileConfig` for more details.\n\nOnce all the files have finished loading they will automatically be converted into a script element\nvia `document.createElement('script')`. They will have their language set to JavaScript, `defer` set to\nfalse and then the resulting element will be appended to `document.head`. Any code then in the\nscript will be executed. This is done in the exact order the files are specified in the url array.\n\nThe URLs can be relative or absolute. If the URLs are relative the `Loader.baseURL` and `Loader.path` values will be prepended to them.\n\nNote: The ability to load this type of file will only be available if the MultiScript File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"scripts","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.17.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.MultiScriptFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["Array."]},"optional":true,"description":"An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'js'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for these files.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#scripts","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"PackFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PackFile.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single JSON Pack File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#pack method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#pack.","kind":"class","name":"PackFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.PackFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"When the JSON file loads only this property will be stored in the Cache.","name":"dataKey"}],"scope":"static","longname":"Phaser.Loader.FileTypes.PackFile","___s":true},{"meta":{"filename":"PackFile.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"PackFile.js","lineno":72,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a JSON File Pack, or array of packs, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.pack('level1', 'data/Level1Files.json');\n}\n```\n\nA File Pack is a JSON file (or object) that contains details about other files that should be added into the Loader.\nHere is a small example:\n\n```json\n{ \n \"test1\": {\n \"files\": [\n {\n \"type\": \"image\",\n \"key\": \"taikodrummaster\",\n \"url\": \"assets/pics/taikodrummaster.jpg\"\n },\n {\n \"type\": \"image\",\n \"key\": \"sukasuka-chtholly\",\n \"url\": \"assets/pics/sukasuka-chtholly.png\"\n }\n ]\n },\n \"meta\": {\n \"generated\": \"1401380327373\",\n \"app\": \"Phaser 3 Asset Packer\",\n \"url\": \"https://phaser.io\",\n \"version\": \"1.0\",\n \"copyright\": \"Photon Storm Ltd. 2018\"\n }\n}\n```\n\nThe pack can be split into sections. In the example above you'll see a section called `test1. You can tell\nthe `load.pack` method to parse only a particular section of a pack. The pack is stored in the JSON Cache,\nso you can pass it to the Loader to process additional sections as needed in your game, or you can just load\nthem all at once without specifying anything.\n\nThe pack file can contain an entry for any type of file that Phaser can load. The object structures exactly\nmatch that of the file type configs, and all properties available within the file type configs can be used\nin the pack file too.\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nThe key must be a unique String. It is used to add the file to the global JSON Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the JSON Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the JSON Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.pack({\n key: 'level1',\n url: 'data/Level1Files.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.PackFileConfig` for more details.\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Waves` the final key will be `LEVEL1.Waves` and\nthis is what you would use to retrieve the text from the JSON Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"data\"\nand no URL is given then the Loader will set the URL to be \"data.json\". It will always add `.json` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nYou can also optionally provide a `dataKey` to use. This allows you to extract only a part of the JSON and store it in the Cache,\nrather than the whole file. For example, if your JSON data had a structure like this:\n\n```json\n{\n \"level1\": {\n \"baddies\": {\n \"aliens\": {},\n \"boss\": {}\n }\n },\n \"level2\": {},\n \"level3\": {}\n}\n```\n\nAnd you only wanted to store the `boss` data in the Cache, then you could pass `level1.baddies.boss`as the `dataKey`.\n\nNote: The ability to load this type of file will only be available if the Pack File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"pack","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.7.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.PackFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["string"]},"optional":true,"description":"When the JSON file loads only this property will be stored in the Cache.","name":"dataKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#pack","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"PluginFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PluginFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Plugin Script File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#plugin method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#plugin.","kind":"class","name":"PluginFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.PluginFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Automatically start the plugin after loading?","name":"start"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Scene, this is the property key used.","name":"mapping"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.PluginFile","___s":true},{"meta":{"filename":"PluginFile.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"PluginFile.js","lineno":129,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Plugin Script file, or array of plugin files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.plugin('modplayer', 'plugins/ModPlayer.js');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String and not already in-use by another file in the Loader.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.plugin({\n key: 'modplayer',\n url: 'plugins/ModPlayer.js'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.PluginFileConfig` for more details.\n\nOnce the file has finished loading it will automatically be converted into a script element\nvia `document.createElement('script')`. It will have its language set to JavaScript, `defer` set to\nfalse and then the resulting element will be appended to `document.head`. Any code then in the\nscript will be executed. It will then be passed to the Phaser PluginCache.register method.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.js\". It will always add `.js` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Plugin File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"plugin","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.PluginFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","function"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\". Or, a plugin function.","name":"url"},{"type":{"names":["boolean"]},"optional":true,"description":"Automatically start the plugin after loading?","name":"start"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Scene, this is the property key used.","name":"mapping"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#plugin","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"SVGFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SVGFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single SVG File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#svg method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#svg.","kind":"class","name":"SVGFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.SVGFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.svg`, i.e. if `key` was \"alien\" then the URL will be \"alien.svg\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.FileTypes.SVGSizeConfig"]},"optional":true,"description":"The svg size configuration object.","name":"svgConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.SVGFile","___s":true},{"meta":{"filename":"SVGFile.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"SVGFile.js","lineno":182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"SVGFile.js","lineno":197,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an SVG File, or array of SVG Files, to the current load queue. When the files are loaded they\nwill be rendered to bitmap textures and stored in the Texture Manager.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.svg('morty', 'images/Morty.svg');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.svg({\n key: 'morty',\n url: 'images/Morty.svg'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.SVGFileConfig` for more details.\n\nOnce the file has finished loading you can use it as a texture for a Game Object by referencing its key:\n\n```javascript\nthis.load.svg('morty', 'images/Morty.svg');\n// and later in your game ...\nthis.add.image(x, y, 'morty');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.html\". It will always add `.html` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nYou can optionally pass an SVG Resize Configuration object when you load an SVG file. By default the SVG will be rendered to a texture\nat the same size defined in the SVG file attributes. However, this isn't always desirable. You may wish to resize the SVG (either down\nor up) to improve texture clarity, or reduce texture memory consumption. You can either specify an exact width and height to resize\nthe SVG to:\n\n```javascript\nfunction preload ()\n{\n this.load.svg('morty', 'images/Morty.svg', { width: 300, height: 600 });\n}\n```\n\nOr when using a configuration object:\n\n```javascript\nthis.load.svg({\n key: 'morty',\n url: 'images/Morty.svg',\n svgConfig: {\n width: 300,\n height: 600\n }\n});\n```\n\nAlternatively, you can just provide a scale factor instead:\n\n```javascript\nfunction preload ()\n{\n this.load.svg('morty', 'images/Morty.svg', { scale: 2.5 });\n}\n```\n\nOr when using a configuration object:\n\n```javascript\nthis.load.svg({\n key: 'morty',\n url: 'images/Morty.svg',\n svgConfig: {\n scale: 2.5\n }\n});\n```\n\nIf scale, width and height values are all given, the scale has priority and the width and height values are ignored.\n\nNote: The ability to load this type of file will only be available if the SVG File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"svg","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.SVGFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.svg`, i.e. if `key` was \"alien\" then the URL will be \"alien.svg\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.FileTypes.SVGSizeConfig"]},"optional":true,"description":"The svg size configuration object.","name":"svgConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#svg","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"SceneFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SceneFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"An external Scene JavaScript File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#sceneFile method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#sceneFile.","kind":"class","name":"SceneFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.16.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.SceneFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.SceneFile","___s":true},{"meta":{"filename":"SceneFile.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.16.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"SceneFile.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.16.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"SceneFile.js","lineno":102,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an external Scene file, or array of Scene files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.sceneFile('Level1', 'src/Level1.js');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Scene Manager upon a successful load.\n\nFor a Scene File it's vitally important that the key matches the class name in the JavaScript file.\n\nFor example here is the source file:\n\n```javascript\nclass ExternalScene extends Phaser.Scene {\n\n constructor ()\n {\n super('myScene');\n }\n\n}\n```\n\nBecause the class is called `ExternalScene` that is the exact same key you must use when loading it:\n\n```javascript\nfunction preload ()\n{\n this.load.sceneFile('ExternalScene', 'src/yourScene.js');\n}\n```\n\nThe key that is used within the Scene Manager can either be set to the same, or you can override it in the Scene\nconstructor, as we've done in the example above, where the Scene key was changed to `myScene`.\n\nThe key should be unique both in terms of files being loaded and Scenes already present in the Scene Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Scene Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.sceneFile({\n key: 'Level1',\n url: 'src/Level1.js'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.SceneFileConfig` for more details.\n\nOnce the file has finished loading it will be added to the Scene Manager.\n\n```javascript\nthis.load.sceneFile('Level1', 'src/Level1.js');\n// and later in your game ...\nthis.scene.start('Level1');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `WORLD1.` and the key was `Story` the final key will be `WORLD1.Story` and\nthis is what you would use to retrieve the text from the Scene Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"story\"\nand no URL is given then the Loader will set the URL to be \"story.js\". It will always add `.js` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Scene File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"sceneFile","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.16.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.SceneFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#sceneFile","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"ScenePluginFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScenePluginFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Scene Plugin Script File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#scenePlugin method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#scenePlugin.","kind":"class","name":"ScenePluginFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.8.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.ScenePluginFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be added to Scene.Systems, this is the property key for it.","name":"systemKey"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be added to the Scene, this is the property key for it.","name":"sceneKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.ScenePluginFile","___s":true},{"meta":{"filename":"ScenePluginFile.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.8.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"ScenePluginFile.js","lineno":123,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Scene Plugin Script file, or array of plugin files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.scenePlugin('ModPlayer', 'plugins/ModPlayer.js', 'modPlayer', 'mods');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String and not already in-use by another file in the Loader.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.scenePlugin({\n key: 'modplayer',\n url: 'plugins/ModPlayer.js'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.ScenePluginFileConfig` for more details.\n\nOnce the file has finished loading it will automatically be converted into a script element\nvia `document.createElement('script')`. It will have its language set to JavaScript, `defer` set to\nfalse and then the resulting element will be appended to `document.head`. Any code then in the\nscript will be executed. It will then be passed to the Phaser PluginCache.register method.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.js\". It will always add `.js` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Script File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"scenePlugin","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.8.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.ScenePluginFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","function"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\". Or, set to a plugin function.","name":"url"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be added to Scene.Systems, this is the property key for it.","name":"systemKey"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be added to the Scene, this is the property key for it.","name":"sceneKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#scenePlugin","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"ScriptFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScriptFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Script File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#script method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#script.","kind":"class","name":"ScriptFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.ScriptFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.ScriptFile","___s":true},{"meta":{"filename":"ScriptFile.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"ScriptFile.js","lineno":90,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Script file, or array of Script files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.script('aliens', 'lib/aliens.js');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String and not already in-use by another file in the Loader.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.script({\n key: 'aliens',\n url: 'lib/aliens.js'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.ScriptFileConfig` for more details.\n\nOnce the file has finished loading it will automatically be converted into a script element\nvia `document.createElement('script')`. It will have its language set to JavaScript, `defer` set to\nfalse and then the resulting element will be appended to `document.head`. Any code then in the\nscript will be executed.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.js\". It will always add `.js` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Script File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"script","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.ScriptFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.js`, i.e. if `key` was \"alien\" then the URL will be \"alien.js\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#script","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"SpriteSheetFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SpriteSheetFile.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Sprite Sheet Image File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#spritesheet method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#spritesheet.","kind":"class","name":"SpriteSheetFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.FileTypes.ImageFrameConfig"]},"optional":true,"description":"The frame configuration object.","name":"frameConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.SpriteSheetFile","___s":true},{"meta":{"filename":"SpriteSheetFile.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"SpriteSheetFile.js","lineno":59,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Sprite Sheet Image, or array of Sprite Sheet Images, to the current load queue.\n\nThe term 'Sprite Sheet' in Phaser means a fixed-size sheet. Where every frame in the sheet is the exact same size,\nand you reference those frames using numbers, not frame names. This is not the same thing as a Texture Atlas, where\nthe frames are packed in a way where they take up the least amount of space, and are referenced by their names,\nnot numbers. Some articles and software use the term 'Sprite Sheet' to mean Texture Atlas, so please be aware of\nwhat sort of file you're actually trying to load.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.spritesheet('bot', 'images/robot.png', { frameWidth: 32, frameHeight: 38 });\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\nIf you try to load an animated gif only the first frame will be rendered. Browsers do not natively support playback\nof animated gifs to Canvas elements.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.spritesheet({\n key: 'bot',\n url: 'images/robot.png',\n frameConfig: {\n frameWidth: 32,\n frameHeight: 38,\n startFrame: 0,\n endFrame: 8\n }\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig` for more details.\n\nOnce the file has finished loading you can use it as a texture for a Game Object by referencing its key:\n\n```javascript\nthis.load.spritesheet('bot', 'images/robot.png', { frameWidth: 32, frameHeight: 38 });\n// and later in your game ...\nthis.add.image(x, y, 'bot', 0);\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `PLAYER.` and the key was `Running` the final key will be `PLAYER.Running` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\nthen you can specify it by providing an array as the `url` where the second element is the normal map:\n\n```javascript\nthis.load.spritesheet('logo', [ 'images/AtariLogo.png', 'images/AtariLogo-n.png' ], { frameWidth: 256, frameHeight: 80 });\n```\n\nOr, if you are using a config object use the `normalMap` property:\n\n```javascript\nthis.load.spritesheet({\n key: 'logo',\n url: 'images/AtariLogo.png',\n normalMap: 'images/AtariLogo-n.png',\n frameConfig: {\n frameWidth: 256,\n frameHeight: 80\n }\n});\n```\n\nThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\nNormal maps are a WebGL only feature.\n\nNote: The ability to load this type of file will only be available if the Sprite Sheet File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"spritesheet","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.FileTypes.ImageFrameConfig"]},"optional":true,"description":"The frame configuration object. At a minimum it should have a `frameWidth` property.","name":"frameConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#spritesheet","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"TextFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextFile.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Text File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#text method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#text.","kind":"class","name":"TextFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TextFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.TextFile","___s":true},{"meta":{"filename":"TextFile.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"TextFile.js","lineno":84,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Text file, or array of Text files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.text('story', 'files/IntroStory.txt');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Text Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Text Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Text Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.text({\n key: 'story',\n url: 'files/IntroStory.txt'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.TextFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.text('story', 'files/IntroStory.txt');\n// and later in your game ...\nvar data = this.cache.text.get('story');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Story` the final key will be `LEVEL1.Story` and\nthis is what you would use to retrieve the text from the Text Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"story\"\nand no URL is given then the Loader will set the URL to be \"story.txt\". It will always add `.txt` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Text File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"text","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TextFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#text","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"TilemapCSVFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TilemapCSVFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Tilemap CSV File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#tilemapCSV method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#tilemapCSV.","kind":"class","name":"TilemapCSVFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.csv`, i.e. if `key` was \"alien\" then the URL will be \"alien.csv\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.TilemapCSVFile","___s":true},{"meta":{"filename":"TilemapCSVFile.js","lineno":69,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"TilemapCSVFile.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"TilemapCSVFile.js","lineno":102,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a CSV Tilemap file, or array of CSV files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.tilemapCSV('level1', 'maps/Level1.csv');\n}\n```\n\nTilemap CSV data can be created in a text editor, or a 3rd party app that exports as CSV.\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Tilemap Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Tilemap Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Text Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.tilemapCSV({\n key: 'level1',\n url: 'maps/Level1.csv'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.tilemapCSV('level1', 'maps/Level1.csv');\n// and later in your game ...\nvar map = this.make.tilemap({ key: 'level1' });\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Story` the final key will be `LEVEL1.Story` and\nthis is what you would use to retrieve the text from the Tilemap Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"level\"\nand no URL is given then the Loader will set the URL to be \"level.csv\". It will always add `.csv` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Tilemap CSV File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"tilemapCSV","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.csv`, i.e. if `key` was \"alien\" then the URL will be \"alien.csv\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#tilemapCSV","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"TilemapImpactFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TilemapImpactFile.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Impact.js Tilemap JSON File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#tilemapImpact method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#tilemapImpact.","kind":"class","name":"TilemapImpactFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.TilemapImpactFile","___s":true},{"meta":{"filename":"TilemapImpactFile.js","lineno":46,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"TilemapImpactFile.js","lineno":63,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an Impact.js Tilemap file, or array of map files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.tilemapImpact('level1', 'maps/Level1.json');\n}\n```\n\nImpact Tilemap data is created the Impact.js Map Editor called Weltmeister.\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Tilemap Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Tilemap Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Text Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.tilemapImpact({\n key: 'level1',\n url: 'maps/Level1.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.tilemapImpact('level1', 'maps/Level1.json');\n// and later in your game ...\nvar map = this.make.tilemap({ key: 'level1' });\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Story` the final key will be `LEVEL1.Story` and\nthis is what you would use to retrieve the text from the Tilemap Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"level\"\nand no URL is given then the Loader will set the URL to be \"level.json\". It will always add `.json` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Tilemap Impact File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"tilemapImpact","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.7.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#tilemapImpact","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"TilemapJSONFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TilemapJSONFile.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Tiled Tilemap JSON File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#tilemapTiledJSON method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#tilemapTiledJSON.","kind":"class","name":"TilemapJSONFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.TilemapJSONFile","___s":true},{"meta":{"filename":"TilemapJSONFile.js","lineno":46,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#addToCache","scope":"instance","overrides":"Phaser.Loader.File#addToCache","___s":true},{"meta":{"filename":"TilemapJSONFile.js","lineno":63,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Tiled JSON Tilemap file, or array of map files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.tilemapTiledJSON('level1', 'maps/Level1.json');\n}\n```\n\nThe Tilemap data is created using the Tiled Map Editor and selecting JSON as the export format.\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Tilemap Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Tilemap Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Text Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.tilemapTiledJSON({\n key: 'level1',\n url: 'maps/Level1.json'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.tilemapTiledJSON('level1', 'maps/Level1.json');\n// and later in your game ...\nvar map = this.make.tilemap({ key: 'level1' });\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Story` the final key will be `LEVEL1.Story` and\nthis is what you would use to retrieve the text from the Tilemap Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"level\"\nand no URL is given then the Loader will set the URL to be \"level.json\". It will always add `.json` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the Tilemap JSON File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"tilemapTiledJSON","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.json`, i.e. if `key` was \"alien\" then the URL will be \"alien.json\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#tilemapTiledJSON","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"UnityAtlasFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"UnityAtlasFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single text file based Unity Texture Atlas File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#unityAtlas method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#unityAtlas.","kind":"class","name":"UnityAtlasFile","augments":["Phaser.Loader.MultiFile"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the texture image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas data file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".","name":"atlasURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas data file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.UnityAtlasFile","___s":true},{"meta":{"filename":"UnityAtlasFile.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds this file to its target cache upon successful loading and processing.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#addToCache","scope":"instance","___s":true},{"meta":{"filename":"UnityAtlasFile.js","lineno":109,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Unity YAML based Texture Atlas, or array of atlases, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.unityAtlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.txt');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\nits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\n\nPhaser expects the atlas data to be provided in a YAML formatted text file as exported from Unity.\n\nPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\n\nThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Texture Manager first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.unityAtlas({\n key: 'mainmenu',\n textureURL: 'images/MainMenu.png',\n atlasURL: 'images/MainMenu.txt'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig` for more details.\n\nOnce the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:\n\n```javascript\nthis.load.unityAtlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.json');\n// and later in your game ...\nthis.add.image(x, y, 'mainmenu', 'background');\n```\n\nTo get a list of all available frames within an atlas please consult your Texture Atlas software.\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\nthis is what you would use to retrieve the image from the Texture Manager.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\nand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\nthen you can specify it by providing an array as the `url` where the second element is the normal map:\n\n```javascript\nthis.load.unityAtlas('mainmenu', [ 'images/MainMenu.png', 'images/MainMenu-n.png' ], 'images/MainMenu.txt');\n```\n\nOr, if you are using a config object use the `normalMap` property:\n\n```javascript\nthis.load.unityAtlas({\n key: 'mainmenu',\n textureURL: 'images/MainMenu.png',\n normalMap: 'images/MainMenu-n.png',\n atlasURL: 'images/MainMenu.txt'\n});\n```\n\nThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\nNormal maps are a WebGL only feature.\n\nNote: The ability to load this type of file will only be available if the Unity Atlas File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"unityAtlas","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the texture image file from. If undefined or `null` it will be set to `.png`, i.e. if `key` was \"alien\" then the URL will be \"alien.png\".","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture atlas data file from. If undefined or `null` it will be set to `.txt`, i.e. if `key` was \"alien\" then the URL will be \"alien.txt\".","name":"atlasURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.","name":"textureXhrSettings"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object for the atlas data file. Used in replacement of the Loaders default XHR Settings.","name":"atlasXhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#unityAtlas","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"VideoFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"VideoFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single Video File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#video method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#video.","kind":"class","name":"VideoFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.20.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.VideoFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["any"]},"optional":true,"description":"The absolute or relative URL to load this file from in a config object.","name":"urlConfig"},{"type":{"names":["string"]},"optional":true,"description":"The load event to listen for when _not_ loading as a blob. Either 'loadeddata', 'canplay' or 'canplaythrough'.","name":"loadEvent"},{"type":{"names":["boolean"]},"optional":true,"description":"Load the video as a data blob, or via the Video element?","name":"asBlob"},{"type":{"names":["boolean"]},"optional":true,"description":"Does the video have an audio track? If not you can enable auto-playing on it.","name":"noAudio"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.VideoFile","___s":true},{"meta":{"filename":"VideoFile.js","lineno":76,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.20.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"VideoFile.js","lineno":196,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.20.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#load","scope":"instance","overrides":"Phaser.Loader.File#load","___s":true},{"meta":{"filename":"VideoFile.js","lineno":292,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds a Video file, or array of video files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.video('intro', [ 'video/level1.mp4', 'video/level1.webm', 'video/level1.mov' ]);\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global Video Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the Video Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the Video Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.video({\n key: 'intro',\n url: [ 'video/level1.mp4', 'video/level1.webm', 'video/level1.mov' ],\n asBlob: false,\n noAudio: true\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.VideoFileConfig` for more details.\n\nThe URLs can be relative or absolute. If the URLs are relative the `Loader.baseURL` and `Loader.path` values will be prepended to them.\n\nDue to different browsers supporting different video file types you should usually provide your video files in a variety of formats.\nmp4, mov and webm are the most common. If you provide an array of URLs then the Loader will determine which _one_ file to load based on\nbrowser support, starting with the first in the array and progressing to the end.\n\nUnlike most asset-types, videos do not _need_ to be preloaded. You can create a Video Game Object and then call its `loadURL` method,\nto load a video at run-time, rather than in advance.\n\nNote: The ability to load this type of file will only be available if the Video File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"video","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.20.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.VideoFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string","Array."]},"optional":true,"description":"The absolute or relative URL to load the video files from.","name":"urls"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'loadeddata'","description":"The load event to listen for when _not_ loading as a blob. Either `loadeddata`, `canplay` or `canplaythrough`.","name":"loadEvent"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Load the video as a data blob, or stream it via the Video element?","name":"asBlob"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Does the video have an audio track? If not you can enable auto-playing on it.","name":"noAudio"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#video","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"XMLFile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"XMLFile.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"classdesc":"A single XML File suitable for loading by the Loader.\n\nThese are created when you use the Phaser.Loader.LoaderPlugin#xml method and are not typically created directly.\n\nFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#xml.","kind":"class","name":"XMLFile","augments":["Phaser.Loader.File"],"memberof":"Phaser.Loader.FileTypes","since":"3.0.0","params":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"A reference to the Loader that is responsible for this file.","name":"loader"},{"type":{"names":["string","Phaser.Types.Loader.FileTypes.XMLFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"scope":"static","longname":"Phaser.Loader.FileTypes.XMLFile","___s":true},{"meta":{"filename":"XMLFile.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Called automatically by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data.","kind":"function","name":"onProcess","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#onProcess","scope":"instance","overrides":"Phaser.Loader.File#onProcess","___s":true},{"meta":{"filename":"XMLFile.js","lineno":94,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"description":"Adds an XML file, or array of XML files, to the current load queue.\n\nYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\n\n```javascript\nfunction preload ()\n{\n this.load.xml('wavedata', 'files/AlienWaveData.xml');\n}\n```\n\nThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\nor if it's already running, when the next free load slot becomes available. This happens automatically if you\nare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\nit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\nThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\nScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\nloaded.\n\nThe key must be a unique String. It is used to add the file to the global XML Cache upon a successful load.\nThe key should be unique both in terms of files being loaded and files already present in the XML Cache.\nLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\nthen remove it from the XML Cache first, before loading a new one.\n\nInstead of passing arguments you can pass a configuration object, such as:\n\n```javascript\nthis.load.xml({\n key: 'wavedata',\n url: 'files/AlienWaveData.xml'\n});\n```\n\nSee the documentation for `Phaser.Types.Loader.FileTypes.XMLFileConfig` for more details.\n\nOnce the file has finished loading you can access it from its Cache using its key:\n\n```javascript\nthis.load.xml('wavedata', 'files/AlienWaveData.xml');\n// and later in your game ...\nvar data = this.cache.xml.get('wavedata');\n```\n\nIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\nkey. For example, if the prefix was `LEVEL1.` and the key was `Waves` the final key will be `LEVEL1.Waves` and\nthis is what you would use to retrieve the text from the XML Cache.\n\nThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\n\nIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"data\"\nand no URL is given then the Loader will set the URL to be \"data.xml\". It will always add `.xml` as the extension, although\nthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\n\nNote: The ability to load this type of file will only be available if the XML File type has been built into Phaser.\nIt is available in the default build but can be excluded from custom builds.","kind":"function","name":"xml","fires":["Phaser.Loader.LoaderPlugin#event:addFileEvent"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.XMLFileConfig","Array."]},"description":"The key to use for this file, or a file configuration object, or array of them.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load this file from. If undefined or `null` it will be set to `.xml`, i.e. if `key` was \"alien\" then the URL will be \"alien.xml\".","name":"url"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.","name":"xhrSettings"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"The Loader instance."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#xml","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes"},"kind":"namespace","name":"FileTypes","memberof":"Phaser.Loader","longname":"Phaser.Loader.FileTypes","scope":"static","___s":true},{"meta":{"filename":"AtlasJSONFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"AtlasJSONFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture image file from.","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'png'","description":"The default file extension to use for the image texture if no url is provided.","name":"textureExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the texture image file.","name":"textureXhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"The filename of an associated normal map. It uses the same path and url to load as the texture image.","name":"normalMap"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the atlas json file from. Or a well formed JSON object to use instead.","name":"atlasURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'json'","description":"The default file extension to use for the atlas json if no url is provided.","name":"atlasExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the atlas json file.","name":"atlasXhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig","scope":"static","___s":true},{"meta":{"filename":"AtlasXMLFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"AtlasXMLFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture image file from.","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'png'","description":"The default file extension to use for the image texture if no url is provided.","name":"textureExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the texture image file.","name":"textureXhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"The filename of an associated normal map. It uses the same path and url to load as the texture image.","name":"normalMap"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the atlas xml file from.","name":"atlasURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'xml'","description":"The default file extension to use for the atlas xml if no url is provided.","name":"atlasExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the atlas xml file.","name":"atlasXhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig","scope":"static","___s":true},{"meta":{"filename":"AudioFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"AudioFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within the Loader and Audio Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"urlConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["AudioContext"]},"optional":true,"description":"The AudioContext this file will use to process itself.","name":"audioContext"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.AudioFileConfig","scope":"static","___s":true},{"meta":{"filename":"AudioSpriteFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"AudioSpriteFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Audio Cache.","name":"key"},{"type":{"names":["string"]},"description":"The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.","name":"jsonURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the json file.","name":"jsonXhrSettings"},{"type":{"names":["Object"]},"optional":true,"description":"The absolute or relative URL to load the audio file from.","name":"audioURL"},{"type":{"names":["any"]},"optional":true,"description":"The audio configuration options.","name":"audioConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the audio file.","name":"audioXhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig","scope":"static","___s":true},{"meta":{"filename":"BinaryFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"BinaryFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Binary Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'bin'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["any"]},"optional":true,"description":"Optional type to cast the binary file to once loaded. For example, `Uint8Array`.","name":"dataType"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.BinaryFileConfig","scope":"static","___s":true},{"meta":{"filename":"BitmapFontFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"BitmapFontFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture image file from.","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'png'","description":"The default file extension to use for the image texture if no url is provided.","name":"textureExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the texture image file.","name":"textureXhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"The filename of an associated normal map. It uses the same path and url to load as the texture image.","name":"normalMap"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the font data xml file from.","name":"fontDataURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'xml'","description":"The default file extension to use for the font data xml if no url is provided.","name":"fontDataExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the font data xml file.","name":"fontDataXhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.BitmapFontFileConfig","scope":"static","___s":true},{"meta":{"filename":"CSSFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"CSSFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within the Loader.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'js'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.CSSFileConfig","scope":"static","___s":true},{"meta":{"filename":"GLSLFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"GLSLFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Text Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'fragment'","description":"The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.","name":"shaderType"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'glsl'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.GLSLFileConfig","scope":"static","___s":true},{"meta":{"filename":"HTMLFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"HTMLFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Text Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'html'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.HTMLFileConfig","scope":"static","___s":true},{"meta":{"filename":"HTMLTextureFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"HTMLTextureFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'html'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":512,"description":"The width of the texture the HTML will be rendered to.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":512,"description":"The height of the texture the HTML will be rendered to.","name":"height"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig","scope":"static","___s":true},{"meta":{"filename":"ImageFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"ImageFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'png'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["string"]},"optional":true,"description":"The filename of an associated normal map. It uses the same path and url to load as the image.","name":"normalMap"},{"type":{"names":["Phaser.Types.Loader.FileTypes.ImageFrameConfig"]},"optional":true,"description":"The frame configuration object. Only provided for, and used by, Sprite Sheets.","name":"frameConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.ImageFileConfig","scope":"static","___s":true},{"meta":{"filename":"ImageFrameConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"ImageFrameConfig","type":{"names":["object"]},"properties":[{"type":{"names":["integer"]},"description":"The width of the frame in pixels.","name":"frameWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the frame in pixels. Uses the `frameWidth` value if not provided.","name":"frameHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The first frame to start parsing from.","name":"startFrame"},{"type":{"names":["integer"]},"optional":true,"description":"The frame to stop parsing at. If not provided it will calculate the value based on the image and frame dimensions.","name":"endFrame"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The margin in the image. This is the space around the edge of the frames.","name":"margin"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The spacing between each frame in the image.","name":"spacing"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.ImageFrameConfig","scope":"static","___s":true},{"meta":{"filename":"JSONFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"JSONFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the JSON Cache.","name":"key"},{"type":{"names":["string","any"]},"optional":true,"description":"The absolute or relative URL to load the file from. Or can be a ready formed JSON object, in which case it will be directly added to the Cache.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'json'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["string"]},"optional":true,"description":"If specified instead of the whole JSON file being parsed and added to the Cache, only the section corresponding to this property key will be added. If the property you want to extract is nested, use periods to divide it.","name":"dataKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.JSONFileConfig","scope":"static","___s":true},{"meta":{"filename":"MultiAtlasFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"MultiAtlasFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the multi atlas json file from. Or, a well formed JSON object.","name":"atlasURL"},{"type":{"names":["string"]},"optional":true,"description":"An alias for 'atlasURL'. If given, it overrides anything set in 'atlasURL'.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'json'","description":"The default file extension to use for the atlas json if no url is provided.","name":"atlasExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the atlas json file.","name":"atlasXhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"Optional path to use when loading the textures defined in the atlas data.","name":"path"},{"type":{"names":["string"]},"optional":true,"description":"Optional Base URL to use when loading the textures defined in the atlas data.","name":"baseURL"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the texture files.","name":"textureXhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig","scope":"static","___s":true},{"meta":{"filename":"MultiScriptFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"MultiScriptFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within the Loader.","name":"key"},{"type":{"names":["Array."]},"optional":true,"description":"An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'js'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for these files.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.MultiScriptFileConfig","scope":"static","___s":true},{"meta":{"filename":"PackFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"PackFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the JSON Cache.","name":"key"},{"type":{"names":["string","any"]},"optional":true,"description":"The absolute or relative URL to load the file from. Or can be a ready formed JSON object, in which case it will be directly processed.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'json'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["string"]},"optional":true,"description":"If specified instead of the whole JSON file being parsed, only the section corresponding to this property key will be added. If the property you want to extract is nested, use periods to divide it.","name":"dataKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.PackFileConfig","scope":"static","___s":true},{"meta":{"filename":"PluginFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"PluginFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within the Loader.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'js'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Automatically start the plugin after loading?","name":"start"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Scene, this is the property key used.","name":"mapping"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.PluginFileConfig","scope":"static","___s":true},{"meta":{"filename":"SVGFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"SVGFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'svg'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"},{"type":{"names":["Phaser.Types.Loader.FileTypes.SVGSizeConfig"]},"optional":true,"description":"The svg size configuration object.","name":"svgConfig"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.SVGFileConfig","scope":"static","___s":true},{"meta":{"filename":"SVGSizeConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"SVGSizeConfig","type":{"names":["object"]},"properties":[{"type":{"names":["integer"]},"optional":true,"description":"An optional width. The SVG will be resized to this size before being rendered to a texture.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"An optional height. The SVG will be resized to this size before being rendered to a texture.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"An optional scale. If given it overrides the width / height properties. The SVG is scaled by the scale factor before being rendered to a texture.","name":"scale"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.SVGSizeConfig","scope":"static","___s":true},{"meta":{"filename":"SceneFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"SceneFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Text Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'txt'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.SceneFileConfig","scope":"static","___s":true},{"meta":{"filename":"ScenePluginFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"ScenePluginFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within the Loader.","name":"key"},{"type":{"names":["string","function"]},"optional":true,"description":"The absolute or relative URL to load the file from. Or, a Scene Plugin.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'js'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be added to Scene.Systems, this is the property key for it.","name":"systemKey"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be added to the Scene, this is the property key for it.","name":"sceneKey"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.ScenePluginFileConfig","scope":"static","___s":true},{"meta":{"filename":"ScriptFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"ScriptFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within the Loader.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'js'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.ScriptFileConfig","scope":"static","___s":true},{"meta":{"filename":"SpriteSheetFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"SpriteSheetFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'png'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["string"]},"optional":true,"description":"The filename of an associated normal map. It uses the same path and url to load as the image.","name":"normalMap"},{"type":{"names":["Phaser.Types.Loader.FileTypes.ImageFrameConfig"]},"optional":true,"description":"The frame configuration object.","name":"frameConfig"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig","scope":"static","___s":true},{"meta":{"filename":"TextFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"TextFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Text Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'txt'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.TextFileConfig","scope":"static","___s":true},{"meta":{"filename":"TilemapCSVFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"TilemapCSVFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Tilemap Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'csv'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig","scope":"static","___s":true},{"meta":{"filename":"TilemapImpactFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"TilemapImpactFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Tilemap Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'json'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig","scope":"static","___s":true},{"meta":{"filename":"TilemapJSONFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"TilemapJSONFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Tilemap Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'json'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig","scope":"static","___s":true},{"meta":{"filename":"UnityAtlasFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"UnityAtlasFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Texture Manager.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the texture image file from.","name":"textureURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'png'","description":"The default file extension to use for the image texture if no url is provided.","name":"textureExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the texture image file.","name":"textureXhrSettings"},{"type":{"names":["string"]},"optional":true,"description":"The filename of an associated normal map. It uses the same path and url to load as the texture image.","name":"normalMap"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the atlas data file from.","name":"atlasURL"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'txt'","description":"The default file extension to use for the atlas data if no url is provided.","name":"atlasExtension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for the atlas data file.","name":"atlasXhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig","scope":"static","___s":true},{"meta":{"filename":"VideoFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"VideoFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string","Phaser.Types.Loader.FileTypes.VideoFileConfig"]},"description":"The key to use for this file, or a file configuration object.","name":"key"},{"type":{"names":["any"]},"optional":true,"description":"The absolute or relative URL to load this file from in a config object.","name":"urlConfig"},{"type":{"names":["string"]},"optional":true,"description":"The load event to listen for when _not_ loading as a blob. Either 'loadeddata', 'canplay' or 'canplaythrough'.","name":"loadEvent"},{"type":{"names":["boolean"]},"optional":true,"description":"Load the video as a data blob, or via the Video element?","name":"asBlob"},{"type":{"names":["boolean"]},"optional":true,"description":"Does the video have an audio track? If not you can enable auto-playing on it.","name":"noAudio"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.VideoFileConfig","scope":"static","___s":true},{"meta":{"filename":"XMLFileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"typedef","name":"XMLFileConfig","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"description":"The key of the file. Must be unique within both the Loader and the Text Cache.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The absolute or relative URL to load the file from.","name":"url"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'xml'","description":"The default file extension to use if no url is provided.","name":"extension"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"optional":true,"description":"Extra XHR Settings specifically for this file.","name":"xhrSettings"}],"memberof":"Phaser.Types.Loader.FileTypes","longname":"Phaser.Types.Loader.FileTypes.XMLFileConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs"},"kind":"namespace","name":"FileTypes","memberof":"Phaser.Types.Loader","longname":"Phaser.Types.Loader.FileTypes","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"kind":"namespace","name":"Loader","memberof":"Phaser","longname":"Phaser.Loader","scope":"static","___s":true},{"meta":{"filename":"FileConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/typedefs"},"kind":"typedef","name":"FileConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type"},{"type":{"names":["string"]},"description":"Unique cache key (unique within its file type)","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The URL of the file, not including baseURL.","name":"url"},{"type":{"names":["string"]},"optional":true,"description":"The path of the file, not including the baseURL.","name":"path"},{"type":{"names":["string"]},"optional":true,"description":"The default extension this file uses.","name":"extension"},{"type":{"names":["XMLHttpRequestResponseType"]},"optional":true,"description":"The responseType to be used by the XHR request.","name":"responseType"},{"type":{"names":["Phaser.Types.Loader.XHRSettingsObject","false"]},"optional":true,"defaultvalue":false,"description":"Custom XHR Settings specific to this file and merged with the Loader defaults.","name":"xhrSettings"},{"type":{"names":["any"]},"optional":true,"description":"A config object that can be used by file types to store transitional data.","name":"config"}],"memberof":"Phaser.Types.Loader","longname":"Phaser.Types.Loader.FileConfig","scope":"static","___s":true},{"meta":{"filename":"XHRSettingsObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/typedefs"},"kind":"typedef","name":"XHRSettingsObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["XMLHttpRequestResponseType"]},"description":"The response type of the XHR request, i.e. `blob`, `text`, etc.","name":"responseType"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the XHR request use async or not?","name":"async"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"Optional username for the XHR request.","name":"user"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"Optional password for the XHR request.","name":"password"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optional XHR timeout value.","name":"timeout"},{"type":{"names":["string","undefined"]},"optional":true,"description":"This value is used to populate the XHR `setRequestHeader` and is undefined by default.","name":"header"},{"type":{"names":["string","undefined"]},"optional":true,"description":"This value is used to populate the XHR `setRequestHeader` and is undefined by default.","name":"headerValue"},{"type":{"names":["string","undefined"]},"optional":true,"description":"This value is used to populate the XHR `setRequestHeader` and is undefined by default.","name":"requestedWith"},{"type":{"names":["string","undefined"]},"optional":true,"description":"Provide a custom mime-type to use instead of the default.","name":"overrideMimeType"}],"memberof":"Phaser.Types.Loader","longname":"Phaser.Types.Loader.XHRSettingsObject","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/loader/typedefs"},"kind":"namespace","name":"Loader","memberof":"Phaser.Types","longname":"Phaser.Types.Loader","scope":"static","___s":true},{"meta":{"filename":"Average.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the mean average of the given values.","kind":"function","name":"Average","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The values to average.","name":"values"}],"returns":[{"type":{"names":["number"]},"description":"The average value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Average","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Bernstein.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"Factorial","longname":"Factorial","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Bernstein.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"[description]","kind":"function","name":"Bernstein","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"n"},{"type":{"names":["number"]},"description":"[description]","name":"i"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Math","longname":"Phaser.Math.Bernstein","scope":"static","___s":true},{"meta":{"filename":"Between.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Compute a random integer between the `min` and `max` values, inclusive.","kind":"function","name":"Between","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The minimum value.","name":"min"},{"type":{"names":["integer"]},"description":"The maximum value.","name":"max"}],"returns":[{"type":{"names":["integer"]},"description":"The random integer."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Between","scope":"static","___s":true},{"meta":{"filename":"CatmullRom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculates a Catmull-Rom value.","kind":"function","name":"CatmullRom","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"t"},{"type":{"names":["number"]},"description":"[description]","name":"p0"},{"type":{"names":["number"]},"description":"[description]","name":"p1"},{"type":{"names":["number"]},"description":"[description]","name":"p2"},{"type":{"names":["number"]},"description":"[description]","name":"p3"}],"returns":[{"type":{"names":["number"]},"description":"The Catmull-Rom value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.CatmullRom","scope":"static","___s":true},{"meta":{"filename":"CeilTo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Ceils to some place comparative to a `base`, default is 10 for decimal place.\n\nThe `place` is represented by the power applied to `base` to get that place.","kind":"function","name":"CeilTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to round.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The place to round to.","name":"place"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The base to round in. Default is 10 for decimal.","name":"base"}],"returns":[{"type":{"names":["number"]},"description":"The rounded value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.CeilTo","scope":"static","___s":true},{"meta":{"filename":"Clamp.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Force a value within the boundaries by clamping it to the range `min`, `max`.","kind":"function","name":"Clamp","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be clamped.","name":"value"},{"type":{"names":["number"]},"description":"The minimum bounds.","name":"min"},{"type":{"names":["number"]},"description":"The maximum bounds.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The clamped value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Clamp","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"DegToRad.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DegToRad.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Convert the given angle from degrees, to the equivalent angle in radians.","kind":"function","name":"DegToRad","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The angle (in degrees) to convert to radians.","name":"degrees"}],"returns":[{"type":{"names":["number"]},"description":"The given angle converted to radians."}],"memberof":"Phaser.Math","longname":"Phaser.Math.DegToRad","scope":"static","___s":true},{"meta":{"filename":"Difference.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculates the positive difference of two given numbers.","kind":"function","name":"Difference","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first number in the calculation.","name":"a"},{"type":{"names":["number"]},"description":"The second number in the calculation.","name":"b"}],"returns":[{"type":{"names":["number"]},"description":"The positive difference of the two given numbers."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Difference","scope":"static","___s":true},{"meta":{"filename":"Factorial.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculates the factorial of a given number for integer values greater than 0.","kind":"function","name":"Factorial","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A positive integer to calculate the factorial of.","name":"value"}],"returns":[{"type":{"names":["number"]},"description":"The factorial of the given number."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Factorial","scope":"static","___s":true},{"meta":{"filename":"FloatBetween.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a random floating point number between the two given bounds, minimum inclusive, maximum exclusive.","kind":"function","name":"FloatBetween","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The lower bound for the float, inclusive.","name":"min"},{"type":{"names":["number"]},"description":"The upper bound for the float exclusive.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"A random float within the given range."}],"memberof":"Phaser.Math","longname":"Phaser.Math.FloatBetween","scope":"static","___s":true},{"meta":{"filename":"FloorTo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Floors to some place comparative to a `base`, default is 10 for decimal place.\n\nThe `place` is represented by the power applied to `base` to get that place.","kind":"function","name":"FloorTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to round.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The place to round to.","name":"place"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The base to round in. Default is 10 for decimal.","name":"base"}],"returns":[{"type":{"names":["number"]},"description":"The rounded value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.FloorTo","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"FromPercent.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FromPercent.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Return a value based on the range between `min` and `max` and the percentage given.","kind":"function","name":"FromPercent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1 representing the percentage.","name":"percent"},{"type":{"names":["number"]},"description":"The minimum value.","name":"min"},{"type":{"names":["number"]},"optional":true,"description":"The maximum value.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The value that is `percent` percent between `min` and `max`."}],"memberof":"Phaser.Math","longname":"Phaser.Math.FromPercent","scope":"static","___s":true},{"meta":{"filename":"GetSpeed.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate a per-ms speed from a distance and time (given in seconds).","kind":"function","name":"GetSpeed","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The distance.","name":"distance"},{"type":{"names":["integer"]},"description":"The time, in seconds.","name":"time"}],"returns":[{"type":{"names":["number"]},"description":"The speed, in distance per ms."}],"examples":["// 400px over 1 second is 0.4 px/ms\nPhaser.Math.GetSpeed(400, 1) // -> 0.4"],"memberof":"Phaser.Math","longname":"Phaser.Math.GetSpeed","scope":"static","___s":true},{"meta":{"filename":"IsEven.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Check if a given value is an even number.","kind":"function","name":"IsEven","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number to perform the check with.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the number is even or not."}],"memberof":"Phaser.Math","longname":"Phaser.Math.IsEven","scope":"static","___s":true},{"meta":{"filename":"IsEvenStrict.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Check if a given value is an even number using a strict type check.","kind":"function","name":"IsEvenStrict","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number to perform the check with.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the number is even or not."}],"memberof":"Phaser.Math","longname":"Phaser.Math.IsEvenStrict","scope":"static","___s":true},{"meta":{"filename":"Linear.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculates a linear (interpolation) value over t.","kind":"function","name":"Linear","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first point.","name":"p0"},{"type":{"names":["number"]},"description":"The second point.","name":"p1"},{"type":{"names":["number"]},"description":"The percentage between p0 and p1 to return, represented as a number between 0 and 1.","name":"t"}],"returns":[{"type":{"names":["number"]},"description":"The step t% of the way between p0 and p1."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Linear","scope":"static","___s":true},{"meta":{"filename":"Matrix3.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"classdesc":"A three-dimensional matrix.\n\nDefaults to the identity matrix when instantiated.","kind":"class","name":"Matrix3","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"optional":true,"description":"Optional Matrix3 to copy values from.","name":"m"}],"scope":"static","longname":"Phaser.Math.Matrix3","___s":true},{"meta":{"filename":"Matrix3.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The matrix values.","name":"val","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#val","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Matrix3.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make a clone of this Matrix3.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"A clone of this Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#clone","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":65,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"This method is an alias for `Matrix3.copy`.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"The Matrix to set the values of this Matrix's from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#set","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the values of a given Matrix into this Matrix.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"The Matrix to copy the values from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#copy","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the values of a given Matrix4 into this Matrix3.","kind":"function","name":"fromMat4","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix4 to copy the values from.","name":"m"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#fromMat4","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the values of this Matrix from the given array.","kind":"function","name":"fromArray","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to copy the values from.","name":"a"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#fromArray","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":163,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Reset this Matrix to an identity (default) matrix.","kind":"function","name":"identity","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#identity","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transpose this Matrix.","kind":"function","name":"transpose","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#transpose","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Invert this Matrix.","kind":"function","name":"invert","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#invert","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":262,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the adjoint, or adjugate, of this Matrix.","kind":"function","name":"adjoint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#adjoint","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the determinant of this Matrix.","kind":"function","name":"determinant","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The determinant of this Matrix."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#determinant","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":322,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Multiply this Matrix by the given Matrix.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"The Matrix to multiply this Matrix by.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#multiply","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Translate this Matrix using the given Vector.","kind":"function","name":"translate","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to translate this Matrix with.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#translate","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":396,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Apply a rotation transformation to this Matrix.","kind":"function","name":"rotate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle in radians to rotate by.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#rotate","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Apply a scale transformation to this Matrix.\n\nUses the `x` and `y` components of the given Vector to scale the Matrix.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to scale this Matrix with.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#scale","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the values of this Matrix from the given Quaternion.","kind":"function","name":"fromQuat","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"The Quaternion to set the values of this Matrix from.","name":"q"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#fromQuat","scope":"instance","___s":true},{"meta":{"filename":"Matrix3.js","lineno":510,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"[description]","kind":"function","name":"normalFromMat4","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"[description]","name":"m"}],"returns":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"This Matrix3."}],"memberof":"Phaser.Math.Matrix3","longname":"Phaser.Math.Matrix3#normalFromMat4","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"classdesc":"A four-dimensional matrix.","kind":"class","name":"Matrix4","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"optional":true,"description":"Optional Matrix4 to copy values from.","name":"m"}],"scope":"static","longname":"Phaser.Math.Matrix4","___s":true},{"meta":{"filename":"Matrix4.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The matrix values.","name":"val","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#val","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Matrix4.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make a clone of this Matrix4.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"A clone of this Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#clone","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"This method is an alias for `Matrix4.copy`.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix to set the values of this Matrix's from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#set","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the values of a given Matrix into this Matrix.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix to copy the values from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#copy","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the values of this Matrix from the given array.","kind":"function","name":"fromArray","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to copy the values from.","name":"a"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#fromArray","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":151,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Reset this Matrix.\n\nSets all values to `0`.","kind":"function","name":"zero","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#zero","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the `x`, `y` and `z` values of this Matrix.","kind":"function","name":"xyz","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x value.","name":"x"},{"type":{"names":["number"]},"description":"The y value.","name":"y"},{"type":{"names":["number"]},"description":"The z value.","name":"z"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#xyz","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":210,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the scaling values of this Matrix.","kind":"function","name":"scaling","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x scaling value.","name":"x"},{"type":{"names":["number"]},"description":"The y scaling value.","name":"y"},{"type":{"names":["number"]},"description":"The z scaling value.","name":"z"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#scaling","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":236,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Reset this Matrix to an identity (default) matrix.","kind":"function","name":"identity","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#identity","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transpose this Matrix.","kind":"function","name":"transpose","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#transpose","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":303,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Invert this Matrix.","kind":"function","name":"invert","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#invert","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":380,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the adjoint, or adjugate, of this Matrix.","kind":"function","name":"adjoint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#adjoint","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the determinant of this Matrix.","kind":"function","name":"determinant","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The determinant of this Matrix."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#determinant","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":481,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Multiply this Matrix by the given Matrix.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix to multiply this Matrix by.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#multiply","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":561,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"[description]","kind":"function","name":"multiplyLocal","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"[description]","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#multiplyLocal","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":600,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Translate this Matrix using the given Vector.","kind":"function","name":"translate","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to translate this Matrix with.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#translate","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Translate this Matrix using the given values.","kind":"function","name":"translateXYZ","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The x component.","name":"x"},{"type":{"names":["number"]},"description":"The y component.","name":"y"},{"type":{"names":["number"]},"description":"The z component.","name":"z"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#translateXYZ","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":649,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Apply a scale transformation to this Matrix.\n\nUses the `x`, `y` and `z` components of the given Vector to scale the Matrix.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to scale this Matrix with.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#scale","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":686,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Apply a scale transformation to this Matrix.","kind":"function","name":"scaleXYZ","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The x component.","name":"x"},{"type":{"names":["number"]},"description":"The y component.","name":"y"},{"type":{"names":["number"]},"description":"The z component.","name":"z"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#scaleXYZ","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":720,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Derive a rotation matrix around the given axis.","kind":"function","name":"makeRotationAxis","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The rotation axis.","name":"axis"},{"type":{"names":["number"]},"description":"The rotation angle in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#makeRotationAxis","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":754,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Apply a rotation transformation to this Matrix.","kind":"function","name":"rotate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle in radians to rotate by.","name":"rad"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The axis to rotate upon.","name":"axis"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#rotate","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":832,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate this matrix on its X axis.","kind":"function","name":"rotateX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle in radians to rotate by.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#rotateX","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":871,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate this matrix on its Y axis.","kind":"function","name":"rotateY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#rotateY","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":910,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate this matrix on its Z axis.","kind":"function","name":"rotateZ","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#rotateZ","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":949,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the values of this Matrix from the given rotation Quaternion and translation Vector.","kind":"function","name":"fromRotationTranslation","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"The Quaternion to set rotation from.","name":"q"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The Vector to set translation from.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#fromRotationTranslation","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1009,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the values of this Matrix from the given Quaternion.","kind":"function","name":"fromQuat","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"The Quaternion to set the values of this Matrix from.","name":"q"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#fromQuat","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1067,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a frustum matrix with the given bounds.","kind":"function","name":"frustum","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The left bound of the frustum.","name":"left"},{"type":{"names":["number"]},"description":"The right bound of the frustum.","name":"right"},{"type":{"names":["number"]},"description":"The bottom bound of the frustum.","name":"bottom"},{"type":{"names":["number"]},"description":"The top bound of the frustum.","name":"top"},{"type":{"names":["number"]},"description":"The near bound of the frustum.","name":"near"},{"type":{"names":["number"]},"description":"The far bound of the frustum.","name":"far"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#frustum","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1113,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a perspective projection matrix with the given bounds.","kind":"function","name":"perspective","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Vertical field of view in radians","name":"fovy"},{"type":{"names":["number"]},"description":"Aspect ratio. Typically viewport width /height.","name":"aspect"},{"type":{"names":["number"]},"description":"Near bound of the frustum.","name":"near"},{"type":{"names":["number"]},"description":"Far bound of the frustum.","name":"far"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#perspective","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a perspective projection matrix with the given bounds.","kind":"function","name":"perspectiveLH","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the frustum.","name":"width"},{"type":{"names":["number"]},"description":"The height of the frustum.","name":"height"},{"type":{"names":["number"]},"description":"Near bound of the frustum.","name":"near"},{"type":{"names":["number"]},"description":"Far bound of the frustum.","name":"far"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#perspectiveLH","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate an orthogonal projection matrix with the given bounds.","kind":"function","name":"ortho","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The left bound of the frustum.","name":"left"},{"type":{"names":["number"]},"description":"The right bound of the frustum.","name":"right"},{"type":{"names":["number"]},"description":"The bottom bound of the frustum.","name":"bottom"},{"type":{"names":["number"]},"description":"The top bound of the frustum.","name":"top"},{"type":{"names":["number"]},"description":"The near bound of the frustum.","name":"near"},{"type":{"names":["number"]},"description":"The far bound of the frustum.","name":"far"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#ortho","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a look-at matrix with the given eye position, focal point, and up axis.","kind":"function","name":"lookAt","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"Position of the viewer","name":"eye"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"Point the viewer is looking at","name":"center"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"vec3 pointing up.","name":"up"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#lookAt","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1353,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the values of this matrix from the given `yaw`, `pitch` and `roll` values.","kind":"function","name":"yawPitchRoll","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"yaw"},{"type":{"names":["number"]},"description":"[description]","name":"pitch"},{"type":{"names":["number"]},"description":"[description]","name":"roll"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#yawPitchRoll","scope":"instance","___s":true},{"meta":{"filename":"Matrix4.js","lineno":1414,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a world matrix from the given rotation, position, scale, view matrix and projection matrix.","kind":"function","name":"setWorldMatrix","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The rotation of the world matrix.","name":"rotation"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The position of the world matrix.","name":"position"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The scale of the world matrix.","name":"scale"},{"type":{"names":["Phaser.Math.Matrix4"]},"optional":true,"description":"The view matrix.","name":"viewMatrix"},{"type":{"names":["Phaser.Math.Matrix4"]},"optional":true,"description":"The projection matrix.","name":"projectionMatrix"}],"returns":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"This Matrix4."}],"memberof":"Phaser.Math.Matrix4","longname":"Phaser.Math.Matrix4#setWorldMatrix","scope":"instance","___s":true},{"meta":{"filename":"MaxAdd.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Add an `amount` to a `value`, limiting the maximum result to `max`.","kind":"function","name":"MaxAdd","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to add to.","name":"value"},{"type":{"names":["number"]},"description":"The amount to add.","name":"amount"},{"type":{"names":["number"]},"description":"The maximum value to return.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The resulting value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.MaxAdd","scope":"static","___s":true},{"meta":{"filename":"MinSub.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Subtract an `amount` from `value`, limiting the minimum result to `min`.","kind":"function","name":"MinSub","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to subtract from.","name":"value"},{"type":{"names":["number"]},"description":"The amount to subtract.","name":"amount"},{"type":{"names":["number"]},"description":"The minimum value to return.","name":"min"}],"returns":[{"type":{"names":["number"]},"description":"The resulting value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.MinSub","scope":"static","___s":true},{"meta":{"filename":"Percent.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Work out what percentage `value` is of the range between `min` and `max`.\nIf `max` isn't given then it will return the percentage of `value` to `min`.\n\nYou can optionally specify an `upperMax` value, which is a mid-way point in the range that represents 100%, after which the % starts to go down to zero again.","kind":"function","name":"Percent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to determine the percentage of.","name":"value"},{"type":{"names":["number"]},"description":"The minimum value.","name":"min"},{"type":{"names":["number"]},"optional":true,"description":"The maximum value.","name":"max"},{"type":{"names":["number"]},"optional":true,"description":"The mid-way point in the range that represents 100%.","name":"upperMax"}],"returns":[{"type":{"names":["number"]},"description":"A value between 0 and 1 representing the percentage."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Percent","scope":"static","___s":true},{"meta":{"filename":"Quaternion.js","lineno":26,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"classdesc":"A quaternion.","kind":"class","name":"Quaternion","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x component.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y component.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The z component.","name":"z"},{"type":{"names":["number"]},"optional":true,"description":"The w component.","name":"w"}],"scope":"static","longname":"Phaser.Math.Quaternion","___s":true},{"meta":{"filename":"Quaternion.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The x component of this Quaternion.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quaternion.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The y component of this Quaternion.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quaternion.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The z component of this Quaternion.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#z","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quaternion.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The w component of this Quaternion.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#w","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Quaternion.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the components of a given Quaternion or Vector into this Quaternion.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to copy the components from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#copy","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":118,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the components of this Quaternion.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["number","object"]},"optional":true,"defaultvalue":0,"description":"The x component, or an object containing x, y, z, and w components.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y component.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z component.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w component.","name":"w"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#set","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":151,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Add a given Quaternion or Vector to this Quaternion. Addition is component-wise.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to add to this Quaternion.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#add","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":171,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Subtract a given Quaternion or Vector from this Quaternion. Subtraction is component-wise.","kind":"function","name":"subtract","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to subtract from this Quaternion.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#subtract","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Scale this Quaternion by the given value.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to scale this Quaternion by.","name":"scale"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#scale","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":211,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length of this Quaternion.","kind":"function","name":"length","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#length","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length of this Quaternion squared.","kind":"function","name":"lengthSq","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Quaternion, squared."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#lengthSq","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":247,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Normalize this Quaternion.","kind":"function","name":"normalize","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#normalize","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":276,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the dot product of this Quaternion and the given Quaternion or Vector.","kind":"function","name":"dot","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to dot product with this Quaternion.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The dot product of this Quaternion and the given Quaternion or Vector."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#dot","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Linearly interpolate this Quaternion towards the given Quaternion or Vector.","kind":"function","name":"lerp","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to interpolate towards.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The percentage of interpolation.","name":"t"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#lerp","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"[description]","kind":"function","name":"rotationTo","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"[description]","name":"a"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"[description]","name":"b"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#rotationTo","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":368,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the axes of this Quaternion.","kind":"function","name":"setAxes","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The view axis.","name":"view"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The right axis.","name":"right"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The upwards axis.","name":"up"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#setAxes","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":399,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Reset this Matrix to an identity (default) Quaternion.","kind":"function","name":"identity","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#identity","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":417,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the axis angle of this Quaternion.","kind":"function","name":"setAxisAngle","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The axis.","name":"axis"},{"type":{"names":["number"]},"description":"The angle in radians.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#setAxisAngle","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":442,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Multiply this Quaternion by the given Quaternion or Vector.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to multiply this Quaternion by.","name":"b"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#multiply","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Smoothly linearly interpolate this Quaternion towards the given Quaternion or Vector.","kind":"function","name":"slerp","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion","Phaser.Math.Vector4"]},"description":"The Quaternion or Vector to interpolate towards.","name":"b"},{"type":{"names":["number"]},"description":"The percentage of interpolation.","name":"t"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#slerp","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":535,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Invert this Quaternion.","kind":"function","name":"invert","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#invert","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":563,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Convert this Quaternion into its conjugate.\n\nSets the x, y and z components.","kind":"function","name":"conjugate","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#conjugate","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":582,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate this Quaternion on the X axis.","kind":"function","name":"rotateX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The rotation angle in radians.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#rotateX","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":612,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate this Quaternion on the Y axis.","kind":"function","name":"rotateY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The rotation angle in radians.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#rotateY","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":642,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate this Quaternion on the Z axis.","kind":"function","name":"rotateZ","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The rotation angle in radians.","name":"rad"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#rotateZ","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":672,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Create a unit (or rotation) Quaternion from its x, y, and z components.\n\nSets the w component.","kind":"function","name":"calculateW","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#calculateW","scope":"instance","___s":true},{"meta":{"filename":"Quaternion.js","lineno":693,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Convert the given Matrix into this Quaternion.","kind":"function","name":"fromMat3","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"The Matrix to convert from.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"This Quaternion."}],"memberof":"Phaser.Math.Quaternion","longname":"Phaser.Math.Quaternion#fromMat3","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"RadToDeg.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RadToDeg.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Convert the given angle in radians, to the equivalent angle in degrees.","kind":"function","name":"RadToDeg","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle in radians to convert ot degrees.","name":"radians"}],"returns":[{"type":{"names":["integer"]},"description":"The given angle converted to degrees."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RadToDeg","scope":"static","___s":true},{"meta":{"filename":"RandomXY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Compute a random unit vector.\n\nComputes random values for the given vector between -1 and 1 that can be used to represent a direction.\n\nOptionally accepts a scale value to scale the resulting vector by.","kind":"function","name":"RandomXY","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to compute random values for.","name":"vector"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The scale of the random values.","name":"scale"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The given Vector."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RandomXY","scope":"static","___s":true},{"meta":{"filename":"RandomXYZ.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Compute a random position vector in a spherical area, optionally defined by the given radius.","kind":"function","name":"RandomXYZ","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The Vector to compute random values for.","name":"vec3"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The radius.","name":"radius"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The given Vector."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RandomXYZ","scope":"static","___s":true},{"meta":{"filename":"RandomXYZW.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Compute a random four-dimensional vector.","kind":"function","name":"RandomXYZW","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"The Vector to compute random values for.","name":"vec4"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The scale of the random values.","name":"scale"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"The given Vector."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RandomXYZW","scope":"static","___s":true},{"meta":{"filename":"Rotate.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate a given point by a given angle around the origin (0, 0), in an anti-clockwise direction.","kind":"function","name":"Rotate","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point to be rotated.","name":"point"},{"type":{"names":["number"]},"description":"The angle to be rotated by in an anticlockwise direction.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The given point, rotated by the given angle in an anticlockwise direction."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Rotate","scope":"static","___s":true},{"meta":{"filename":"RotateAround.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate a `point` around `x` and `y` by the given `angle`.","kind":"function","name":"RotateAround","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point to be rotated.","name":"point"},{"type":{"names":["number"]},"description":"The horizontal coordinate to rotate around.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to rotate around.","name":"y"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The given point, rotated by the given angle around the given coordinates."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RotateAround","scope":"static","___s":true},{"meta":{"filename":"RotateAroundDistance.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotate a `point` around `x` and `y` by the given `angle` and `distance`.","kind":"function","name":"RotateAroundDistance","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The point to be rotated.","name":"point"},{"type":{"names":["number"]},"description":"The horizontal coordinate to rotate around.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to rotate around.","name":"y"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"angle"},{"type":{"names":["number"]},"description":"The distance from (x, y) to place the point at.","name":"distance"}],"returns":[{"type":{"names":["Phaser.Geom.Point"]},"description":"The given point."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RotateAroundDistance","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"RotateVec3.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"Vector3","longname":"Vector3","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateVec3.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Rotates a vector in place by axis angle.\n\nThis is the same as transforming a point by an\naxis-angle quaternion, but it has higher precision.","kind":"function","name":"RotateVec3","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The vector to be rotated.","name":"vec"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The axis to rotate around.","name":"axis"},{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The given vector."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RotateVec3","scope":"static","___s":true},{"meta":{"filename":"RoundAwayFromZero.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Round a given number so it is further away from zero. That is, positive numbers are rounded up, and negative numbers are rounded down.","kind":"function","name":"RoundAwayFromZero","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number to round.","name":"value"}],"returns":[{"type":{"names":["number"]},"description":"The rounded number, rounded away from zero."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RoundAwayFromZero","scope":"static","___s":true},{"meta":{"filename":"RoundTo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Round a value to the given precision.\n\nFor example:\n\n```javascript\nRoundTo(123.456, 0) = 123\nRoundTo(123.456, 1) = 120\nRoundTo(123.456, 2) = 100\n```\n\nTo round the decimal, i.e. to round to precision, pass in a negative `place`:\n\n```javascript\nRoundTo(123.456789, 0) = 123\nRoundTo(123.456789, -1) = 123.5\nRoundTo(123.456789, -2) = 123.46\nRoundTo(123.456789, -3) = 123.457\n```","kind":"function","name":"RoundTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to round.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The place to round to. Positive to round the units, negative to round the decimal.","name":"place"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The base to round in. Default is 10 for decimal.","name":"base"}],"returns":[{"type":{"names":["number"]},"description":"The rounded value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.RoundTo","scope":"static","___s":true},{"meta":{"filename":"SinCosTableGenerator.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Generate a series of sine and cosine values.","kind":"function","name":"SinCosTableGenerator","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number of values to generate.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The sine value amplitude.","name":"sinAmp"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The cosine value amplitude.","name":"cosAmp"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The frequency of the values.","name":"frequency"}],"returns":[{"type":{"names":["Phaser.Types.Math.SinCosTable"]},"description":"The generated values."}],"memberof":"Phaser.Math","longname":"Phaser.Math.SinCosTableGenerator","scope":"static","___s":true},{"meta":{"filename":"SmoothStep.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate a smooth interpolation percentage of `x` between `min` and `max`.\n\nThe function receives the number `x` as an argument and returns 0 if `x` is less than or equal to the left edge,\n1 if `x` is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial,\nbetween 0 and 1 otherwise.","kind":"function","name":"SmoothStep","since":"3.0.0","see":["{@link https://en.wikipedia.org/wiki/Smoothstep}"],"params":[{"type":{"names":["number"]},"description":"The input value.","name":"x"},{"type":{"names":["number"]},"description":"The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1."}],"memberof":"Phaser.Math","longname":"Phaser.Math.SmoothStep","scope":"static","___s":true},{"meta":{"filename":"SmootherStep.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate a smoother interpolation percentage of `x` between `min` and `max`.\n\nThe function receives the number `x` as an argument and returns 0 if `x` is less than or equal to the left edge,\n1 if `x` is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial,\nbetween 0 and 1 otherwise.\n\nProduces an even smoother interpolation than {@link Phaser.Math.SmoothStep}.","kind":"function","name":"SmootherStep","since":"3.0.0","see":["{@link https://en.wikipedia.org/wiki/Smoothstep#Variations}"],"params":[{"type":{"names":["number"]},"description":"The input value.","name":"x"},{"type":{"names":["number"]},"description":"The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1."}],"memberof":"Phaser.Math","longname":"Phaser.Math.SmootherStep","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"ToXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"Vector2","longname":"Vector2","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ToXY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Returns a Vector2 containing the x and y position of the given index in a `width` x `height` sized grid.\n\nFor example, in a 6 x 4 grid, index 16 would equal x: 4 y: 2.\n\nIf the given index is out of range an empty Vector2 is returned.","kind":"function","name":"ToXY","since":"3.19.0","params":[{"type":{"names":["integer"]},"description":"The position within the grid to get the x/y value for.","name":"index"},{"type":{"names":["integer"]},"description":"The width of the grid.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the grid.","name":"height"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"An optional Vector2 to store the result in. If not given, a new Vector2 instance will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector2 where the x and y properties contain the given grid index."}],"memberof":"Phaser.Math","longname":"Phaser.Math.ToXY","scope":"static","___s":true},{"meta":{"range":[180,210],"filename":"TransformXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"Vector2","longname":"Vector2","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TransformXY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Takes the `x` and `y` coordinates and transforms them into the same space as\ndefined by the position, rotation and scale values.","kind":"function","name":"TransformXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to be transformed.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to be transformed.","name":"y"},{"type":{"names":["number"]},"description":"Horizontal position of the transform point.","name":"positionX"},{"type":{"names":["number"]},"description":"Vertical position of the transform point.","name":"positionY"},{"type":{"names":["number"]},"description":"Rotation of the transform point, in radians.","name":"rotation"},{"type":{"names":["number"]},"description":"Horizontal scale of the transform point.","name":"scaleX"},{"type":{"names":["number"]},"description":"Vertical scale of the transform point.","name":"scaleY"},{"type":{"names":["Phaser.Math.Vector2","Phaser.Geom.Point","object"]},"optional":true,"description":"The output vector, point or object for the translated coordinates.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Geom.Point","object"]},"description":"The translated point."}],"memberof":"Phaser.Math","longname":"Phaser.Math.TransformXY","scope":"static","___s":true},{"meta":{"filename":"Vector2.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"classdesc":"A representation of a vector in 2D space.\n\nA two-component vector.","kind":"class","name":"Vector2","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["number","Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"The x component, or an object with `x` and `y` properties.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y component.","name":"y"}],"scope":"static","longname":"Phaser.Math.Vector2","___s":true},{"meta":{"filename":"Vector2.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The x component of this Vector.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector2.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The y component of this Vector.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector2.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make a clone of this Vector2.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A clone of this Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#clone","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the components of a given Vector into this Vector.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to copy the components from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#copy","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the component values of this Vector from a given Vector2Like object.","kind":"function","name":"setFromObject","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The object containing the component values to set for this Vector.","name":"obj"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#setFromObject","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":115,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the `x` and `y` components of the this Vector to the given `x` and `y` values.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x value to set for this Vector.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y value to set for this Vector.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#set","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"This method is an alias for `Vector2.set`.","kind":"function","name":"setTo","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The x value to set for this Vector.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y value to set for this Vector.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#setTo","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Sets the `x` and `y` values of this object from a given polar coordinate.","kind":"function","name":"setToPolar","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angular coordinate, in radians.","name":"azimuth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The radial coordinate (length).","name":"radius"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#setToPolar","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Check whether this Vector is equal to a given Vector.\n\nPerforms a strict equality check against each Vector's components.","kind":"function","name":"equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The vector to compare with this Vector.","name":"v"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the given Vector is equal to this Vector."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#equals","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the angle between this Vector and the positive x-axis, in radians.","kind":"function","name":"angle","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The angle between this Vector, and the positive x-axis, given in radians."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#angle","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":212,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Add a given Vector to this Vector. Addition is component-wise.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to add to this Vector.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#add","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":230,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Subtract the given Vector from this Vector. Subtraction is component-wise.","kind":"function","name":"subtract","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to subtract from this Vector.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#subtract","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":248,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Perform a component-wise multiplication between this Vector and the given Vector.\n\nMultiplies this Vector by the given Vector.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to multiply this Vector by.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#multiply","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Scale this Vector by the given value.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to scale this Vector by.","name":"value"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#scale","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":294,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Perform a component-wise division between this Vector and the given Vector.\n\nDivides this Vector by the given Vector.","kind":"function","name":"divide","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to divide this Vector by.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#divide","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Negate the `x` and `y` components of this Vector.","kind":"function","name":"negate","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#negate","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the distance between this Vector and the given Vector.","kind":"function","name":"distance","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to calculate the distance to.","name":"src"}],"returns":[{"type":{"names":["number"]},"description":"The distance from this Vector to the given Vector."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#distance","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":348,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the distance between this Vector and the given Vector, squared.","kind":"function","name":"distanceSq","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector to calculate the distance to.","name":"src"}],"returns":[{"type":{"names":["number"]},"description":"The distance from this Vector to the given Vector, squared."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#distanceSq","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":366,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length (or magnitude) of this Vector.","kind":"function","name":"length","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Vector."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#length","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":382,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length of this Vector squared.","kind":"function","name":"lengthSq","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Vector, squared."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#lengthSq","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":398,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Normalize this Vector.\n\nMakes the vector a unit length vector (magnitude of 1) in the same direction.","kind":"function","name":"normalize","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#normalize","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Right-hand normalize (make unit length) this Vector.","kind":"function","name":"normalizeRightHand","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#normalizeRightHand","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the dot product of this Vector and the given Vector.","kind":"function","name":"dot","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector2 to dot product with this Vector2.","name":"src"}],"returns":[{"type":{"names":["number"]},"description":"The dot product of this Vector and the given Vector."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#dot","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":458,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the cross product of this Vector and the given Vector.","kind":"function","name":"cross","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector2 to cross with this Vector2.","name":"src"}],"returns":[{"type":{"names":["number"]},"description":"The cross product of this Vector and the given Vector."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#cross","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":473,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Linearly interpolate between this Vector and the given Vector.\n\nInterpolates this Vector towards the given Vector.","kind":"function","name":"lerp","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector2 to interpolate towards.","name":"src"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The interpolation percentage, between 0 and 1.","name":"t"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#lerp","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":499,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Matrix.","kind":"function","name":"transformMat3","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"The Matrix3 to transform this Vector2 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#transformMat3","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":521,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Matrix.","kind":"function","name":"transformMat4","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix4 to transform this Vector2 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#transformMat4","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":543,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make this Vector the zero vector (0, 0).","kind":"function","name":"reset","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"This Vector2."}],"memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2#reset","scope":"instance","___s":true},{"meta":{"filename":"Vector2.js","lineno":561,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static zero Vector2 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"ZERO","type":{"names":["Phaser.Math.Vector2"]},"since":"3.1.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2.ZERO","scope":"static","___s":true},{"meta":{"filename":"Vector2.js","lineno":573,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static right Vector2 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"RIGHT","type":{"names":["Phaser.Math.Vector2"]},"since":"3.16.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2.RIGHT","scope":"static","___s":true},{"meta":{"filename":"Vector2.js","lineno":585,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static left Vector2 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"LEFT","type":{"names":["Phaser.Math.Vector2"]},"since":"3.16.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2.LEFT","scope":"static","___s":true},{"meta":{"filename":"Vector2.js","lineno":597,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static up Vector2 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"UP","type":{"names":["Phaser.Math.Vector2"]},"since":"3.16.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2.UP","scope":"static","___s":true},{"meta":{"filename":"Vector2.js","lineno":609,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static down Vector2 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"DOWN","type":{"names":["Phaser.Math.Vector2"]},"since":"3.16.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2.DOWN","scope":"static","___s":true},{"meta":{"filename":"Vector2.js","lineno":621,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static one Vector2 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"ONE","type":{"names":["Phaser.Math.Vector2"]},"since":"3.16.0","memberof":"Phaser.Math.Vector2","longname":"Phaser.Math.Vector2.ONE","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"classdesc":"A representation of a vector in 3D space.\n\nA three-component vector.","kind":"class","name":"Vector3","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x component.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y component.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The z component.","name":"z"}],"scope":"static","longname":"Phaser.Math.Vector3","___s":true},{"meta":{"filename":"Vector3.js","lineno":33,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The x component of this Vector.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector3.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The y component of this Vector.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector3.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The z component of this Vector.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#z","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector3.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set this Vector to point up.\n\nSets the y component of the vector to 1, and the others to 0.","kind":"function","name":"up","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#up","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make a clone of this Vector3.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"A new Vector3 object containing this Vectors values."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#clone","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the cross (vector) product of two given Vectors.","kind":"function","name":"crossVectors","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The first Vector to multiply.","name":"a"},{"type":{"names":["Phaser.Math.Vector3"]},"description":"The second Vector to multiply.","name":"b"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#crossVectors","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Check whether this Vector is equal to a given Vector.\n\nPerforms a strict equality check against each Vector's components.","kind":"function","name":"equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The Vector3 to compare against.","name":"v"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the two vectors strictly match, otherwise false."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#equals","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":153,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the components of a given Vector into this Vector.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to copy the components from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#copy","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":172,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the `x`, `y`, and `z` components of this Vector to the given `x`, `y`, and `z` values.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["number","object"]},"description":"The x value to set for this Vector, or an object containing x, y and z components.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y value to set for this Vector.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The z value to set for this Vector.","name":"z"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#set","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Add a given Vector to this Vector. Addition is component-wise.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to add to this Vector.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#add","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Subtract the given Vector from this Vector. Subtraction is component-wise.","kind":"function","name":"subtract","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to subtract from this Vector.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#subtract","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":240,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Perform a component-wise multiplication between this Vector and the given Vector.\n\nMultiplies this Vector by the given Vector.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to multiply this Vector by.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#multiply","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":261,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Scale this Vector by the given value.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to scale this Vector by.","name":"scale"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#scale","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":289,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Perform a component-wise division between this Vector and the given Vector.\n\nDivides this Vector by the given Vector.","kind":"function","name":"divide","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to divide this Vector by.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#divide","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Negate the `x`, `y` and `z` components of this Vector.","kind":"function","name":"negate","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#negate","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":327,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the distance between this Vector and the given Vector.","kind":"function","name":"distance","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to calculate the distance to.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The distance from this Vector to the given Vector."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#distance","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":346,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the distance between this Vector and the given Vector, squared.","kind":"function","name":"distanceSq","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3"]},"description":"The Vector to calculate the distance to.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The distance from this Vector to the given Vector, squared."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#distanceSq","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":365,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length (or magnitude) of this Vector.","kind":"function","name":"length","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Vector."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#length","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":382,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length of this Vector squared.","kind":"function","name":"lengthSq","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Vector, squared."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#lengthSq","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":399,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Normalize this Vector.\n\nMakes the vector a unit length vector (magnitude of 1) in the same direction.","kind":"function","name":"normalize","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#normalize","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":428,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the dot product of this Vector and the given Vector.","kind":"function","name":"dot","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The Vector3 to dot product with this Vector3.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The dot product of this Vector and `v`."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#dot","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the cross (vector) product of this Vector (which will be modified) and the given Vector.","kind":"function","name":"cross","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The Vector to cross product with.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#cross","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":469,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Linearly interpolate between this Vector and the given Vector.\n\nInterpolates this Vector towards the given Vector.","kind":"function","name":"lerp","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"The Vector3 to interpolate towards.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The interpolation percentage, between 0 and 1.","name":"t"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#lerp","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":497,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Matrix.","kind":"function","name":"transformMat3","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix3"]},"description":"The Matrix3 to transform this Vector3 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#transformMat3","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":521,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Matrix.","kind":"function","name":"transformMat4","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix4 to transform this Vector3 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#transformMat4","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transforms the coordinates of this Vector3 with the given Matrix4.","kind":"function","name":"transformCoordinates","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix4 to transform this Vector3 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#transformCoordinates","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":574,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Quaternion.","kind":"function","name":"transformQuat","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"The Quaternion to transform this Vector with.","name":"q"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#transformQuat","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":609,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Multiplies this Vector3 by the specified matrix, applying a W divide. This is useful for projection,\ne.g. unprojecting a 2D point into 3D space.","kind":"function","name":"project","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix4 to multiply this Vector3 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#project","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":653,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Unproject this point from 2D space to 3D space.\nThe point should have its x and y properties set to\n2D screen space, and the z either at 0 (near plane)\nor 1 (far plane). The provided matrix is assumed to already\nbe combined, i.e. projection * view * model.\n\nAfter this operation, this vector's (x, y, z) components will\nrepresent the unprojected 3D coordinate.","kind":"function","name":"unproject","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"Screen x, y, width and height in pixels.","name":"viewport"},{"type":{"names":["Phaser.Math.Matrix4"]},"description":"Combined projection and view matrix.","name":"invProjectionView"}],"returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#unproject","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":689,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make this Vector the zero vector (0, 0, 0).","kind":"function","name":"reset","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector3"]},"description":"This Vector3."}],"memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3#reset","scope":"instance","___s":true},{"meta":{"filename":"Vector3.js","lineno":708,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static zero Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"ZERO","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.ZERO","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":720,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static right Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"RIGHT","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.RIGHT","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":732,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static left Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"LEFT","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.LEFT","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":744,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static up Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"UP","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.UP","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":756,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static down Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"DOWN","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.DOWN","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":768,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static forward Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"FORWARD","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.FORWARD","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":780,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static back Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"BACK","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.BACK","scope":"static","___s":true},{"meta":{"filename":"Vector3.js","lineno":792,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"A static one Vector3 for use by reference.\n\nThis constant is meant for comparison operations and should not be modified directly.","kind":"constant","name":"ONE","type":{"names":["Phaser.Math.Vector3"]},"since":"3.16.0","memberof":"Phaser.Math.Vector3","longname":"Phaser.Math.Vector3.ONE","scope":"static","___s":true},{"meta":{"filename":"Vector4.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"classdesc":"A representation of a vector in 4D space.\n\nA four-component vector.","kind":"class","name":"Vector4","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x component.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y component.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The z component.","name":"z"},{"type":{"names":["number"]},"optional":true,"description":"The w component.","name":"w"}],"scope":"static","longname":"Phaser.Math.Vector4","___s":true},{"meta":{"filename":"Vector4.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The x component of this Vector.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector4.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The y component of this Vector.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector4.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The z component of this Vector.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#z","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector4.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The w component of this Vector.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#w","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Vector4.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make a clone of this Vector4.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"A clone of this Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#clone","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Copy the components of a given Vector into this Vector.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"The Vector to copy the components from.","name":"src"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#copy","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":123,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Check whether this Vector is equal to a given Vector.\n\nPerforms a strict quality check against each Vector's components.","kind":"function","name":"equals","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"The vector to check equality with.","name":"v"}],"returns":[{"type":{"names":["boolean"]},"description":"A boolean indicating whether the two Vectors are equal or not."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#equals","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Set the `x`, `y`, `z` and `w` components of the this Vector to the given `x`, `y`, `z` and `w` values.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["number","object"]},"description":"The x value to set for this Vector, or an object containing x, y, z and w components.","name":"x"},{"type":{"names":["number"]},"description":"The y value to set for this Vector.","name":"y"},{"type":{"names":["number"]},"description":"The z value to set for this Vector.","name":"z"},{"type":{"names":["number"]},"description":"The z value to set for this Vector.","name":"w"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#set","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Add a given Vector to this Vector. Addition is component-wise.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to add to this Vector.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#add","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":193,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Subtract the given Vector from this Vector. Subtraction is component-wise.","kind":"function","name":"subtract","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to subtract from this Vector.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#subtract","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Scale this Vector by the given value.","kind":"function","name":"scale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to scale this Vector by.","name":"scale"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#scale","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":233,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length (or magnitude) of this Vector.","kind":"function","name":"length","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Vector."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#length","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":251,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the length of this Vector squared.","kind":"function","name":"lengthSq","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The length of this Vector, squared."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#lengthSq","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Normalize this Vector.\n\nMakes the vector a unit length vector (magnitude of 1) in the same direction.","kind":"function","name":"normalize","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#normalize","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the dot product of this Vector and the given Vector.","kind":"function","name":"dot","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"The Vector4 to dot product with this Vector4.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The dot product of this Vector and the given Vector."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#dot","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":315,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Linearly interpolate between this Vector and the given Vector.\n\nInterpolates this Vector towards the given Vector.","kind":"function","name":"lerp","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"The Vector4 to interpolate towards.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The interpolation percentage, between 0 and 1.","name":"t"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#lerp","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":345,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Perform a component-wise multiplication between this Vector and the given Vector.\n\nMultiplies this Vector by the given Vector.","kind":"function","name":"multiply","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to multiply this Vector by.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#multiply","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Perform a component-wise division between this Vector and the given Vector.\n\nDivides this Vector by the given Vector.","kind":"function","name":"divide","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to divide this Vector by.","name":"v"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#divide","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":389,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the distance between this Vector and the given Vector.","kind":"function","name":"distance","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to calculate the distance to.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The distance from this Vector to the given Vector."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#distance","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":409,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Calculate the distance between this Vector and the given Vector, squared.","kind":"function","name":"distanceSq","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","Phaser.Math.Vector3","Phaser.Math.Vector4"]},"description":"The Vector to calculate the distance to.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The distance from this Vector to the given Vector, squared."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#distanceSq","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":429,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Negate the `x`, `y`, `z` and `w` components of this Vector.","kind":"function","name":"negate","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#negate","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":447,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Matrix.","kind":"function","name":"transformMat4","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Matrix4"]},"description":"The Matrix4 to transform this Vector4 with.","name":"mat"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#transformMat4","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":473,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Transform this Vector with the given Quaternion.","kind":"function","name":"transformQuat","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Quaternion"]},"description":"The Quaternion to transform this Vector with.","name":"q"}],"returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#transformQuat","scope":"instance","___s":true},{"meta":{"filename":"Vector4.js","lineno":510,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Make this Vector the zero vector (0, 0, 0, 0).","kind":"function","name":"reset","since":"3.0.0","returns":[{"type":{"names":["Phaser.Math.Vector4"]},"description":"This Vector4."}],"memberof":"Phaser.Math.Vector4","longname":"Phaser.Math.Vector4#reset","scope":"instance","___s":true},{"meta":{"filename":"Within.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Checks if the two values are within the given `tolerance` of each other.","kind":"function","name":"Within","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first value to use in the calculation.","name":"a"},{"type":{"names":["number"]},"description":"The second value to use in the calculation.","name":"b"},{"type":{"names":["number"]},"description":"The tolerance. Anything equal to or less than this value is considered as being within range.","name":"tolerance"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if `a` is less than or equal to the tolerance of `b`."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Within","scope":"static","___s":true},{"meta":{"filename":"Wrap.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"Wrap the given `value` between `min` and `max.","kind":"function","name":"Wrap","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to wrap.","name":"value"},{"type":{"names":["number"]},"description":"The minimum value.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The wrapped value."}],"memberof":"Phaser.Math","longname":"Phaser.Math.Wrap","scope":"static","___s":true},{"meta":{"filename":"Between.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Find the angle of a segment from (x1, y1) -> (x2, y2).","kind":"function","name":"Between","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"}],"returns":[{"type":{"names":["number"]},"description":"The angle in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.Between","scope":"static","___s":true},{"meta":{"filename":"BetweenPoints.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).\n\nCalculates the angle of the vector from the first point to the second point.","kind":"function","name":"BetweenPoints","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The first point.","name":"point1"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The second point.","name":"point2"}],"returns":[{"type":{"names":["number"]},"description":"The angle in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.BetweenPoints","scope":"static","___s":true},{"meta":{"filename":"BetweenPointsY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).\n\nThe difference between this method and {@link Phaser.Math.Angle.BetweenPoints} is that this assumes the y coordinate\ntravels down the screen.","kind":"function","name":"BetweenPointsY","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The first point.","name":"point1"},{"type":{"names":["Phaser.Geom.Point","object"]},"description":"The second point.","name":"point2"}],"returns":[{"type":{"names":["number"]},"description":"The angle in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.BetweenPointsY","scope":"static","___s":true},{"meta":{"filename":"BetweenY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Find the angle of a segment from (x1, y1) -> (x2, y2).\n\nThe difference between this method and {@link Phaser.Math.Angle.Between} is that this assumes the y coordinate\ntravels down the screen.","kind":"function","name":"BetweenY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"}],"returns":[{"type":{"names":["number"]},"description":"The angle in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.BetweenY","scope":"static","___s":true},{"meta":{"range":[180,207],"filename":"CounterClockwise.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CounterClockwise.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Takes an angle in Phasers default clockwise format and converts it so that\n0 is North, 90 is West, 180 is South and 270 is East,\ntherefore running counter-clockwise instead of clockwise.\n\nYou can pass in the angle from a Game Object using:\n\n```javascript\nvar converted = CounterClockwise(gameobject.rotation);\n```\n\nAll values for this function are in radians.","kind":"function","name":"CounterClockwise","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The angle to convert, in radians.","name":"angle"}],"returns":[{"type":{"names":["number"]},"description":"The converted angle, in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.CounterClockwise","scope":"static","___s":true},{"meta":{"filename":"Normalize.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Normalize an angle to the [0, 2pi] range.","kind":"function","name":"Normalize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle to normalize, in radians.","name":"angle"}],"returns":[{"type":{"names":["number"]},"description":"The normalized angle, in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.Normalize","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Reverse.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"name":"Normalize","longname":"Normalize","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Reverse.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Reverse the given angle.","kind":"function","name":"Reverse","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle to reverse, in radians.","name":"angle"}],"returns":[{"type":{"names":["number"]},"description":"The reversed angle, in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.Reverse","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"RotateTo.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateTo.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Rotates `currentAngle` towards `targetAngle`, taking the shortest rotation distance. The `lerp` argument is the amount to rotate by in this call.","kind":"function","name":"RotateTo","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current angle, in radians.","name":"currentAngle"},{"type":{"names":["number"]},"description":"The target angle to rotate to, in radians.","name":"targetAngle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.05,"description":"The lerp value to add to the current angle.","name":"lerp"}],"returns":[{"type":{"names":["number"]},"description":"The adjusted angle."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.RotateTo","scope":"static","___s":true},{"meta":{"filename":"ShortestBetween.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Gets the shortest angle between `angle1` and `angle2`.\n\nBoth angles must be in the range -180 to 180, which is the same clamped\nrange that `sprite.angle` uses, so you can pass in two sprite angles to\nthis method and get the shortest angle back between the two of them.\n\nThe angle returned will be in the same range. If the returned angle is\ngreater than 0 then it's a counter-clockwise rotation, if < 0 then it's\na clockwise rotation.\n\nTODO: Wrap the angles in this function?","kind":"function","name":"ShortestBetween","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first angle in the range -180 to 180.","name":"angle1"},{"type":{"names":["number"]},"description":"The second angle in the range -180 to 180.","name":"angle2"}],"returns":[{"type":{"names":["number"]},"description":"The shortest angle, in degrees. If greater than zero it's a counter-clockwise rotation."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.ShortestBetween","scope":"static","___s":true},{"meta":{"range":[180,209],"filename":"Wrap.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"name":"MathWrap","longname":"MathWrap","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Wrap.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Wrap an angle.\n\nWraps the angle to a value in the range of -PI to PI.","kind":"function","name":"Wrap","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle to wrap, in radians.","name":"angle"}],"returns":[{"type":{"names":["number"]},"description":"The wrapped angle, in radians."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.Wrap","scope":"static","___s":true},{"meta":{"range":[180,205],"filename":"WrapDegrees.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"name":"Wrap","longname":"Wrap","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WrapDegrees.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"description":"Wrap an angle in degrees.\n\nWraps the angle to a value in the range of -180 to 180.","kind":"function","name":"WrapDegrees","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle to wrap, in degrees.","name":"angle"}],"returns":[{"type":{"names":["number"]},"description":"The wrapped angle, in degrees."}],"memberof":"Phaser.Math.Angle","longname":"Phaser.Math.Angle.WrapDegrees","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/angle"},"kind":"namespace","name":"Angle","memberof":"Phaser.Math","longname":"Phaser.Math.Angle","scope":"static","___s":true},{"meta":{"range":[180,1861],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"MATH_CONST","longname":"MATH_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The value of PI * 2.","name":"PI2","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Math","longname":"Phaser.Math.PI2","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The value of PI * 0.5.","name":"TAU","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Math","longname":"Phaser.Math.TAU","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"An epsilon value (1.0e-6)","name":"EPSILON","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Math","longname":"Phaser.Math.EPSILON","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"For converting degrees to radians (PI / 180)","name":"DEG_TO_RAD","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Math","longname":"Phaser.Math.DEG_TO_RAD","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"For converting radians to degrees (180 / PI)","name":"RAD_TO_DEG","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Math","longname":"Phaser.Math.RAD_TO_DEG","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"An instance of the Random Number Generator.\nThis is not set until the Game boots.","name":"RND","type":{"names":["Phaser.Math.RandomDataGenerator"]},"since":"3.0.0","memberof":"Phaser.Math","longname":"Phaser.Math.RND","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The minimum safe integer this browser supports.\nWe use a const for backward compatibility with Internet Explorer.","name":"MIN_SAFE_INTEGER","type":{"names":["number"]},"since":"3.21.0","memberof":"Phaser.Math","longname":"Phaser.Math.MIN_SAFE_INTEGER","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":74,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"description":"The maximum safe integer this browser supports.\nWe use a const for backward compatibility with Internet Explorer.","name":"MAX_SAFE_INTEGER","type":{"names":["number"]},"since":"3.21.0","memberof":"Phaser.Math","longname":"Phaser.Math.MAX_SAFE_INTEGER","scope":"static","kind":"member","___s":true},{"meta":{"filename":"DistanceBetween.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the distance between two sets of coordinates (points).","kind":"function","name":"Between","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"}],"returns":[{"type":{"names":["number"]},"description":"The distance between each point."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.Between","scope":"static","___s":true},{"meta":{"filename":"DistanceBetweenPoints.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the distance between two points.","kind":"function","name":"BetweenPoints","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The first point.","name":"a"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The second point.","name":"b"}],"returns":[{"type":{"names":["number"]},"description":"The distance between the points."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.BetweenPoints","scope":"static","___s":true},{"meta":{"filename":"DistanceBetweenPointsSquared.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the squared distance between two points.","kind":"function","name":"BetweenPointsSquared","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The first point.","name":"a"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The second point.","name":"b"}],"returns":[{"type":{"names":["number"]},"description":"The squared distance between the points."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.BetweenPointsSquared","scope":"static","___s":true},{"meta":{"filename":"DistanceChebyshev.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the Chebyshev distance between two sets of coordinates (points).\n\nChebyshev distance (or chessboard distance) is the maximum of the horizontal and vertical distances.\nIt's the effective distance when movement can be horizontal, vertical, or diagonal.","kind":"function","name":"Chebyshev","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"}],"returns":[{"type":{"names":["number"]},"description":"The distance between each point."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.Chebyshev","scope":"static","___s":true},{"meta":{"filename":"DistancePower.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the distance between two sets of coordinates (points) to the power of `pow`.","kind":"function","name":"Power","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"},{"type":{"names":["number"]},"description":"The exponent.","name":"pow"}],"returns":[{"type":{"names":["number"]},"description":"The distance between each point."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.Power","scope":"static","___s":true},{"meta":{"filename":"DistanceSnake.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the snake distance between two sets of coordinates (points).\n\nSnake distance (rectilinear distance, Manhattan distance) is the sum of the horizontal and vertical distances.\nIt's the effective distance when movement is allowed only horizontally or vertically (but not both).","kind":"function","name":"Snake","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"}],"returns":[{"type":{"names":["number"]},"description":"The distance between each point."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.Snake","scope":"static","___s":true},{"meta":{"filename":"DistanceSquared.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"description":"Calculate the distance between two sets of coordinates (points), squared.","kind":"function","name":"Squared","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the first point.","name":"x1"},{"type":{"names":["number"]},"description":"The y coordinate of the first point.","name":"y1"},{"type":{"names":["number"]},"description":"The x coordinate of the second point.","name":"x2"},{"type":{"names":["number"]},"description":"The y coordinate of the second point.","name":"y2"}],"returns":[{"type":{"names":["number"]},"description":"The distance between each point, squared."}],"memberof":"Phaser.Math.Distance","longname":"Phaser.Math.Distance.Squared","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/distance"},"kind":"namespace","name":"Distance","memberof":"Phaser.Math","longname":"Phaser.Math.Distance","scope":"static","___s":true},{"meta":{"range":[180,204],"filename":"EaseMap.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing"},"name":"Back","longname":"Back","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/back"},"description":"Back ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1.70158,"description":"The overshoot amount.","name":"overshoot"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Back","longname":"Phaser.Math.Easing.Back.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/back"},"description":"Back ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1.70158,"description":"The overshoot amount.","name":"overshoot"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Back","longname":"Phaser.Math.Easing.Back.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/back"},"description":"Back ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1.70158,"description":"The overshoot amount.","name":"overshoot"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Back","longname":"Phaser.Math.Easing.Back.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/back"},"kind":"namespace","name":"Back","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Back","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/bounce"},"description":"Bounce ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Bounce","longname":"Phaser.Math.Easing.Bounce.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/bounce"},"description":"Bounce ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Bounce","longname":"Phaser.Math.Easing.Bounce.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/bounce"},"description":"Bounce ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Bounce","longname":"Phaser.Math.Easing.Bounce.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/bounce"},"kind":"namespace","name":"Bounce","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Bounce","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/circular"},"description":"Circular ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Circular","longname":"Phaser.Math.Easing.Circular.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/circular"},"description":"Circular ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Circular","longname":"Phaser.Math.Easing.Circular.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/circular"},"description":"Circular ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Circular","longname":"Phaser.Math.Easing.Circular.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/circular"},"kind":"namespace","name":"Circular","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Circular","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/cubic"},"description":"Cubic ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Cubic","longname":"Phaser.Math.Easing.Cubic.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/cubic"},"description":"Cubic ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Cubic","longname":"Phaser.Math.Easing.Cubic.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/cubic"},"description":"Cubic ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Cubic","longname":"Phaser.Math.Easing.Cubic.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/cubic"},"kind":"namespace","name":"Cubic","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Cubic","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/elastic"},"description":"Elastic ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"The amplitude of the elastic ease.","name":"amplitude"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"Sets how tight the sine-wave is, where smaller values are tighter waves, which result in more cycles.","name":"period"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Elastic","longname":"Phaser.Math.Easing.Elastic.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/elastic"},"description":"Elastic ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"The amplitude of the elastic ease.","name":"amplitude"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"Sets how tight the sine-wave is, where smaller values are tighter waves, which result in more cycles.","name":"period"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Elastic","longname":"Phaser.Math.Easing.Elastic.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/elastic"},"description":"Elastic ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"The amplitude of the elastic ease.","name":"amplitude"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"Sets how tight the sine-wave is, where smaller values are tighter waves, which result in more cycles.","name":"period"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Elastic","longname":"Phaser.Math.Easing.Elastic.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/elastic"},"kind":"namespace","name":"Elastic","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Elastic","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/expo"},"description":"Exponential ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Expo","longname":"Phaser.Math.Easing.Expo.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/expo"},"description":"Exponential ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Expo","longname":"Phaser.Math.Easing.Expo.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/expo"},"description":"Exponential ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Expo","longname":"Phaser.Math.Easing.Expo.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/expo"},"kind":"namespace","name":"Expo","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Expo","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing"},"kind":"namespace","name":"Easing","memberof":"Phaser.Math","longname":"Phaser.Math.Easing","scope":"static","___s":true},{"meta":{"filename":"Linear.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/linear"},"description":"Linear easing (no variation).","kind":"function","name":"Linear","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Linear","longname":"Phaser.Math.Easing.Linear.Linear","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/linear"},"kind":"namespace","name":"Linear","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Linear","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic"},"description":"Quadratic ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quadratic","longname":"Phaser.Math.Easing.Quadratic.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic"},"description":"Quadratic ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quadratic","longname":"Phaser.Math.Easing.Quadratic.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic"},"description":"Quadratic ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quadratic","longname":"Phaser.Math.Easing.Quadratic.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic"},"kind":"namespace","name":"Quadratic","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Quadratic","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quartic"},"description":"Quartic ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quartic","longname":"Phaser.Math.Easing.Quartic.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quartic"},"description":"Quartic ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quartic","longname":"Phaser.Math.Easing.Quartic.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quartic"},"description":"Quartic ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quartic","longname":"Phaser.Math.Easing.Quartic.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quartic"},"kind":"namespace","name":"Quartic","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Quartic","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quintic"},"description":"Quintic ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quintic","longname":"Phaser.Math.Easing.Quintic.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quintic"},"description":"Quintic ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quintic","longname":"Phaser.Math.Easing.Quintic.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quintic"},"description":"Quintic ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Quintic","longname":"Phaser.Math.Easing.Quintic.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/quintic"},"kind":"namespace","name":"Quintic","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Quintic","scope":"static","___s":true},{"meta":{"filename":"In.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/sine"},"description":"Sinusoidal ease-in.","kind":"function","name":"In","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Sine","longname":"Phaser.Math.Easing.Sine.In","scope":"static","___s":true},{"meta":{"filename":"InOut.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/sine"},"description":"Sinusoidal ease-in/out.","kind":"function","name":"InOut","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Sine","longname":"Phaser.Math.Easing.Sine.InOut","scope":"static","___s":true},{"meta":{"filename":"Out.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/sine"},"description":"Sinusoidal ease-out.","kind":"function","name":"Out","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Sine","longname":"Phaser.Math.Easing.Sine.Out","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/sine"},"kind":"namespace","name":"Sine","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Sine","scope":"static","___s":true},{"meta":{"filename":"Stepped.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/stepped"},"description":"Stepped easing.","kind":"function","name":"Stepped","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to be tweened.","name":"v"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The number of steps in the ease.","name":"steps"}],"returns":[{"type":{"names":["number"]},"description":"The tweened value."}],"memberof":"Phaser.Math.Easing.Stepped","longname":"Phaser.Math.Easing.Stepped.Stepped","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/easing/stepped"},"kind":"namespace","name":"Stepped","memberof":"Phaser.Math.Easing","longname":"Phaser.Math.Easing.Stepped","scope":"static","___s":true},{"meta":{"filename":"Ceil.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/fuzzy"},"description":"Calculate the fuzzy ceiling of the given value.","kind":"function","name":"Ceil","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.0001,"description":"The epsilon.","name":"epsilon"}],"returns":[{"type":{"names":["number"]},"description":"The fuzzy ceiling of the value."}],"memberof":"Phaser.Math.Fuzzy","longname":"Phaser.Math.Fuzzy.Ceil","scope":"static","___s":true},{"meta":{"filename":"Equal.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/fuzzy"},"description":"Check whether the given values are fuzzily equal.\n\nTwo numbers are fuzzily equal if their difference is less than `epsilon`.","kind":"function","name":"Equal","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first value.","name":"a"},{"type":{"names":["number"]},"description":"The second value.","name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.0001,"description":"The epsilon.","name":"epsilon"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the values are fuzzily equal, otherwise `false`."}],"memberof":"Phaser.Math.Fuzzy","longname":"Phaser.Math.Fuzzy.Equal","scope":"static","___s":true},{"meta":{"filename":"Floor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/fuzzy"},"description":"Calculate the fuzzy floor of the given value.","kind":"function","name":"Floor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.0001,"description":"The epsilon.","name":"epsilon"}],"returns":[{"type":{"names":["number"]},"description":"The floor of the value."}],"memberof":"Phaser.Math.Fuzzy","longname":"Phaser.Math.Fuzzy.Floor","scope":"static","___s":true},{"meta":{"filename":"GreaterThan.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/fuzzy"},"description":"Check whether `a` is fuzzily greater than `b`.\n\n`a` is fuzzily greater than `b` if it is more than `b - epsilon`.","kind":"function","name":"GreaterThan","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first value.","name":"a"},{"type":{"names":["number"]},"description":"The second value.","name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.0001,"description":"The epsilon.","name":"epsilon"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if `a` is fuzzily greater than than `b`, otherwise `false`."}],"memberof":"Phaser.Math.Fuzzy","longname":"Phaser.Math.Fuzzy.GreaterThan","scope":"static","___s":true},{"meta":{"filename":"LessThan.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/fuzzy"},"description":"Check whether `a` is fuzzily less than `b`.\n\n`a` is fuzzily less than `b` if it is less than `b + epsilon`.","kind":"function","name":"LessThan","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The first value.","name":"a"},{"type":{"names":["number"]},"description":"The second value.","name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.0001,"description":"The epsilon.","name":"epsilon"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if `a` is fuzzily less than `b`, otherwise `false`."}],"memberof":"Phaser.Math.Fuzzy","longname":"Phaser.Math.Fuzzy.LessThan","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/fuzzy"},"kind":"namespace","name":"Fuzzy","memberof":"Phaser.Math","longname":"Phaser.Math.Fuzzy","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math"},"kind":"namespace","name":"Math","memberof":"Phaser","longname":"Phaser.Math","scope":"static","___s":true},{"meta":{"range":[180,215],"filename":"BezierInterpolation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"name":"Bernstein","longname":"Bernstein","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BezierInterpolation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A bezier interpolation method.","kind":"function","name":"Bezier","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The input array of values to interpolate between.","name":"v"},{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1.","name":"k"}],"returns":[{"type":{"names":["number"]},"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.Bezier","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"CatmullRomInterpolation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"name":"CatmullRom","longname":"CatmullRom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CatmullRomInterpolation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A Catmull-Rom interpolation method.","kind":"function","name":"CatmullRom","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The input array of values to interpolate between.","name":"v"},{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1.","name":"k"}],"returns":[{"type":{"names":["number"]},"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.CatmullRom","scope":"static","___s":true},{"meta":{"range":[195,263],"filename":"CubicBezierInterpolation.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P0","longname":"P0","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[284,356],"filename":"CubicBezierInterpolation.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P1","longname":"P1","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[377,435],"filename":"CubicBezierInterpolation.js","lineno":30,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P2","longname":"P2","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[456,504],"filename":"CubicBezierInterpolation.js","lineno":38,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P3","longname":"P3","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"filename":"CubicBezierInterpolation.js","lineno":43,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A cubic bezier interpolation method.\n\nhttps://medium.com/@adrian_cooney/bezier-interpolation-13b68563313a","kind":"function","name":"CubicBezier","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1.","name":"t"},{"type":{"names":["number"]},"description":"The start point.","name":"p0"},{"type":{"names":["number"]},"description":"The first control point.","name":"p1"},{"type":{"names":["number"]},"description":"The second control point.","name":"p2"},{"type":{"names":["number"]},"description":"The end point.","name":"p3"}],"returns":[{"type":{"names":["number"]},"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.CubicBezier","scope":"static","___s":true},{"meta":{"range":[180,209],"filename":"LinearInterpolation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"name":"Linear","longname":"Linear","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LinearInterpolation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A linear interpolation method.","kind":"function","name":"Linear","since":"3.0.0","see":["{@link https://en.wikipedia.org/wiki/Linear_interpolation}"],"params":[{"type":{"names":["Array."]},"description":"The input array of values to interpolate between.","name":"v"},{"type":{"names":["number"]},"nullable":false,"description":"The percentage of interpolation, between 0 and 1.","name":"k"}],"returns":[{"type":{"names":["number"]},"nullable":false,"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.Linear","scope":"static","___s":true},{"meta":{"range":[195,259],"filename":"QuadraticBezierInterpolation.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P0","longname":"P0","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[280,334],"filename":"QuadraticBezierInterpolation.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P1","longname":"P1","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[355,399],"filename":"QuadraticBezierInterpolation.js","lineno":28,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"ignore":true,"name":"P2","longname":"P2","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuadraticBezierInterpolation.js","lineno":35,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A quadratic bezier interpolation method.","kind":"function","name":"QuadraticBezier","since":"3.2.0","params":[{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1.","name":"t"},{"type":{"names":["number"]},"description":"The start point.","name":"p0"},{"type":{"names":["number"]},"description":"The control point.","name":"p1"},{"type":{"names":["number"]},"description":"The end point.","name":"p2"}],"returns":[{"type":{"names":["number"]},"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.QuadraticBezier","scope":"static","___s":true},{"meta":{"range":[180,217],"filename":"SmoothStepInterpolation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"name":"SmoothStep","longname":"SmoothStep","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SmoothStepInterpolation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A Smooth Step interpolation method.","kind":"function","name":"SmoothStep","since":"3.9.0","see":["{@link https://en.wikipedia.org/wiki/Smoothstep}"],"params":[{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1.","name":"t"},{"type":{"names":["number"]},"description":"The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.SmoothStep","scope":"static","___s":true},{"meta":{"range":[180,221],"filename":"SmootherStepInterpolation.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"name":"SmootherStep","longname":"SmootherStep","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SmootherStepInterpolation.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"description":"A Smoother Step interpolation method.","kind":"function","name":"SmootherStep","since":"3.9.0","see":["{@link https://en.wikipedia.org/wiki/Smoothstep#Variations}"],"params":[{"type":{"names":["number"]},"description":"The percentage of interpolation, between 0 and 1.","name":"t"},{"type":{"names":["number"]},"description":"The minimum value, also known as the 'left edge', assumed smaller than the 'right edge'.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value, also known as the 'right edge', assumed greater than the 'left edge'.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"The interpolated value."}],"memberof":"Phaser.Math.Interpolation","longname":"Phaser.Math.Interpolation.SmootherStep","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/interpolation"},"kind":"namespace","name":"Interpolation","memberof":"Phaser.Math","longname":"Phaser.Math.Interpolation","scope":"static","___s":true},{"meta":{"filename":"GetPowerOfTwo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/pow2"},"description":"Returns the nearest power of 2 to the given `value`.","kind":"function","name":"GetNext","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value.","name":"value"}],"returns":[{"type":{"names":["integer"]},"description":"The nearest power of 2 to `value`."}],"memberof":"Phaser.Math.Pow2","longname":"Phaser.Math.Pow2.GetNext","scope":"static","___s":true},{"meta":{"filename":"IsSizePowerOfTwo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/pow2"},"description":"Checks if the given `width` and `height` are a power of two.\nUseful for checking texture dimensions.","kind":"function","name":"IsSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width.","name":"width"},{"type":{"names":["number"]},"description":"The height.","name":"height"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if `width` and `height` are a power of two, otherwise `false`."}],"memberof":"Phaser.Math.Pow2","longname":"Phaser.Math.Pow2.IsSize","scope":"static","___s":true},{"meta":{"filename":"IsValuePowerOfTwo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/pow2"},"description":"Tests the value and returns `true` if it is a power of two.","kind":"function","name":"IsValue","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to check if it's a power of two.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if `value` is a power of two, otherwise `false`."}],"memberof":"Phaser.Math.Pow2","longname":"Phaser.Math.Pow2.IsValue","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/pow2"},"kind":"namespace","name":"Pow2","memberof":"Phaser.Math","longname":"Phaser.Math.Pow2","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"RandomDataGenerator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"classdesc":"A seeded Random Data Generator.\n\nAccess via `Phaser.Math.RND` which is an instance of this class pre-defined\nby Phaser. Or, create your own instance to use as you require.\n\nThe `Math.RND` generator is seeded by the Game Config property value `seed`.\nIf no such config property exists, a random number is used.\n\nIf you create your own instance of this class you should provide a seed for it.\nIf no seed is given it will use a 'random' one based on Date.now.","kind":"class","name":"RandomDataGenerator","memberof":"Phaser.Math","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"optional":true,"description":"The seeds to use for the random number generator.","name":"seeds"}],"scope":"static","longname":"Phaser.Math.RandomDataGenerator","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Signs to choose from.","name":"signs","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#signs","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":163,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Initialize the state of the random data generator.","kind":"function","name":"init","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The seeds to initialize the random data generator with.","name":"seeds"}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#init","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Reset the seed of the random data generator.\n\n_Note_: the seed array is only processed up to the first `undefined` (or `null`) value, should such be present.","kind":"function","name":"sow","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The array of seeds: the `toString()` of each value is used.","name":"seeds"}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#sow","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random integer between 0 and 2^32.","kind":"function","name":"integer","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A random integer between 0 and 2^32."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#integer","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":235,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random real number between 0 and 1.","kind":"function","name":"frac","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A random real number between 0 and 1."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#frac","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random real number between 0 and 2^32.","kind":"function","name":"real","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A random real number between 0 and 2^32."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#real","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":262,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random integer between and including min and max.","kind":"function","name":"integerInRange","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum value in the range.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value in the range.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"A random number between min and max."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#integerInRange","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random integer between and including min and max.\nThis method is an alias for RandomDataGenerator.integerInRange.","kind":"function","name":"between","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum value in the range.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value in the range.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"A random number between min and max."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#between","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random real number between min and max.","kind":"function","name":"realInRange","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum value in the range.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value in the range.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"A random number between min and max."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#realInRange","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":311,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random real number between -1 and 1.","kind":"function","name":"normal","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A random real number between -1 and 1."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#normal","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":324,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a valid RFC4122 version4 ID hex string from https://gist.github.com/1308368","kind":"function","name":"uuid","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"A valid RFC4122 version4 ID hex string"}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#uuid","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":345,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random element from within the given array.","kind":"function","name":"pick","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The array to pick a random element from.","name":"array"}],"returns":[{"type":{"names":["T"]},"description":"A random member of the array."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#pick","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":364,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a sign to be used with multiplication operator.","kind":"function","name":"sign","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"-1 or +1."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#sign","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":377,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random element from within the given array, favoring the earlier entries.","kind":"function","name":"weightedPick","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The array to pick a random element from.","name":"array"}],"returns":[{"type":{"names":["T"]},"description":"A random member of the array."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#weightedPick","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":396,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random timestamp between min and max, or between the beginning of 2000 and the end of 2020 if min and max aren't specified.","kind":"function","name":"timestamp","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum value in the range.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value in the range.","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"A random timestamp between min and max."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#timestamp","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":412,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random angle between -180 and 180.","kind":"function","name":"angle","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A random number between -180 and 180."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#angle","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Returns a random rotation in radians, between -3.141 and 3.141","kind":"function","name":"rotation","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A random number between -3.141 and 3.141"}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#rotation","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":438,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Gets or Sets the state of the generator. This allows you to retain the values\nthat the generator is using between games, i.e. in a game save file.\n\nTo seed this generator with a previously saved state you can pass it as the\n`seed` value in your game config, or call this method directly after Phaser has booted.\n\nCall this method with no parameters to return the current state.\n\nIf providing a state it should match the same format that this method\nreturns, which is a string with a header `!rnd` followed by the `c`,\n`s0`, `s1` and `s2` values respectively, each comma-delimited.","kind":"function","name":"state","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"Generator state to be set.","name":"state"}],"returns":[{"type":{"names":["string"]},"description":"The current state of the generator."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#state","scope":"instance","___s":true},{"meta":{"filename":"RandomDataGenerator.js","lineno":473,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/math/random-data-generator"},"description":"Shuffles the given array, using the current seed.","kind":"function","name":"shuffle","since":"3.7.0","params":[{"type":{"names":["Array."]},"optional":true,"description":"The array to be shuffled.","name":"array"}],"returns":[{"type":{"names":["Array."]},"description":"The shuffled array."}],"memberof":"Phaser.Math.RandomDataGenerator","longname":"Phaser.Math.RandomDataGenerator#shuffle","scope":"instance","___s":true},{"meta":{"filename":"SnapCeil.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/snap"},"description":"Snap a value to nearest grid slice, using ceil.\n\nExample: if you have an interval gap of `5` and a position of `12`... you will snap to `15`.\nAs will `14` snap to `15`... but `16` will snap to `20`.","kind":"function","name":"Ceil","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to snap.","name":"value"},{"type":{"names":["number"]},"description":"The interval gap of the grid.","name":"gap"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional starting offset for gap.","name":"start"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` it will divide the snapped value by the gap before returning.","name":"divide"}],"returns":[{"type":{"names":["number"]},"description":"The snapped value."}],"memberof":"Phaser.Math.Snap","longname":"Phaser.Math.Snap.Ceil","scope":"static","___s":true},{"meta":{"filename":"SnapFloor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/snap"},"description":"Snap a value to nearest grid slice, using floor.\n\nExample: if you have an interval gap of `5` and a position of `12`... you will snap to `10`.\nAs will `14` snap to `10`... but `16` will snap to `15`.","kind":"function","name":"Floor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to snap.","name":"value"},{"type":{"names":["number"]},"description":"The interval gap of the grid.","name":"gap"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional starting offset for gap.","name":"start"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` it will divide the snapped value by the gap before returning.","name":"divide"}],"returns":[{"type":{"names":["number"]},"description":"The snapped value."}],"memberof":"Phaser.Math.Snap","longname":"Phaser.Math.Snap.Floor","scope":"static","___s":true},{"meta":{"filename":"SnapTo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/snap"},"description":"Snap a value to nearest grid slice, using rounding.\n\nExample: if you have an interval gap of `5` and a position of `12`... you will snap to `10` whereas `14` will snap to `15`.","kind":"function","name":"To","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to snap.","name":"value"},{"type":{"names":["number"]},"description":"The interval gap of the grid.","name":"gap"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional starting offset for gap.","name":"start"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` it will divide the snapped value by the gap before returning.","name":"divide"}],"returns":[{"type":{"names":["number"]},"description":"The snapped value."}],"memberof":"Phaser.Math.Snap","longname":"Phaser.Math.Snap.To","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/snap"},"kind":"namespace","name":"Snap","memberof":"Phaser.Math","longname":"Phaser.Math.Snap","scope":"static","___s":true},{"meta":{"filename":"SinCosTable.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/typedefs"},"kind":"typedef","name":"SinCosTable","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The sine value.","name":"sin"},{"type":{"names":["number"]},"description":"The cosine value.","name":"cos"},{"type":{"names":["number"]},"description":"The length.","name":"length"}],"memberof":"Phaser.Types.Math","longname":"Phaser.Types.Math.SinCosTable","scope":"static","___s":true},{"meta":{"filename":"Vector2Like.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/typedefs"},"kind":"typedef","name":"Vector2Like","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"description":"The x component.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y component.","name":"y"}],"memberof":"Phaser.Types.Math","longname":"Phaser.Types.Math.Vector2Like","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/math/typedefs"},"kind":"namespace","name":"Math","memberof":"Phaser.Types","longname":"Phaser.Types.Math","scope":"static","___s":true},{"meta":{"filename":"phaser.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src"},"kind":"namespace","name":"Phaser","longname":"Phaser","scope":"global","___s":true},{"meta":{"filename":"phaser.js","lineno":77,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src"},"description":"The root types namespace.","kind":"namespace","name":"Types","since":"3.17.0","memberof":"Phaser","longname":"Phaser.Types","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"ArcadeImage.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ArcadeImage.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"An Arcade Physics Image is an Image with an Arcade Physics body and related components.\nThe body can be dynamic or static.\n\nThe main difference between an Arcade Image and an Arcade Sprite is that you cannot animate an Arcade Image.","kind":"class","name":"Image","augments":["Phaser.GameObjects.Image","Phaser.Physics.Arcade.Components.Acceleration","Phaser.Physics.Arcade.Components.Angular","Phaser.Physics.Arcade.Components.Bounce","Phaser.Physics.Arcade.Components.Debug","Phaser.Physics.Arcade.Components.Drag","Phaser.Physics.Arcade.Components.Enable","Phaser.Physics.Arcade.Components.Friction","Phaser.Physics.Arcade.Components.Gravity","Phaser.Physics.Arcade.Components.Immovable","Phaser.Physics.Arcade.Components.Mass","Phaser.Physics.Arcade.Components.Size","Phaser.Physics.Arcade.Components.Velocity","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.Physics.Arcade.Image","___s":true},{"meta":{"filename":"ArcadeImage.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This Game Object's Physics Body.","name":"body","type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#body","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Image#body","___s":true},{"meta":{"range":[180,216],"filename":"ArcadePhysics.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":21,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"The Arcade Physics Plugin belongs to a Scene and sets up and manages the Scene's physics simulation.\nIt also holds some useful methods for moving and rotating Arcade Physics Bodies.\n\nYou can access it from within a Scene using `this.physics`.\n\nArcade Physics uses the Projection Method of collision resolution and separation. While it's fast and suitable\nfor 'arcade' style games it lacks stability when multiple objects are in close proximity or resting upon each other.\nThe separation that stops two objects penetrating may create a new penetration against a different object. If you\nrequire a high level of stability please consider using an alternative physics system, such as Matter.js.","kind":"class","name":"ArcadePhysics","memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that this Plugin belongs to.","name":"scene"}],"scope":"static","longname":"Phaser.Physics.Arcade.ArcadePhysics","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Scene that this Plugin belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Scene's Systems.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A configuration object. Union of the `physics.arcade.*` properties of the GameConfig and SceneConfig objects.","name":"config","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The physics simulation.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"An object holding the Arcade Physics factory methods.","name":"add","type":{"names":["Phaser.Physics.Arcade.Factory"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#add","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates the physics configuration for the current Scene.","kind":"function","name":"getConfig","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"The physics configuration."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#getConfig","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":156,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Tests if Game Objects overlap. See {@link Phaser.Physics.Arcade.World#overlap}","kind":"function","name":"overlap","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object or array of objects to check.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"optional":true,"description":"The second object or array of objects to check, or `undefined`.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they overlap. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if at least one Game Object overlaps another."}],"see":["Phaser.Physics.Arcade.World#overlap"],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#overlap","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Performs a collision check and separation between the two physics enabled objects given, which can be single\nGame Objects, arrays of Game Objects, Physics Groups, arrays of Physics Groups or normal Groups.\n\nIf you don't require separation then use {@link #overlap} instead.\n\nIf two Groups or arrays are passed, each member of one will be tested against each member of the other.\n\nIf **only** one Group is passed (as `object1`), each member of the Group will be collided against the other members.\n\nIf **only** one Array is passed, the array is iterated and every element in it is tested against the others.\n\nTwo callbacks can be provided. The `collideCallback` is invoked if a collision occurs and the two colliding\nobjects are passed to it.\n\nArcade Physics uses the Projection Method of collision resolution and separation. While it's fast and suitable\nfor 'arcade' style games it lacks stability when multiple objects are in close proximity or resting upon each other.\nThe separation that stops two objects penetrating may create a new penetration against a different object. If you\nrequire a high level of stability please consider using an alternative physics system, such as Matter.js.","kind":"function","name":"collide","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object or array of objects to check.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"optional":true,"description":"The second object or array of objects to check, or `undefined`.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if any overlapping Game Objects were separated, otherwise false."}],"see":["Phaser.Physics.Arcade.World#collide"],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#collide","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This advanced method is specifically for testing for collision between a single Sprite and an array of Tile objects.\n\nYou should generally use the `collide` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\ntile filtering and culling for you, as well as handle the interesting face collision automatically.\n\nThis method is offered for those who would like to check for collision with specific Tiles in a layer, without\nhaving to set any collision attributes on the tiles in question. This allows you to perform quick dynamic collisions\non small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\nyou should filter them before passing them to this method.\n\nImportant: Use of this method skips the `interesting faces` system that Tilemap Layers use. This means if you have\nsay a row or column of tiles, and you jump into, or walk over them, it's possible to get stuck on the edges of the\ntiles as the interesting face calculations are skipped. However, for quick-fire small collision set tests on\ndynamic maps, this method can prove very useful.","kind":"function","name":"collideTiles","fires":["Phaser.Physics.Arcade.Events#event:TILE_COLLIDE"],"since":"3.17.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first object to check for collision.","name":"sprite"},{"type":{"names":["Array."]},"description":"An array of Tiles to check for collision against.","name":"tiles"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#collideTiles","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This advanced method is specifically for testing for overlaps between a single Sprite and an array of Tile objects.\n\nYou should generally use the `overlap` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\ntile filtering and culling for you, as well as handle the interesting face collision automatically.\n\nThis method is offered for those who would like to check for overlaps with specific Tiles in a layer, without\nhaving to set any collision attributes on the tiles in question. This allows you to perform quick dynamic overlap\ntests on small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\nyou should filter them before passing them to this method.","kind":"function","name":"overlapTiles","fires":["Phaser.Physics.Arcade.Events#event:TILE_OVERLAP"],"since":"3.17.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first object to check for collision.","name":"sprite"},{"type":{"names":["Array."]},"description":"An array of Tiles to check for collision against.","name":"tiles"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects overlap.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#overlapTiles","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":284,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Pauses the simulation.","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The simulation."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#pause","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Resumes the simulation (if paused).","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The simulation."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#resume","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the acceleration.x/y property on the game object so it will move towards the x/y coordinates at the given rate (in pixels per second squared)\n\nYou must give a maximum speed value, beyond which the game object won't go any faster.\n\nNote: The game object does not continuously track the target. If the target changes location during transit the game object will not modify its course.\nNote: The game object doesn't stop moving once it reaches the destination coordinates.","kind":"function","name":"accelerateTo","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"Any Game Object with an Arcade Physics body.","name":"gameObject"},{"type":{"names":["number"]},"description":"The x coordinate to accelerate towards.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to accelerate towards.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The acceleration (change in speed) in pixels per second squared.","name":"speed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":500,"description":"The maximum x velocity the game object can reach.","name":"xSpeedMax"},{"type":{"names":["number"]},"optional":true,"defaultvalue":500,"description":"The maximum y velocity the game object can reach.","name":"ySpeedMax"}],"returns":[{"type":{"names":["number"]},"description":"The angle (in radians) that the object should be visually set to in order to match its new velocity."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#accelerateTo","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":346,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the acceleration.x/y property on the game object so it will move towards the x/y coordinates at the given rate (in pixels per second squared)\n\nYou must give a maximum speed value, beyond which the game object won't go any faster.\n\nNote: The game object does not continuously track the target. If the target changes location during transit the game object will not modify its course.\nNote: The game object doesn't stop moving once it reaches the destination coordinates.","kind":"function","name":"accelerateToObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"Any Game Object with an Arcade Physics body.","name":"gameObject"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to move towards. Can be any object but must have visible x/y properties.","name":"destination"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The acceleration (change in speed) in pixels per second squared.","name":"speed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":500,"description":"The maximum x velocity the game object can reach.","name":"xSpeedMax"},{"type":{"names":["number"]},"optional":true,"defaultvalue":500,"description":"The maximum y velocity the game object can reach.","name":"ySpeedMax"}],"returns":[{"type":{"names":["number"]},"description":"The angle (in radians) that the object should be visually set to in order to match its new velocity."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#accelerateToObject","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Finds the Body or Game Object closest to a source point or object.\n\nIf a `targets` argument is passed, this method finds the closest of those.\nThe targets can be Arcade Physics Game Objects, Dynamic Bodies, or Static Bodies.\n\nIf no `targets` argument is passed, this method finds the closest Dynamic Body.\n\nIf two or more targets are the exact same distance from the source point, only the first target\nis returned.","kind":"function","name":"closest","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"Any object with public `x` and `y` properties, such as a Game Object or Geometry object.","name":"source"},{"type":{"names":["Array.","Array.","Array."]},"optional":true,"description":"The targets.","name":"targets"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody","Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The target closest to the given source point."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#closest","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":424,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Finds the Body or Game Object farthest from a source point or object.\n\nIf a `targets` argument is passed, this method finds the farthest of those.\nThe targets can be Arcade Physics Game Objects, Dynamic Bodies, or Static Bodies.\n\nIf no `targets` argument is passed, this method finds the farthest Dynamic Body.\n\nIf two or more targets are the exact same distance from the source point, only the first target\nis returned.","kind":"function","name":"furthest","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"Any object with public `x` and `y` properties, such as a Game Object or Geometry object.","name":"source"},{"type":{"names":["Array.","Array.","Array."]},"optional":true,"description":"The targets.","name":"targets"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody","Phaser.GameObjects.GameObject"]},"nullable":true,"description":"The target farthest from the given source point."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#furthest","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":479,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Move the given display object towards the x/y coordinates at a steady velocity.\nIf you specify a maxTime then it will adjust the speed (over-writing what you set) so it arrives at the destination in that number of seconds.\nTimings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.\nNote: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\nNote: The display object doesn't stop moving once it reaches the destination coordinates.\nNote: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)","kind":"function","name":"moveTo","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"Any Game Object with an Arcade Physics body.","name":"gameObject"},{"type":{"names":["number"]},"description":"The x coordinate to move towards.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to move towards.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The speed it will move, in pixels per second (default is 60 pixels/sec)","name":"speed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms.","name":"maxTime"}],"returns":[{"type":{"names":["number"]},"description":"The angle (in radians) that the object should be visually set to in order to match its new velocity."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#moveTo","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Move the given display object towards the destination object at a steady velocity.\nIf you specify a maxTime then it will adjust the speed (overwriting what you set) so it arrives at the destination in that number of seconds.\nTimings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.\nNote: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\nNote: The display object doesn't stop moving once it reaches the destination coordinates.\nNote: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)","kind":"function","name":"moveToObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"Any Game Object with an Arcade Physics body.","name":"gameObject"},{"type":{"names":["object"]},"description":"Any object with public `x` and `y` properties, such as a Game Object or Geometry object.","name":"destination"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The speed it will move, in pixels per second (default is 60 pixels/sec)","name":"speed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms.","name":"maxTime"}],"returns":[{"type":{"names":["number"]},"description":"The angle (in radians) that the object should be visually set to in order to match its new velocity."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#moveToObject","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":539,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Given the angle (in degrees) and speed calculate the velocity and return it as a vector, or set it to the given vector object.\nOne way to use this is: velocityFromAngle(angle, 200, sprite.body.velocity) which will set the values directly to the sprite's velocity and not create a new vector object.","kind":"function","name":"velocityFromAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle in degrees calculated in clockwise positive direction (down = 90 degrees positive, right = 0 degrees positive, up = 90 degrees negative)","name":"angle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The speed it will move, in pixels per second squared.","name":"speed"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"The Vector2 in which the x and y properties will be set to the calculated velocity.","name":"vec2"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector2 that stores the velocity."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#velocityFromAngle","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":560,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Given the rotation (in radians) and speed calculate the velocity and return it as a vector, or set it to the given vector object.\nOne way to use this is: velocityFromRotation(rotation, 200, sprite.body.velocity) which will set the values directly to the sprite's velocity and not create a new vector object.","kind":"function","name":"velocityFromRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angle in radians.","name":"rotation"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The speed it will move, in pixels per second squared","name":"speed"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"The Vector2 in which the x and y properties will be set to the calculated velocity.","name":"vec2"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The Vector2 that stores the velocity."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#velocityFromRotation","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":581,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This method will search the given rectangular area and return an array of all physics bodies that\noverlap with it. It can return either Dynamic, Static bodies or a mixture of both.\n\nA body only has to intersect with the search area to be considered, it doesn't have to be fully\ncontained within it.\n\nIf Arcade Physics is set to use the RTree (which it is by default) then the search for is extremely fast,\notherwise the search is O(N) for Dynamic Bodies.","kind":"function","name":"overlapRect","since":"3.17.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the area to search within.","name":"x"},{"type":{"names":["number"]},"description":"The top-left y coordinate of the area to search within.","name":"y"},{"type":{"names":["number"]},"description":"The width of the area to search within.","name":"width"},{"type":{"names":["number"]},"description":"The height of the area to search within.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the search include Dynamic Bodies?","name":"includeDynamic"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the search include Static Bodies?","name":"includeStatic"}],"returns":[{"type":{"names":["Array.","Array."]},"description":"An array of bodies that overlap with the given area."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#overlapRect","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This method will search the given circular area and return an array of all physics bodies that\noverlap with it. It can return either Dynamic, Static bodies or a mixture of both.\n\nA body only has to intersect with the search area to be considered, it doesn't have to be fully\ncontained within it.\n\nIf Arcade Physics is set to use the RTree (which it is by default) then the search is rather fast,\notherwise the search is O(N) for Dynamic Bodies.","kind":"function","name":"overlapCirc","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the area to search within.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the area to search within.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the area to search within.","name":"radius"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the search include Dynamic Bodies?","name":"includeDynamic"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the search include Static Bodies?","name":"includeStatic"}],"returns":[{"type":{"names":["Array.","Array."]},"description":"An array of bodies that overlap with the given area."}],"memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#overlapCirc","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":634,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Scene that owns this plugin is shutting down.\nWe need to kill and reset all internal properties as well as stop listening to Scene events.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#shutdown","scope":"instance","___s":true},{"meta":{"filename":"ArcadePhysics.js","lineno":662,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Scene that owns this plugin is being destroyed.\nWe need to shutdown and then kill off all external references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Arcade.ArcadePhysics","longname":"Phaser.Physics.Arcade.ArcadePhysics#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"ArcadeSprite.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ArcadeSprite.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"An Arcade Physics Sprite is a Sprite with an Arcade Physics body and related components.\nThe body can be dynamic or static.\n\nThe main difference between an Arcade Sprite and an Arcade Image is that you cannot animate an Arcade Image.\nIf you do not require animation then you can safely use Arcade Images instead of Arcade Sprites.","kind":"class","name":"Sprite","augments":["Phaser.GameObjects.Sprite","Phaser.Physics.Arcade.Components.Acceleration","Phaser.Physics.Arcade.Components.Angular","Phaser.Physics.Arcade.Components.Bounce","Phaser.Physics.Arcade.Components.Debug","Phaser.Physics.Arcade.Components.Drag","Phaser.Physics.Arcade.Components.Enable","Phaser.Physics.Arcade.Components.Friction","Phaser.Physics.Arcade.Components.Gravity","Phaser.Physics.Arcade.Components.Immovable","Phaser.Physics.Arcade.Components.Mass","Phaser.Physics.Arcade.Components.Size","Phaser.Physics.Arcade.Components.Velocity","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.","name":"scene"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.Physics.Arcade.Sprite","___s":true},{"meta":{"filename":"ArcadeSprite.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This Game Object's Physics Body.","name":"body","type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#body","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Sprite#body","___s":true},{"meta":{"range":[248,284],"filename":"Body.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Body.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"A Dynamic Arcade Body.\n\nIts static counterpart is {@link Phaser.Physics.Arcade.StaticBody}.","kind":"class","name":"Body","memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The Arcade Physics simulation this Body belongs to.","name":"world"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object this Body belongs to.","name":"gameObject"}],"scope":"static","longname":"Phaser.Physics.Arcade.Body","___s":true},{"meta":{"filename":"Body.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Arcade Physics simulation this Body belongs to.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Game Object this Body belongs to.","name":"gameObject","type":{"names":["Phaser.GameObjects.GameObject"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#gameObject","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Transformations applied to this Body.","name":"transform","type":{"names":["object"]},"since":"3.4.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#transform","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the Body's boundary is drawn to the debug display.","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#debugShowBody","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the Body's velocity is drawn to the debug display.","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#debugShowVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The color of this Body on the debug display.","name":"debugBodyColor","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#debugBodyColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is updated by the physics simulation.","name":"enable","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#enable","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body's boundary is circular (true) or rectangular (false).","name":"isCircle","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.Physics.Arcade.Body#setCircle"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#isCircle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"If this Body is circular, this is the unscaled radius of the Body's boundary, as set by setCircle(), in source pixels.\nThe true radius is equal to `halfWidth`.","name":"radius","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","see":["Phaser.Physics.Arcade.Body#setCircle"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#radius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The offset of this Body's position from its Game Object's position, in source pixels.","name":"offset","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#setOffset"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The position of this Body within the simulation.","name":"position","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#position","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":153,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The position of this Body during the previous step.","name":"prev","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#prev","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":162,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The position of this Body during the previous frame.","name":"prevFrame","type":{"names":["Phaser.Math.Vector2"]},"since":"3.20.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#prevFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":171,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body's `rotation` is affected by its angular acceleration and angular velocity.","name":"allowRotation","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#allowRotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":181,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This body's rotation, in degrees, based on its angular acceleration and angular velocity.\nThe Body's rotation controls the `angle` of its Game Object.\nIt doesn't rotate the Body's boundary, which is always an axis-aligned rectangle or a circle.","name":"rotation","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body rotation, in degrees, during the previous step.","name":"preRotation","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#preRotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":201,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The width of the Body boundary, in pixels.\nIf the Body is circular, this is also the diameter.\nIf you wish to change the width use the `Body.setSize` method.","name":"width","type":{"names":["number"]},"readonly":true,"defaultvalue":"64","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":214,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The height of the Body boundary, in pixels.\nIf the Body is circular, this is also the diameter.\nIf you wish to change the height use the `Body.setSize` method.","name":"height","type":{"names":["number"]},"readonly":true,"defaultvalue":"64","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":227,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The unscaled width of the Body, in source pixels, as set by setSize().\nThe default is the width of the Body's Game Object's texture frame.","name":"sourceWidth","type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#setSize"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#sourceWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":238,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The unscaled height of the Body, in source pixels, as set by setSize().\nThe default is the height of the Body's Game Object's texture frame.","name":"sourceHeight","type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#setSize"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#sourceHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":255,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Half the Body's width, in pixels.","name":"halfWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#halfWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":264,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Half the Body's height, in pixels.","name":"halfHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#halfHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The center of the Body's boundary.\nThe midpoint of its `position` (top-left corner) and its bottom-right corner.","name":"center","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#center","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":283,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's velocity, in pixels per second.","name":"velocity","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#velocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":292,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's change in position (due to velocity) at the last step, in pixels.\n\nThe size of this value depends on the simulation's step rate.","name":"newVelocity","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#newVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":304,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's absolute maximum change in position, in pixels per step.","name":"deltaMax","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaMax","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":313,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's change in velocity, in pixels per second squared.","name":"acceleration","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#acceleration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":322,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body's velocity is affected by its `drag`.","name":"allowDrag","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#allowDrag","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":332,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","name":"drag","type":{"names":["Phaser.Math.Vector2","number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#drag","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":349,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body's position is affected by gravity (local or world).","name":"allowGravity","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","see":["Phaser.Physics.Arcade.Body#gravity","Phaser.Physics.Arcade.World#gravity"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#allowGravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":361,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Acceleration due to gravity (specific to this Body), in pixels per second squared.\nTotal gravity is the sum of this vector and the simulation's `gravity`.","name":"gravity","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.World#gravity"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#gravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":372,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Rebound following a collision, relative to 1.","name":"bounce","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#bounce","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":381,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Rebound following a collision with the world boundary, relative to 1.\nIf null, `bounce` is used instead.","name":"worldBounce","type":{"names":["Phaser.Math.Vector2"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#worldBounce","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":392,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The rectangle used for world boundary collisions.\n\nBy default it is set to the world boundary rectangle. Or, if this Body was\ncreated by a Physics Group, then whatever rectangle that Group defined.\n\nYou can also change it by using the `Body.setBoundsRectangle` method.","name":"customBoundsRectangle","type":{"names":["Phaser.Geom.Rectangle"]},"nullable":true,"since":"3.20","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#customBoundsRectangle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":408,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation emits a `worldbounds` event when this Body collides with the world boundary (and `collideWorldBounds` is also true).","name":"onWorldBounds","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.Physics.Arcade.World#worldboundsEvent"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#onWorldBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":419,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation emits a `collide` event when this Body collides with another.","name":"onCollide","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.Physics.Arcade.World#collideEvent"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#onCollide","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":430,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation emits an `overlap` event when this Body overlaps with another.","name":"onOverlap","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.Physics.Arcade.World#overlapEvent"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#onOverlap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":441,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's absolute maximum velocity, in pixels per second.\nThe horizontal and vertical components are applied separately.","name":"maxVelocity","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#maxVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":451,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The maximum speed this Body is allowed to reach, in pixels per second.\n\nIf not negative it limits the scalar value of speed.\n\nAny negative value means no maximum is being applied (the default).","name":"maxSpeed","type":{"names":["number"]},"defaultvalue":"-1","since":"3.16.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#maxSpeed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":465,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"If this Body is `immovable` and in motion, `friction` is the proportion of this Body's motion received by the riding Body on each axis, relative to 1.\nThe horizontal component (x) is applied only when two colliding Bodies are separated vertically.\nThe vertical component (y) is applied only when two colliding Bodies are separated horizontally.\nThe default value (1, 0) moves the riding Body horizontally in equal proportion to this Body and vertically not at all.","name":"friction","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#friction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":477,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"If this Body is using `drag` for deceleration this property controls how the drag is applied.\nIf set to `true` drag will use a damping effect rather than a linear approach. If you are\ncreating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\nthe game Asteroids) then you will get a far smoother and more visually correct deceleration\nby using damping, avoiding the axis-drift that is prone with linear deceleration.\n\nIf you enable this property then you should use far smaller `drag` values than with linear, as\nthey are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\ndeceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.","name":"useDamping","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.10.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#useDamping","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":495,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The rate of change of this Body's `rotation`, in degrees per second.","name":"angularVelocity","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#angularVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":505,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's angular acceleration (change in angular velocity), in degrees per second squared.","name":"angularAcceleration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#angularAcceleration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":515,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Loss of angular velocity due to angular movement, in degrees per second.\n\nAngular drag is applied only when angular acceleration is zero.","name":"angularDrag","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#angularDrag","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":527,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's maximum angular velocity, in degrees per second.","name":"maxAngular","type":{"names":["number"]},"defaultvalue":"1000","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#maxAngular","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":537,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's inertia, relative to a default unit (1).\nWith `bounce`, this affects the exchange of momentum (velocities) during collisions.","name":"mass","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#mass","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":548,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The calculated angle of this Body's velocity vector, in radians, during the last step.","name":"angle","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":558,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The calculated magnitude of the Body's velocity, in pixels per second, during the last step.","name":"speed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#speed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":568,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The direction of the Body's velocity, as calculated during the last step.\nIf the Body is moving on both axes (diagonally), this describes motion on the vertical axis only.","name":"facing","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#facing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":578,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body can be moved by collisions with another Body.","name":"immovable","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#immovable","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":588,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the Body's position and rotation are affected by its velocity, acceleration, drag, and gravity.","name":"moves","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#moves","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":598,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A flag disabling the default horizontal separation of colliding bodies.\nPass your own `collideCallback` to the collider.","name":"customSeparateX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#customSeparateX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":609,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A flag disabling the default vertical separation of colliding bodies.\nPass your own `collideCallback` to the collider.","name":"customSeparateY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#customSeparateY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":620,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The amount of horizontal overlap (before separation), if this Body is colliding with another.","name":"overlapX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#overlapX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":630,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The amount of vertical overlap (before separation), if this Body is colliding with another.","name":"overlapY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#overlapY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":640,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The amount of overlap (before separation), if this Body is circular and colliding with another circular body.","name":"overlapR","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#overlapR","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":650,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is overlapped with another and both are not moving, on at least one axis.","name":"embedded","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#embedded","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":660,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body interacts with the world boundary.","name":"collideWorldBounds","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#collideWorldBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":670,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is checked for collisions and for which directions.\nYou can set `checkCollision.none = true` to disable collision checks.","name":"checkCollision","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#checkCollision","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":680,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is colliding with a Body or Static Body and in which direction.\nIn a collision where both bodies have zero velocity, `embedded` will be set instead.","name":"touching","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#blocked","Phaser.Physics.Arcade.Body#embedded"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#touching","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":693,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This Body's `touching` value during the previous step.","name":"wasTouching","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#touching"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#wasTouching","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":704,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is colliding with a Static Body, a tile, or the world boundary.\nIn a collision with a Static Body, if this Body has zero velocity then `embedded` will be set instead.","name":"blocked","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#embedded","Phaser.Physics.Arcade.Body#touching"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#blocked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":717,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether to automatically synchronize this Body's dimensions to the dimensions of its Game Object's visual bounds.","name":"syncBounds","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.GameObjects.Components.GetBounds#getBounds"],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#syncBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":728,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's physics type (dynamic or static).","name":"physicsType","type":{"names":["integer"]},"readonly":true,"defaultvalue":"Phaser.Physics.Arcade.DYNAMIC_BODY","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#physicsType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":814,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Updates the Body's `transform`, `width`, `height`, and `center` from its Game Object.\nThe Body's `position` isn't changed.","kind":"function","name":"updateBounds","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#updateBounds","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":885,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Updates the Body's `center` from its `position`, `width`, and `height`.","kind":"function","name":"updateCenter","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#updateCenter","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":896,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Prepares the Body for a physics step by resetting the `wasTouching`, `touching` and `blocked` states.\n\nThis method is only called if the physics world is going to run a step this frame.","kind":"function","name":"resetFlags","since":"3.18.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#resetFlags","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":932,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Syncs the position body position with the parent Game Object.\n\nThis method is called every game frame, regardless if the world steps or not.","kind":"function","name":"preUpdate","since":"3.17.0","params":[{"type":{"names":["boolean"]},"description":"Will this Body run an update as well?","name":"willStep"},{"type":{"names":["number"]},"description":"The delta time, in seconds, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#preUpdate","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":977,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Performs a single physics step and updates the body velocity, angle, speed and other properties.\n\nThis method can be called multiple times per game frame, depending on the physics step rate.\n\nThe results are synced back to the Game Object in `postUpdate`.","kind":"function","name":"update","fires":["Phaser.Physics.Arcade.Events#event:WORLD_BOUNDS"],"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delta time, in seconds, elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#update","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1024,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Feeds the Body results back into the parent Game Object.\n\nThis method is called every game frame, regardless if the world steps or not.","kind":"function","name":"postUpdate","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#postUpdate","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1097,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets a custom collision boundary rectangle. Use if you want to have a custom\nboundary instead of the world boundaries.","kind":"function","name":"setBoundsRectangle","since":"3.20","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"nullable":true,"description":"The new boundary rectangle. Pass `null` to use the World bounds.","name":"bounds"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setBoundsRectangle","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1115,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Checks for collisions between this Body and the world boundary and separates them.","kind":"function","name":"checkWorldBounds","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if this Body is colliding with the world boundary."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#checkWorldBounds","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1172,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the offset of the Body's position from its Game Object's position.","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal offset, in source pixels.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical offset, in source pixels.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setOffset","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1193,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sizes and positions this Body's boundary, as a rectangle.\nModifies the Body `offset` if `center` is true (the default).\nResets the width and height to match current frame, if no width and height provided and a frame is found.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The width of the Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame width.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame height.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Modify the Body's `offset`, placing the Body's center on its Game Object's center. Only works if the Game Object has the `getCenter` method.","name":"center"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setSize","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1248,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sizes and positions this Body's boundary, as a circle.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the Body, in source pixels.","name":"radius"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal offset of the Body from its Game Object, in source pixels.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"description":"The vertical offset of the Body from its Game Object, in source pixels.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setCircle","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Resets this Body to the given coordinates. Also positions its parent Game Object to the same coordinates.\nIf the Body had any velocity or acceleration it is lost as a result of calling this.","kind":"function","name":"reset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position to place the Game Object and Body.","name":"y"}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#reset","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1328,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets acceleration, velocity, and speed to zero.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#stop","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1347,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Copies the coordinates of this Body's edges into an object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyBounds"]},"description":"An object to copy the values into.","name":"obj"}],"returns":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyBounds"]},"description":"- An object with {x, y, right, bottom}."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#getBounds","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Tests if the coordinates are within this Body's boundary.","kind":"function","name":"hitTest","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"True if (x, y) is within this Body."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#hitTest","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1397,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is touching a tile or the world boundary while moving down.","kind":"function","name":"onFloor","since":"3.0.0","see":["Phaser.Physics.Arcade.Body#blocked"],"returns":[{"type":{"names":["boolean"]},"description":"True if touching."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#onFloor","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is touching a tile or the world boundary while moving up.","kind":"function","name":"onCeiling","since":"3.0.0","see":["Phaser.Physics.Arcade.Body#blocked"],"returns":[{"type":{"names":["boolean"]},"description":"True if touching."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#onCeiling","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body is touching a tile or the world boundary while moving left or right.","kind":"function","name":"onWall","since":"3.0.0","see":["Phaser.Physics.Arcade.Body#blocked"],"returns":[{"type":{"names":["boolean"]},"description":"True if touching."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#onWall","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1439,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The absolute (non-negative) change in this Body's horizontal position from the previous step.","kind":"function","name":"deltaAbsX","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The delta value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaAbsX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1452,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The absolute (non-negative) change in this Body's vertical position from the previous step.","kind":"function","name":"deltaAbsY","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The delta value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaAbsY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this Body's horizontal position from the previous step.\nThis value is set during the Body's update phase.\n\nAs a Body can update multiple times per step this may not hold the final\ndelta value for the Body. In this case, please see the `deltaXFinal` method.","kind":"function","name":"deltaX","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The delta value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1482,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this Body's vertical position from the previous step.\nThis value is set during the Body's update phase.\n\nAs a Body can update multiple times per step this may not hold the final\ndelta value for the Body. In this case, please see the `deltaYFinal` method.","kind":"function","name":"deltaY","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The delta value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1499,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this Body's horizontal position from the previous game update.\n\nThis value is set during the `postUpdate` phase and takes into account the\n`deltaMax` and final position of the Body.\n\nBecause this value is not calculated until `postUpdate`, you must listen for it\nduring a Scene `POST_UPDATE` or `RENDER` event, and not in `update`, as it will\nnot be calculated by that point. If you _do_ use these values in `update` they\nwill represent the delta from the _previous_ game frame.","kind":"function","name":"deltaXFinal","since":"3.22.0","returns":[{"type":{"names":["number"]},"description":"The final delta x value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaXFinal","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1520,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this Body's vertical position from the previous game update.\n\nThis value is set during the `postUpdate` phase and takes into account the\n`deltaMax` and final position of the Body.\n\nBecause this value is not calculated until `postUpdate`, you must listen for it\nduring a Scene `POST_UPDATE` or `RENDER` event, and not in `update`, as it will\nnot be calculated by that point. If you _do_ use these values in `update` they\nwill represent the delta from the _previous_ game frame.","kind":"function","name":"deltaYFinal","since":"3.22.0","returns":[{"type":{"names":["number"]},"description":"The final delta y value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaYFinal","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this Body's rotation from the previous step, in degrees.","kind":"function","name":"deltaZ","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The delta value."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#deltaZ","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Disables this Body and marks it for deletion by the simulation.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#destroy","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1570,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Draws this Body's boundary and velocity, if enabled.","kind":"function","name":"drawDebug","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to draw on.","name":"graphic"}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#drawDebug","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1625,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Body will be drawn to the debug display.","kind":"function","name":"willDrawDebug","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if either `debugShowBody` or `debugShowVelocity` are enabled."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#willDrawDebug","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1638,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets whether this Body collides with the world boundary.\n\nOptionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.","kind":"function","name":"setCollideWorldBounds","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if this body should collide with the world bounds, otherwise `false`.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.x` value.","name":"bounceX"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.y` value.","name":"bounceY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setCollideWorldBounds","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1682,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's velocity.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity, in pixels per second.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity, in pixels per second.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setVelocity","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1705,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's horizontal velocity.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The velocity, in pixels per second.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setVelocityX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1727,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's vertical velocity.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The velocity, in pixels per second.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setVelocityY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1749,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's maximum velocity.","kind":"function","name":"setMaxVelocity","since":"3.10.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity, in pixels per second.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity, in pixels per second.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setMaxVelocity","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1767,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the maximum speed the Body can move.","kind":"function","name":"setMaxSpeed","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The maximum speed value, in pixels per second. Set to a negative value to disable.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setMaxSpeed","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1784,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's bounce.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal bounce, relative to 1.","name":"x"},{"type":{"names":["number"]},"description":"The vertical bounce, relative to 1.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setBounce","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1802,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's horizontal bounce.","kind":"function","name":"setBounceX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The bounce, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setBounceX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1819,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's vertical bounce.","kind":"function","name":"setBounceY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The bounce, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setBounceY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1836,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's acceleration.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal component, in pixels per second squared.","name":"x"},{"type":{"names":["number"]},"description":"The vertical component, in pixels per second squared.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAcceleration","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1854,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's horizontal acceleration.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The acceleration, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAccelerationX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1871,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's vertical acceleration.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The acceleration, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAccelerationY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1888,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Enables or disables drag.","kind":"function","name":"setAllowDrag","since":"3.9.0","see":["Phaser.Physics.Arcade.Body#allowDrag"],"params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` to allow drag on this body, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAllowDrag","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1908,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Enables or disables gravity's effect on this Body.","kind":"function","name":"setAllowGravity","since":"3.9.0","see":["Phaser.Physics.Arcade.Body#allowGravity"],"params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` to allow gravity on this body, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAllowGravity","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1928,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Enables or disables rotation.","kind":"function","name":"setAllowRotation","since":"3.9.0","see":["Phaser.Physics.Arcade.Body#allowRotation"],"params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` to allow rotation on this body, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAllowRotation","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1948,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's drag.","kind":"function","name":"setDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal component, in pixels per second squared.","name":"x"},{"type":{"names":["number"]},"description":"The vertical component, in pixels per second squared.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setDrag","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1966,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's horizontal drag.","kind":"function","name":"setDragX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The drag, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setDragX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":1983,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's vertical drag.","kind":"function","name":"setDragY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The drag, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setDragY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2000,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's gravity.","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal component, in pixels per second squared.","name":"x"},{"type":{"names":["number"]},"description":"The vertical component, in pixels per second squared.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setGravity","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2018,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's horizontal gravity.","kind":"function","name":"setGravityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravity, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setGravityX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2035,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's vertical gravity.","kind":"function","name":"setGravityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravity, in pixels per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setGravityY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2052,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's friction.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal component, relative to 1.","name":"x"},{"type":{"names":["number"]},"description":"The vertical component, relative to 1.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setFriction","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2070,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's horizontal friction.","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The friction value, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setFrictionX","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2087,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's vertical friction.","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The friction value, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setFrictionY","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2104,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's angular velocity.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The velocity, in degrees per second.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAngularVelocity","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2121,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's angular acceleration.","kind":"function","name":"setAngularAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The acceleration, in degrees per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAngularAcceleration","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2138,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's angular drag.","kind":"function","name":"setAngularDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The drag, in degrees per second squared.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setAngularDrag","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's mass.","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The mass value, relative to 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setMass","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2172,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's `immovable` property.","kind":"function","name":"setImmovable","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The value to assign to `immovable`.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setImmovable","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Body's `enable` property.","kind":"function","name":"setEnable","since":"3.15.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The value to assign to `enable`.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#setEnable","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":2210,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's horizontal position (left edge).","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":2231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Body's vertical position (top edge).","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":2252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The left edge of the Body's boundary. Identical to x.","name":"left","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":2269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The right edge of the Body's boundary.","name":"right","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":2286,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The top edge of the Body's boundary. Identical to y.","name":"top","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":2303,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The bottom edge of this Body's boundary.","name":"bottom","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Body","longname":"Phaser.Physics.Arcade.Body#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"Collider.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Collider.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"An Arcade Physics Collider will automatically check for collision, or overlaps, between two objects\nevery step. If a collision, or overlap, occurs it will invoke the given callbacks.","kind":"class","name":"Collider","memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The Arcade physics World that will manage the collisions.","name":"world"},{"type":{"names":["boolean"]},"description":"Whether to check for collisions or overlap.","name":"overlapOnly"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object to check for collision.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The second object to check for collision.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"description":"The callback to invoke when the two objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"description":"The callback to invoke when the two objects collide. Must return a boolean.","name":"processCallback"},{"type":{"names":["any"]},"description":"The scope in which to call the callbacks.","name":"callbackContext"}],"scope":"static","longname":"Phaser.Physics.Arcade.Collider","___s":true},{"meta":{"filename":"Collider.js","lineno":33,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The world in which the bodies will collide.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The name of the collider (unused by Phaser).","name":"name","type":{"names":["string"]},"since":"3.1.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the collider is active.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether to check for collisions or overlaps.","name":"overlapOnly","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#overlapOnly","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The first object to check for collision.","name":"object1","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#object1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The second object to check for collision.","name":"object2","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#object2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The callback to invoke when the two objects collide.","name":"collideCallback","type":{"names":["ArcadePhysicsCallback"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#collideCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"If a processCallback exists it must return true or collision checking will be skipped.","name":"processCallback","type":{"names":["ArcadePhysicsCallback"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#processCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The context the collideCallback and processCallback will run in.","name":"callbackContext","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#callbackContext","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Collider.js","lineno":116,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A name for the Collider.\n\nPhaser does not use this value, it's for your own reference.","kind":"function","name":"setName","since":"3.1.0","params":[{"type":{"names":["string"]},"description":"The name to assign to the Collider.","name":"name"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Collider"]},"description":"This Collider instance."}],"memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#setName","scope":"instance","___s":true},{"meta":{"filename":"Collider.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Called by World as part of its step processing, initial operation of collision checking.","kind":"function","name":"update","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#update","scope":"instance","___s":true},{"meta":{"filename":"Collider.js","lineno":153,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Removes Collider from World and disposes of its resources.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Collider","longname":"Phaser.Physics.Arcade.Collider#destroy","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"Factory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"ArcadeImage","longname":"ArcadeImage","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Factory.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"The Arcade Physics Factory allows you to easily create Arcade Physics enabled Game Objects.\nObjects that are created by this Factory are automatically added to the physics world.","kind":"class","name":"Factory","memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The Arcade Physics World instance.","name":"world"}],"scope":"static","longname":"Phaser.Physics.Arcade.Factory","___s":true},{"meta":{"filename":"Factory.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A reference to the Arcade Physics World.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A reference to the Scene this Arcade Physics instance belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A reference to the Scene.Systems this Arcade Physics instance belongs to.","name":"sys","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#sys","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Arcade Physics Collider object.","kind":"function","name":"collider","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group","Array."]},"description":"The first object to check for collision.","name":"object1"},{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group","Array."]},"description":"The second object to check for collision.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects collide. Must return a boolean.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The scope in which to call the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Collider"]},"description":"The Collider that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#collider","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Arcade Physics Collider Overlap object.","kind":"function","name":"overlap","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group","Array."]},"description":"The first object to check for overlap.","name":"object1"},{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group","Array."]},"description":"The second object to check for overlap.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects collide. Must return a boolean.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The scope in which to call the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Collider"]},"description":"The Collider that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#overlap","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Adds an Arcade Physics Body to the given Game Object.","kind":"function","name":"existing","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A Game Object.","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a Static body (true) or Dynamic body (false).","name":"isStatic"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#existing","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":118,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Arcade Image object with a Static body.","kind":"function","name":"staticImage","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"The Image object that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#staticImage","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":142,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Arcade Image object with a Dynamic body.","kind":"function","name":"image","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"The Image object that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#image","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Arcade Sprite object with a Static body.","kind":"function","name":"staticSprite","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"The Sprite object that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#staticSprite","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Arcade Sprite object with a Dynamic body.","kind":"function","name":"sprite","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"The Sprite object that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#sprite","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":216,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a Static Physics Group object.\nAll Game Objects created by this Group will automatically be static Arcade Physics objects.","kind":"function","name":"staticGroup","since":"3.0.0","params":[{"type":{"names":["Array.","Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Game Objects to add to this group; or the `config` argument.","name":"children"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Settings for this group.","name":"config"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticGroup"]},"description":"The Static Group object that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#staticGroup","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":233,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a Physics Group object.\nAll Game Objects created by this Group will automatically be dynamic Arcade Physics objects.","kind":"function","name":"group","since":"3.0.0","params":[{"type":{"names":["Array.","Phaser.Types.Physics.Arcade.PhysicsGroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Game Objects to add to this group; or the `config` argument.","name":"children"},{"type":{"names":["Phaser.Types.Physics.Arcade.PhysicsGroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Settings for this group.","name":"config"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Group"]},"description":"The Group object that was created."}],"memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#group","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":250,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Destroys this Factory.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Physics.Arcade.Factory","longname":"Phaser.Physics.Arcade.Factory#destroy","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"GetOverlapX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetOverlapX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Calculates and returns the horizontal overlap between two arcade physics bodies and sets their properties\naccordingly, including: `touching.left`, `touching.right`, `touching.none` and `overlapX'.","kind":"function","name":"GetOverlapX","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first Body to separate.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second Body to separate.","name":"body2"},{"type":{"names":["boolean"]},"description":"Is this an overlap only check, or part of separation?","name":"overlapOnly"},{"type":{"names":["number"]},"description":"A value added to the delta values during collision checks. Increase it to prevent sprite tunneling(sprites passing through another instead of colliding).","name":"bias"}],"returns":[{"type":{"names":["number"]},"description":"The amount of overlap."}],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.GetOverlapX","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"GetOverlapY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetOverlapY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Calculates and returns the vertical overlap between two arcade physics bodies and sets their properties\naccordingly, including: `touching.up`, `touching.down`, `touching.none` and `overlapY'.","kind":"function","name":"GetOverlapY","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first Body to separate.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second Body to separate.","name":"body2"},{"type":{"names":["boolean"]},"description":"Is this an overlap only check, or part of separation?","name":"overlapOnly"},{"type":{"names":["number"]},"description":"A value added to the delta values during collision checks. Increase it to prevent sprite tunneling(sprites passing through another instead of colliding).","name":"bias"}],"returns":[{"type":{"names":["number"]},"description":"The amount of overlap."}],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.GetOverlapY","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"PhysicsGroup.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"ArcadeSprite","longname":"ArcadeSprite","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"An Arcade Physics Group object.\n\nAll Game Objects created by this Group will automatically be given dynamic Arcade Physics bodies.\n\nIts static counterpart is {@link Phaser.Physics.Arcade.StaticGroup}.","kind":"class","name":"Group","augments":["Phaser.GameObjects.Group"],"memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The physics simulation.","name":"world"},{"type":{"names":["Phaser.Scene"]},"description":"The scene this group belongs to.","name":"scene"},{"type":{"names":["Array.","Phaser.Types.Physics.Arcade.PhysicsGroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Game Objects to add to this group; or the `config` argument.","name":"children"},{"type":{"names":["Phaser.Types.Physics.Arcade.PhysicsGroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Settings for this group.","name":"config"}],"scope":"static","longname":"Phaser.Physics.Arcade.Group","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The physics simulation.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The class to create new Group members from.\n\nThis should be either `Phaser.Physics.Arcade.Image`, `Phaser.Physics.Arcade.Sprite`, or a class extending one of those.","name":"classType","type":{"names":["function"]},"defaultvalue":"ArcadeSprite","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#classType","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Group#classType","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":100,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The physics type of the Group's members.","name":"physicsType","type":{"names":["integer"]},"defaultvalue":"Phaser.Physics.Arcade.DYNAMIC_BODY","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#physicsType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Default physics properties applied to Game Objects added to the Group or created by the Group. Derived from the `config` argument.","name":"defaults","type":{"names":["Phaser.Types.Physics.Arcade.PhysicsGroupDefaults"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#defaults","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":150,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A textual representation of this Game Object.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"defaultvalue":"'PhysicsGroup'","since":"3.21.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#type","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Group#type","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":162,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Enables a Game Object's Body and assigns `defaults`. Called when a Group member is added or created.","kind":"function","name":"createCallbackHandler","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object being added.","name":"child"}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#createCallbackHandler","scope":"instance","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Disables a Game Object's Body. Called when a Group member is removed.","kind":"function","name":"removeCallbackHandler","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object being removed.","name":"child"}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#removeCallbackHandler","scope":"instance","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the velocity of each Group member.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity.","name":"x"},{"type":{"names":["number"]},"description":"The vertical velocity.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The velocity increment. When set, the first member receives velocity (x, y), the second (x + step, y + step), and so on.","name":"step"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Group"]},"description":"This Physics Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setVelocity","scope":"instance","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the horizontal velocity of each Group member.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The velocity value.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The velocity increment. When set, the first member receives velocity (x), the second (x + step), and so on.","name":"step"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Group"]},"description":"This Physics Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setVelocityX","scope":"instance","___s":true},{"meta":{"filename":"PhysicsGroup.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the vertical velocity of each Group member.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The velocity value.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The velocity increment. When set, the first member receives velocity (y), the second (y + step), and so on.","name":"step"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Group"]},"description":"This Physics Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setVelocityY","scope":"instance","___s":true},{"meta":{"range":[180,218],"filename":"SeparateX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"GetOverlapX","longname":"GetOverlapX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SeparateX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Separates two overlapping bodies on the X-axis (horizontally).\n\nSeparation involves moving two overlapping bodies so they don't overlap anymore and adjusting their velocities based on their mass. This is a core part of collision detection.\n\nThe bodies won't be separated if there is no horizontal overlap between them, if they are static, or if either one uses custom logic for its separation.","kind":"function","name":"SeparateX","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first Body to separate.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second Body to separate.","name":"body2"},{"type":{"names":["boolean"]},"description":"If `true`, the bodies will only have their overlap data set and no separation will take place.","name":"overlapOnly"},{"type":{"names":["number"]},"description":"A value to add to the delta value during overlap checking. Used to prevent sprite tunneling.","name":"bias"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two bodies overlap horizontally, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.SeparateX","scope":"static","___s":true},{"meta":{"range":[180,218],"filename":"SeparateY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"GetOverlapY","longname":"GetOverlapY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SeparateY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Separates two overlapping bodies on the Y-axis (vertically).\n\nSeparation involves moving two overlapping bodies so they don't overlap anymore and adjusting their velocities based on their mass. This is a core part of collision detection.\n\nThe bodies won't be separated if there is no vertical overlap between them, if they are static, or if either one uses custom logic for its separation.","kind":"function","name":"SeparateY","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first Body to separate.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second Body to separate.","name":"body2"},{"type":{"names":["boolean"]},"description":"If `true`, the bodies will only have their overlap data set and no separation will take place.","name":"overlapOnly"},{"type":{"names":["number"]},"description":"A value to add to the delta value during overlap checking. Used to prevent sprite tunneling.","name":"bias"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the two bodies overlap vertically, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.SeparateY","scope":"static","___s":true},{"meta":{"range":[180,234],"filename":"StaticBody.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"CircleContains","longname":"CircleContains","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"StaticBody.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"A Static Arcade Physics Body.\n\nA Static Body never moves, and isn't automatically synchronized with its parent Game Object.\nThat means if you make any change to the parent's origin, position, or scale after creating or adding the body, you'll need to update the Body manually.\n\nA Static Body can collide with other Bodies, but is never moved by collisions.\n\nIts dynamic counterpart is {@link Phaser.Physics.Arcade.Body}.","kind":"class","name":"StaticBody","memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The Arcade Physics simulation this Static Body belongs to.","name":"world"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object this Static Body belongs to.","name":"gameObject"}],"scope":"static","longname":"Phaser.Physics.Arcade.StaticBody","___s":true},{"meta":{"filename":"StaticBody.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Arcade Physics simulation this Static Body belongs to.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Game Object this Static Body belongs to.","name":"gameObject","type":{"names":["Phaser.GameObjects.GameObject"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#gameObject","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the Static Body's boundary is drawn to the debug display.","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#debugShowBody","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The color of this Static Body on the debug display.","name":"debugBodyColor","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#debugBodyColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Static Body is updated by the physics simulation.","name":"enable","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#enable","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this Static Body's boundary is circular (`true`) or rectangular (`false`).","name":"isCircle","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#isCircle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"If this Static Body is circular, this is the unscaled radius of the Static Body's boundary, as set by {@link #setCircle}, in source pixels.\nThe true radius is equal to `halfWidth`.","name":"radius","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#radius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The offset of this Static Body's actual position from any updated position.\n\nUnlike a dynamic Body, a Static Body does not follow its Game Object. As such, this offset is only applied when resizing the Static Body.","name":"offset","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The position of this Static Body within the simulation.","name":"position","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#position","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The width of the Static Body's boundary, in pixels.\nIf the Static Body is circular, this is also the Static Body's diameter.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The height of the Static Body's boundary, in pixels.\nIf the Static Body is circular, this is also the Static Body's diameter.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Half the Static Body's width, in pixels.\nIf the Static Body is circular, this is also the Static Body's radius.","name":"halfWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#halfWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Half the Static Body's height, in pixels.\nIf the Static Body is circular, this is also the Static Body's radius.","name":"halfHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#halfHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The center of the Static Body's boundary.\nThis is the midpoint of its `position` (top-left corner) and its bottom-right corner.","name":"center","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#center","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A constant zero velocity used by the Arcade Physics simulation for calculations.","name":"velocity","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#velocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":188,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A constant `false` value expected by the Arcade Physics simulation.","name":"allowGravity","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#allowGravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":199,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Gravitational force applied specifically to this Body. Values are in pixels per second squared. Always zero for a Static Body.","name":"gravity","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#gravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":209,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Rebound, or restitution, following a collision, relative to 1. Always zero for a Static Body.","name":"bounce","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#bounce","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":221,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation emits a `worldbounds` event when this StaticBody collides with the world boundary.\nAlways false for a Static Body. (Static Bodies never collide with the world boundary and never trigger a `worldbounds` event.)","name":"onWorldBounds","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#onWorldBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":233,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation emits a `collide` event when this StaticBody collides with another.","name":"onCollide","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#onCollide","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":243,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation emits an `overlap` event when this StaticBody overlaps with another.","name":"onOverlap","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#onOverlap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":253,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The StaticBody's inertia, relative to a default unit (1). With `bounce`, this affects the exchange of momentum (velocities) during collisions.","name":"mass","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#mass","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":263,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this object can be moved by collisions with another body.","name":"immovable","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#immovable","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A flag disabling the default horizontal separation of colliding bodies. Pass your own `collideHandler` to the collider.","name":"customSeparateX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#customSeparateX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":283,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A flag disabling the default vertical separation of colliding bodies. Pass your own `collideHandler` to the collider.","name":"customSeparateY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#customSeparateY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":293,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The amount of horizontal overlap (before separation), if this Body is colliding with another.","name":"overlapX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#overlapX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":303,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The amount of vertical overlap (before separation), if this Body is colliding with another.","name":"overlapY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#overlapY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":313,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The amount of overlap (before separation), if this StaticBody is circular and colliding with another circular body.","name":"overlapR","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#overlapR","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":323,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this StaticBody has ever overlapped with another while both were not moving.","name":"embedded","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#embedded","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":333,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this StaticBody interacts with the world boundary.\nAlways false for a Static Body. (Static Bodies never collide with the world boundary.)","name":"collideWorldBounds","type":{"names":["boolean"]},"readonly":true,"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#collideWorldBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":345,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this StaticBody is checked for collisions and for which directions. You can set `checkCollision.none = false` to disable collision checks.","name":"checkCollision","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#checkCollision","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":354,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this StaticBody has ever collided with another body and in which direction.","name":"touching","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#touching","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":363,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this StaticBody was colliding with another body during the last step or any previous step, and in which direction.","name":"wasTouching","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#wasTouching","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":372,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether this StaticBody has ever collided with a tile or the world boundary.","name":"blocked","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyCollision"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#blocked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":381,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The StaticBody's physics type (static by default).","name":"physicsType","type":{"names":["integer"]},"defaultvalue":"Phaser.Physics.Arcade.STATIC_BODY","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#physicsType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":416,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Changes the Game Object this Body is bound to.\nFirst it removes its reference from the old Game Object, then sets the new one.\nYou can optionally update the position and dimensions of this Body to reflect that of the new Game Object.","kind":"function","name":"setGameObject","since":"3.1.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The new Game Object that will own this Body.","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Reposition and resize this Body to match the new Game Object?","name":"update"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"see":["Phaser.Physics.Arcade.StaticBody#updateFromGameObject"],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#setGameObject","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":452,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Syncs the Body's position and size with its parent Game Object.","kind":"function","name":"updateFromGameObject","since":"3.1.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#updateFromGameObject","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":481,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the offset of the body.","kind":"function","name":"setOffset","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The horizontal offset of the Body from the Game Object's center.","name":"x"},{"type":{"names":["number"]},"description":"The vertical offset of the Body from the Game Object's center.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#setOffset","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the size of the body.\nResets the width and height to match current frame, if no width and height provided and a frame is found.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The width of the Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame width.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame height.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Modify the Body's `offset`, placing the Body's center on its Game Object's center. Only works if the Game Object has the `getCenter` method.","name":"center"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#setSize","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":574,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets this Static Body to have a circular body and sets its sizes and position.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the StaticBody, in pixels.","name":"radius"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal offset of the StaticBody from its Game Object, in pixels.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"description":"The vertical offset of the StaticBody from its Game Object, in pixels.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#setCircle","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":619,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Updates the StaticBody's `center` from its `position` and dimensions.","kind":"function","name":"updateCenter","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#updateCenter","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":630,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Resets this Body to the given coordinates. Also positions its parent Game Object to the same coordinates.","kind":"function","name":"reset","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x coordinate to reset the body to. If not given will use the parent Game Object's coordinate.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to reset the body to. If not given will use the parent Game Object's coordinate.","name":"y"}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#reset","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":657,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"NOOP function. A Static Body cannot be stopped.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#stop","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":670,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Returns the x and y coordinates of the top left and bottom right points of the StaticBody.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyBounds"]},"description":"The object which will hold the coordinates of the bounds.","name":"obj"}],"returns":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeBodyBounds"]},"description":"The same object that was passed with `x`, `y`, `right` and `bottom` values matching the respective values of the StaticBody."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#getBounds","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":690,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Checks to see if a given x,y coordinate is colliding with this Static Body.","kind":"function","name":"hitTest","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to check against this body.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to check against this body.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the given coordinate lies within this body, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#hitTest","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":706,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"NOOP","kind":"function","name":"postUpdate","since":"3.12.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#postUpdate","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":716,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The absolute (non-negative) change in this StaticBody's horizontal position from the previous step. Always zero.","kind":"function","name":"deltaAbsX","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"Always zero for a Static Body."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#deltaAbsX","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":729,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The absolute (non-negative) change in this StaticBody's vertical position from the previous step. Always zero.","kind":"function","name":"deltaAbsY","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"Always zero for a Static Body."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#deltaAbsY","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this StaticBody's horizontal position from the previous step. Always zero.","kind":"function","name":"deltaX","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The change in this StaticBody's velocity from the previous step. Always zero."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#deltaX","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":755,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this StaticBody's vertical position from the previous step. Always zero.","kind":"function","name":"deltaY","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The change in this StaticBody's velocity from the previous step. Always zero."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#deltaY","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":768,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The change in this StaticBody's rotation from the previous step. Always zero.","kind":"function","name":"deltaZ","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The change in this StaticBody's rotation from the previous step. Always zero."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#deltaZ","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":781,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Disables this Body and marks it for destruction during the next step.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#destroy","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":794,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Draws a graphical representation of the StaticBody for visual debugging purposes.","kind":"function","name":"drawDebug","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to use for the debug drawing of the StaticBody.","name":"graphic"}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#drawDebug","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":825,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Indicates whether the StaticBody is going to be showing a debug visualization during postUpdate.","kind":"function","name":"willDrawDebug","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether or not the StaticBody is going to show the debug visualization during postUpdate."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#willDrawDebug","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":838,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the Mass of the StaticBody. Will set the Mass to 0.1 if the value passed is less than or equal to zero.","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to set the Mass to. Values of zero or less are changed to 0.1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticBody"]},"description":"This Static Body object."}],"memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#setMass","scope":"instance","___s":true},{"meta":{"filename":"StaticBody.js","lineno":861,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The x coordinate of the StaticBody.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":886,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The y coordinate of the StaticBody.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":911,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Returns the left-most x coordinate of the area of the StaticBody.","name":"left","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#left","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":928,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The right-most x coordinate of the area of the StaticBody.","name":"right","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#right","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":945,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The highest y coordinate of the area of the StaticBody.","name":"top","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#top","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticBody.js","lineno":962,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The lowest y coordinate of the area of the StaticBody. (y + height)","name":"bottom","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticBody","longname":"Phaser.Physics.Arcade.StaticBody#bottom","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,220],"filename":"StaticPhysicsGroup.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"ArcadeSprite","longname":"ArcadeSprite","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"An Arcade Physics Static Group object.\n\nAll Game Objects created by this Group will automatically be given static Arcade Physics bodies.\n\nIts dynamic counterpart is {@link Phaser.Physics.Arcade.Group}.","kind":"class","name":"StaticGroup","augments":["Phaser.GameObjects.Group"],"memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"The physics simulation.","name":"world"},{"type":{"names":["Phaser.Scene"]},"description":"The scene this group belongs to.","name":"scene"},{"type":{"names":["Array.","Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Game Objects to add to this group; or the `config` argument.","name":"children"},{"type":{"names":["Phaser.Types.GameObjects.Group.GroupConfig","Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"optional":true,"description":"Settings for this group.","name":"config"}],"scope":"static","longname":"Phaser.Physics.Arcade.StaticGroup","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The physics simulation.","name":"world","type":{"names":["Phaser.Physics.Arcade.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":85,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The scene this group belongs to.","name":"physicsType","type":{"names":["integer"]},"defaultvalue":"Phaser.Physics.Arcade.STATIC_BODY","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#physicsType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A textual representation of this Game Object.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"defaultvalue":"'StaticPhysicsGroup'","since":"3.21.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#type","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Group#type","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Adds a static physics body to the new group member (if it lacks one) and adds it to the simulation.","kind":"function","name":"createCallbackHandler","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The new group member.","name":"child"}],"see":["Phaser.Physics.Arcade.World#enableBody"],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#createCallbackHandler","scope":"instance","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Disables the group member's physics body, removing it from the simulation.","kind":"function","name":"removeCallbackHandler","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The group member being removed.","name":"child"}],"see":["Phaser.Physics.Arcade.World#disableBody"],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#removeCallbackHandler","scope":"instance","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Refreshes the group.","kind":"function","name":"createMultipleCallbackHandler","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The newly created group members.","name":"entries"}],"see":["Phaser.Physics.Arcade.StaticGroup#refresh"],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#createMultipleCallbackHandler","scope":"instance","___s":true},{"meta":{"filename":"StaticPhysicsGroup.js","lineno":160,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Resets each Body to the position of its parent Game Object.\nBody sizes aren't changed (use {@link Phaser.Physics.Arcade.Components.Enable#refreshBody} for that).","kind":"function","name":"refresh","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.StaticGroup"]},"description":"This group."}],"see":["Phaser.Physics.Arcade.StaticBody#reset"],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#refresh","scope":"instance","___s":true},{"meta":{"range":[180,204],"filename":"World.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"World.js","lineno":35,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"classdesc":"The Arcade Physics World.\n\nThe World is responsible for creating, managing, colliding and updating all of the bodies within it.\n\nAn instance of the World belongs to a Phaser.Scene and is accessed via the property `physics.world`.","kind":"class","name":"World","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Physics.Arcade","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this World instance belongs.","name":"scene"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeWorldConfig"]},"description":"An Arcade Physics Configuration object.","name":"config"}],"scope":"static","longname":"Phaser.Physics.Arcade.World","___s":true},{"meta":{"filename":"World.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The Scene this simulation belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Dynamic Bodies in this simulation.","name":"bodies","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#bodies","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Static Bodies in this simulation.","name":"staticBodies","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#staticBodies","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Static Bodies marked for deletion.","name":"pendingDestroy","type":{"names":["Phaser.Structs.Set.<(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody)>"]},"since":"3.1.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#pendingDestroy","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This simulation's collision processors.","name":"colliders","type":{"names":["Phaser.Structs.ProcessQueue."]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#colliders","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Acceleration of Bodies due to gravity, in pixels per second.","name":"gravity","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#gravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A boundary constraining Bodies.","name":"bounds","type":{"names":["Phaser.Geom.Rectangle"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#bounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The boundary edges that Bodies can collide with.","name":"checkCollision","type":{"names":["Phaser.Types.Physics.Arcade.CheckCollisionObject"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#checkCollision","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The number of physics steps to be taken per second.\n\nThis property is read-only. Use the `setFPS` method to modify it at run-time.","name":"fps","readonly":true,"type":{"names":["number"]},"defaultvalue":"60","since":"3.10.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#fps","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The number of steps that took place in the last frame.","name":"stepsLastFrame","readonly":true,"type":{"names":["number"]},"since":"3.10.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#stepsLastFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":197,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Scaling factor applied to the frame rate.\n\n- 1.0 = normal speed\n- 2.0 = half speed\n- 0.5 = double speed","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.10.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The maximum absolute difference of a Body's per-step velocity and its overlap with another Body that will result in separation on *each axis*.\nLarger values favor separation.\nSmaller values favor no separation.","name":"OVERLAP_BIAS","type":{"names":["number"]},"defaultvalue":"4","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#OVERLAP_BIAS","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":223,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The maximum absolute value of a Body's overlap with a tile that will result in separation on *each axis*.\nLarger values favor separation.\nSmaller values favor no separation.\nThe optimum value may be similar to the tile size.","name":"TILE_BIAS","type":{"names":["number"]},"defaultvalue":"16","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#TILE_BIAS","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":236,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Always separate overlapping Bodies horizontally before vertically.\nFalse (the default) means Bodies are first separated on the axis of greater gravity, or the vertical axis if neither is greater.","name":"forceX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#forceX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":247,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Whether the simulation advances with the game loop.","name":"isPaused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#isPaused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":268,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Enables the debug display.","name":"drawDebug","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#drawDebug","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":278,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The graphics object drawing the debug display.","name":"debugGraphic","type":{"names":["Phaser.GameObjects.Graphics"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#debugGraphic","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":287,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Default debug display settings for new Bodies.","name":"defaults","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeWorldDefaults"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#defaults","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":303,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The maximum number of items per node on the RTree.\n\nThis is ignored if `useTree` is `false`. If you have a large number of bodies in\nyour world then you may find search performance improves by increasing this value,\nto allow more items per node and less node division.","name":"maxEntries","type":{"names":["integer"]},"defaultvalue":"16","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#maxEntries","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":317,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Should this Arcade Physics World use an RTree for Dynamic and Static Physics bodies?\n\nAn RTree is a fast way of spatially sorting of all the bodies in the world.\nHowever, at certain limits, the cost of clearing and inserting the bodies into the\ntree every frame becomes more expensive than the search speed gains it provides.\n\nIf you have a large number of dynamic bodies in your world then it may be best to\ndisable the use of the RTree by setting this property to `false` in the physics config.\n\nThe number it can cope with depends on browser and device, but a conservative estimate\nof around 5,000 bodies should be considered the max before disabling it.\n\nThis only applies to dynamic bodies. Static bodies are always kept in an RTree,\nbecause they don't have to be cleared every frame, so you benefit from the\nmassive search speeds all the time.","name":"useTree","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.10.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#useTree","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":341,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The spatial index of Dynamic Bodies.","name":"tree","type":{"names":["Phaser.Structs.RTree"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#tree","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":350,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"The spatial index of Static Bodies.","name":"staticTree","type":{"names":["Phaser.Structs.RTree"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#staticTree","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":359,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Recycled input for tree searches.","name":"treeMinMax","type":{"names":["Phaser.Types.Physics.Arcade.ArcadeWorldTreeMinMax"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#treeMinMax","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":394,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Adds an Arcade Physics Body to a Game Object, an array of Game Objects, or the children of a Group.\n\nThe difference between this and the `enableBody` method is that you can pass arrays or Groups\nto this method.\n\nYou can specify if the bodies are to be Dynamic or Static. A dynamic body can move via velocity and\nacceleration. A static body remains fixed in place and as such is able to use an optimized search\ntree, making it ideal for static elements such as level objects. You can still collide and overlap\nwith static bodies.\n\nNormally, rather than calling this method directly, you'd use the helper methods available in the\nArcade Physics Factory, such as:\n\n```javascript\nthis.physics.add.image(x, y, textureKey);\nthis.physics.add.sprite(x, y, textureKey);\n```\n\nCalling factory methods encapsulates the creation of a Game Object and the creation of its\nbody at the same time. If you are creating custom classes then you can pass them to this\nmethod to have their bodies created.","kind":"function","name":"enable","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group","Array."]},"description":"The object, or objects, on which to create the bodies.","name":"object"},{"type":{"names":["integer"]},"optional":true,"description":"The type of Body to create. Either `DYNAMIC_BODY` or `STATIC_BODY`.","name":"bodyType"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#enable","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":462,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates an Arcade Physics Body on a single Game Object.\n\nIf the Game Object already has a body, this method will simply add it back into the simulation.\n\nYou can specify if the body is Dynamic or Static. A dynamic body can move via velocity and\nacceleration. A static body remains fixed in place and as such is able to use an optimized search\ntree, making it ideal for static elements such as level objects. You can still collide and overlap\nwith static bodies.\n\nNormally, rather than calling this method directly, you'd use the helper methods available in the\nArcade Physics Factory, such as:\n\n```javascript\nthis.physics.add.image(x, y, textureKey);\nthis.physics.add.sprite(x, y, textureKey);\n```\n\nCalling factory methods encapsulates the creation of a Game Object and the creation of its\nbody at the same time. If you are creating custom classes then you can pass them to this\nmethod to have their bodies created.","kind":"function","name":"enableBody","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object on which to create the body.","name":"object"},{"type":{"names":["integer"]},"optional":true,"description":"The type of Body to create. Either `DYNAMIC_BODY` or `STATIC_BODY`.","name":"bodyType"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object on which the body was created."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#enableBody","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Adds an existing Arcade Physics Body or StaticBody to the simulation.\n\nThe body is enabled and added to the local search trees.","kind":"function","name":"add","since":"3.10.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The Body to be added to the simulation.","name":"body"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The Body that was added to the simulation."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#add","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":543,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Disables the Arcade Physics Body of a Game Object, an array of Game Objects, or the children of a Group.\n\nThe difference between this and the `disableBody` method is that you can pass arrays or Groups\nto this method.\n\nThe body itself is not deleted, it just has its `enable` property set to false, which\nmeans you can re-enable it again at any point by passing it to enable `World.enable` or `World.add`.","kind":"function","name":"disable","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group","Array."]},"description":"The object, or objects, on which to disable the bodies.","name":"object"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#disable","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":594,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Disables an existing Arcade Physics Body or StaticBody and removes it from the simulation.\n\nThe body is disabled and removed from the local search trees.\n\nThe body itself is not deleted, it just has its `enable` property set to false, which\nmeans you can re-enable it again at any point by passing it to enable `World.enable` or `World.add`.","kind":"function","name":"disableBody","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The Body to be disabled.","name":"body"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#disableBody","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":614,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Removes an existing Arcade Physics Body or StaticBody from the simulation.\n\nThe body is disabled and removed from the local search trees.\n\nThe body itself is not deleted, it just has its `enabled` property set to false, which\nmeans you can re-enable it again at any point by passing it to enable `enable` or `add`.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The body to be removed from the simulation.","name":"body"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#remove","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":641,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a Graphics Game Object that the world will use to render the debug display to.\n\nThis is called automatically when the World is instantiated if the `debug` config property\nwas set to `true`. However, you can call it at any point should you need to display the\ndebug Graphic from a fixed point.\n\nYou can control which objects are drawn to the Graphics object, and the colors they use,\nby setting the debug properties in the physics config.\n\nYou should not typically use this in a production game. Use it to aid during debugging.","kind":"function","name":"createDebugGraphic","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object that was created for use by the World."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#createDebugGraphic","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":671,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the position, size and properties of the World boundary.\n\nThe World boundary is an invisible rectangle that defines the edges of the World.\nIf a Body is set to collide with the world bounds then it will automatically stop\nwhen it reaches any of the edges. You can optionally set which edges of the boundary\nshould be checked against.","kind":"function","name":"setBounds","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the boundary.","name":"x"},{"type":{"names":["number"]},"description":"The top-left y coordinate of the boundary.","name":"y"},{"type":{"names":["number"]},"description":"The width of the boundary.","name":"width"},{"type":{"names":["number"]},"description":"The height of the boundary.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"description":"Should bodies check against the left edge of the boundary?","name":"checkLeft"},{"type":{"names":["boolean"]},"optional":true,"description":"Should bodies check against the right edge of the boundary?","name":"checkRight"},{"type":{"names":["boolean"]},"optional":true,"description":"Should bodies check against the top edge of the boundary?","name":"checkUp"},{"type":{"names":["boolean"]},"optional":true,"description":"Should bodies check against the bottom edge of the boundary?","name":"checkDown"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#setBounds","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":705,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Enables or disables collisions on each edge of the World boundary.","kind":"function","name":"setBoundsCollision","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should bodies check against the left edge of the boundary?","name":"left"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should bodies check against the right edge of the boundary?","name":"right"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should bodies check against the top edge of the boundary?","name":"up"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should bodies check against the bottom edge of the boundary?","name":"down"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#setBoundsCollision","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":733,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Pauses the simulation.\n\nA paused simulation does not update any existing bodies, or run any Colliders.\n\nHowever, you can still enable and disable bodies within it, or manually run collide or overlap\nchecks.","kind":"function","name":"pause","fires":["Phaser.Physics.Arcade.Events#event:PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#pause","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":756,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Resumes the simulation, if paused.","kind":"function","name":"resume","fires":["Phaser.Physics.Arcade.Events#event:RESUME"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#resume","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":774,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Collider object and adds it to the simulation.\n\nA Collider is a way to automatically perform collision checks between two objects,\ncalling the collide and process callbacks if they occur.\n\nColliders are run as part of the World update, after all of the Bodies have updated.\n\nBy creating a Collider you don't need then call `World.collide` in your `update` loop,\nas it will be handled for you automatically.","kind":"function","name":"addCollider","since":"3.0.0","see":["Phaser.Physics.Arcade.World#collide"],"params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object to check for collision.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The second object to check for collision.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects collide. Must return a boolean.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The scope in which to call the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Collider"]},"description":"The Collider that was created."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#addCollider","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":810,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Creates a new Overlap Collider object and adds it to the simulation.\n\nA Collider is a way to automatically perform overlap checks between two objects,\ncalling the collide and process callbacks if they occur.\n\nColliders are run as part of the World update, after all of the Bodies have updated.\n\nBy creating a Collider you don't need then call `World.overlap` in your `update` loop,\nas it will be handled for you automatically.","kind":"function","name":"addOverlap","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object to check for overlap.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The second object to check for overlap.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects overlap.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The callback to invoke when the two objects overlap. Must return a boolean.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The scope in which to call the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Collider"]},"description":"The Collider that was created."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#addOverlap","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":845,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Removes a Collider from the simulation so it is no longer processed.\n\nThis method does not destroy the Collider. If you wish to add it back at a later stage you can call\n`World.colliders.add(Collider)`.\n\nIf you no longer need the Collider you can call the `Collider.destroy` method instead, which will\nautomatically clear all of its references and then remove it from the World. If you call destroy on\na Collider you _don't_ need to pass it to this method too.","kind":"function","name":"removeCollider","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Collider"]},"description":"The Collider to remove from the simulation.","name":"collider"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#removeCollider","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":869,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Sets the frame rate to run the simulation at.\n\nThe frame rate value is used to simulate a fixed update time step. This fixed\ntime step allows for a straightforward implementation of a deterministic game state.\n\nThis frame rate is independent of the frequency at which the game is rendering. The\nhigher you set the fps, the more physics simulation steps will occur per game step.\nConversely, the lower you set it, the less will take place.\n\nYou can optionally advance the simulation directly yourself by calling the `step` method.","kind":"function","name":"setFPS","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The frame rate to advance the simulation at.","name":"framerate"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#setFPS","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":978,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Advances the simulation by a time increment.","kind":"function","name":"step","fires":["Phaser.Physics.Arcade.Events#event:WORLD_STEP"],"since":"3.10.0","params":[{"type":{"names":["number"]},"description":"The delta time amount, in seconds, by which to advance the simulation.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#step","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1030,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Updates bodies, draws the debug display, and handles pending queue operations.","kind":"function","name":"postUpdate","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#postUpdate","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Calculates a Body's velocity and updates its position.","kind":"function","name":"updateMotion","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body to be updated.","name":"body"},{"type":{"names":["number"]},"description":"The delta value to be used in the motion calculations, in seconds.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#updateMotion","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1144,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Calculates a Body's angular velocity.","kind":"function","name":"computeAngularVelocity","since":"3.10.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body to compute the velocity for.","name":"body"},{"type":{"names":["number"]},"description":"The delta value to be used in the calculation, in seconds.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#computeAngularVelocity","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Calculates a Body's per-axis velocity.","kind":"function","name":"computeVelocity","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body to compute the velocity for.","name":"body"},{"type":{"names":["number"]},"description":"The delta value to be used in the calculation, in seconds.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#computeVelocity","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1313,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Separates two Bodies.","kind":"function","name":"separate","fires":["Phaser.Physics.Arcade.Events#event:COLLIDE","Phaser.Physics.Arcade.Events#event:OVERLAP"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first Body to be separated.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second Body to be separated.","name":"body2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"The process callback.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The context in which to invoke the callback.","name":"callbackContext"},{"type":{"names":["boolean"]},"optional":true,"description":"If this a collide or overlap check?","name":"overlapOnly"}],"returns":[{"type":{"names":["boolean"]},"description":"True if separation occurred, otherwise false."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#separate","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Separates two Bodies, when both are circular.","kind":"function","name":"separateCircle","fires":["Phaser.Physics.Arcade.Events#event:COLLIDE","Phaser.Physics.Arcade.Events#event:OVERLAP"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first Body to be separated.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second Body to be separated.","name":"body2"},{"type":{"names":["boolean"]},"optional":true,"description":"If this a collide or overlap check?","name":"overlapOnly"},{"type":{"names":["number"]},"optional":true,"description":"A small value added to the calculations.","name":"bias"}],"returns":[{"type":{"names":["boolean"]},"description":"True if separation occurred, otherwise false."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#separateCircle","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1560,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Checks to see if two Bodies intersect at all.","kind":"function","name":"intersects","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The first body to check.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The second body to check.","name":"body2"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the two bodies intersect, otherwise false."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#intersects","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Tests if a circular Body intersects with another Body.","kind":"function","name":"circleBodyIntersects","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The circular body to test.","name":"circle"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The rectangular body to test.","name":"body"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the two bodies intersect, otherwise false."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#circleBodyIntersects","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1630,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Tests if Game Objects overlap.","kind":"function","name":"overlap","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object or array of objects to check.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"optional":true,"description":"The second object or array of objects to check, or `undefined`.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects overlap.","name":"overlapCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they overlap. If this is set then `overlapCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if at least one Game Object overlaps another."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#overlap","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1653,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Performs a collision check and separation between the two physics enabled objects given, which can be single\nGame Objects, arrays of Game Objects, Physics Groups, arrays of Physics Groups or normal Groups.\n\nIf you don't require separation then use {@link #overlap} instead.\n\nIf two Groups or arrays are passed, each member of one will be tested against each member of the other.\n\nIf **only** one Group is passed (as `object1`), each member of the Group will be collided against the other members.\n\nIf **only** one Array is passed, the array is iterated and every element in it is tested against the others.\n\nTwo callbacks can be provided. The `collideCallback` is invoked if a collision occurs and the two colliding\nobjects are passed to it.\n\nArcade Physics uses the Projection Method of collision resolution and separation. While it's fast and suitable\nfor 'arcade' style games it lacks stability when multiple objects are in close proximity or resting upon each other.\nThe separation that stops two objects penetrating may create a new penetration against a different object. If you\nrequire a high level of stability please consider using an alternative physics system, such as Matter.js.","kind":"function","name":"collide","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"description":"The first object or array of objects to check.","name":"object1"},{"type":{"names":["Phaser.Types.Physics.Arcade.ArcadeColliderType"]},"optional":true,"description":"The second object or array of objects to check, or `undefined`.","name":"object2"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if any overlapping Game Objects were separated, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#collide","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2039,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This advanced method is specifically for testing for collision between a single Sprite and an array of Tile objects.\n\nYou should generally use the `collide` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\ntile filtering and culling for you, as well as handle the interesting face collision automatically.\n\nThis method is offered for those who would like to check for collision with specific Tiles in a layer, without\nhaving to set any collision attributes on the tiles in question. This allows you to perform quick dynamic collisions\non small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\nyou should filter them before passing them to this method.\n\nImportant: Use of this method skips the `interesting faces` system that Tilemap Layers use. This means if you have\nsay a row or column of tiles, and you jump into, or walk over them, it's possible to get stuck on the edges of the\ntiles as the interesting face calculations are skipped. However, for quick-fire small collision set tests on\ndynamic maps, this method can prove very useful.","kind":"function","name":"collideTiles","fires":["Phaser.Physics.Arcade.Events#event:TILE_COLLIDE"],"since":"3.17.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first object to check for collision.","name":"sprite"},{"type":{"names":["Array."]},"description":"An array of Tiles to check for collision against.","name":"tiles"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#collideTiles","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2079,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"This advanced method is specifically for testing for overlaps between a single Sprite and an array of Tile objects.\n\nYou should generally use the `overlap` method instead, with a Sprite vs. a Tilemap Layer, as that will perform\ntile filtering and culling for you, as well as handle the interesting face collision automatically.\n\nThis method is offered for those who would like to check for overlaps with specific Tiles in a layer, without\nhaving to set any collision attributes on the tiles in question. This allows you to perform quick dynamic overlap\ntests on small sets of Tiles. As such, no culling or checks are made to the array of Tiles given to this method,\nyou should filter them before passing them to this method.","kind":"function","name":"overlapTiles","fires":["Phaser.Physics.Arcade.Events#event:TILE_OVERLAP"],"since":"3.17.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first object to check for collision.","name":"sprite"},{"type":{"names":["Array."]},"description":"An array of Tiles to check for collision against.","name":"tiles"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects overlap.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#overlapTiles","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Internal handler for Sprite vs. Tilemap collisions.\nPlease use Phaser.Physics.Arcade.World#collide instead.","kind":"function","name":"collideSpriteVsTilemapLayer","fires":["Phaser.Physics.Arcade.Events#event:TILE_COLLIDE","Phaser.Physics.Arcade.Events#event:TILE_OVERLAP"],"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first object to check for collision.","name":"sprite"},{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"description":"The second object to check for collision.","name":"tilemapLayer"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the objects collide.","name":"collideCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.","name":"processCallback"},{"type":{"names":["any"]},"optional":true,"description":"The context in which to run the callbacks.","name":"callbackContext"},{"type":{"names":["boolean"]},"optional":true,"description":"Whether this is a collision or overlap check.","name":"overlapOnly"}],"returns":[{"type":{"names":["boolean"]},"description":"True if any objects overlap (with `overlapOnly`); or true if any overlapping objects were separated."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#collideSpriteVsTilemapLayer","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2286,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Wrap an object's coordinates (or several objects' coordinates) within {@link Phaser.Physics.Arcade.World#bounds}.\n\nIf the object is outside any boundary edge (left, top, right, bottom), it will be moved to the same offset from the opposite edge (the interior).","kind":"function","name":"wrap","since":"3.3.0","params":[{"type":{"names":["*"]},"description":"A Game Object, a Group, an object with `x` and `y` coordinates, or an array of such objects.","name":"object"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"An amount added to each boundary edge during the operation.","name":"padding"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#wrap","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2317,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Wrap each object's coordinates within {@link Phaser.Physics.Arcade.World#bounds}.","kind":"function","name":"wrapArray","since":"3.3.0","params":[{"type":{"names":["Array.<*>"]},"description":"An array of objects to be wrapped.","name":"objects"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"An amount added to the boundary.","name":"padding"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#wrapArray","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2334,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Wrap an object's coordinates within {@link Phaser.Physics.Arcade.World#bounds}.","kind":"function","name":"wrapObject","since":"3.3.0","params":[{"type":{"names":["*"]},"description":"A Game Object, a Physics Body, or any object with `x` and `y` coordinates","name":"object"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"An amount added to the boundary.","name":"padding"}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#wrapObject","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Shuts down the simulation, clearing physics data and removing listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#shutdown","scope":"instance","overrides":"Phaser.Events.EventEmitter#shutdown","___s":true},{"meta":{"filename":"World.js","lineno":2368,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Shuts down the simulation and disconnects it from the current scene.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"Acceleration.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the acceleration properties of an Arcade Physics Body.","kind":"namespace","name":"Acceleration","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Acceleration","scope":"static","___s":true},{"meta":{"filename":"Acceleration.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal and vertical acceleration. If the vertical acceleration value is not provided, the vertical acceleration is set to the same value as the horizontal acceleration.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal acceleration","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical acceleration","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Acceleration"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Acceleration","longname":"Phaser.Physics.Arcade.Components.Acceleration#setAcceleration","scope":"instance","___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal acceleration.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal acceleration","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Acceleration"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Acceleration","longname":"Phaser.Physics.Arcade.Components.Acceleration#setAccelerationX","scope":"instance","___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's vertical acceleration.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical acceleration","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Acceleration"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Acceleration","longname":"Phaser.Physics.Arcade.Components.Acceleration#setAccelerationY","scope":"instance","___s":true},{"meta":{"filename":"Angular.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the angular acceleration properties of an Arcade Physics Body.","kind":"namespace","name":"Angular","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Angular","scope":"static","___s":true},{"meta":{"filename":"Angular.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular velocity of the body.\n\nIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\nHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\ncausing them to visually rotate, even though the body remains axis-aligned.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Angular"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Angular","longname":"Phaser.Physics.Arcade.Components.Angular#setAngularVelocity","scope":"instance","___s":true},{"meta":{"filename":"Angular.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular acceleration of the body.\n\nIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\nHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\ncausing them to visually rotate, even though the body remains axis-aligned.","kind":"function","name":"setAngularAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of angular acceleration.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Angular"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Angular","longname":"Phaser.Physics.Arcade.Components.Angular#setAngularAcceleration","scope":"instance","___s":true},{"meta":{"filename":"Angular.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular drag of the body. Drag is applied to the current velocity, providing a form of deceleration.","kind":"function","name":"setAngularDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of drag.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Angular"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Angular","longname":"Phaser.Physics.Arcade.Components.Angular#setAngularDrag","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the bounce properties of an Arcade Physics Body.","kind":"namespace","name":"Bounce","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Bounce","scope":"static","___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the bounce values of this body.\n\nBounce is the amount of restitution, or elasticity, the body has when it collides with another object.\nA value of 1 means that it will retain its full velocity after the rebound. A value of 0 means it will not rebound at all.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Bounce"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Bounce","longname":"Phaser.Physics.Arcade.Components.Bounce#setBounce","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the horizontal bounce value for this body.","kind":"function","name":"setBounceX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Bounce"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Bounce","longname":"Phaser.Physics.Arcade.Components.Bounce#setBounceX","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the vertical bounce value for this body.","kind":"function","name":"setBounceY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Bounce"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Bounce","longname":"Phaser.Physics.Arcade.Components.Bounce#setBounceY","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets whether this Body collides with the world boundary.\n\nOptionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.","kind":"function","name":"setCollideWorldBounds","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if this body should collide with the world bounds, otherwise `false`.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.x` value.","name":"bounceX"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.y` value.","name":"bounceY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Bounce"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Bounce","longname":"Phaser.Physics.Arcade.Components.Bounce#setCollideWorldBounds","scope":"instance","___s":true},{"meta":{"filename":"Debug.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the debug properties of an Arcade Physics Body.","kind":"namespace","name":"Debug","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Debug","scope":"static","___s":true},{"meta":{"filename":"Debug.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the debug values of this body.\n\nBodies will only draw their debug if debug has been enabled for Arcade Physics as a whole.\nNote that there is a performance cost in drawing debug displays. It should never be used in production.","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` to have this body render its outline to the debug display.","name":"showBody"},{"type":{"names":["boolean"]},"description":"Set to `true` to have this body render a velocity marker to the debug display.","name":"showVelocity"},{"type":{"names":["number"]},"description":"The color of the body outline when rendered to the debug display.","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Debug"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Debug","longname":"Phaser.Physics.Arcade.Components.Debug#setDebug","scope":"instance","___s":true},{"meta":{"filename":"Debug.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the color of the body outline when it renders to the debug display.","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The color of the body outline when rendered to the debug display.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Debug"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Debug","longname":"Phaser.Physics.Arcade.Components.Debug#setDebugBodyColor","scope":"instance","___s":true},{"meta":{"filename":"Debug.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set to `true` to have this body render its outline to the debug display.","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components.Debug","longname":"Phaser.Physics.Arcade.Components.Debug#debugShowBody","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Debug.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set to `true` to have this body render a velocity marker to the debug display.","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components.Debug","longname":"Phaser.Physics.Arcade.Components.Debug#debugShowVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Debug.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"The color of the body outline when it renders to the debug display.","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components.Debug","longname":"Phaser.Physics.Arcade.Components.Debug#debugBodyColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Drag.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the drag properties of an Arcade Physics Body.","kind":"namespace","name":"Drag","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Drag","scope":"static","___s":true},{"meta":{"filename":"Drag.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal and vertical drag. If the vertical drag value is not provided, the vertical drag is set to the same value as the horizontal drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal drag to apply.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical drag to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Drag"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Drag","longname":"Phaser.Physics.Arcade.Components.Drag#setDrag","scope":"instance","___s":true},{"meta":{"filename":"Drag.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDragX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal drag to apply.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Drag"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Drag","longname":"Phaser.Physics.Arcade.Components.Drag#setDragX","scope":"instance","___s":true},{"meta":{"filename":"Drag.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's vertical drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDragY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of vertical drag to apply.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Drag"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Drag","longname":"Phaser.Physics.Arcade.Components.Drag#setDragY","scope":"instance","___s":true},{"meta":{"filename":"Drag.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"If this Body is using `drag` for deceleration this function controls how the drag is applied.\nIf set to `true` drag will use a damping effect rather than a linear approach. If you are\ncreating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\nthe game Asteroids) then you will get a far smoother and more visually correct deceleration\nby using damping, avoiding the axis-drift that is prone with linear deceleration.\n\nIf you enable this property then you should use far smaller `drag` values than with linear, as\nthey are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\ndeceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.","kind":"function","name":"setDamping","since":"3.10.0","params":[{"type":{"names":["boolean"]},"description":"`true` to use damping for deceleration, or `false` to use linear deceleration.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Drag"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Drag","longname":"Phaser.Physics.Arcade.Components.Drag#setDamping","scope":"instance","___s":true},{"meta":{"filename":"Enable.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the enable properties of an Arcade Physics Body.","kind":"namespace","name":"Enable","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Enable","scope":"static","___s":true},{"meta":{"filename":"Enable.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Enables this Game Object's Body.","kind":"function","name":"enableBody","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Also reset the Body and place it at (x, y).","name":"reset"},{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"x"},{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"y"},{"type":{"names":["boolean"]},"description":"Also activate this Game Object.","name":"enableGameObject"},{"type":{"names":["boolean"]},"description":"Also show this Game Object.","name":"showGameObject"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Enable"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.Body#enable","Phaser.Physics.Arcade.StaticBody#enable","Phaser.Physics.Arcade.Body#reset","Phaser.Physics.Arcade.StaticBody#reset","Phaser.GameObjects.GameObject#active","Phaser.GameObjects.GameObject#visible"],"memberof":"Phaser.Physics.Arcade.Components.Enable","longname":"Phaser.Physics.Arcade.Components.Enable#enableBody","scope":"instance","___s":true},{"meta":{"filename":"Enable.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Stops and disables this Game Object's Body.","kind":"function","name":"disableBody","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also deactivate this Game Object.","name":"disableGameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also hide this Game Object.","name":"hideGameObject"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Enable"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.Body#enable","Phaser.Physics.Arcade.StaticBody#enable","Phaser.GameObjects.GameObject#active","Phaser.GameObjects.GameObject#visible"],"memberof":"Phaser.Physics.Arcade.Components.Enable","longname":"Phaser.Physics.Arcade.Components.Enable#disableBody","scope":"instance","___s":true},{"meta":{"filename":"Enable.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Syncs the Body's position and size with its parent Game Object.\nYou don't need to call this for Dynamic Bodies, as it happens automatically.\nBut for Static bodies it's a useful way of modifying the position of a Static Body\nin the Physics World, based on its Game Object.","kind":"function","name":"refreshBody","since":"3.1.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Enable"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.StaticBody#updateFromGameObject"],"memberof":"Phaser.Physics.Arcade.Components.Enable","longname":"Phaser.Physics.Arcade.Components.Enable#refreshBody","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving horizontally in the X axis. The higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"namespace","name":"Friction","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Friction","scope":"static","___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal friction to apply.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical friction to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Friction"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Friction","longname":"Phaser.Physics.Arcade.Components.Friction#setFriction","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving horizontally in the X axis.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of friction to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Friction"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Friction","longname":"Phaser.Physics.Arcade.Components.Friction#setFrictionX","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving vertically in the Y axis.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of friction to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Friction"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Friction","longname":"Phaser.Physics.Arcade.Components.Friction#setFrictionY","scope":"instance","___s":true},{"meta":{"filename":"Gravity.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods for setting the gravity properties of an Arcade Physics Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Gravity","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Gravity","scope":"static","___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the X and Y values of the gravitational pull to act upon this Arcade Physics Game Object. Values can be positive or negative. Larger values result in a stronger effect.\n\nIf only one value is provided, this value will be used for both the X and Y axis.","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the X-axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The gravitational force to be applied to the Y-axis. If this is not specified, the X value will be used.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Gravity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Gravity","longname":"Phaser.Physics.Arcade.Components.Gravity#setGravity","scope":"instance","___s":true},{"meta":{"filename":"Gravity.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the gravitational force to be applied to the X axis. Value can be positive or negative. Larger values result in a stronger effect.","kind":"function","name":"setGravityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the X-axis.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Gravity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Gravity","longname":"Phaser.Physics.Arcade.Components.Gravity#setGravityX","scope":"instance","___s":true},{"meta":{"filename":"Gravity.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the gravitational force to be applied to the Y axis. Value can be positive or negative. Larger values result in a stronger effect.","kind":"function","name":"setGravityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the Y-axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Gravity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Gravity","longname":"Phaser.Physics.Arcade.Components.Gravity#setGravityY","scope":"instance","___s":true},{"meta":{"filename":"Immovable.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the immovable properties of an Arcade Physics Body.","kind":"namespace","name":"Immovable","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Immovable","scope":"static","___s":true},{"meta":{"filename":"Immovable.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets Whether this Body can be moved by collisions with another Body.","kind":"function","name":"setImmovable","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets if this body can be moved by collisions with another Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Immovable"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Immovable","longname":"Phaser.Physics.Arcade.Components.Immovable#setImmovable","scope":"instance","___s":true},{"meta":{"filename":"Mass.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods used for setting the mass properties of an Arcade Physics Body.","kind":"namespace","name":"Mass","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Mass","scope":"static","___s":true},{"meta":{"filename":"Mass.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the mass of the physics body","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"New value for the mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Mass"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Mass","longname":"Phaser.Physics.Arcade.Components.Mass#setMass","scope":"instance","___s":true},{"meta":{"filename":"OverlapCirc.js","lineno":6,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"This method will search the given circular area and return an array of all physics bodies that\noverlap with it. It can return either Dynamic, Static bodies or a mixture of both.\n\nA body only has to intersect with the search area to be considered, it doesn't have to be fully\ncontained within it.\n\nIf Arcade Physics is set to use the RTree (which it is by default) then the search is rather fast,\notherwise the search is O(N) for Dynamic Bodies.","kind":"function","name":"OverlapCirc","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the center of the area to search within.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the center of the area to search within.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the area to search within.","name":"radius"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the search include Dynamic Bodies?","name":"includeDynamic"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the search include Static Bodies?","name":"includeStatic"}],"returns":[{"type":{"names":["Array.","Array."]},"description":"An array of bodies that overlap with the given area."}],"memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.OverlapCirc","scope":"static","___s":true},{"meta":{"filename":"OverlapRect.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"This method will search the given rectangular area and return an array of all physics bodies that\noverlap with it. It can return either Dynamic, Static bodies or a mixture of both.\n\nA body only has to intersect with the search area to be considered, it doesn't have to be fully\ncontained within it.\n\nIf Arcade Physics is set to use the RTree (which it is by default) then the search for is extremely fast,\notherwise the search is O(N) for Dynamic Bodies.","kind":"function","name":"OverlapRect","since":"3.17.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the area to search within.","name":"x"},{"type":{"names":["number"]},"description":"The top-left y coordinate of the area to search within.","name":"y"},{"type":{"names":["number"]},"description":"The width of the area to search within.","name":"width"},{"type":{"names":["number"]},"description":"The height of the area to search within.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the search include Dynamic Bodies?","name":"includeDynamic"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the search include Static Bodies?","name":"includeStatic"}],"returns":[{"type":{"names":["Array.","Array."]},"description":"An array of bodies that overlap with the given area."}],"memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.OverlapRect","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods for setting the size of an Arcade Physics Game Object.\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Size","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Size","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body offset. This allows you to adjust the difference between the center of the body\nand the x and y coordinates of the parent Game Object.","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to offset the body from the parent Game Object along the x-axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Size"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Size","longname":"Phaser.Physics.Arcade.Components.Size#setOffset","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the size of this physics body. Setting the size does not adjust the dimensions\nof the parent Game Object.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new width of the physics body, in pixels.","name":"width"},{"type":{"names":["number"]},"description":"The new height of the physics body, in pixels.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the body be re-positioned so its center aligns with the parent Game Object?","name":"center"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Size"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Size","longname":"Phaser.Physics.Arcade.Components.Size#setSize","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":55,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets this physics body to use a circle for collision instead of a rectangle.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the physics body, in pixels.","name":"radius"},{"type":{"names":["number"]},"optional":true,"description":"The amount to offset the body from the parent Game Object along the x-axis.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to offset the body from the parent Game Object along the y-axis.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Size"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Size","longname":"Phaser.Physics.Arcade.Components.Size#setCircle","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Provides methods for modifying the velocity of an Arcade Physics body.\n\nShould be applied as a mixin and not used directly.","kind":"namespace","name":"Velocity","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Components","longname":"Phaser.Physics.Arcade.Components.Velocity","scope":"static","___s":true},{"meta":{"filename":"Velocity.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the velocity of the Body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity of the body. Positive values move the body to the right, while negative values move it to the left.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity of the body. Positive values move the body down, while negative values move it up.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Velocity","longname":"Phaser.Physics.Arcade.Components.Velocity#setVelocity","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the horizontal component of the body's velocity.\n\nPositive values move the body to the right, while negative values move it to the left.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new horizontal velocity.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Velocity","longname":"Phaser.Physics.Arcade.Components.Velocity#setVelocityX","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the vertical component of the body's velocity.\n\nPositive values move the body down, while negative values move it up.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new vertical velocity of the body.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Velocity","longname":"Phaser.Physics.Arcade.Components.Velocity#setVelocityY","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the maximum velocity of the body.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new maximum horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The new maximum vertical velocity.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Components.Velocity","longname":"Phaser.Physics.Arcade.Components.Velocity#setMaxVelocity","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"kind":"namespace","name":"Components","memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.Components","scope":"static","___s":true},{"meta":{"range":[229,2318],"filename":"const.js","lineno":13,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Arcade Physics consts.","ignore":true,"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Dynamic Body.","name":"DYNAMIC_BODY","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#physicsType","Phaser.Physics.Arcade.Group#physicsType"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.DYNAMIC_BODY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Static Body.","name":"STATIC_BODY","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#physicsType","Phaser.Physics.Arcade.StaticBody#physicsType"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.STATIC_BODY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":41,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Arcade Physics Group containing Dynamic Bodies.","name":"GROUP","readonly":true,"type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.GROUP","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":51,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"A Tilemap Layer.","name":"TILEMAPLAYER","readonly":true,"type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.TILEMAPLAYER","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Facing no direction (initial value).","name":"FACING_NONE","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#facing"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.FACING_NONE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Facing up.","name":"FACING_UP","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#facing"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.FACING_UP","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Facing down.","name":"FACING_DOWN","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#facing"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.FACING_DOWN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Facing left.","name":"FACING_LEFT","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#facing"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.FACING_LEFT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"description":"Facing right.","name":"FACING_RIGHT","readonly":true,"type":{"names":["number"]},"since":"3.0.0","see":["Phaser.Physics.Arcade.Body#facing"],"memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.FACING_RIGHT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"COLLIDE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics World Collide Event.\n\nThis event is dispatched by an Arcade Physics World instance if two bodies collide _and_ at least\none of them has their [onCollide]{@link Phaser.Physics.Arcade.Body#onCollide} property set to `true`.\n\nIt provides an alternative means to handling collide events rather than using the callback approach.\n\nListen to it from a Scene using: `this.physics.world.on('collide', listener)`.\n\nPlease note that 'collide' and 'overlap' are two different things in Arcade Physics.","kind":"event","name":"COLLIDE","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first Game Object involved in the collision. This is the parent of `body1`.","name":"gameObject1"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The second Game Object involved in the collision. This is the parent of `body2`.","name":"gameObject2"},{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The first Physics Body involved in the collision.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The second Physics Body involved in the collision.","name":"body2"}],"memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:COLLIDE","scope":"instance","___s":true},{"meta":{"filename":"OVERLAP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics World Overlap Event.\n\nThis event is dispatched by an Arcade Physics World instance if two bodies overlap _and_ at least\none of them has their [onOverlap]{@link Phaser.Physics.Arcade.Body#onOverlap} property set to `true`.\n\nIt provides an alternative means to handling overlap events rather than using the callback approach.\n\nListen to it from a Scene using: `this.physics.world.on('overlap', listener)`.\n\nPlease note that 'collide' and 'overlap' are two different things in Arcade Physics.","kind":"event","name":"OVERLAP","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first Game Object involved in the overlap. This is the parent of `body1`.","name":"gameObject1"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The second Game Object involved in the overlap. This is the parent of `body2`.","name":"gameObject2"},{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The first Physics Body involved in the overlap.","name":"body1"},{"type":{"names":["Phaser.Physics.Arcade.Body","Phaser.Physics.Arcade.StaticBody"]},"description":"The second Physics Body involved in the overlap.","name":"body2"}],"memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:OVERLAP","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics World Pause Event.\n\nThis event is dispatched by an Arcade Physics World instance when it is paused.\n\nListen to it from a Scene using: `this.physics.world.on('pause', listener)`.","kind":"event","name":"PAUSE","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:PAUSE","scope":"instance","___s":true},{"meta":{"filename":"RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics World Resume Event.\n\nThis event is dispatched by an Arcade Physics World instance when it resumes from a paused state.\n\nListen to it from a Scene using: `this.physics.world.on('resume', listener)`.","kind":"event","name":"RESUME","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:RESUME","scope":"instance","___s":true},{"meta":{"filename":"TILE_COLLIDE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics Tile Collide Event.\n\nThis event is dispatched by an Arcade Physics World instance if a body collides with a Tile _and_\nhas its [onCollide]{@link Phaser.Physics.Arcade.Body#onCollide} property set to `true`.\n\nIt provides an alternative means to handling collide events rather than using the callback approach.\n\nListen to it from a Scene using: `this.physics.world.on('tilecollide', listener)`.\n\nPlease note that 'collide' and 'overlap' are two different things in Arcade Physics.","kind":"event","name":"TILE_COLLIDE","since":"3.16.1","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object involved in the collision. This is the parent of `body`.","name":"gameObject"},{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile the body collided with.","name":"tile"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Arcade Physics Body of the Game Object involved in the collision.","name":"body"}],"memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:TILE_COLLIDE","scope":"instance","___s":true},{"meta":{"filename":"TILE_OVERLAP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics Tile Overlap Event.\n\nThis event is dispatched by an Arcade Physics World instance if a body overlaps with a Tile _and_\nhas its [onOverlap]{@link Phaser.Physics.Arcade.Body#onOverlap} property set to `true`.\n\nIt provides an alternative means to handling overlap events rather than using the callback approach.\n\nListen to it from a Scene using: `this.physics.world.on('tileoverlap', listener)`.\n\nPlease note that 'collide' and 'overlap' are two different things in Arcade Physics.","kind":"event","name":"TILE_OVERLAP","since":"3.16.1","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object involved in the overlap. This is the parent of `body`.","name":"gameObject"},{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile the body overlapped.","name":"tile"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Arcade Physics Body of the Game Object involved in the overlap.","name":"body"}],"memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:TILE_OVERLAP","scope":"instance","___s":true},{"meta":{"filename":"WORLD_BOUNDS_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics World Bounds Event.\n\nThis event is dispatched by an Arcade Physics World instance if a body makes contact with the world bounds _and_\nit has its [onWorldBounds]{@link Phaser.Physics.Arcade.Body#onWorldBounds} property set to `true`.\n\nIt provides an alternative means to handling collide events rather than using the callback approach.\n\nListen to it from a Scene using: `this.physics.world.on('worldbounds', listener)`.","kind":"event","name":"WORLD_BOUNDS","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Arcade Physics Body that hit the world bounds.","name":"body"},{"type":{"names":["boolean"]},"description":"Is the Body blocked up? I.e. collided with the top of the world bounds.","name":"up"},{"type":{"names":["boolean"]},"description":"Is the Body blocked down? I.e. collided with the bottom of the world bounds.","name":"down"},{"type":{"names":["boolean"]},"description":"Is the Body blocked left? I.e. collided with the left of the world bounds.","name":"left"},{"type":{"names":["boolean"]},"description":"Is the Body blocked right? I.e. collided with the right of the world bounds.","name":"right"}],"memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:WORLD_BOUNDS","scope":"instance","___s":true},{"meta":{"filename":"WORLD_STEP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"description":"The Arcade Physics World Step Event.\n\nThis event is dispatched by an Arcade Physics World instance whenever a physics step is run.\nIt is emitted _after_ the bodies and colliders have been updated.\n\nIn high framerate settings this can be multiple times per game frame.\n\nListen to it from a Scene using: `this.physics.world.on('worldstep', listener)`.","kind":"event","name":"WORLD_STEP","since":"3.18.0","memberof":"Phaser.Physics.Arcade.Events","longname":"Phaser.Physics.Arcade.Events#event:WORLD_STEP","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.Events","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"kind":"typedef","name":"ArcadePhysicsCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The first Body to separate.","name":"object1"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The second Body to separate.","name":"object2"}],"longname":"ArcadePhysicsCallback","scope":"global","___s":true},{"meta":{"filename":"index.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade"},"kind":"namespace","name":"Arcade","memberof":"Phaser.Physics","longname":"Phaser.Physics.Arcade","scope":"static","___s":true},{"meta":{"filename":"ProcessTileCallbacks.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"A function to process the collision callbacks between a single tile and an Arcade Physics enabled Game Object.","kind":"function","name":"ProcessTileCallbacks","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The Tile to process.","name":"tile"},{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"The Game Object to process with the Tile.","name":"sprite"}],"returns":[{"type":{"names":["boolean"]},"description":"The result of the callback, `true` for further processing, or `false` to skip this pair."}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.ProcessTileCallbacks","scope":"static","___s":true},{"meta":{"filename":"ProcessTileSeparationX.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"Internal function to process the separation of a physics body from a tile.","kind":"function","name":"ProcessTileSeparationX","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body object to separate.","name":"body"},{"type":{"names":["number"]},"description":"The x separation amount.","name":"x"}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.ProcessTileSeparationX","scope":"static","___s":true},{"meta":{"filename":"ProcessTileSeparationY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"Internal function to process the separation of a physics body from a tile.","kind":"function","name":"ProcessTileSeparationY","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body object to separate.","name":"body"},{"type":{"names":["number"]},"description":"The y separation amount.","name":"y"}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.ProcessTileSeparationY","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"SeparateTile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"name":"TileCheckX","longname":"TileCheckX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SeparateTile.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"The core separation function to separate a physics body and a tile.","kind":"function","name":"SeparateTile","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The index of the tile within the map data.","name":"i"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body object to separate.","name":"body"},{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile to collide against.","name":"tile"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A rectangle-like object defining the dimensions of the tile.","name":"tileWorldRect"},{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"description":"The tilemapLayer to collide against.","name":"tilemapLayer"},{"type":{"names":["number"]},"description":"The tile bias value. Populated by the `World.TILE_BIAS` constant.","name":"tileBias"},{"type":{"names":["boolean"]},"description":"Is this check coming from a TilemapLayer or an array of tiles?","name":"isLayer"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the body was separated, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.SeparateTile","scope":"static","___s":true},{"meta":{"range":[180,240],"filename":"TileCheckX.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"name":"ProcessTileSeparationX","longname":"ProcessTileSeparationX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TileCheckX.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"Check the body against the given tile on the X axis.\nUsed internally by the SeparateTile function.","kind":"function","name":"TileCheckX","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body object to separate.","name":"body"},{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile to check.","name":"tile"},{"type":{"names":["number"]},"description":"The left position of the tile within the tile world.","name":"tileLeft"},{"type":{"names":["number"]},"description":"The right position of the tile within the tile world.","name":"tileRight"},{"type":{"names":["number"]},"description":"The tile bias value. Populated by the `World.TILE_BIAS` constant.","name":"tileBias"},{"type":{"names":["boolean"]},"description":"Is this check coming from a TilemapLayer or an array of tiles?","name":"isLayer"}],"returns":[{"type":{"names":["number"]},"description":"The amount of separation that occurred."}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.TileCheckX","scope":"static","___s":true},{"meta":{"range":[180,240],"filename":"TileCheckY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"name":"ProcessTileSeparationY","longname":"ProcessTileSeparationY","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TileCheckY.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"Check the body against the given tile on the Y axis.\nUsed internally by the SeparateTile function.","kind":"function","name":"TileCheckY","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The Body object to separate.","name":"body"},{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile to check.","name":"tile"},{"type":{"names":["number"]},"description":"The top position of the tile within the tile world.","name":"tileTop"},{"type":{"names":["number"]},"description":"The bottom position of the tile within the tile world.","name":"tileBottom"},{"type":{"names":["number"]},"description":"The tile bias value. Populated by the `World.TILE_BIAS` constant.","name":"tileBias"},{"type":{"names":["boolean"]},"description":"Is this check coming from a TilemapLayer or an array of tiles?","name":"isLayer"}],"returns":[{"type":{"names":["number"]},"description":"The amount of separation that occurred."}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.TileCheckY","scope":"static","___s":true},{"meta":{"filename":"TileIntersectsBody.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"description":"Checks for intersection between the given tile rectangle-like object and an Arcade Physics body.","kind":"function","name":"TileIntersectsBody","since":"3.0.0","params":[{"type":{"names":["Object"]},"description":"A rectangle object that defines the tile placement in the world.","name":"tileWorldRect"},{"type":{"names":["Phaser.Physics.Arcade.Body"]},"description":"The body to check for intersection against.","name":"body"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` of the tile intersects with the body, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.Tilemap","longname":"Phaser.Physics.Arcade.Tilemap.TileIntersectsBody","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap"},"kind":"namespace","name":"Tilemap","memberof":"Phaser.Physics.Arcade","longname":"Phaser.Physics.Arcade.Tilemap","scope":"static","___s":true},{"meta":{"filename":"ArcadeBodyBounds.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"ArcadeBodyBounds","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The left edge.","name":"x"},{"type":{"names":["number"]},"description":"The upper edge.","name":"y"},{"type":{"names":["number"]},"description":"The right edge.","name":"right"},{"type":{"names":["number"]},"description":"The lower edge.","name":"bottom"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.ArcadeBodyBounds","scope":"static","___s":true},{"meta":{"filename":"ArcadeBodyCollision.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"ArcadeBodyCollision","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"True if the Body is not colliding.","name":"none"},{"type":{"names":["boolean"]},"description":"True if the Body is colliding on its upper edge.","name":"up"},{"type":{"names":["boolean"]},"description":"True if the Body is colliding on its lower edge.","name":"down"},{"type":{"names":["boolean"]},"description":"True if the Body is colliding on its left edge.","name":"left"},{"type":{"names":["boolean"]},"description":"True if the Body is colliding on its right edge.","name":"right"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.ArcadeBodyCollision","scope":"static","___s":true},{"meta":{"filename":"ArcadeColliderType.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"description":"An Arcade Physics Collider Type.","kind":"typedef","name":"ArcadeColliderType","type":{"names":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Group","Phaser.Physics.Arcade.Sprite","Phaser.Physics.Arcade.Image","Phaser.Physics.Arcade.StaticGroup","Phaser.Physics.Arcade.Group","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer","Array.","Array.","Array.","Array.","Array.","Array.","Array."]},"since":"3.0.0","memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.ArcadeColliderType","scope":"static","___s":true},{"meta":{"filename":"ArcadeWorldConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"ArcadeWorldConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"Sets {@link Phaser.Physics.Arcade.World#fps}.","name":"fps"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Sets {@link Phaser.Physics.Arcade.World#timeScale}.","name":"timeScale"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"Sets {@link Phaser.Physics.Arcade.World#gravity}.","name":"gravity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.World#bounds bounds.x}.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.World#bounds bounds.y}.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.World#bounds bounds.width}.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.World#bounds bounds.height}.","name":"height"},{"type":{"names":["Phaser.Types.Physics.Arcade.CheckCollisionObject"]},"optional":true,"description":"Sets {@link Phaser.Physics.Arcade.World#checkCollision}.","name":"checkCollision"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"Sets {@link Phaser.Physics.Arcade.World#OVERLAP_BIAS}.","name":"overlapBias"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16,"description":"Sets {@link Phaser.Physics.Arcade.World#TILE_BIAS}.","name":"tileBias"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets {@link Phaser.Physics.Arcade.World#forceX}.","name":"forceX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets {@link Phaser.Physics.Arcade.World#isPaused}.","name":"isPaused"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets {@link Phaser.Physics.Arcade.World#debug}.","name":"debug"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.World#defaults debugShowBody}.","name":"debugShowBody"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.World#defaults debugShowStaticBody}.","name":"debugShowStaticBody"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.World#defaults debugShowStaticBody}.","name":"debugShowVelocity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xff00ff","description":"Sets {@link Phaser.Physics.Arcade.World#defaults debugBodyColor}.","name":"debugBodyColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x0000ff","description":"Sets {@link Phaser.Physics.Arcade.World#defaults debugStaticBodyColor}.","name":"debugStaticBodyColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x00ff00","description":"Sets {@link Phaser.Physics.Arcade.World#defaults debugVelocityColor}.","name":"debugVelocityColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16,"description":"Sets {@link Phaser.Physics.Arcade.World#maxEntries}.","name":"maxEntries"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.World#useTree}.","name":"useTree"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.ArcadeWorldConfig","scope":"static","___s":true},{"meta":{"filename":"ArcadeWorldDefaults.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"ArcadeWorldDefaults","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Set to `true` to render dynamic body outlines to the debug display.","name":"debugShowBody"},{"type":{"names":["boolean"]},"description":"Set to `true` to render static body outlines to the debug display.","name":"debugShowStaticBody"},{"type":{"names":["boolean"]},"description":"Set to `true` to render body velocity markers to the debug display.","name":"debugShowVelocity"},{"type":{"names":["number"]},"description":"The color of dynamic body outlines when rendered to the debug display.","name":"bodyDebugColor"},{"type":{"names":["number"]},"description":"The color of static body outlines when rendered to the debug display.","name":"staticBodyDebugColor"},{"type":{"names":["number"]},"description":"The color of the velocity markers when rendered to the debug display.","name":"velocityDebugColor"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.ArcadeWorldDefaults","scope":"static","___s":true},{"meta":{"filename":"ArcadeWorldTreeMinMax.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"ArcadeWorldTreeMinMax","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The minimum x value used in RTree searches.","name":"minX"},{"type":{"names":["number"]},"description":"The minimum y value used in RTree searches.","name":"minY"},{"type":{"names":["number"]},"description":"The maximum x value used in RTree searches.","name":"maxX"},{"type":{"names":["number"]},"description":"The maximum y value used in RTree searches.","name":"maxY"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.ArcadeWorldTreeMinMax","scope":"static","___s":true},{"meta":{"filename":"CheckCollisionObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"CheckCollisionObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Will bodies collide with the top side of the world bounds?","name":"up"},{"type":{"names":["boolean"]},"description":"Will bodies collide with the bottom side of the world bounds?","name":"down"},{"type":{"names":["boolean"]},"description":"Will bodies collide with the left side of the world bounds?","name":"left"},{"type":{"names":["boolean"]},"description":"Will bodies collide with the right side of the world bounds?","name":"right"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.CheckCollisionObject","scope":"static","___s":true},{"meta":{"filename":"PhysicsGroupConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"PhysicsGroupConfig","type":{"names":["object"]},"augments":["Phaser.Types.GameObjects.Group.GroupConfig"],"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets {@link Phaser.Physics.Arcade.Body#collideWorldBounds}.","name":"collideWorldBounds"},{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"defaultvalue":null,"description":"Sets {@link Phaser.Physics.Arcade.Body#setBoundsRectangle setBoundsRectangle}.","name":"customBoundsRectangle"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#acceleration acceleration.x}.","name":"accelerationX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#acceleration acceleration.y}.","name":"accelerationY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.Body#allowDrag}.","name":"allowDrag"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.Body#allowGravity}.","name":"allowGravity"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.Body#allowRotation}.","name":"allowRotation"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#bounce bounce.x}.","name":"bounceX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#bounce bounce.y}.","name":"bounceY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#drag drag.x}.","name":"dragX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#drag drag.y}.","name":"dragY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets {@link Phaser.Physics.Arcade.Body#enable enable}.","name":"enable"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#gravity gravity.x}.","name":"gravityX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#gravity gravity.y}.","name":"gravityY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#friction friction.x}.","name":"frictionX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#friction friction.y}.","name":"frictionY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#velocity velocity.x}.","name":"velocityX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#velocity velocity.y}.","name":"velocityY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#angularVelocity}.","name":"angularVelocity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#angularAcceleration}.","name":"angularAcceleration"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#angularDrag}.","name":"angularDrag"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Arcade.Body#mass}.","name":"mass"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets {@link Phaser.Physics.Arcade.Body#immovable}.","name":"immovable"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.PhysicsGroupConfig","scope":"static","___s":true},{"meta":{"filename":"PhysicsGroupDefaults.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"typedef","name":"PhysicsGroupDefaults","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"As {@link Phaser.Physics.Arcade.Body#setCollideWorldBounds}.","name":"setCollideWorldBounds"},{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"As {@link Phaser.Physics.Arcade.Body#setBoundsRectangle}.","name":"setBoundsRectangle"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAccelerationX}.","name":"setAccelerationX"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAccelerationY}.","name":"setAccelerationY"},{"type":{"names":["boolean"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAllowDrag}.","name":"setAllowDrag"},{"type":{"names":["boolean"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAllowGravity}.","name":"setAllowGravity"},{"type":{"names":["boolean"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAllowRotation}.","name":"setAllowRotation"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setBounceX}.","name":"setBounceX"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setBounceY}.","name":"setBounceY"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setDragX}.","name":"setDragX"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setDragY}.","name":"setDragY"},{"type":{"names":["boolean"]},"description":"As {@link Phaser.Physics.Arcade.Body#setEnable}.","name":"setEnable"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setGravityX}.","name":"setGravityX"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setGravityY}.","name":"setGravityY"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setFrictionX}.","name":"setFrictionX"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setFrictionY}.","name":"setFrictionY"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setVelocityX}.","name":"setVelocityX"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setVelocityY}.","name":"setVelocityY"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAngularVelocity}.","name":"setAngularVelocity"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAngularAcceleration}.","name":"setAngularAcceleration"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setAngularDrag}.","name":"setAngularDrag"},{"type":{"names":["number"]},"description":"As {@link Phaser.Physics.Arcade.Body#setMass}.","name":"setMass"},{"type":{"names":["boolean"]},"description":"As {@link Phaser.Physics.Arcade.Body#setImmovable}.","name":"setImmovable"}],"memberof":"Phaser.Types.Physics.Arcade","longname":"Phaser.Types.Physics.Arcade.PhysicsGroupDefaults","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs"},"kind":"namespace","name":"Arcade","memberof":"Phaser.Types.Physics","longname":"Phaser.Types.Physics.Arcade","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Body.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Body.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"kind":"typedef","name":"BodyUpdateCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"body"}],"memberof":"Phaser.Types.Physics.Impact","longname":"Phaser.Types.Physics.Impact.BodyUpdateCallback","scope":"static","___s":true},{"meta":{"filename":"Body.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"An Impact.js compatible physics body.\nThis re-creates the properties you'd get on an Entity and the math needed to update them.","kind":"class","name":"Body","memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"[description]","name":"world"},{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16,"description":"[description]","name":"sx"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16,"description":"[description]","name":"sy"}],"scope":"static","longname":"Phaser.Physics.Impact.Body","___s":true},{"meta":{"filename":"Body.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"world","type":{"names":["Phaser.Physics.Impact.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"gameObject","type":{"names":["Phaser.GameObjects.GameObject"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#gameObject","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The ImpactBody, ImpactSprite or ImpactImage object that owns this Body, if any.","name":"parent","type":{"names":["Phaser.Physics.Impact.ImpactBody","Phaser.Physics.Impact.ImpactImage","Phaser.Physics.Impact.ImpactSprite"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"id","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#id","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"size","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#size","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"offset","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"pos","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#pos","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"last","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#last","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"vel","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#vel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"accel","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#accel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"friction","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#friction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"maxVel","type":{"names":["Phaser.Types.Math.Vector2Like"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#maxVel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"standing","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#standing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":184,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"gravityFactor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#gravityFactor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":193,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"bounciness","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#bounciness","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":202,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"minBounceVelocity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#minBounceVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"accelGround","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#accelGround","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":221,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"accelAir","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#accelAir","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":231,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"jumpSpeed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#jumpSpeed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":241,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"type","type":{"names":["Phaser.Physics.Impact.TYPE"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":250,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"checkAgainst","type":{"names":["Phaser.Physics.Impact.TYPE"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#checkAgainst","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":259,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"collides","type":{"names":["Phaser.Physics.Impact.COLLIDES"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#collides","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":268,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#debugShowBody","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":277,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#debugShowVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":286,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"debugBodyColor","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#debugBodyColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":295,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"updateCallback","type":{"names":["Phaser.Types.Physics.Impact.BodyUpdateCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#updateCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":304,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"min 44 deg, max 136 deg","name":"slopeStanding","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#slopeStanding","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Body.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"reset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#reset","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":347,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#update","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"drawDebug","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"[description]","name":"graphic"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#drawDebug","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":419,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"willDrawDebug","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#willDrawDebug","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"skipHash","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#skipHash","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":445,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Determines whether the body collides with the `other` one or not.","kind":"function","name":"touches","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"other"}],"returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#touches","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Reset the size and position of the physics body.","kind":"function","name":"resetSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to position the body.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to position the body.","name":"y"},{"type":{"names":["number"]},"description":"The width of the body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the body.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"This Body object."}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#resetSize","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":488,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Export this body object to JSON.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Physics.Impact.JSONImpactBody"]},"description":"JSON representation of this body object."}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#toJSON","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":517,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"fromJSON","todo":["Code it!"],"since":"3.0.0","params":[{"type":{"names":["object"]},"description":"[description]","name":"config"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#fromJSON","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":530,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Can be overridden by user code","kind":"function","name":"check","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"other"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#check","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":542,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Can be overridden by user code","kind":"function","name":"collideWith","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"other"},{"type":{"names":["string"]},"description":"[description]","name":"axis"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#collideWith","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":559,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Can be overridden by user code but must return a boolean.","kind":"function","name":"handleMovementTrace","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"res"}],"returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#handleMovementTrace","scope":"instance","___s":true},{"meta":{"filename":"Body.js","lineno":574,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Impact.Body","longname":"Phaser.Physics.Impact.Body#destroy","scope":"instance","___s":true},{"meta":{"filename":"COLLIDES.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Collision Types - Determine if and how entities collide with each other.\n\nIn ACTIVE vs. LITE or FIXED vs. ANY collisions, only the \"weak\" entity moves,\nwhile the other one stays fixed. In ACTIVE vs. ACTIVE and ACTIVE vs. PASSIVE\ncollisions, both entities are moved. LITE or PASSIVE entities don't collide\nwith other LITE or PASSIVE entities at all. The behavior for FIXED vs.\nFIXED collisions is undefined.","kind":"namespace","name":"COLLIDES","memberof":"Phaser.Physics.Impact","since":"3.0.0","longname":"Phaser.Physics.Impact.COLLIDES","scope":"static","___s":true},{"meta":{"filename":"COLLIDES.js","lineno":23,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Never collides.","name":"NEVER","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.COLLIDES","longname":"Phaser.Physics.Impact.COLLIDES.NEVER","scope":"static","___s":true},{"meta":{"filename":"COLLIDES.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Lite collision.","name":"LITE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.COLLIDES","longname":"Phaser.Physics.Impact.COLLIDES.LITE","scope":"static","___s":true},{"meta":{"filename":"COLLIDES.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Passive collision.","name":"PASSIVE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.COLLIDES","longname":"Phaser.Physics.Impact.COLLIDES.PASSIVE","scope":"static","___s":true},{"meta":{"filename":"COLLIDES.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Active collision.","name":"ACTIVE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.COLLIDES","longname":"Phaser.Physics.Impact.COLLIDES.ACTIVE","scope":"static","___s":true},{"meta":{"filename":"COLLIDES.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Fixed collision.","name":"FIXED","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.COLLIDES","longname":"Phaser.Physics.Impact.COLLIDES.FIXED","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"CollisionMap.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CollisionMap.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"[description]","kind":"class","name":"CollisionMap","memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"[description]","name":"tilesize"},{"type":{"names":["array"]},"optional":true,"description":"[description]","name":"data"}],"scope":"static","longname":"Phaser.Physics.Impact.CollisionMap","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":30,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"tilesize","type":{"names":["integer"]},"defaultvalue":"32","since":"3.0.0","memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#tilesize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"data","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"lastSlope","type":{"names":["integer"]},"defaultvalue":"55","since":"3.0.0","memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#lastSlope","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"tiledef","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#tiledef","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"trace","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"description":"[description]","name":"vx"},{"type":{"names":["number"]},"description":"[description]","name":"vy"},{"type":{"names":["number"]},"description":"[description]","name":"objectWidth"},{"type":{"names":["number"]},"description":"[description]","name":"objectHeight"}],"returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#trace","scope":"instance","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":156,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"step","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"[description]","name":"res"},{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"description":"[description]","name":"vx"},{"type":{"names":["number"]},"description":"[description]","name":"vy"},{"type":{"names":["number"]},"description":"[description]","name":"width"},{"type":{"names":["number"]},"description":"[description]","name":"height"},{"type":{"names":["number"]},"description":"[description]","name":"rvx"},{"type":{"names":["number"]},"description":"[description]","name":"rvy"},{"type":{"names":["number"]},"description":"[description]","name":"step"}],"memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#step","scope":"instance","___s":true},{"meta":{"filename":"CollisionMap.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"checkDef","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"[description]","name":"res"},{"type":{"names":["number"]},"description":"[description]","name":"t"},{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"description":"[description]","name":"vx"},{"type":{"names":["number"]},"description":"[description]","name":"vy"},{"type":{"names":["number"]},"description":"[description]","name":"width"},{"type":{"names":["number"]},"description":"[description]","name":"height"},{"type":{"names":["number"]},"description":"[description]","name":"tileX"},{"type":{"names":["number"]},"description":"[description]","name":"tileY"}],"returns":[{"type":{"names":["boolean"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.CollisionMap","longname":"Phaser.Physics.Impact.CollisionMap#checkDef","scope":"instance","___s":true},{"meta":{"range":[180,187],"filename":"DefaultDefs.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"H","longname":"H","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,216],"filename":"Factory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Factory.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"The Impact Physics Factory allows you to easily create Impact Physics enabled Game Objects.\nObjects that are created by this Factory are automatically added to the physics world.","kind":"class","name":"Factory","memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"A reference to the Impact Physics world.","name":"world"}],"scope":"static","longname":"Phaser.Physics.Impact.Factory","___s":true},{"meta":{"filename":"Factory.js","lineno":30,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"A reference to the Impact Physics world.","name":"world","type":{"names":["Phaser.Physics.Impact.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"A reference to the Scene.Systems this Impact Physics instance belongs to.","name":"sys","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#sys","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":49,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Creates a new ImpactBody object and adds it to the physics simulation.","kind":"function","name":"body","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the body in the physics world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the body in the physics world.","name":"y"},{"type":{"names":["number"]},"description":"The width of the body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the body.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"The ImpactBody object that was created."}],"memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#body","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Adds an Impact Physics Body to the given Game Object.","kind":"function","name":"existing","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to receive the physics body.","name":"gameObject"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object."}],"memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#existing","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Creates a new ImpactImage object and adds it to the physics world.","kind":"function","name":"image","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"The ImpactImage object that was created."}],"memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#image","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Creates a new ImpactSprite object and adds it to the physics world.","kind":"function","name":"sprite","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"The ImpactSprite object that was created."}],"memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#sprite","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":137,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Destroys this Factory.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Physics.Impact.Factory","longname":"Phaser.Physics.Impact.Factory#destroy","scope":"instance","___s":true},{"meta":{"range":[180,215],"filename":"GetVelocity.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetVelocity.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"GetVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"},{"type":{"names":["number"]},"description":"[description]","name":"vel"},{"type":{"names":["number"]},"description":"[description]","name":"accel"},{"type":{"names":["number"]},"description":"[description]","name":"friction"},{"type":{"names":["number"]},"description":"[description]","name":"max"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.GetVelocity","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"ImpactBody.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImpactBody.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"[description]","kind":"class","name":"ImpactBody","memberof":"Phaser.Physics.Impact","since":"3.0.0","augments":["Phaser.Physics.Impact.Components.Acceleration","Phaser.Physics.Impact.Components.BodyScale","Phaser.Physics.Impact.Components.BodyType","Phaser.Physics.Impact.Components.Bounce","Phaser.Physics.Impact.Components.CheckAgainst","Phaser.Physics.Impact.Components.Collides","Phaser.Physics.Impact.Components.Debug","Phaser.Physics.Impact.Components.Friction","Phaser.Physics.Impact.Components.Gravity","Phaser.Physics.Impact.Components.Offset","Phaser.Physics.Impact.Components.SetGameObject","Phaser.Physics.Impact.Components.Velocity"],"params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"[description]","name":"world"},{"type":{"names":["number"]},"description":"x - The horizontal position of this physics body in the world.","name":"x"},{"type":{"names":["number"]},"description":"y - The vertical position of this physics body in the world.","name":"y"},{"type":{"names":["number"]},"description":"The width of the physics body in the world.","name":"width"},{"type":{"names":["number"]},"description":"[description]","name":"height"}],"scope":"static","longname":"Phaser.Physics.Impact.ImpactBody","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"body","type":{"names":["Phaser.Physics.Impact.Body"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#body","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"size","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#size","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"offset","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"vel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#vel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"accel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#accel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"friction","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#friction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactBody.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"maxVel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#maxVel","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"ImpactImage.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImpactImage.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"An Impact Physics Image Game Object.\n\nAn Image is a light-weight Game Object useful for the display of static images in your game,\nsuch as logos, backgrounds, scenery or other non-animated elements. Images can have input\nevents and physics bodies, or be tweened, tinted or scrolled. The main difference between an\nImage and a Sprite is that you cannot animate an Image as they do not have the Animation component.","kind":"class","name":"ImpactImage","augments":["Phaser.GameObjects.Image","Phaser.Physics.Impact.Components.Acceleration","Phaser.Physics.Impact.Components.BodyScale","Phaser.Physics.Impact.Components.BodyType","Phaser.Physics.Impact.Components.Bounce","Phaser.Physics.Impact.Components.CheckAgainst","Phaser.Physics.Impact.Components.Collides","Phaser.Physics.Impact.Components.Debug","Phaser.Physics.Impact.Components.Friction","Phaser.Physics.Impact.Components.Gravity","Phaser.Physics.Impact.Components.Offset","Phaser.Physics.Impact.Components.SetGameObject","Phaser.Physics.Impact.Components.Velocity","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"The physics world of the Impact physics system.","name":"world"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.Physics.Impact.ImpactImage","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The Physics Body linked to an ImpactImage.","name":"body","type":{"names":["Phaser.Physics.Impact.Body"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#body","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Image#body","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The size of the physics Body.","name":"size","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#size","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The X and Y offset of the Body from the left and top of the Image.","name":"offset","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":113,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The velocity, or rate of change the Body's position. Measured in pixels per second.","name":"vel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#vel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The acceleration is the rate of change of the velocity. Measured in pixels per second squared.","name":"accel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#accel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Friction between colliding bodies.","name":"friction","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#friction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactImage.js","lineno":140,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"The maximum velocity of the body.","name":"maxVel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#maxVel","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"ImpactPhysics.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"[description]","kind":"class","name":"ImpactPhysics","memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"[description]","name":"scene"}],"scope":"static","longname":"Phaser.Physics.Impact.ImpactPhysics","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"config","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"world","type":{"names":["Phaser.Physics.Impact.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"add","type":{"names":["Phaser.Physics.Impact.Factory"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#add","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"getConfig","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#getConfig","scope":"instance","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":141,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"The Impact World object."}],"memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#pause","scope":"instance","___s":true},{"meta":{"filename":"ImpactPhysics.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"The Impact World object."}],"memberof":"Phaser.Physics.Impact.ImpactPhysics","longname":"Phaser.Physics.Impact.ImpactPhysics#resume","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"ImpactSprite.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"An Impact Physics Sprite Game Object.\n\nA Sprite Game Object is used for the display of both static and animated images in your game.\nSprites can have input events and physics bodies. They can also be tweened, tinted, scrolled\nand animated.\n\nThe main difference between a Sprite and an Image Game Object is that you cannot animate Images.\nAs such, Sprites take a fraction longer to process and have a larger API footprint due to the Animation\nComponent. If you do not require animation then you can safely use Images to replace Sprites in all cases.","kind":"class","name":"ImpactSprite","augments":["Phaser.GameObjects.Sprite","Phaser.Physics.Impact.Components.Acceleration","Phaser.Physics.Impact.Components.BodyScale","Phaser.Physics.Impact.Components.BodyType","Phaser.Physics.Impact.Components.Bounce","Phaser.Physics.Impact.Components.CheckAgainst","Phaser.Physics.Impact.Components.Collides","Phaser.Physics.Impact.Components.Debug","Phaser.Physics.Impact.Components.Friction","Phaser.Physics.Impact.Components.Gravity","Phaser.Physics.Impact.Components.Offset","Phaser.Physics.Impact.Components.SetGameObject","Phaser.Physics.Impact.Components.Velocity","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"[description]","name":"world"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"}],"scope":"static","longname":"Phaser.Physics.Impact.ImpactSprite","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"body","type":{"names":["Phaser.Physics.Impact.Body"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#body","scope":"instance","kind":"member","overrides":"Phaser.GameObjects.Sprite#body","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"size","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#size","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"offset","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"vel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#vel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":125,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"accel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#accel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"friction","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#friction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImpactSprite.js","lineno":143,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"maxVel","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#maxVel","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SeparateX.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"SeparateX","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"[description]","name":"world"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"left"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"right"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"optional":true,"description":"[description]","name":"weak"}],"memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.SeparateX","scope":"static","___s":true},{"meta":{"filename":"SeparateY.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"SeparateY","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"[description]","name":"world"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"top"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"bottom"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"optional":true,"description":"[description]","name":"weak"}],"memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.SeparateY","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"Solver.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"COLLIDES","longname":"COLLIDES","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Solver.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Impact Physics Solver","kind":"function","name":"Solver","fires":["Phaser.Physics.Impact.Events#event:COLLIDE"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"The Impact simulation to run the solver in.","name":"world"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"The first body in the collision.","name":"bodyA"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"The second body in the collision.","name":"bodyB"}],"memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.Solver","scope":"static","___s":true},{"meta":{"filename":"TYPE.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Collision Types - Determine if and how entities collide with each other.\n\nIn ACTIVE vs. LITE or FIXED vs. ANY collisions, only the \"weak\" entity moves,\nwhile the other one stays fixed. In ACTIVE vs. ACTIVE and ACTIVE vs. PASSIVE\ncollisions, both entities are moved. LITE or PASSIVE entities don't collide\nwith other LITE or PASSIVE entities at all. The behavior for FIXED vs.\nFIXED collisions is undefined.","kind":"namespace","name":"TYPE","memberof":"Phaser.Physics.Impact","since":"3.0.0","longname":"Phaser.Physics.Impact.TYPE","scope":"static","___s":true},{"meta":{"filename":"TYPE.js","lineno":22,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Collides with nothing.","name":"NONE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.TYPE","longname":"Phaser.Physics.Impact.TYPE.NONE","scope":"static","___s":true},{"meta":{"filename":"TYPE.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Type A. Collides with Type B.","name":"A","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.TYPE","longname":"Phaser.Physics.Impact.TYPE.A","scope":"static","___s":true},{"meta":{"filename":"TYPE.js","lineno":42,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Type B. Collides with Type A.","name":"B","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.TYPE","longname":"Phaser.Physics.Impact.TYPE.B","scope":"static","___s":true},{"meta":{"filename":"TYPE.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Collides with both types A and B.","name":"BOTH","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Physics.Impact.TYPE","longname":"Phaser.Physics.Impact.TYPE.BOTH","scope":"static","___s":true},{"meta":{"filename":"UpdateMotion.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Set up the trace-result\nvar res = {\n collision: {x: false, y: false, slope: false},\n pos: {x: x, y: y},\n tile: {x: 0, y: 0}\n};","kind":"function","name":"UpdateMotion","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"body"},{"type":{"names":["object"]},"description":"[description]","name":"res"}],"memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.UpdateMotion","scope":"static","___s":true},{"meta":{"range":[180,204],"filename":"World.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"World.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"classdesc":"[description]","kind":"class","name":"World","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Physics.Impact","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Impact World instance belongs.","name":"scene"},{"type":{"names":["Phaser.Types.Physics.Impact.WorldConfig"]},"description":"[description]","name":"config"}],"scope":"static","longname":"Phaser.Physics.Impact.World","___s":true},{"meta":{"filename":"World.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"bodies","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#bodies","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"gravity","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#gravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Spatial hash cell dimensions","name":"cellSize","type":{"names":["integer"]},"defaultvalue":"64","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#cellSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"collisionMap","type":{"names":["Phaser.Physics.Impact.CollisionMap"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#collisionMap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":90,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":100,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Impacts maximum time step is 20 fps.","name":"maxStep","type":{"names":["number"]},"defaultvalue":"0.05","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#maxStep","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"drawDebug","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#drawDebug","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"debugGraphic","type":{"names":["Phaser.GameObjects.Graphics"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#debugGraphic","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":140,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"defaults","type":{"names":["Phaser.Types.Physics.Impact.WorldDefaults"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#defaults","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"An object containing the 4 wall bodies that bound the physics world.","name":"walls","type":{"names":["Phaser.Types.Physics.Impact.WorldWalls"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#walls","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","name":"delta","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#delta","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":219,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Sets the collision map for the world either from a Weltmeister JSON level in the cache or from\na 2D array. If loading from a Weltmeister level, the map must have a layer called \"collision\".","kind":"function","name":"setCollisionMap","since":"3.0.0","params":[{"type":{"names":["string","Array.>"]},"description":"Either a string key that corresponds to a Weltmeister level\nin the cache, or a 2D array of collision IDs.","name":"key"},{"type":{"names":["integer"]},"description":"The size of a tile. This is optional if loading from a Weltmeister\nlevel in the cache.","name":"tileSize"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.CollisionMap"]},"nullable":true,"description":"The newly created CollisionMap, or null if the method failed to\ncreate the CollisionMap."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setCollisionMap","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Sets the collision map for the world from a tilemap layer. Only tiles that are marked as\ncolliding will be used. You can specify the mapping from tiles to slope IDs in a couple of\nways. The easiest is to use Tiled and the slopeTileProperty option. Alternatively, you can\nmanually create a slopeMap that stores the mapping between tile indices and slope IDs.","kind":"function","name":"setCollisionMapFromTilemapLayer","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"description":"The tilemap layer to use.","name":"tilemapLayer"},{"type":{"names":["Phaser.Types.Physics.Impact.CollisionOptions"]},"optional":true,"description":"Options for controlling the mapping from tiles to slope IDs.","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.CollisionMap"]},"description":"The newly created CollisionMap."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setCollisionMapFromTilemapLayer","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":338,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Sets the bounds of the Physics world to match the given world pixel dimensions.\nYou can optionally set which 'walls' to create: left, right, top or bottom.\nIf none of the walls are given it will default to use the walls settings it had previously.\nI.e. if you previously told it to not have the left or right walls, and you then adjust the world size\nthe newly created bounds will also not have the left and right walls.\nExplicitly state them in the parameters to override this.","kind":"function","name":"setBounds","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The x coordinate of the top-left corner of the bounds.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate of the top-left corner of the bounds.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the bounds.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the bounds.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"[description]","name":"thickness"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the left bounds wall.","name":"left"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the right bounds wall.","name":"right"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the top bounds wall.","name":"top"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the bottom bounds wall.","name":"bottom"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setBounds","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":381,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"position = 'left', 'right', 'top' or 'bottom'","kind":"function","name":"updateWall","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"[description]","name":"add"},{"type":{"names":["string"]},"description":"[description]","name":"position"},{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"description":"[description]","name":"width"},{"type":{"names":["number"]},"description":"[description]","name":"height"}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#updateWall","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":423,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Creates a Graphics Game Object used for debug display and enables the world for debug drawing.","kind":"function","name":"createDebugGraphic","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object created that will have the debug visuals drawn to it."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#createDebugGraphic","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":444,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"getNextID","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#getNextID","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":457,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"description":"[description]","name":"sizeX"},{"type":{"names":["number"]},"description":"[description]","name":"sizeY"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"The Body that was added to this World."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#create","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":479,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"The Body to remove from this World.","name":"object"}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#remove","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":492,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"pause","fires":["Phaser.Physics.Impact.Events#event:PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#pause","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":510,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"resume","fires":["Phaser.Physics.Impact.Events#event:RESUME"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#resume","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":528,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#update","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":599,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"Check the body against the spatial hash.","kind":"function","name":"checkHash","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"body"},{"type":{"names":["object"]},"description":"[description]","name":"hash"},{"type":{"names":["number"]},"description":"[description]","name":"size"}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#checkHash","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":651,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"checkBodies","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"bodyA"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"bodyB"}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#checkBodies","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":685,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setCollidesNever","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the collides value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setCollidesNever","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":705,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setLite","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the collides value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setLite","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":725,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setPassive","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the collides value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setPassive","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":745,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the collides value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setActive","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":765,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setFixed","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the collides value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setFixed","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":785,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setTypeNone","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setTypeNone","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":805,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setTypeA","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setTypeA","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":825,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setTypeB","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setTypeB","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":845,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setAvsB","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setAvsB","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":866,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setBvsA","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setBvsA","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":887,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setCheckAgainstNone","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setCheckAgainstNone","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":907,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setCheckAgainstA","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setCheckAgainstA","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":927,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"setCheckAgainstB","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An Array of Impact Bodies to set the type value on.","name":"bodies"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"This World object."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#setCheckAgainstB","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":947,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#shutdown","scope":"instance","overrides":"Phaser.Events.EventEmitter#shutdown","___s":true},{"meta":{"filename":"World.js","lineno":958,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"[description]","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"Acceleration.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Acceleration component.\nShould be applied as a mixin.","kind":"namespace","name":"Acceleration","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Acceleration","scope":"static","___s":true},{"meta":{"filename":"Acceleration.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal acceleration of this body.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Acceleration"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Acceleration","longname":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationX","scope":"instance","___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical acceleration of this body.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Acceleration"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Acceleration","longname":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationY","scope":"instance","___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical acceleration of this body.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal acceleration to apply.","name":"x"},{"type":{"names":["number"]},"description":"The amount of vertical acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Acceleration"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Acceleration","longname":"Phaser.Physics.Impact.Components.Acceleration#setAcceleration","scope":"instance","___s":true},{"meta":{"filename":"BodyScale.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Body Scale component.\nShould be applied as a mixin.","kind":"namespace","name":"BodyScale","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.BodyScale","scope":"static","___s":true},{"meta":{"filename":"BodyScale.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the size of the physics body.","kind":"function","name":"setBodySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the body in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height of the body in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.BodyScale"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.BodyScale","longname":"Phaser.Physics.Impact.Components.BodyScale#setBodySize","scope":"instance","___s":true},{"meta":{"filename":"BodyScale.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the scale of the physics body.","kind":"function","name":"setBodyScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of the body.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The vertical scale of the body. If not given, will use the horizontal scale value.","name":"scaleY"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.BodyScale"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.BodyScale","longname":"Phaser.Physics.Impact.Components.BodyScale#setBodyScale","scope":"instance","___s":true},{"meta":{"range":[180,205],"filename":"BodyType.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"name":"TYPE","longname":"TYPE","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BodyType.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Body Type component.\nShould be applied as a mixin.","kind":"namespace","name":"BodyType","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.BodyType","scope":"static","___s":true},{"meta":{"filename":"BodyType.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"getBodyType","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.Components.BodyType","longname":"Phaser.Physics.Impact.Components.BodyType#getBodyType","scope":"instance","___s":true},{"meta":{"filename":"BodyType.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.BodyType","longname":"Phaser.Physics.Impact.Components.BodyType#setTypeNone","scope":"instance","___s":true},{"meta":{"filename":"BodyType.js","lineno":46,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.BodyType","longname":"Phaser.Physics.Impact.Components.BodyType#setTypeA","scope":"instance","___s":true},{"meta":{"filename":"BodyType.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.BodyType","longname":"Phaser.Physics.Impact.Components.BodyType#setTypeB","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Bounce component.\nShould be applied as a mixin.","kind":"namespace","name":"Bounce","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Bounce","scope":"static","___s":true},{"meta":{"filename":"Bounce.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the impact physics bounce, or restitution, value.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 (no rebound) and 1 (full rebound)","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Bounce","longname":"Phaser.Physics.Impact.Components.Bounce#setBounce","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the minimum velocity the body is allowed to be moving to be considered for rebound.","kind":"function","name":"setMinBounceVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum allowed velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Bounce","longname":"Phaser.Physics.Impact.Components.Bounce#setMinBounceVelocity","scope":"instance","___s":true},{"meta":{"filename":"Bounce.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The bounce, or restitution, value of this body.\nA value between 0 (no rebound) and 1 (full rebound)","name":"bounce","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.Bounce","longname":"Phaser.Physics.Impact.Components.Bounce#bounce","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,205],"filename":"CheckAgainst.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"name":"TYPE","longname":"TYPE","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Check Against component.\nShould be applied as a mixin.","kind":"namespace","name":"CheckAgainst","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.CheckAgainst","scope":"static","___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setAvsB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.CheckAgainst","longname":"Phaser.Physics.Impact.Components.CheckAgainst#setAvsB","scope":"instance","___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setBvsA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.CheckAgainst","longname":"Phaser.Physics.Impact.Components.CheckAgainst#setBvsA","scope":"instance","___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.CheckAgainst","longname":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstNone","scope":"instance","___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.CheckAgainst","longname":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstA","scope":"instance","___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.CheckAgainst","longname":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstB","scope":"instance","___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"checkAgainst","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.CheckAgainst","longname":"Phaser.Physics.Impact.Components.CheckAgainst#checkAgainst","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,213],"filename":"Collides.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"name":"COLLIDES","longname":"COLLIDES","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Collides.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"kind":"typedef","name":"CollideCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"body"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"[description]","name":"other"},{"type":{"names":["string"]},"description":"[description]","name":"axis"}],"longname":"CollideCallback","scope":"global","___s":true},{"meta":{"filename":"Collides.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Collides component.\nShould be applied as a mixin.","kind":"namespace","name":"Collides","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Collides","scope":"static","___s":true},{"meta":{"filename":"Collides.js","lineno":29,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollideCallback","since":"3.0.0","params":[{"type":{"names":["CollideCallback"]},"description":"[description]","name":"callback"},{"type":{"names":["*"]},"description":"[description]","name":"scope"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#setCollideCallback","scope":"instance","___s":true},{"meta":{"filename":"Collides.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollidesNever","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#setCollidesNever","scope":"instance","___s":true},{"meta":{"filename":"Collides.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setLiteCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#setLiteCollision","scope":"instance","___s":true},{"meta":{"filename":"Collides.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setPassiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#setPassiveCollision","scope":"instance","___s":true},{"meta":{"filename":"Collides.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setActiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#setActiveCollision","scope":"instance","___s":true},{"meta":{"filename":"Collides.js","lineno":112,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFixedCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#setFixedCollision","scope":"instance","___s":true},{"meta":{"filename":"Collides.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"collides","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.Collides","longname":"Phaser.Physics.Impact.Components.Collides#collides","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Debug.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Debug component.\nShould be applied as a mixin.","kind":"namespace","name":"Debug","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Debug","scope":"static","___s":true},{"meta":{"filename":"Debug.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"[description]","name":"showBody"},{"type":{"names":["boolean"]},"description":"[description]","name":"showVelocity"},{"type":{"names":["number"]},"description":"[description]","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Debug","longname":"Phaser.Physics.Impact.Components.Debug#setDebug","scope":"instance","___s":true},{"meta":{"filename":"Debug.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Debug","longname":"Phaser.Physics.Impact.Components.Debug#setDebugBodyColor","scope":"instance","___s":true},{"meta":{"filename":"Debug.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.Debug","longname":"Phaser.Physics.Impact.Components.Debug#debugShowBody","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Debug.js","lineno":75,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.Debug","longname":"Phaser.Physics.Impact.Components.Debug#debugShowVelocity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Debug.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.Debug","longname":"Phaser.Physics.Impact.Components.Debug#debugBodyColor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Friction.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Friction component.\nShould be applied as a mixin.","kind":"namespace","name":"Friction","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Friction","scope":"static","___s":true},{"meta":{"filename":"Friction.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Friction","longname":"Phaser.Physics.Impact.Components.Friction#setFrictionX","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Friction","longname":"Phaser.Physics.Impact.Components.Friction#setFrictionY","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Friction","longname":"Phaser.Physics.Impact.Components.Friction#setFriction","scope":"instance","___s":true},{"meta":{"filename":"Gravity.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Gravity component.\nShould be applied as a mixin.","kind":"namespace","name":"Gravity","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Gravity","scope":"static","___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Gravity","longname":"Phaser.Physics.Impact.Components.Gravity#setGravity","scope":"instance","___s":true},{"meta":{"filename":"Gravity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"gravity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.Components.Gravity","longname":"Phaser.Physics.Impact.Components.Gravity#gravity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Offset.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Offset component.\nShould be applied as a mixin.","kind":"namespace","name":"Offset","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Offset","scope":"static","___s":true},{"meta":{"filename":"Offset.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Offset","longname":"Phaser.Physics.Impact.Components.Offset#setOffset","scope":"instance","___s":true},{"meta":{"filename":"SetGameObject.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Set Game Object component.\nShould be applied as a mixin.","kind":"namespace","name":"SetGameObject","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.SetGameObject","scope":"static","___s":true},{"meta":{"filename":"SetGameObject.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGameObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"[description]","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"[description]","name":"sync"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.SetGameObject","longname":"Phaser.Physics.Impact.Components.SetGameObject#setGameObject","scope":"instance","___s":true},{"meta":{"filename":"SetGameObject.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"syncGameObject","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.SetGameObject","longname":"Phaser.Physics.Impact.Components.SetGameObject#syncGameObject","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The Impact Velocity component.\nShould be applied as a mixin.","kind":"namespace","name":"Velocity","since":"3.0.0","memberof":"Phaser.Physics.Impact.Components","longname":"Phaser.Physics.Impact.Components.Velocity","scope":"static","___s":true},{"meta":{"filename":"Velocity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Velocity","longname":"Phaser.Physics.Impact.Components.Velocity#setVelocityX","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Velocity","longname":"Phaser.Physics.Impact.Components.Velocity#setVelocityY","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical velocities of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Velocity","longname":"Phaser.Physics.Impact.Components.Velocity#setVelocity","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the maximum velocity this body can travel at.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The maximum allowed horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The maximum allowed vertical velocity. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.Components.Velocity"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.Components.Velocity","longname":"Phaser.Physics.Impact.Components.Velocity#setMaxVelocity","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"kind":"namespace","name":"Components","memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.Components","scope":"static","___s":true},{"meta":{"filename":"COLLIDE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/events"},"description":"The Impact Physics World Collide Event.\n\nThis event is dispatched by an Impact Physics World instance if two bodies collide.\n\nListen to it from a Scene using: `this.impact.world.on('collide', listener)`.","kind":"event","name":"COLLIDE","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"The first body involved in the collision.","name":"bodyA"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"description":"The second body involved in the collision.","name":"bodyB"},{"type":{"names":["string"]},"description":"The collision axis. Either `x` or `y`.","name":"axis"}],"memberof":"Phaser.Physics.Impact.Events","longname":"Phaser.Physics.Impact.Events#event:COLLIDE","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/events"},"description":"The Impact Physics World Pause Event.\n\nThis event is dispatched by an Impact Physics World instance when it is paused.\n\nListen to it from a Scene using: `this.impact.world.on('pause', listener)`.","kind":"event","name":"PAUSE","since":"3.0.0","memberof":"Phaser.Physics.Impact.Events","longname":"Phaser.Physics.Impact.Events#event:PAUSE","scope":"instance","___s":true},{"meta":{"filename":"RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/events"},"description":"The Impact Physics World Resume Event.\n\nThis event is dispatched by an Impact Physics World instance when it resumes from a paused state.\n\nListen to it from a Scene using: `this.impact.world.on('resume', listener)`.","kind":"event","name":"RESUME","since":"3.0.0","memberof":"Phaser.Physics.Impact.Events","longname":"Phaser.Physics.Impact.Events#event:RESUME","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Physics.Impact","longname":"Phaser.Physics.Impact.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact"},"description":"An Impact.js compatible physics world, body and solver, for those who are used\nto the Impact way of defining and controlling physics bodies. Also works with\nthe new Loader support for Weltmeister map data.\n\nWorld updated to run off the Phaser main loop.\nBody extended to support additional setter functions.\n\nTo create the map data you'll need Weltmeister, which comes with Impact\nand can be purchased from http://impactjs.com\n\nMy thanks to Dominic Szablewski for his permission to support Impact in Phaser.","kind":"namespace","name":"Impact","memberof":"Phaser.Physics","longname":"Phaser.Physics.Impact","scope":"static","___s":true},{"meta":{"filename":"CollisionOptions.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs"},"kind":"typedef","name":"CollisionOptions","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":null,"description":"Slope IDs can be stored on tiles directly\nusing Impacts tileset editor. If a tile has a property with the given slopeTileProperty string\nname, the value of that property for the tile will be used for its slope mapping. E.g. a 45\ndegree slope upward could be given a \"slope\" property with a value of 2.","name":"slopeTileProperty"},{"type":{"names":["object"]},"optional":true,"defaultvalue":null,"description":"A tile index to slope definition map.","name":"slopeMap"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":null,"description":"If specified, the default slope ID to\nassign to a colliding tile. If not specified, the tile's index is used.","name":"defaultCollidingSlope"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The default slope ID to assign to a\nnon-colliding tile.","name":"defaultNonCollidingSlope"}],"memberof":"Phaser.Types.Physics.Impact","longname":"Phaser.Types.Physics.Impact.CollisionOptions","scope":"static","___s":true},{"meta":{"filename":"JSONImpactBody.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs"},"kind":"typedef","name":"JSONImpactBody","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"[description]","name":"name"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"[description]","name":"size"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The entity's position in the game world.","name":"pos"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Current velocity in pixels per second.","name":"vel"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Current acceleration to be added to the entity's velocity per second. E.g. an entity with a `vel.x` of 0 and `accel.x` of 10 will have a `vel.x` of 100 ten seconds later.","name":"accel"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Deceleration to be subtracted from the entity's velocity per second. Only applies if `accel` is 0.","name":"friction"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"The maximum velocity a body can move.","name":"maxVel"},{"type":{"names":["number"]},"description":"[description]","name":"gravityFactor"},{"type":{"names":["number"]},"description":"[description]","name":"bounciness"},{"type":{"names":["number"]},"description":"[description]","name":"minBounceVelocity"},{"type":{"names":["Phaser.Physics.Impact.TYPE"]},"description":"[description]","name":"type"},{"type":{"names":["Phaser.Physics.Impact.TYPE"]},"description":"[description]","name":"checkAgainst"},{"type":{"names":["Phaser.Physics.Impact.COLLIDES"]},"description":"[description]","name":"collides"}],"memberof":"Phaser.Types.Physics.Impact","longname":"Phaser.Types.Physics.Impact.JSONImpactBody","scope":"static","___s":true},{"meta":{"filename":"WorldConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs"},"kind":"typedef","name":"WorldConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sets {@link Phaser.Physics.Impact.World#gravity}","name":"gravity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The size of the cells used for the broadphase pass. Increase this value if you have lots of large objects in the world.","name":"cellSize"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A number that allows per-body time scaling, e.g. a force-field where bodies inside are in slow-motion, while others are at full speed.","name":"timeScale"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.05,"description":"[description]","name":"maxStep"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets {@link Phaser.Physics.Impact.World#debug}.","name":"debug"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"The maximum velocity a body can move.","name":"maxVelocity"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether the Body's boundary is drawn to the debug display.","name":"debugShowBody"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether the Body's velocity is drawn to the debug display.","name":"debugShowVelocity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xff00ff","description":"The color of this Body on the debug display.","name":"debugBodyColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x00ff00","description":"The color of the Body's velocity on the debug display.","name":"debugVelocityColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"maxVelocity","description":"Maximum X velocity objects can move.","name":"maxVelocityX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"maxVelocity","description":"Maximum Y velocity objects can move.","name":"maxVelocityY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":40,"description":"The minimum velocity an object can be moving at to be considered for bounce.","name":"minBounceVelocity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Gravity multiplier. Set to 0 for no gravity.","name":"gravityFactor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The default bounce, or restitution, of bodies in the world.","name":"bounciness"},{"type":{"names":["object","boolean"]},"optional":true,"description":"Should the world have bounds enabled by default?","name":"setBounds"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the world bounds.","name":"setBounds.x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the world bounds.","name":"setBounds.y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the world bounds.","name":"setBounds.width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the world bounds.","name":"setBounds.height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The thickness of the walls of the world bounds.","name":"setBounds.thickness"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the left-side world bounds wall be created?","name":"setBounds.left"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the right-side world bounds wall be created?","name":"setBounds.right"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the top world bounds wall be created?","name":"setBounds.top"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the bottom world bounds wall be created?","name":"setBounds.bottom"}],"memberof":"Phaser.Types.Physics.Impact","longname":"Phaser.Types.Physics.Impact.WorldConfig","scope":"static","___s":true},{"meta":{"filename":"WorldDefaults.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs"},"description":"An object containing the 4 wall bodies that bound the physics world.","kind":"typedef","name":"WorldDefaults","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"description":"Whether the Body's boundary is drawn to the debug display.","name":"debugShowBody"},{"type":{"names":["boolean"]},"description":"Whether the Body's velocity is drawn to the debug display.","name":"debugShowVelocity"},{"type":{"names":["number"]},"description":"The color of this Body on the debug display.","name":"bodyDebugColor"},{"type":{"names":["number"]},"description":"The color of the Body's velocity on the debug display.","name":"velocityDebugColor"},{"type":{"names":["number"]},"description":"Maximum X velocity objects can move.","name":"maxVelocityX"},{"type":{"names":["number"]},"description":"Maximum Y velocity objects can move.","name":"maxVelocityY"},{"type":{"names":["number"]},"description":"The minimum velocity an object can be moving at to be considered for bounce.","name":"minBounceVelocity"},{"type":{"names":["number"]},"description":"Gravity multiplier. Set to 0 for no gravity.","name":"gravityFactor"},{"type":{"names":["number"]},"description":"The default bounce, or restitution, of bodies in the world.","name":"bounciness"}],"memberof":"Phaser.Types.Physics.Impact","longname":"Phaser.Types.Physics.Impact.WorldDefaults","scope":"static","___s":true},{"meta":{"filename":"WorldWalls.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs"},"kind":"typedef","name":"WorldWalls","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Physics.Impact.Body"]},"nullable":true,"description":"The left-side wall of the world bounds.","name":"left"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"nullable":true,"description":"The right-side wall of the world bounds.","name":"right"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"nullable":true,"description":"The top wall of the world bounds.","name":"top"},{"type":{"names":["Phaser.Physics.Impact.Body"]},"nullable":true,"description":"The bottom wall of the world bounds.","name":"bottom"}],"memberof":"Phaser.Types.Physics.Impact","longname":"Phaser.Types.Physics.Impact.WorldWalls","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs"},"kind":"namespace","name":"Impact","memberof":"Phaser.Types.Physics","longname":"Phaser.Types.Physics.Impact","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics"},"kind":"namespace","name":"Physics","memberof":"Phaser","longname":"Phaser.Physics","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics"},"kind":"namespace","name":"Physics","memberof":"Phaser.Types","longname":"Phaser.Types.Physics","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"BodyBounds.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BodyBounds.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"The Body Bounds class contains methods to help you extract the world coordinates from various points around\nthe bounds of a Matter Body. Because Matter bodies are positioned based on their center of mass, and not a\ndimension based center, you often need to get the bounds coordinates in order to properly align them in the world.\n\nYou can access this class via the MatterPhysics class from a Scene, i.e.:\n\n```javascript\nthis.matter.bodyBounds.getTopLeft(body);\n```\n\nSee also the `MatterPhysics.alignBody` method.","kind":"class","name":"BodyBounds","memberof":"Phaser.Physics.Matter","since":"3.22.0","scope":"static","longname":"Phaser.Physics.Matter.BodyBounds","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":36,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A Vector2 that stores the temporary bounds center value during calculations by methods in this class.","name":"boundsCenter","type":{"names":["Phaser.Math.Vector2"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#boundsCenter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":45,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A Vector2 that stores the temporary center diff values during calculations by methods in this class.","name":"centerDiff","type":{"names":["Phaser.Math.Vector2"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#centerDiff","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":55,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Parses the given body to get the bounds diff values from it.\n\nThey're stored in this class in the temporary properties `boundsCenter` and `centerDiff`.\n\nThis method is called automatically by all other methods in this class.","kind":"function","name":"parseBody","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the bounds position from.","name":"body"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if it was able to get the bounds, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#parseBody","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the top-left of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getTopLeft","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getTopLeft","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the top-center of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getTopCenter","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getTopCenter","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":161,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the top-right of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getTopRight","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getTopRight","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the left-center of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getLeftCenter","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getLeftCenter","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the center of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getCenter","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getCenter","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":262,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the right-center of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getRightCenter","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getRightCenter","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":296,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the bottom-left of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getBottomLeft","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getBottomLeft","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the bottom-center of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getBottomCenter","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getBottomCenter","scope":"instance","___s":true},{"meta":{"filename":"BodyBounds.js","lineno":364,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes a Body and returns the world coordinates of the bottom-right of its _bounds_.\n\nBody bounds are updated by Matter each step and factor in scale and rotation.\nThis will return the world coordinate based on the bodies _current_ position and bounds.","kind":"function","name":"getBottomRight","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to get the position from.","name":"body"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional horizontal offset to add to the returned coordinates.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional vertical offset to add to the returned coordinates.","name":"y"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","false"]},"description":"A Vector2 containing the coordinates, or `false` if it was unable to parse the body."}],"memberof":"Phaser.Physics.Matter.BodyBounds","longname":"Phaser.Physics.Matter.BodyBounds#getBottomRight","scope":"instance","___s":true},{"meta":{"filename":"CustomMain.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"kind":"namespace","name":"Matter","memberof":"Phaser.Physics.Matter","longname":"Phaser.Physics.Matter.Matter","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"Factory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Bodies","longname":"Bodies","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Factory.js","lineno":21,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"The Matter Factory is responsible for quickly creating a variety of different types of\nbodies, constraints and Game Objects and adding them into the physics world.\n\nYou access the factory from within a Scene using `add`:\n\n```javascript\nthis.matter.add.rectangle(x, y, width, height);\n```\n\nUse of the Factory is optional. All of the objects it creates can also be created\ndirectly via your own code or constructors. It is provided as a means to keep your\ncode concise.","kind":"class","name":"Factory","memberof":"Phaser.Physics.Matter","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"The Matter World which this Factory adds to.","name":"world"}],"scope":"static","longname":"Phaser.Physics.Matter.Factory","___s":true},{"meta":{"filename":"Factory.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Matter World which this Factory adds to.","name":"world","type":{"names":["Phaser.Physics.Matter.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Scene which this Factory's Matter World belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Scene.Systems this Matter Physics instance belongs to.","name":"sys","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#sys","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Factory.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a new rigid rectangular Body and adds it to the World.","kind":"function","name":"rectangle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the center of the Body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the center of the Body.","name":"y"},{"type":{"names":["number"]},"description":"The width of the Body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the Body.","name":"height"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#rectangle","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a new rigid trapezoidal Body and adds it to the World.","kind":"function","name":"trapezoid","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the center of the Body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the center of the Body.","name":"y"},{"type":{"names":["number"]},"description":"The width of the trapezoid Body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the trapezoid Body.","name":"height"},{"type":{"names":["number"]},"description":"The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.","name":"slope"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#trapezoid","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":124,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a new rigid circular Body and adds it to the World.","kind":"function","name":"circle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the center of the Body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the center of the Body.","name":"y"},{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"},{"type":{"names":["number"]},"optional":true,"description":"The maximum amount of sides to use for the polygon which will approximate this circle.","name":"maxSides"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#circle","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a new rigid polygonal Body and adds it to the World.","kind":"function","name":"polygon","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the center of the Body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the center of the Body.","name":"y"},{"type":{"names":["number"]},"description":"The number of sides the polygon will have.","name":"sides"},{"type":{"names":["number"]},"description":"The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#polygon","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a body using the supplied vertices (or an array containing multiple sets of vertices) and adds it to the World.\nIf the vertices are convex, they will pass through as supplied. Otherwise, if the vertices are concave, they will be decomposed. Note that this process is not guaranteed to support complex sets of vertices, e.g. ones with holes.","kind":"function","name":"fromVertices","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the center of the Body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the center of the Body.","name":"y"},{"type":{"names":["string","array"]},"description":"The vertices data. Either a path string or an array of vertices.","name":"vertexSets"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Flag internal edges (coincident part edges)","name":"flagInternal"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.01,"description":"Whether Matter.js will discard collinear edges (to improve performance).","name":"removeCollinear"},{"type":{"names":["number"]},"optional":true,"defaultvalue":10,"description":"During decomposition discard parts that have an area less than this.","name":"minimumArea"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#fromVertices","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a body using data exported from the application PhysicsEditor (https://www.codeandweb.com/physicseditor)\n\nThe PhysicsEditor file should be loaded as JSON:\n\n```javascript\npreload ()\n{\n this.load.json('vehicles', 'assets/vehicles.json);\n}\n\ncreate ()\n{\n const vehicleShapes = this.cache.json.get('vehicles');\n this.matter.add.fromPhysicsEditor(400, 300, vehicleShapes.truck);\n}\n```\n\nDo not pass the entire JSON file to this method, but instead pass one of the shapes contained within it.\n\nIf you pas in an `options` object, any settings in there will override those in the PhysicsEditor config object.","kind":"function","name":"fromPhysicsEditor","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The horizontal world location of the body.","name":"x"},{"type":{"names":["number"]},"description":"The vertical world location of the body.","name":"y"},{"type":{"names":["any"]},"description":"The JSON data exported from PhysicsEditor.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the newly created body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#fromPhysicsEditor","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":248,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a body using the path data from an SVG file.\n\nSVG Parsing requires the pathseg polyfill from https://github.com/progers/pathseg\n\nThe SVG file should be loaded as XML, as this method requires the ability to extract\nthe path data from it. I.e.:\n\n```javascript\npreload ()\n{\n this.load.xml('face', 'assets/face.svg);\n}\n\ncreate ()\n{\n this.matter.add.fromSVG(400, 300, this.cache.xml.get('face'));\n}\n```","kind":"function","name":"fromSVG","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the body.","name":"y"},{"type":{"names":["object"]},"description":"The SVG Path data.","name":"xml"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Scale the vertices by this amount after creation.","name":"scale"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the newly created body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#fromSVG","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":311,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a body using the supplied physics data, as provided by a JSON file.\n\nThe data file should be loaded as JSON:\n\n```javascript\npreload ()\n{\n this.load.json('ninjas', 'assets/ninjas.json);\n}\n\ncreate ()\n{\n const ninjaShapes = this.cache.json.get('ninjas');\n\n this.matter.add.fromJSON(400, 300, ninjaShapes.shinobi);\n}\n```\n\nDo not pass the entire JSON file to this method, but instead pass one of the shapes contained within it.\n\nIf you pas in an `options` object, any settings in there will override those in the config object.\n\nThe structure of the JSON file is as follows:\n\n```text\n{\n 'generator_info': // The name of the application that created the JSON data\n 'shapeName': {\n 'type': // The type of body\n 'label': // Optional body label\n 'vertices': // An array, or an array of arrays, containing the vertex data in x/y object pairs\n }\n}\n```\n\nAt the time of writing, only the Phaser Physics Tracer App exports in this format.","kind":"function","name":"fromJSON","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the body.","name":"x"},{"type":{"names":["number"]},"description":"The Y coordinate of the body.","name":"y"},{"type":{"names":["any"]},"description":"The JSON physics data.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the newly created body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#fromJSON","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":375,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Create a new composite containing Matter Image objects created in a grid arrangement.\nThis function uses the body bounds to prevent overlaps.","kind":"function","name":"imageStack","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"description":"An optional frame from the Texture this Game Object is rendering with. Set to `null` to skip this value.","name":"frame"},{"type":{"names":["number"]},"description":"The horizontal position of this composite in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this composite in the world.","name":"y"},{"type":{"names":["number"]},"description":"The number of columns in the grid.","name":"columns"},{"type":{"names":["number"]},"description":"The number of rows in the grid.","name":"rows"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The distance between each column.","name":"columnGap"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The distance between each row.","name":"rowGap"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"A Matter JS Composite Stack."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#imageStack","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":419,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Create a new composite containing bodies created in the callback in a grid arrangement.\n\nThis function uses the body bounds to prevent overlaps.","kind":"function","name":"stack","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this composite in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this composite in the world.","name":"y"},{"type":{"names":["number"]},"description":"The number of columns in the grid.","name":"columns"},{"type":{"names":["number"]},"description":"The number of rows in the grid.","name":"rows"},{"type":{"names":["number"]},"description":"The distance between each column.","name":"columnGap"},{"type":{"names":["number"]},"description":"The distance between each row.","name":"rowGap"},{"type":{"names":["function"]},"description":"The callback that creates the stack.","name":"callback"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"A new composite containing objects created in the callback."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#stack","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":446,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Create a new composite containing bodies created in the callback in a pyramid arrangement.\nThis function uses the body bounds to prevent overlaps.","kind":"function","name":"pyramid","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this composite in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this composite in the world.","name":"y"},{"type":{"names":["number"]},"description":"The number of columns in the pyramid.","name":"columns"},{"type":{"names":["number"]},"description":"The number of rows in the pyramid.","name":"rows"},{"type":{"names":["number"]},"description":"The distance between each column.","name":"columnGap"},{"type":{"names":["number"]},"description":"The distance between each row.","name":"rowGap"},{"type":{"names":["function"]},"description":"The callback function to be invoked.","name":"callback"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"A Matter JS Composite pyramid."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#pyramid","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Chains all bodies in the given composite together using constraints.","kind":"function","name":"chain","since":"3.0.0","params":[{"type":{"names":["MatterJS.CompositeType"]},"description":"The composite in which all bodies will be chained together sequentially.","name":"composite"},{"type":{"names":["number"]},"description":"The horizontal offset of the BodyA constraint. This is a percentage based on the body size, not a world position.","name":"xOffsetA"},{"type":{"names":["number"]},"description":"The vertical offset of the BodyA constraint. This is a percentage based on the body size, not a world position.","name":"yOffsetA"},{"type":{"names":["number"]},"description":"The horizontal offset of the BodyB constraint. This is a percentage based on the body size, not a world position.","name":"xOffsetB"},{"type":{"names":["number"]},"description":"The vertical offset of the BodyB constraint. This is a percentage based on the body size, not a world position.","name":"yOffsetB"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"The original composite that was passed to this method."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#chain","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":492,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Connects bodies in the composite with constraints in a grid pattern, with optional cross braces.","kind":"function","name":"mesh","since":"3.0.0","params":[{"type":{"names":["MatterJS.CompositeType"]},"description":"The composite in which all bodies will be chained together.","name":"composite"},{"type":{"names":["number"]},"description":"The number of columns in the mesh.","name":"columns"},{"type":{"names":["number"]},"description":"The number of rows in the mesh.","name":"rows"},{"type":{"names":["boolean"]},"description":"Create cross braces for the mesh as well?","name":"crossBrace"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"The original composite that was passed to this method."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#mesh","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":511,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a composite with a Newton's Cradle setup of bodies and constraints.","kind":"function","name":"newtonsCradle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the start of the cradle.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the start of the cradle.","name":"y"},{"type":{"names":["number"]},"description":"The number of balls in the cradle.","name":"number"},{"type":{"names":["number"]},"description":"The radius of each ball in the cradle.","name":"size"},{"type":{"names":["number"]},"description":"The length of the 'string' the balls hang from.","name":"length"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"A Newton's cradle composite."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#newtonsCradle","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":534,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a composite with simple car setup of bodies and constraints.","kind":"function","name":"car","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the car in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the car in the world.","name":"y"},{"type":{"names":["number"]},"description":"The width of the car chasis.","name":"width"},{"type":{"names":["number"]},"description":"The height of the car chasis.","name":"height"},{"type":{"names":["number"]},"description":"The radius of the car wheels.","name":"wheelSize"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"A new composite car body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#car","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":557,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a simple soft body like object.","kind":"function","name":"softBody","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this composite in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this composite in the world.","name":"y"},{"type":{"names":["number"]},"description":"The number of columns in the Composite.","name":"columns"},{"type":{"names":["number"]},"description":"The number of rows in the Composite.","name":"rows"},{"type":{"names":["number"]},"description":"The distance between each column.","name":"columnGap"},{"type":{"names":["number"]},"description":"The distance between each row.","name":"rowGap"},{"type":{"names":["boolean"]},"description":"`true` to create cross braces between the bodies, or `false` to create just straight braces.","name":"crossBrace"},{"type":{"names":["number"]},"description":"The radius of this circlular composite.","name":"particleRadius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"particleOptions"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"constraintOptions"}],"returns":[{"type":{"names":["MatterJS.CompositeType"]},"description":"A new composite simple soft body."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#softBody","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":585,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"This method is an alias for `Factory.constraint`.\n\nConstraints (or joints) are used for specifying that a fixed distance must be maintained\nbetween two bodies, or a body and a fixed world-space position.\n\nThe stiffness of constraints can be modified to create springs or elastic.\n\nTo simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\nvalue (e.g. `0.7` or above).\n\nIf the constraint is unstable, try lowering the `stiffness` value and / or increasing\n`constraintIterations` within the Matter Config.\n\nFor compound bodies, constraints must be applied to the parent body and not one of its parts.","kind":"function","name":"joint","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The first possible `Body` that this constraint is attached to.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"The second possible `Body` that this constraint is attached to.","name":"bodyB"},{"type":{"names":["number"]},"optional":true,"description":"A Number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.","name":"stiffness"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"A Matter JS Constraint."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#joint","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":617,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"This method is an alias for `Factory.constraint`.\n\nConstraints (or joints) are used for specifying that a fixed distance must be maintained\nbetween two bodies, or a body and a fixed world-space position.\n\nThe stiffness of constraints can be modified to create springs or elastic.\n\nTo simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\nvalue (e.g. `0.7` or above).\n\nIf the constraint is unstable, try lowering the `stiffness` value and / or increasing\n`constraintIterations` within the Matter Config.\n\nFor compound bodies, constraints must be applied to the parent body and not one of its parts.","kind":"function","name":"spring","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The first possible `Body` that this constraint is attached to.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"The second possible `Body` that this constraint is attached to.","name":"bodyB"},{"type":{"names":["number"]},"optional":true,"description":"A Number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.","name":"stiffness"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"A Matter JS Constraint."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#spring","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":649,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Constraints (or joints) are used for specifying that a fixed distance must be maintained\nbetween two bodies, or a body and a fixed world-space position.\n\nThe stiffness of constraints can be modified to create springs or elastic.\n\nTo simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\nvalue (e.g. `0.7` or above).\n\nIf the constraint is unstable, try lowering the `stiffness` value and / or increasing\n`constraintIterations` within the Matter Config.\n\nFor compound bodies, constraints must be applied to the parent body and not one of its parts.","kind":"function","name":"constraint","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The first possible `Body` that this constraint is attached to.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"The second possible `Body` that this constraint is attached to.","name":"bodyB"},{"type":{"names":["number"]},"optional":true,"description":"A Number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.","name":"stiffness"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"A Matter JS Constraint."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#constraint","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":696,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Constraints (or joints) are used for specifying that a fixed distance must be maintained\nbetween two bodies, or a body and a fixed world-space position.\n\nA world constraint has only one body, you should specify a `pointA` position in\nthe constraint options parameter to attach the constraint to the world.\n\nThe stiffness of constraints can be modified to create springs or elastic.\n\nTo simulate a revolute constraint (or pin joint) set `length: 0` and a high `stiffness`\nvalue (e.g. `0.7` or above).\n\nIf the constraint is unstable, try lowering the `stiffness` value and / or increasing\n`constraintIterations` within the Matter Config.\n\nFor compound bodies, constraints must be applied to the parent body and not one of its parts.","kind":"function","name":"worldConstraint","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Matter `Body` that this constraint is attached to.","name":"body"},{"type":{"names":["number"]},"optional":true,"description":"A number that specifies the target resting length of the constraint. If not given it is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.","name":"length"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts as a soft spring.","name":"stiffness"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"A Matter JS Constraint."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#worldConstraint","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":744,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"This method is an alias for `Factory.pointerConstraint`.\n\nA Pointer Constraint is a special type of constraint that allows you to click\nand drag bodies in a Matter World. It monitors the active Pointers in a Scene,\nand when one is pressed down it checks to see if that hit any part of any active\nbody in the world. If it did, and the body has input enabled, it will begin to\ndrag it until either released, or you stop it via the `stopDrag` method.\n\nYou can adjust the stiffness, length and other properties of the constraint via\nthe `options` object on creation.","kind":"function","name":"mouseSpring","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"A Matter JS Constraint."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#mouseSpring","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":768,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A Pointer Constraint is a special type of constraint that allows you to click\nand drag bodies in a Matter World. It monitors the active Pointers in a Scene,\nand when one is pressed down it checks to see if that hit any part of any active\nbody in the world. If it did, and the body has input enabled, it will begin to\ndrag it until either released, or you stop it via the `stopDrag` method.\n\nYou can adjust the stiffness, length and other properties of the constraint via\nthe `options` object on creation.","kind":"function","name":"pointerConstraint","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintConfig"]},"optional":true,"description":"An optional Constraint configuration object that is used to set initial Constraint properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"A Matter JS Constraint."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#pointerConstraint","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":801,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a Matter Physics Image Game Object.\n\nAn Image is a light-weight Game Object useful for the display of static images in your game,\nsuch as logos, backgrounds, scenery or other non-animated elements. Images can have input\nevents and physics bodies, or be tweened, tinted or scrolled. The main difference between an\nImage and a Sprite is that you cannot animate an Image as they do not have the Animation component.","kind":"function","name":"image","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with. Set to `null` to skip this value.","name":"frame"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"The Matter Image Game Object."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#image","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":829,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a wrapper around a Tile that provides access to a corresponding Matter body. A tile can only\nhave one Matter body associated with it. You can either pass in an existing Matter body for\nthe tile or allow the constructor to create the corresponding body for you. If the Tile has a\ncollision group (defined in Tiled), those shapes will be used to create the body. If not, the\ntile's rectangle bounding box will be used.\n\nThe corresponding body will be accessible on the Tile itself via Tile.physics.matterBody.\n\nNote: not all Tiled collision shapes are supported. See\nPhaser.Physics.Matter.TileBody#setFromTileCollision for more information.","kind":"function","name":"tileBody","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The target tile that should have a Matter body.","name":"tile"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterTileOptions"]},"optional":true,"description":"Options to be used when creating the Matter body.","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"The Matter Tile Body Game Object."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#tileBody","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":854,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a Matter Physics Sprite Game Object.\n\nA Sprite Game Object is used for the display of both static and animated images in your game.\nSprites can have input events and physics bodies. They can also be tweened, tinted, scrolled\nand animated.\n\nThe main difference between a Sprite and an Image Game Object is that you cannot animate Images.\nAs such, Sprites take a fraction longer to process and have a larger API footprint due to the Animation\nComponent. If you do not require animation then you can safely use Images to replace Sprites in all cases.","kind":"function","name":"sprite","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with. Set to `null` to skip this value.","name":"frame"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"The Matter Sprite Game Object."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#sprite","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":886,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes an existing Game Object and injects all of the Matter Components into it.\n\nThis enables you to use component methods such as `setVelocity` or `isSensor` directly from\nthis Game Object.\n\nYou can also pass in either a Matter Body Configuration object, or a Matter Body instance\nto link with this Game Object.","kind":"function","name":"gameObject","since":"3.3.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to inject the Matter Components in to.","name":"gameObject"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig","MatterJS.Body"]},"optional":true,"description":"A Matter Body configuration object, or an instance of a Matter Body.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Add this Matter Body to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that had the Matter Components injected into it."}],"memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#gameObject","scope":"instance","___s":true},{"meta":{"filename":"Factory.js","lineno":909,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Destroys this Factory.","kind":"function","name":"destroy","since":"3.5.0","memberof":"Phaser.Physics.Matter.Factory","longname":"Phaser.Physics.Matter.Factory#destroy","scope":"instance","___s":true},{"meta":{"range":[180,216],"filename":"MatterGameObject.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Components","longname":"Components","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MatterGameObject.js","lineno":26,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A Matter Game Object is a generic object that allows you to combine any Phaser Game Object,\nincluding those you have extended or created yourself, with all of the Matter Components.\n\nThis enables you to use component methods such as `setVelocity` or `isSensor` directly from\nthis Game Object.","kind":"function","name":"MatterGameObject","since":"3.3.0","params":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"The Matter world to add the body to.","name":"world"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that will have the Matter body applied to it.","name":"gameObject"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig","MatterJS.Body"]},"optional":true,"description":"A Matter Body configuration object, or an instance of a Matter Body.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the newly created body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object that was created with the Matter body."}],"memberof":"Phaser.Physics.Matter","longname":"Phaser.Physics.Matter.MatterGameObject","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"MatterImage.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MatterImage.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"A Matter Physics Image Game Object.\n\nAn Image is a light-weight Game Object useful for the display of static images in your game,\nsuch as logos, backgrounds, scenery or other non-animated elements. Images can have input\nevents and physics bodies, or be tweened, tinted or scrolled. The main difference between an\nImage and a Sprite is that you cannot animate an Image as they do not have the Animation component.","kind":"class","name":"Image","augments":["Phaser.GameObjects.Image","Phaser.Physics.Matter.Components.Bounce","Phaser.Physics.Matter.Components.Collision","Phaser.Physics.Matter.Components.Force","Phaser.Physics.Matter.Components.Friction","Phaser.Physics.Matter.Components.Gravity","Phaser.Physics.Matter.Components.Mass","Phaser.Physics.Matter.Components.Sensor","Phaser.Physics.Matter.Components.SetBody","Phaser.Physics.Matter.Components.Sleep","Phaser.Physics.Matter.Components.Static","Phaser.Physics.Matter.Components.Transform","Phaser.Physics.Matter.Components.Velocity","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Physics.Matter","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"A reference to the Matter.World instance that this body belongs to.","name":"world"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"scope":"static","longname":"Phaser.Physics.Matter.Image","___s":true},{"meta":{"filename":"MatterImage.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Matter.World instance that this body belongs to.","name":"world","type":{"names":["Phaser.Physics.Matter.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#world","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,230],"filename":"MatterPhysics.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"ALIGN_CONST","longname":"ALIGN_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":41,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"The Phaser Matter plugin provides the ability to use the Matter JS Physics Engine within your Phaser games.\n\nUnlike Arcade Physics, the other physics system provided with Phaser, Matter JS is a full-body physics system.\nIt features:\n\n* Rigid bodies\n* Compound bodies\n* Composite bodies\n* Concave and convex hulls\n* Physical properties (mass, area, density etc.)\n* Restitution (elastic and inelastic collisions)\n* Collisions (broad-phase, mid-phase and narrow-phase)\n* Stable stacking and resting\n* Conservation of momentum\n* Friction and resistance\n* Constraints\n* Gravity\n* Sleeping and static bodies\n* Rounded corners (chamfering)\n* Views (translate, zoom)\n* Collision queries (raycasting, region tests)\n* Time scaling (slow-mo, speed-up)\n\nConfiguration of Matter is handled via the Matter World Config object, which can be passed in either the\nPhaser Game Config, or Phaser Scene Config. Here is a basic example:\n\n```js\nphysics: {\n default: 'matter',\n matter: {\n enableSleeping: true,\n gravity: {\n y: 0\n },\n debug: {\n showBody: true,\n showStaticBody: true\n }\n }\n}\n```\n\nThis class acts as an interface between a Phaser Scene and a single instance of the Matter Engine.\n\nUse it to access the most common Matter features and helper functions.\n\nYou can find details, documentation and examples on the Matter JS website: https://brm.io/matter-js/","kind":"class","name":"MatterPhysics","memberof":"Phaser.Physics.Matter","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Phaser Scene that owns this Matter Physics instance.","name":"scene"}],"scope":"static","longname":"Phaser.Physics.Matter.MatterPhysics","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Phaser Scene that owns this Matter Physics instance","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":113,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Scene Systems that belong to the Scene owning this Matter Physics instance.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":122,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The parsed Matter Configuration object.","name":"config","type":{"names":["Phaser.Types.Physics.Matter.MatterWorldConfig"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"An instance of the Matter World class. This class is responsible for the updating of the\nMatter Physics world, as well as handling debug drawing functions.","name":"world","type":{"names":["Phaser.Physics.Matter.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"An instance of the Matter Factory. This class provides lots of functions for creating a\nwide variety of physics objects and adds them automatically to the Matter World.\n\nYou can use this class to cut-down on the amount of code required in your game, however,\nuse of the Factory is entirely optional and should be seen as a development aid. It's\nperfectly possible to create and add components to the Matter world without using it.","name":"add","type":{"names":["Phaser.Physics.Matter.Factory"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#add","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"An instance of the Body Bounds class. This class contains functions used for getting the\nworld position from various points around the bounds of a physics body.","name":"bodyBounds","type":{"names":["Phaser.Physics.Matter.BodyBounds"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#bodyBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Body` module.\n\nThe `Matter.Body` module contains methods for creating and manipulating body models.\nA `Matter.Body` is a rigid body that can be simulated by a `Matter.Engine`.\nFactories for commonly used body configurations (such as rectangles, circles and other polygons) can be found in the `Bodies` module.","name":"body","type":{"names":["MatterJS.BodyFactory"]},"since":"3.18.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#body","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":180,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Composite` module.\n\nThe `Matter.Composite` module contains methods for creating and manipulating composite bodies.\nA composite body is a collection of `Matter.Body`, `Matter.Constraint` and other `Matter.Composite`, therefore composites form a tree structure.\nIt is important to use the functions in this module to modify composites, rather than directly modifying their properties.\nNote that the `Matter.World` object is also a type of `Matter.Composite` and as such all composite methods here can also operate on a `Matter.World`.","name":"composite","type":{"names":["MatterJS.CompositeFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#composite","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Detector` module.\n\nThe `Matter.Detector` module contains methods for detecting collisions given a set of pairs.","name":"detector","type":{"names":["MatterJS.DetectorFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#detector","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":207,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Grid` module.\n\nThe `Matter.Grid` module contains methods for creating and manipulating collision broadphase grid structures.","name":"grid","type":{"names":["MatterJS.GridFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#grid","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":218,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Pair` module.\n\nThe `Matter.Pair` module contains methods for creating and manipulating collision pairs.","name":"pair","type":{"names":["MatterJS.PairFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#pair","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":229,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Pairs` module.\n\nThe `Matter.Pairs` module contains methods for creating and manipulating collision pair sets.","name":"pairs","type":{"names":["MatterJS.PairsFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#pairs","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":240,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Query` module.\n\nThe `Matter.Query` module contains methods for performing collision queries.","name":"query","type":{"names":["MatterJS.QueryFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#query","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":251,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Resolver` module.\n\nThe `Matter.Resolver` module contains methods for resolving collision pairs.","name":"resolver","type":{"names":["MatterJS.ResolverFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#resolver","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":262,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.SAT` module.\n\nThe `Matter.SAT` module contains methods for detecting collisions using the Separating Axis Theorem.","name":"sat","type":{"names":["MatterJS.SATFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#sat","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":275,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Constraint` module.\n\nThe `Matter.Constraint` module contains methods for creating and manipulating constraints.\nConstraints are used for specifying that a fixed distance must be maintained between two bodies (or a body and a fixed world-space position).\nThe stiffness of constraints can be modified to create springs or elastic.","name":"constraint","type":{"names":["MatterJS.ConstraintFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#constraint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":290,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Bodies` module.\n\nThe `Matter.Bodies` module contains factory methods for creating rigid bodies\nwith commonly used body configurations (such as rectangles, circles and other polygons).","name":"bodies","type":{"names":["MatterJS.BodiesFactory"]},"since":"3.18.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#bodies","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":302,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Composites` module.\n\nThe `Matter.Composites` module contains factory methods for creating composite bodies\nwith commonly used configurations (such as stacks and chains).","name":"composites","type":{"names":["MatterJS.CompositesFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#composites","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":316,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Axes` module.\n\nThe `Matter.Axes` module contains methods for creating and manipulating sets of axes.","name":"axes","type":{"names":["MatterJS.AxesFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#axes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":327,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Bounds` module.\n\nThe `Matter.Bounds` module contains methods for creating and manipulating axis-aligned bounding boxes (AABB).","name":"bounds","type":{"names":["MatterJS.BoundsFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#bounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":338,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Svg` module.\n\nThe `Matter.Svg` module contains methods for converting SVG images into an array of vector points.\n\nTo use this module you also need the SVGPathSeg polyfill: https://github.com/progers/pathseg","name":"svg","type":{"names":["MatterJS.SvgFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#svg","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":351,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Vector` module.\n\nThe `Matter.Vector` module contains methods for creating and manipulating vectors.\nVectors are the basis of all the geometry related operations in the engine.\nA `Matter.Vector` object is of the form `{ x: 0, y: 0 }`.","name":"vector","type":{"names":["MatterJS.VectorFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#vector","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":364,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Vertices` module.\n\nThe `Matter.Vertices` module contains methods for creating and manipulating sets of vertices.\nA set of vertices is an array of `Matter.Vector` with additional indexing properties inserted by `Vertices.create`.\nA `Matter.Body` maintains a set of vertices to represent the shape of the object (its convex hull).","name":"vertices","type":{"names":["MatterJS.VerticesFactory"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#vertices","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":377,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the `Matter.Vertices` module.\n\nThe `Matter.Vertices` module contains methods for creating and manipulating sets of vertices.\nA set of vertices is an array of `Matter.Vector` with additional indexing properties inserted by `Vertices.create`.\nA `Matter.Body` maintains a set of vertices to represent the shape of the object (its convex hull).","name":"verts","type":{"names":["MatterJS.VerticesFactory"]},"since":"3.14.0","memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#verts","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"This internal method is called when this class starts and retrieves the final Matter World Config.","kind":"function","name":"getConfig","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterWorldConfig"]},"description":"The Matter World Config."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#getConfig","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":489,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Enables the Matter Attractors Plugin.\n\nThe attractors plugin that makes it easy to apply continual forces on bodies.\nIt's possible to simulate effects such as wind, gravity and magnetism.\n\nhttps://github.com/liabru/matter-attractors\n\nThis method is called automatically if `plugins.attractors` is set in the Matter World Config.\nHowever, you can also call it directly from within your game.","kind":"function","name":"enableAttractorPlugin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#enableAttractorPlugin","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Enables the Matter Wrap Plugin.\n\nThe coordinate wrapping plugin that automatically wraps the position of bodies such that they always stay\nwithin the given bounds. Upon crossing a boundary the body will appear on the opposite side of the bounds,\nwhile maintaining its velocity.\n\nhttps://github.com/liabru/matter-wrap\n\nThis method is called automatically if `plugins.wrap` is set in the Matter World Config.\nHowever, you can also call it directly from within your game.","kind":"function","name":"enableWrapPlugin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#enableWrapPlugin","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":538,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Enables the Matter Collision Events Plugin.\n\nNote that this plugin is enabled by default. So you should only ever need to call this\nmethod if you have specifically disabled the plugin in your Matter World Config.\nYou can disable it by setting `plugins.collisionevents: false` in your Matter World Config.\n\nThis plugin triggers three new events on Matter.Body:\n\n1. `onCollide`\n2. `onCollideEnd`\n3. `onCollideActive`\n\nThese events correspond to the Matter.js events `collisionStart`, `collisionActive` and `collisionEnd`, respectively.\nYou can listen to these events via Matter.Events or they will also be emitted from the Matter World.\n\nThis plugin also extends Matter.Body with three convenience functions:\n\n`Matter.Body.setOnCollide(callback)`\n`Matter.Body.setOnCollideEnd(callback)`\n`Matter.Body.setOnCollideActive(callback)`\n\nYou can register event callbacks by providing a function of type (pair: Matter.Pair) => void\n\nhttps://github.com/dxu/matter-collision-events","kind":"function","name":"enableCollisionEventsPlugin","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#enableCollisionEventsPlugin","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":577,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Pauses the Matter World instance and sets `enabled` to `false`.\n\nA paused world will not run any simulations for the duration it is paused.","kind":"function","name":"pause","fires":["Phaser.Physics.Matter.Events#event:PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"The Matter World object."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#pause","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":593,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Resumes this Matter World instance from a paused state and sets `enabled` to `true`.","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"The Matter World object."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#resume","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":606,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the Matter Engine to run at fixed timestep of 60Hz and enables `autoUpdate`.\nIf you have set a custom `getDelta` function then this will override it.","kind":"function","name":"set60Hz","since":"3.4.0","returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#set60Hz","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":623,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the Matter Engine to run at fixed timestep of 30Hz and enables `autoUpdate`.\nIf you have set a custom `getDelta` function then this will override it.","kind":"function","name":"set30Hz","since":"3.4.0","returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#set30Hz","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":640,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Manually advances the physics simulation by one iteration.\n\nYou can optionally pass in the `delta` and `correction` values to be used by Engine.update.\nIf undefined they use the Matter defaults of 60Hz and no correction.\n\nCalling `step` directly bypasses any checks of `enabled` or `autoUpdate`.\n\nIt also ignores any custom `getDelta` functions, as you should be passing the delta\nvalue in to this call.\n\nYou can adjust the number of iterations that Engine.update performs internally.\nUse the Scene Matter Physics config object to set the following properties:\n\npositionIterations (defaults to 6)\nvelocityIterations (defaults to 4)\nconstraintIterations (defaults to 2)\n\nAdjusting these values can help performance in certain situations, depending on the physics requirements\nof your game.","kind":"function","name":"step","since":"3.4.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":16.666,"description":"The delta value.","name":"delta"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Optional delta correction value.","name":"correction"}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#step","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":672,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Checks if the vertices of the given body, or an array of bodies, contains the given point, or not.\n\nYou can pass in either a single body, or an array of bodies to be checked. This method will\nreturn `true` if _any_ of the bodies in the array contain the point. See the `intersectPoint` method if you need\nto get a list of intersecting bodies.\n\nThe point should be transformed into the Matter World coordinate system in advance. This happens by\ndefault with Input Pointers, but if you wish to use points from another system you may need to\ntransform them before passing them.","kind":"function","name":"containsPoint","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"The body, or an array of bodies, to check against the point.","name":"body"},{"type":{"names":["number"]},"description":"The horizontal coordinate of the point.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the point.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the point is within one of the bodies given, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#containsPoint","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":703,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Checks the given coordinates to see if any vertices of the given bodies contain it.\n\nIf no bodies are provided it will search all bodies in the Matter World, including within Composites.\n\nThe coordinates should be transformed into the Matter World coordinate system in advance. This happens by\ndefault with Input Pointers, but if you wish to use coordinates from another system you may need to\ntransform them before passing them.","kind":"function","name":"intersectPoint","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the point.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the point.","name":"y"},{"type":{"names":["Array."]},"optional":true,"description":"An array of bodies to check. If not provided it will search all bodies in the world.","name":"bodies"}],"returns":[{"type":{"names":["Array."]},"description":"An array of bodies which contain the given point."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#intersectPoint","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Checks the given rectangular area to see if any vertices of the given bodies intersect with it.\nOr, if the `outside` parameter is set to `true`, it checks to see which bodies do not\nintersect with it.\n\nIf no bodies are provided it will search all bodies in the Matter World, including within Composites.","kind":"function","name":"intersectRect","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the top-left of the area.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate of the top-left of the area.","name":"y"},{"type":{"names":["number"]},"description":"The width of the area.","name":"width"},{"type":{"names":["number"]},"description":"The height of the area.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `false` it checks for vertices inside the area, if `true` it checks for vertices outside the area.","name":"outside"},{"type":{"names":["Array."]},"optional":true,"description":"An array of bodies to check. If not provided it will search all bodies in the world.","name":"bodies"}],"returns":[{"type":{"names":["Array."]},"description":"An array of bodies that intersect with the given area."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#intersectRect","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":787,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Checks the given ray segment to see if any vertices of the given bodies intersect with it.\n\nIf no bodies are provided it will search all bodies in the Matter World.\n\nThe width of the ray can be specified via the `rayWidth` parameter.","kind":"function","name":"intersectRay","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate of the start of the ray segment.","name":"x1"},{"type":{"names":["number"]},"description":"The vertical coordinate of the start of the ray segment.","name":"y1"},{"type":{"names":["number"]},"description":"The horizontal coordinate of the end of the ray segment.","name":"x2"},{"type":{"names":["number"]},"description":"The vertical coordinate of the end of the ray segment.","name":"y2"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The width of the ray segment.","name":"rayWidth"},{"type":{"names":["Array."]},"optional":true,"description":"An array of bodies to check. If not provided it will search all bodies in the world.","name":"bodies"}],"returns":[{"type":{"names":["Array."]},"description":"An array of bodies whos vertices intersect with the ray segment."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#intersectRay","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":823,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Checks the given Matter Body to see if it intersects with any of the given bodies.\n\nIf no bodies are provided it will check against all bodies in the Matter World.","kind":"function","name":"intersectBody","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The target body.","name":"body"},{"type":{"names":["Array."]},"optional":true,"description":"An array of bodies to check the target body against. If not provided it will search all bodies in the world.","name":"bodies"}],"returns":[{"type":{"names":["Array."]},"description":"An array of bodies whos vertices intersect with target body."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#intersectBody","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":860,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Checks to see if the target body, or an array of target bodies, intersects with any of the given bodies.\n\nIf intersection occurs this method will return `true` and, if provided, invoke the callbacks.\n\nIf no bodies are provided for the second parameter the target will check again all bodies in the Matter World.\n\nNote that bodies can only overlap if they are in non-colliding collision groups or categories.\n\nIf you provide a `processCallback` then the two bodies that overlap are sent to it. This callback\nmust return a boolean and is used to allow you to perform additional processing tests before a final\noutcome is decided. If it returns `true` then the bodies are finally passed to the `overlapCallback`, if set.\n\nIf you provide an `overlapCallback` then the matching pairs of overlapping bodies will be sent to it.\n\nBoth callbacks have the following signature: `function (bodyA, bodyB, collisionInfo)` where `bodyA` is always\nthe target body. The `collisionInfo` object contains additional data, such as the angle and depth of penetration.","kind":"function","name":"overlap","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"The target body, or array of target bodies, to check.","name":"target"},{"type":{"names":["Array."]},"optional":true,"description":"The second body, or array of bodies, to check. If falsey it will check against all bodies in the world.","name":"bodies"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that is called if the bodies overlap.","name":"overlapCallback"},{"type":{"names":["ArcadePhysicsCallback"]},"optional":true,"description":"An optional callback function that lets you perform additional checks against the two bodies if they overlap. If this is set then `overlapCallback` will only be invoked if this callback returns `true`.","name":"processCallback"},{"type":{"names":["*"]},"optional":true,"description":"The context, or scope, in which to run the callbacks.","name":"callbackContext"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the target body intersects with _any_ of the bodies given, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#overlap","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":936,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the collision filter category of all given Matter Bodies to the given value.\n\nThis number must be a power of two between 2^0 (= 1) and 2^31.\n\nBodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\ncategories are included in their collision masks (see {@link #setCollidesWith}).","kind":"function","name":"setCollisionCategory","since":"3.22.0","params":[{"type":{"names":["Array."]},"description":"An array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"Unique category bitfield.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setCollisionCategory","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":964,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the collision filter group of all given Matter Bodies to the given value.\n\nIf the group value is zero, or if two Matter Bodies have different group values,\nthey will collide according to the usual collision filter rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\n\nIf two Matter Bodies have the same positive group value, they will always collide;\nif they have the same negative group value they will never collide.","kind":"function","name":"setCollisionGroup","since":"3.22.0","params":[{"type":{"names":["Array."]},"description":"An array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"Unique group index.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":993,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the collision filter mask of all given Matter Bodies to the given value.\n\nTwo Matter Bodies with different collision groups will only collide if each one includes the others\ncategory in its mask based on a bitwise AND operation: `(categoryA & maskB) !== 0` and \n`(categoryB & maskA) !== 0` are both true.","kind":"function","name":"setCollidesWith","since":"3.22.0","params":[{"type":{"names":["Array."]},"description":"An array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number","Array."]},"description":"A unique category bitfield, or an array of them.","name":"categories"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setCollidesWith","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1034,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Takes an array and returns a new array made from all of the Matter Bodies found in the original array.\n\nFor example, passing in Matter Game Objects, such as a bunch of Matter Sprites, to this method, would\nreturn an array containing all of their native Matter Body objects.\n\nIf the `bodies` argument is falsey, it will return all bodies in the world.","kind":"function","name":"getMatterBodies","since":"3.22.0","params":[{"type":{"names":["array"]},"optional":true,"description":"An array of objects to extract the bodies from. If falsey, it will return all bodies in the world.","name":"bodies"}],"returns":[{"type":{"names":["Array."]},"description":"An array of native Matter Body objects."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#getMatterBodies","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1073,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets both the horizontal and vertical linear velocity of the physics bodies.","kind":"function","name":"setVelocity","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"The horizontal linear velocity value.","name":"x"},{"type":{"names":["number"]},"description":"The vertical linear velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setVelocity","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1102,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets just the horizontal linear velocity of the physics bodies.\nThe vertical velocity of the body is unchanged.","kind":"function","name":"setVelocityX","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"The horizontal linear velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setVelocityX","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets just the vertical linear velocity of the physics bodies.\nThe horizontal velocity of the body is unchanged.","kind":"function","name":"setVelocityY","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"The vertical linear velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setVelocityY","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1160,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the angular velocity of the bodies instantly.\nPosition, angle, force etc. are unchanged.","kind":"function","name":"setAngularVelocity","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"The angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#setAngularVelocity","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Applies a force to a body, at the bodies current position, including resulting torque.","kind":"function","name":"applyForce","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#applyForce","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1212,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Applies a force to a body, from the given world position, including resulting torque.\nIf no angle is given, the current body angle is used.\n\nUse very small speed values, such as 0.1, depending on the mass and required velocity.","kind":"function","name":"applyForceFromPosition","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"A Vector that specifies the world-space position to apply the force at.","name":"position"},{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"},{"type":{"names":["number"]},"optional":true,"description":"The angle, in radians, to apply the force from. Leave undefined to use the current body angle.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#applyForceFromPosition","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1250,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Apply a force to a body based on the given angle and speed.\nIf no angle is given, the current body angle is used.\n\nUse very small speed values, such as 0.1, depending on the mass and required velocity.","kind":"function","name":"applyForceFromAngle","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody","Array."]},"description":"Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.","name":"bodies"},{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"},{"type":{"names":["number"]},"optional":true,"description":"The angle, in radians, to apply the force from. Leave undefined to use the current body angle.","name":"angle"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#applyForceFromAngle","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns the length of the given constraint, which is the distance between the two points.","kind":"function","name":"getConstraintLength","since":"3.22.0","params":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"The constraint to get the length from.","name":"constraint"}],"returns":[{"type":{"names":["number"]},"description":"The length of the constraint."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#getConstraintLength","scope":"instance","___s":true},{"meta":{"filename":"MatterPhysics.js","lineno":1319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Aligns a Body, or Matter Game Object, against the given coordinates.\n\nThe alignment takes place using the body bounds, which take into consideration things\nlike body scale and rotation.\n\nAlthough a Body has a `position` property, it is based on the center of mass for the body,\nnot a dimension based center. This makes aligning bodies difficult, especially if they have\nrotated or scaled. This method will derive the correct position based on the body bounds and\nits center of mass offset, in order to align the body with the given coordinate.\n\nFor example, if you wanted to align a body so it sat in the bottom-center of the\nScene, and the world was 800 x 600 in size:\n\n```javascript\nthis.matter.alignBody(body, 400, 600, Phaser.Display.Align.BOTTOM_CENTER);\n```\n\nYou pass in 400 for the x coordinate, because that is the center of the world, and 600 for\nthe y coordinate, as that is the base of the world.","kind":"function","name":"alignBody","since":"3.22.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBody"]},"description":"The Body to align.","name":"body"},{"type":{"names":["number"]},"description":"The horizontal position to align the body to.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position to align the body to.","name":"y"},{"type":{"names":["integer"]},"description":"One of the `Phaser.Display.Align` constants, such as `Phaser.Display.Align.TOP_LEFT`.","name":"align"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"description":"This Matter Physics instance."}],"memberof":"Phaser.Physics.Matter.MatterPhysics","longname":"Phaser.Physics.Matter.MatterPhysics#alignBody","scope":"instance","___s":true},{"meta":{"range":[180,250],"filename":"MatterSprite.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"AnimationComponent","longname":"AnimationComponent","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MatterSprite.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"A Matter Physics Sprite Game Object.\n\nA Sprite Game Object is used for the display of both static and animated images in your game.\nSprites can have input events and physics bodies. They can also be tweened, tinted, scrolled\nand animated.\n\nThe main difference between a Sprite and an Image Game Object is that you cannot animate Images.\nAs such, Sprites take a fraction longer to process and have a larger API footprint due to the Animation\nComponent. If you do not require animation then you can safely use Images to replace Sprites in all cases.","kind":"class","name":"Sprite","augments":["Phaser.GameObjects.Sprite","Phaser.Physics.Matter.Components.Bounce","Phaser.Physics.Matter.Components.Collision","Phaser.Physics.Matter.Components.Force","Phaser.Physics.Matter.Components.Friction","Phaser.Physics.Matter.Components.Gravity","Phaser.Physics.Matter.Components.Mass","Phaser.Physics.Matter.Components.Sensor","Phaser.Physics.Matter.Components.SetBody","Phaser.Physics.Matter.Components.Sleep","Phaser.Physics.Matter.Components.Static","Phaser.Physics.Matter.Components.Transform","Phaser.Physics.Matter.Components.Velocity","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Size","Phaser.GameObjects.Components.Texture","Phaser.GameObjects.Components.Tint","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Physics.Matter","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"A reference to the Matter.World instance that this body belongs to.","name":"world"},{"type":{"names":["number"]},"description":"The horizontal position of this Game Object in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of this Game Object in the world.","name":"y"},{"type":{"names":["string"]},"description":"The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.","name":"texture"},{"type":{"names":["string","integer"]},"optional":true,"description":"An optional frame from the Texture this Game Object is rendering with.","name":"frame"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"scope":"static","longname":"Phaser.Physics.Matter.Sprite","___s":true},{"meta":{"filename":"MatterSprite.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Matter.World instance that this body belongs to.","name":"world","type":{"names":["Phaser.Physics.Matter.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#world","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,220],"filename":"MatterTileBody.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Bodies","longname":"Bodies","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"A wrapper around a Tile that provides access to a corresponding Matter body. A tile can only\nhave one Matter body associated with it. You can either pass in an existing Matter body for\nthe tile or allow the constructor to create the corresponding body for you. If the Tile has a\ncollision group (defined in Tiled), those shapes will be used to create the body. If not, the\ntile's rectangle bounding box will be used.\n\nThe corresponding body will be accessible on the Tile itself via Tile.physics.matterBody.\n\nNote: not all Tiled collision shapes are supported. See\nPhaser.Physics.Matter.TileBody#setFromTileCollision for more information.","kind":"class","name":"TileBody","memberof":"Phaser.Physics.Matter","since":"3.0.0","augments":["Phaser.Physics.Matter.Components.Bounce","Phaser.Physics.Matter.Components.Collision","Phaser.Physics.Matter.Components.Friction","Phaser.Physics.Matter.Components.Gravity","Phaser.Physics.Matter.Components.Mass","Phaser.Physics.Matter.Components.Sensor","Phaser.Physics.Matter.Components.Sleep","Phaser.Physics.Matter.Components.Static"],"params":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"The Matter world instance this body belongs to.","name":"world"},{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The target tile that should have a Matter body.","name":"tile"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterTileOptions"]},"optional":true,"description":"Options to be used when creating the Matter body.","name":"options"}],"scope":"static","longname":"Phaser.Physics.Matter.TileBody","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":63,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The tile object the body is associated with.","name":"tile","type":{"names":["Phaser.Tilemaps.Tile"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#tile","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Matter world the body exists within.","name":"world","type":{"names":["Phaser.Physics.Matter.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":116,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the current body to a rectangle that matches the bounds of the tile.","kind":"function","name":"setFromTileRectangle","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyTileOptions"]},"optional":true,"description":"Options to be used when creating the Matter body. See MatterJS.Body for a list of what Matter accepts.","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This TileBody object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setFromTileRectangle","scope":"instance","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":142,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the current body from the collision group associated with the Tile. This is typically\nset up in Tiled's collision editor.\n\nNote: Matter doesn't support all shapes from Tiled. Rectangles and polygons are directly\nsupported. Ellipses are converted into circle bodies. Polylines are treated as if they are\nclosed polygons. If a tile has multiple shapes, a multi-part body will be created. Concave\nshapes are supported if poly-decomp library is included. Decomposition is not guaranteed to\nwork for complex shapes (e.g. holes), so it's often best to manually decompose a concave\npolygon into multiple convex polygons yourself.","kind":"function","name":"setFromTileCollision","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyTileOptions"]},"optional":true,"description":"Options to be used when creating the Matter body. See MatterJS.Body for a list of what Matter accepts.","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This TileBody object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setFromTileCollision","scope":"instance","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":239,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the current body to the given body. This will remove the previous body, if one already\nexists.","kind":"function","name":"setBody","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The new Matter body to use.","name":"body"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to add the body to the Matter world.","name":"addToWorld"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This TileBody object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setBody","scope":"instance","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":271,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Removes the current body from the TileBody and from the Matter world","kind":"function","name":"removeBody","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This TileBody object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#removeBody","scope":"instance","___s":true},{"meta":{"filename":"MatterTileBody.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Removes the current body from the tile and the world.","kind":"function","name":"destroy","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This TileBody object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#destroy","scope":"instance","___s":true},{"meta":{"range":[274,314],"filename":"PhysicsEditorParser.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Bodies","longname":"Bodies","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PhysicsEditorParser.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Use PhysicsEditorParser.parseBody() to build a Matter body object, based on a physics data file\ncreated and exported with PhysicsEditor (https://www.codeandweb.com/physicseditor).","kind":"namespace","name":"PhysicsEditorParser","since":"3.10.0","memberof":"Phaser.Physics.Matter","longname":"Phaser.Physics.Matter.PhysicsEditorParser","scope":"static","___s":true},{"meta":{"filename":"PhysicsEditorParser.js","lineno":24,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Parses a body element exported by PhysicsEditor.","kind":"function","name":"parseBody","since":"3.10.0","params":[{"type":{"names":["number"]},"description":"The horizontal world location of the body.","name":"x"},{"type":{"names":["number"]},"description":"The vertical world location of the body.","name":"y"},{"type":{"names":["object"]},"description":"The body configuration and fixture (child body) definitions, as exported by PhysicsEditor.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A compound Matter JS Body."}],"memberof":"Phaser.Physics.Matter.PhysicsEditorParser","longname":"Phaser.Physics.Matter.PhysicsEditorParser.parseBody","scope":"static","___s":true},{"meta":{"filename":"PhysicsEditorParser.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Parses an element of the \"fixtures\" list exported by PhysicsEditor","kind":"function","name":"parseFixture","since":"3.10.0","params":[{"type":{"names":["object"]},"description":"The fixture object to parse.","name":"fixtureConfig"}],"returns":[{"type":{"names":["Array."]},"description":"- An array of Matter JS Bodies."}],"memberof":"Phaser.Physics.Matter.PhysicsEditorParser","longname":"Phaser.Physics.Matter.PhysicsEditorParser.parseFixture","scope":"static","___s":true},{"meta":{"filename":"PhysicsEditorParser.js","lineno":104,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Parses the \"vertices\" lists exported by PhysicsEditor.","kind":"function","name":"parseVertices","since":"3.10.0","params":[{"type":{"names":["array"]},"description":"The vertex lists to parse.","name":"vertexSets"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Array."]},"description":"- An array of Matter JS Bodies."}],"memberof":"Phaser.Physics.Matter.PhysicsEditorParser","longname":"Phaser.Physics.Matter.PhysicsEditorParser.parseVertices","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"PhysicsJSONParser.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Bodies","longname":"Bodies","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PhysicsJSONParser.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a body using the supplied physics data, as provided by a JSON file.\n\nThe data file should be loaded as JSON:\n\n```javascript\npreload ()\n{\n this.load.json('ninjas', 'assets/ninjas.json);\n}\n\ncreate ()\n{\n const ninjaShapes = this.cache.json.get('ninjas');\n\n this.matter.add.fromJSON(400, 300, ninjaShapes.shinobi);\n}\n```\n\nDo not pass the entire JSON file to this method, but instead pass one of the shapes contained within it.\n\nIf you pas in an `options` object, any settings in there will override those in the config object.\n\nThe structure of the JSON file is as follows:\n\n```text\n{\n 'generator_info': // The name of the application that created the JSON data\n 'shapeName': {\n 'type': // The type of body\n 'label': // Optional body label\n 'vertices': // An array, or an array of arrays, containing the vertex data in x/y object pairs\n }\n}\n```\n\nAt the time of writing, only the Phaser Physics Tracer App exports in this format.","kind":"namespace","name":"PhysicsJSONParser","since":"3.22.0","memberof":"Phaser.Physics.Matter","longname":"Phaser.Physics.Matter.PhysicsJSONParser","scope":"static","___s":true},{"meta":{"filename":"PhysicsJSONParser.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Parses a body element from the given JSON data.","kind":"function","name":"parseBody","since":"3.22.0","params":[{"type":{"names":["number"]},"description":"The horizontal world location of the body.","name":"x"},{"type":{"names":["number"]},"description":"The vertical world location of the body.","name":"y"},{"type":{"names":["object"]},"description":"The body configuration data.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"A Matter JS Body."}],"memberof":"Phaser.Physics.Matter.PhysicsJSONParser","longname":"Phaser.Physics.Matter.PhysicsJSONParser.parseBody","scope":"static","___s":true},{"meta":{"range":[180,221],"filename":"PointerConstraint.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Bounds","longname":"Bounds","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"A Pointer Constraint is a special type of constraint that allows you to click\nand drag bodies in a Matter World. It monitors the active Pointers in a Scene,\nand when one is pressed down it checks to see if that hit any part of any active\nbody in the world. If it did, and the body has input enabled, it will begin to\ndrag it until either released, or you stop it via the `stopDrag` method.\n\nYou can adjust the stiffness, length and other properties of the constraint via\nthe `options` object on creation.","kind":"class","name":"PointerConstraint","memberof":"Phaser.Physics.Matter","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene to which this Pointer Constraint belongs.","name":"scene"},{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"A reference to the Matter World instance to which this Constraint belongs.","name":"world"},{"type":{"names":["object"]},"optional":true,"description":"A Constraint configuration object.","name":"options"}],"scope":"static","longname":"Phaser.Physics.Matter.PointerConstraint","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Scene to which this Pointer Constraint belongs.\nThis is the same Scene as the Matter World instance.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Matter World instance to which this Constraint belongs.","name":"world","type":{"names":["Phaser.Physics.Matter.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#world","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Camera the Pointer was interacting with when the input\ndown event was processed.","name":"camera","type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#camera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A reference to the Input Pointer that activated this Constraint.\nThis is set in the `onDown` handler.","name":"pointer","type":{"names":["Phaser.Input.Pointer"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#pointer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Is this Constraint active or not?\n\nAn active constraint will be processed each update. An inactive one will be skipped.\nUse this to toggle a Pointer Constraint on and off.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The internal transformed position.","name":"position","type":{"names":["Phaser.Math.Vector2"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#position","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The body that is currently being dragged, if any.","name":"body","type":{"names":["MatterJS.BodyType"]},"nullable":true,"since":"3.16.2","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#body","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":133,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The part of the body that was clicked on to start the drag.","name":"part","type":{"names":["MatterJS.BodyType"]},"nullable":true,"since":"3.16.2","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#part","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The native Matter Constraint that is used to attach to bodies.","name":"constraint","type":{"names":["MatterJS.ConstraintType"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#constraint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A Pointer has been pressed down onto the Scene.\n\nIf this Constraint doesn't have an active Pointer then a hit test is set to\nrun against all active bodies in the world during the _next_ call to `update`.\nIf a body is found, it is bound to this constraint and the drag begins.","kind":"function","name":"onDown","since":"3.0.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"A reference to the Pointer that was pressed.","name":"pointer"}],"memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#onDown","scope":"instance","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A Pointer has been released from the Scene. If it was the one this constraint was using, it's cleared.","kind":"function","name":"onUp","since":"3.22.0","params":[{"type":{"names":["Phaser.Input.Pointer"]},"description":"A reference to the Pointer that was pressed.","name":"pointer"}],"memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#onUp","scope":"instance","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":194,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Scans all active bodies in the current Matter World to see if any of them\nare hit by the Pointer. The _first one_ found to hit is set as the active contraint\nbody.","kind":"function","name":"getBody","fires":["Phaser.Physics.Matter.Events#event:DRAG_START"],"since":"3.16.2","returns":[{"type":{"names":["boolean"]},"description":"`true` if a body was found and set, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#getBody","scope":"instance","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":234,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Scans the current body to determine if a part of it was clicked on.\nIf a part is found the body is set as the `constraint.bodyB` property,\nas well as the `body` property of this class. The part is also set.","kind":"function","name":"hitTestBody","since":"3.16.2","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Matter Body to check.","name":"body"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"A translated hit test position.","name":"position"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if a part of the body was hit, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#hitTestBody","scope":"instance","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Internal update handler. Called in the Matter BEFORE_UPDATE step.","kind":"function","name":"update","fires":["Phaser.Physics.Matter.Events#event:DRAG"],"since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#update","scope":"instance","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Stops the Pointer Constraint from dragging the body any further.\n\nThis is called automatically if the Pointer is released while actively\ndragging a body. Or, you can call it manually to release a body from a\nconstraint without having to first release the pointer.","kind":"function","name":"stopDrag","fires":["Phaser.Physics.Matter.Events#event:DRAG_END"],"since":"3.16.2","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#stopDrag","scope":"instance","___s":true},{"meta":{"filename":"PointerConstraint.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Destroys this Pointer Constraint instance and all of its references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Matter.PointerConstraint","longname":"Phaser.Physics.Matter.PointerConstraint#destroy","scope":"instance","___s":true},{"meta":{"range":[180,220],"filename":"World.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"name":"Bodies","longname":"Bodies","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"World.js","lineno":23,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"classdesc":"The Matter World class is responsible for managing one single instance of a Matter Physics World for Phaser.\n\nAccess this via `this.matter.world` from within a Scene.\n\nThis class creates a Matter JS World Composite along with the Matter JS Engine during instantiation. It also\nhandles delta timing, bounds, body and constraint creation and debug drawing.\n\nIf you wish to access the Matter JS World object directly, see the `localWorld` property.\nIf you wish to access the Matter Engine directly, see the `engine` property.\n\nThis class is an Event Emitter and will proxy _all_ Matter JS events, as they are received.","kind":"class","name":"World","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Physics.Matter","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Matter World instance belongs.","name":"scene"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterWorldConfig"]},"description":"The Matter World configuration object.","name":"config"}],"scope":"static","longname":"Phaser.Physics.Matter.World","___s":true},{"meta":{"filename":"World.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Scene to which this Matter World instance belongs.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"An instance of the MatterJS Engine.","name":"engine","type":{"names":["MatterJS.Engine"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#engine","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A `World` composite object that will contain all simulated bodies and constraints.","name":"localWorld","type":{"names":["MatterJS.World"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#localWorld","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"An object containing the 4 wall bodies that bound the physics world.","name":"walls","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#walls","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A flag that toggles if the world is enabled or not.","name":"enabled","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#enabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":113,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The correction argument is an optional Number that specifies the time correction factor to apply to the update.\nThis can help improve the accuracy of the simulation in cases where delta is changing between updates.\nThe value of correction is defined as delta / lastDelta, i.e. the percentage change of delta over the last step.\nTherefore the value is always 1 (no correction) when delta is constant (or when no correction is desired, which is the default).\nSee the paper on Time Corrected Verlet for more information.","name":"correction","type":{"names":["number"]},"defaultvalue":"1","since":"3.4.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#correction","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"This function is called every time the core game loop steps, which is bound to the\nRequest Animation Frame frequency unless otherwise modified.\n\nThe function is passed two values: `time` and `delta`, both of which come from the game step values.\n\nIt must return a number. This number is used as the delta value passed to Matter.Engine.update.\n\nYou can override this function with your own to define your own timestep.\n\nIf you need to update the Engine multiple times in a single game step then call\n`World.update` as many times as required. Each call will trigger the `getDelta` function.\nIf you wish to have full control over when the Engine updates then see the property `autoUpdate`.\n\nYou can also adjust the number of iterations that Engine.update performs.\nUse the Scene Matter Physics config object to set the following properties:\n\npositionIterations (defaults to 6)\nvelocityIterations (defaults to 4)\nconstraintIterations (defaults to 2)\n\nAdjusting these values can help performance in certain situations, depending on the physics requirements\nof your game.","name":"getDelta","type":{"names":["function"]},"since":"3.4.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#getDelta","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":172,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The Matter JS Runner Configuration object.\n\nThis object is populated via the Matter Configuration object's `runner` property and is\nupdated constantly during the game step.","name":"runner","type":{"names":["Phaser.Types.Physics.Matter.MatterRunnerConfig"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#runner","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":198,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Automatically call Engine.update every time the game steps.\nIf you disable this then you are responsible for calling `World.step` directly from your game.\nIf you call `set60Hz` or `set30Hz` then `autoUpdate` is reset to `true`.","name":"autoUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.4.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#autoUpdate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":212,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"A flag that controls if the debug graphics will be drawn to or not.","name":"drawDebug","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#drawDebug","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":222,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"An instance of the Graphics object the debug bodies are drawn to, if enabled.","name":"debugGraphic","type":{"names":["Phaser.GameObjects.Graphics"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#debugGraphic","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":231,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The debug configuration object.\n\nThe values stored in this object are read from the Matter World Config `debug` property.\n\nWhen a new Body or Constraint is _added to the World_, they are given the values stored in this object,\nunless they have their own `render` object set that will override them.\n\nNote that while you can modify the values of properties in this object at run-time, it will not change\nany of the Matter objects _already added_. It will only impact objects newly added to the world, or one\nthat is removed and then re-added at a later time.","name":"debugConfig","type":{"names":["Phaser.Types.Physics.Matter.MatterDebugConfig"]},"since":"3.22.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#debugConfig","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"World.js","lineno":347,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the debug render style for the children of the given Matter Composite.\n\nComposites themselves do not render, but they can contain bodies, constraints and other composites that may do.\nSo the children of this composite are passed to the `setBodyRenderStyle`, `setCompositeRenderStyle` and\n`setConstraintRenderStyle` methods accordingly.","kind":"function","name":"setCompositeRenderStyle","since":"3.22.0","params":[{"type":{"names":["MatterJS.CompositeType"]},"description":"The Matter Composite to set the render style on.","name":"composite"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#setCompositeRenderStyle","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":397,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the debug render style for the given Matter Body.\n\nIf you are using this on a Phaser Game Object, such as a Matter Sprite, then pass in the body property\nto this method, not the Game Object itself.\n\nIf you wish to skip a parameter, so it retains its current value, pass `false` for it.\n\nIf you wish to reset the Body render colors to the defaults found in the World Debug Config, then call\nthis method with just the `body` parameter provided and no others.","kind":"function","name":"setBodyRenderStyle","since":"3.22.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Matter Body to set the render style on.","name":"body"},{"type":{"names":["number"]},"optional":true,"description":"The line color. If `null` it will use the World Debug Config value.","name":"lineColor"},{"type":{"names":["number"]},"optional":true,"description":"The line opacity, between 0 and 1. If `null` it will use the World Debug Config value.","name":"lineOpacity"},{"type":{"names":["number"]},"optional":true,"description":"The line thickness. If `null` it will use the World Debug Config value.","name":"lineThickness"},{"type":{"names":["number"]},"optional":true,"description":"The fill color. If `null` it will use the World Debug Config value.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The fill opacity, between 0 and 1. If `null` it will use the World Debug Config value.","name":"fillOpacity"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#setBodyRenderStyle","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the debug render style for the given Matter Constraint.\n\nIf you are using this on a Phaser Game Object, then pass in the body property\nto this method, not the Game Object itself.\n\nIf you wish to skip a parameter, so it retains its current value, pass `false` for it.\n\nIf you wish to reset the Constraint render colors to the defaults found in the World Debug Config, then call\nthis method with just the `constraint` parameter provided and no others.","kind":"function","name":"setConstraintRenderStyle","since":"3.22.0","params":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"The Matter Constraint to set the render style on.","name":"constraint"},{"type":{"names":["number"]},"optional":true,"description":"The line color. If `null` it will use the World Debug Config value.","name":"lineColor"},{"type":{"names":["number"]},"optional":true,"description":"The line opacity, between 0 and 1. If `null` it will use the World Debug Config value.","name":"lineOpacity"},{"type":{"names":["number"]},"optional":true,"description":"The line thickness. If `null` it will use the World Debug Config value.","name":"lineThickness"},{"type":{"names":["number"]},"optional":true,"description":"If this constraint is a pin, this sets the size of the pin circle. If `null` it will use the World Debug Config value.","name":"pinSize"},{"type":{"names":["number"]},"optional":true,"description":"The color used when rendering this constraints anchors. If `null` it will use the World Debug Config value.","name":"anchorColor"},{"type":{"names":["number"]},"optional":true,"description":"The size of the anchor circle, if this constraint has anchors. If `null` it will use the World Debug Config value.","name":"anchorSize"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#setConstraintRenderStyle","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":594,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"This internal method acts as a proxy between all of the Matter JS events and then re-emits them\nvia this class.","kind":"function","name":"setEventsProxy","since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#setEventsProxy","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the bounds of the Physics world to match the given world pixel dimensions.\nYou can optionally set which 'walls' to create: left, right, top or bottom.\nIf none of the walls are given it will default to use the walls settings it had previously.\nI.e. if you previously told it to not have the left or right walls, and you then adjust the world size\nthe newly created bounds will also not have the left and right walls.\nExplicitly state them in the parameters to override this.","kind":"function","name":"setBounds","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the top-left corner of the bounds.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the top-left corner of the bounds.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the bounds.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the bounds.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The thickness of each wall, in pixels.","name":"thickness"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the left bounds wall.","name":"left"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the right bounds wall.","name":"right"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the top bounds wall.","name":"top"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true will create the bottom bounds wall.","name":"bottom"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#setBounds","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":760,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Updates the 4 rectangle bodies that were created, if `setBounds` was set in the Matter config, to use\nthe new positions and sizes. This method is usually only called internally via the `setBounds` method.","kind":"function","name":"updateWall","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` if the walls are being added or updated, `false` to remove them from the world.","name":"add"},{"type":{"names":["string"]},"optional":true,"description":"Either `left`, `right`, `top` or `bottom`. Only optional if `add` is `false`.","name":"position"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position to place the walls at. Only optional if `add` is `false`.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position to place the walls at. Only optional if `add` is `false`.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the walls, in pixels. Only optional if `add` is `false`.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the walls, in pixels. Only optional if `add` is `false`.","name":"height"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#updateWall","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":802,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a Phaser.GameObjects.Graphics object that is used to render all of the debug bodies and joints to.\n\nThis method is called automatically by the constructor, if debugging has been enabled.\n\nThe created Graphics object is automatically added to the Scene at 0x0 and given a depth of `Number.MAX_VALUE`,\nso it renders above all else in the Scene.\n\nThe Graphics object is assigned to the `debugGraphic` property of this class and `drawDebug` is enabled.","kind":"function","name":"createDebugGraphic","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The newly created Graphics object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#createDebugGraphic","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":830,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the world gravity and gravity scale to 0.","kind":"function","name":"disableGravity","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#disableGravity","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":847,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Sets the worlds gravity to the values given.\n\nGravity effects all bodies in the world, unless they have the `ignoreGravity` flag set.","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world gravity x component.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The world gravity y component.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.001,"description":"The gravity scale factor.","name":"scale"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#setGravity","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":877,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Creates a rectangle Matter body and adds it to the world.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal position of the body in the world.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position of the body in the world.","name":"y"},{"type":{"names":["number"]},"description":"The width of the body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the body.","name":"height"},{"type":{"names":["object"]},"description":"Optional Matter configuration object.","name":"options"}],"returns":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Matter.js body that was created."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#create","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":900,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Adds a Matter JS object, or array of objects, to the world.\n\nThe objects should be valid Matter JS entities, such as a Body, Composite or Constraint.\n\nTriggers `beforeAdd` and `afterAdd` events.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["object","Array."]},"description":"Can be single object, or an array, and can be a body, composite or constraint.","name":"object"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#add","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":921,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Removes a Matter JS object, or array of objects, from the world.\n\nThe objects should be valid Matter JS entities, such as a Body, Composite or Constraint.\n\nTriggers `beforeRemove` and `afterRemove` events.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["object","Array."]},"description":"Can be single object, or an array, and can be a body, composite or constraint.","name":"object"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally search the objects children and recursively remove those as well.","name":"deep"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#remove","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":955,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Removes a Matter JS constraint, or array of constraints, from the world.\n\nTriggers `beforeRemove` and `afterRemove` events.","kind":"function","name":"removeConstraint","since":"3.0.0","params":[{"type":{"names":["MatterJS.ConstraintType","Array."]},"description":"A Matter JS Constraint, or an array of constraints, to be removed.","name":"constraint"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally search the objects children and recursively remove those as well.","name":"deep"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#removeConstraint","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":975,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Adds `MatterTileBody` instances for all the colliding tiles within the given tilemap layer.\n\nSet the appropriate tiles in your layer to collide before calling this method!","kind":"function","name":"convertTilemapLayer","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"description":"An array of tiles.","name":"tilemapLayer"},{"type":{"names":["object"]},"optional":true,"description":"Options to be passed to the MatterTileBody constructor. {@see Phaser.Physics.Matter.TileBody}","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#convertTilemapLayer","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":999,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Adds `MatterTileBody` instances for the given tiles. This adds bodies regardless of whether the\ntiles are set to collide or not.","kind":"function","name":"convertTiles","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of tiles.","name":"tiles"},{"type":{"names":["object"]},"optional":true,"description":"Options to be passed to the MatterTileBody constructor. {@see Phaser.Physics.Matter.TileBody}","name":"options"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#convertTiles","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1026,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns the next unique group index for which bodies will collide.\nIf `isNonColliding` is `true`, returns the next unique group index for which bodies will not collide.","kind":"function","name":"nextGroup","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true`, returns the next unique group index for which bodies will _not_ collide.","name":"isNonColliding"}],"returns":[{"type":{"names":["number"]},"description":"Unique category bitfield"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#nextGroup","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1042,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns the next unique category bitfield (starting after the initial default category 0x0001).\nThere are 32 available.","kind":"function","name":"nextCategory","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"Unique category bitfield"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#nextCategory","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1056,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Pauses this Matter World instance and sets `enabled` to `false`.\n\nA paused world will not run any simulations for the duration it is paused.","kind":"function","name":"pause","fires":["Phaser.Physics.Matter.Events#event:PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#pause","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1076,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Resumes this Matter World instance from a paused state and sets `enabled` to `true`.","kind":"function","name":"resume","fires":["Phaser.Physics.Matter.Events#event:RESUME"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World object."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#resume","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1094,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"The internal update method. This is called automatically by the parent Scene.\n\nMoves the simulation forward in time by delta ms. Uses `World.correction` value as an optional number that\nspecifies the time correction factor to apply to the update. This can help improve the accuracy of the\nsimulation in cases where delta is changing between updates. The value of correction is defined as `delta / lastDelta`,\ni.e. the percentage change of delta over the last step. Therefore the value is always 1 (no correction) when\ndelta is constant (or when no correction is desired, which is the default).\nSee the paper on Time Corrected Verlet for more information.\n\nTriggers `beforeUpdate` and `afterUpdate` events. Triggers `collisionStart`, `collisionActive` and `collisionEnd` events.\n\nIf the World is paused, `update` is still run, but exits early and does not update the Matter Engine.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#update","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Manually advances the physics simulation by one iteration.\n\nYou can optionally pass in the `delta` and `correction` values to be used by Engine.update.\nIf undefined they use the Matter defaults of 60Hz and no correction.\n\nCalling `step` directly bypasses any checks of `enabled` or `autoUpdate`.\n\nIt also ignores any custom `getDelta` functions, as you should be passing the delta\nvalue in to this call.\n\nYou can adjust the number of iterations that Engine.update performs internally.\nUse the Scene Matter Physics config object to set the following properties:\n\npositionIterations (defaults to 6)\nvelocityIterations (defaults to 4)\nconstraintIterations (defaults to 2)\n\nAdjusting these values can help performance in certain situations, depending on the physics requirements\nof your game.","kind":"function","name":"step","since":"3.4.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":16.666,"description":"The delta value.","name":"delta"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Optional delta correction value.","name":"correction"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#step","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Runs the Matter Engine.update at a fixed timestep of 60Hz.","kind":"function","name":"update60Hz","since":"3.4.0","returns":[{"type":{"names":["number"]},"description":"The delta value to be passed to Engine.update."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#update60Hz","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1226,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Runs the Matter Engine.update at a fixed timestep of 30Hz.","kind":"function","name":"update30Hz","since":"3.4.0","returns":[{"type":{"names":["number"]},"description":"The delta value to be passed to Engine.update."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#update30Hz","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1239,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns `true` if the given body can be found within the World.","kind":"function","name":"has","since":"3.22.0","params":[{"type":{"names":["MatterJS.Body","Phaser.GameObjects.GameObject"]},"description":"The Matter Body, or Game Object, to search for within the world.","name":"body"}],"returns":[{"type":{"names":["Array."]},"description":"An array of all the Matter JS Bodies in this World."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#has","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns all the bodies in the Matter World, including all bodies in children, recursively.","kind":"function","name":"getAllBodies","since":"3.22.0","returns":[{"type":{"names":["Array."]},"description":"An array of all the Matter JS Bodies in this World."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#getAllBodies","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns all the constraints in the Matter World, including all constraints in children, recursively.","kind":"function","name":"getAllConstraints","since":"3.22.0","returns":[{"type":{"names":["Array."]},"description":"An array of all the Matter JS Constraints in this World."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#getAllConstraints","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1282,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Returns all the composites in the Matter World, including all composites in children, recursively.","kind":"function","name":"getAllComposites","since":"3.22.0","returns":[{"type":{"names":["Array."]},"description":"An array of all the Matter JS Composites in this World."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#getAllComposites","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1360,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders the Engine Broadphase Controller Grid to the given Graphics instance.\n\nThe debug renderer calls this method if the `showBroadphase` config value is set.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render the Grid to your own Graphics instance.","kind":"function","name":"renderGrid","since":"3.22.0","params":[{"type":{"names":["MatterJS.Grid"]},"description":"The Matter Grid to be rendered.","name":"grid"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"},{"type":{"names":["number"]},"description":"The line opacity, between 0 and 1.","name":"lineOpacity"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderGrid","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1406,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders the list of Pair separations to the given Graphics instance.\n\nThe debug renderer calls this method if the `showSeparations` config value is set.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render the Grid to your own Graphics instance.","kind":"function","name":"renderSeparations","since":"3.22.0","params":[{"type":{"names":["Array."]},"description":"An array of Matter Pairs to be rendered.","name":"pairs"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderSeparations","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1475,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders the list of collision points and normals to the given Graphics instance.\n\nThe debug renderer calls this method if the `showCollisions` config value is set.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render the Grid to your own Graphics instance.","kind":"function","name":"renderCollisions","since":"3.22.0","params":[{"type":{"names":["Array."]},"description":"An array of Matter Pairs to be rendered.","name":"pairs"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderCollisions","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1569,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders the bounds of an array of Bodies to the given Graphics instance.\n\nIf the body is a compound body, it will render the bounds for the parent compound.\n\nThe debug renderer calls this method if the `showBounds` config value is set.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render bounds to your own Graphics instance.","kind":"function","name":"renderBodyBounds","since":"3.22.0","params":[{"type":{"names":["array"]},"description":"An array of bodies from the localWorld.","name":"bodies"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"},{"type":{"names":["number"]},"description":"The line opacity, between 0 and 1.","name":"lineOpacity"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderBodyBounds","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1633,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders either all axes, or a single axis indicator, for an array of Bodies, to the given Graphics instance.\n\nThe debug renderer calls this method if the `showAxes` or `showAngleIndicator` config values are set.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render bounds to your own Graphics instance.","kind":"function","name":"renderBodyAxes","since":"3.22.0","params":[{"type":{"names":["array"]},"description":"An array of bodies from the localWorld.","name":"bodies"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["boolean"]},"description":"If `true` it will render all body axes. If `false` it will render a single axis indicator.","name":"showAxes"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"},{"type":{"names":["number"]},"description":"The line opacity, between 0 and 1.","name":"lineOpacity"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderBodyAxes","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1710,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders a velocity indicator for an array of Bodies, to the given Graphics instance.\n\nThe debug renderer calls this method if the `showVelocity` config value is set.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render bounds to your own Graphics instance.","kind":"function","name":"renderBodyVelocity","since":"3.22.0","params":[{"type":{"names":["array"]},"description":"An array of bodies from the localWorld.","name":"bodies"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"},{"type":{"names":["number"]},"description":"The line opacity, between 0 and 1.","name":"lineOpacity"},{"type":{"names":["number"]},"description":"The line thickness.","name":"lineThickness"}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderBodyVelocity","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1842,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders a single Matter Body to the given Phaser Graphics Game Object.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render a Body to your own Graphics instance.\n\nIf you don't wish to render a line around the body, set the `lineColor` parameter to `null`.\nEqually, if you don't wish to render a fill, set the `fillColor` parameter to `null`.","kind":"function","name":"renderBody","since":"3.22.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Matter Body to be rendered.","name":"body"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["boolean"]},"description":"Render internal edges of the polygon?","name":"showInternalEdges"},{"type":{"names":["number"]},"optional":true,"description":"The line color.","name":"lineColor"},{"type":{"names":["number"]},"optional":true,"description":"The line opacity, between 0 and 1.","name":"lineOpacity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The line thickness.","name":"lineThickness"},{"type":{"names":["number"]},"optional":true,"description":"The fill color.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The fill opacity, between 0 and 1.","name":"fillOpacity"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderBody","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":1982,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders the Convex Hull for a single Matter Body to the given Phaser Graphics Game Object.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render a Body hull to your own Graphics instance.","kind":"function","name":"renderConvexHull","since":"3.22.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Matter Body to be rendered.","name":"body"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The color used to render the hull.","name":"hullColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The hull line thickness.","name":"lineThickness"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderConvexHull","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2060,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Renders a single Matter Constraint, such as a Pin or a Spring, to the given Phaser Graphics Game Object.\n\nThis method is used internally by the Matter Debug Renderer, but is also exposed publically should\nyou wish to render a Constraint to your own Graphics instance.","kind":"function","name":"renderConstraint","since":"3.22.0","params":[{"type":{"names":["MatterJS.ConstraintType"]},"description":"The Matter Constraint to render.","name":"constraint"},{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to render to.","name":"graphics"},{"type":{"names":["number"]},"description":"The line color.","name":"lineColor"},{"type":{"names":["number"]},"description":"The line opacity, between 0 and 1.","name":"lineOpacity"},{"type":{"names":["number"]},"description":"The line thickness.","name":"lineThickness"},{"type":{"names":["number"]},"description":"If this constraint is a pin, this sets the size of the pin circle.","name":"pinSize"},{"type":{"names":["number"]},"description":"The color used when rendering this constraints anchors. Set to `null` to not render anchors.","name":"anchorColor"},{"type":{"names":["number"]},"description":"The size of the anchor circle, if this constraint has anchors and is rendering them.","name":"anchorSize"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"This Matter World instance for method chaining."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#renderConstraint","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2156,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Resets the internal collision IDs that Matter.JS uses for Body collision groups.\n\nYou should call this before destroying your game if you need to restart the game\nagain on the same page, without first reloading the page. Or, if you wish to\nconsistently destroy a Scene that contains Matter.js and then run it again\nlater in the same game.","kind":"function","name":"resetCollisionIDs","since":"3.17.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#resetCollisionIDs","scope":"instance","___s":true},{"meta":{"filename":"World.js","lineno":2176,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Will remove all Matter physics event listeners and clear the matter physics world,\nengine and any debug graphics, if any.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#shutdown","scope":"instance","overrides":"Phaser.Events.EventEmitter#shutdown","___s":true},{"meta":{"filename":"World.js","lineno":2199,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"description":"Will remove all Matter physics event listeners and clear the matter physics world,\nengine and any debug graphics, if any.\n\nAfter destroying the world it cannot be re-used again.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"Bounce.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A component to set restitution on objects.","kind":"namespace","name":"Bounce","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Bounce","scope":"static","___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the restitution on the physics object.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Bounce","longname":"Phaser.Physics.Matter.Components.Bounce#setBounce","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Contains methods for changing the collision filter of a Matter Body. Should be used as a mixin and not called directly.","kind":"namespace","name":"Collision","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Collision","scope":"static","___s":true},{"meta":{"filename":"Collision.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\nTwo bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\ncategories are included in their collision masks (see {@link #setCollidesWith}).","kind":"function","name":"setCollisionCategory","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique category bitfield.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setCollisionCategory","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\nthey will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\nIf two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\nthey will never collide.","kind":"function","name":"setCollisionGroup","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique group index.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\ncollide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\nand `(categoryB & maskA) !== 0` are both true.","kind":"function","name":"setCollidesWith","since":"3.0.0","params":[{"type":{"names":["number","Array."]},"description":"A unique category bitfield, or an array of them.","name":"categories"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setCollidesWith","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollide","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body starts colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setOnCollide","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideEnd","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body stops colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setOnCollideEnd","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideActive","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke for the duration of this body colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setOnCollideActive","scope":"instance","___s":true},{"meta":{"filename":"Collision.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideWith","since":"3.22.0","params":[{"type":{"names":["MatterJS.Body","Array."]},"description":"The body, or an array of bodies, to test for collisions with.","name":"body"},{"type":{"names":["function"]},"description":"The callback to invoke when this body collides with the given body or bodies.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Collision","longname":"Phaser.Physics.Matter.Components.Collision#setOnCollideWith","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"Force.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Force.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A component to apply force to Matter.js bodies.","kind":"namespace","name":"Force","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Force","scope":"static","___s":true},{"meta":{"filename":"Force.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Applies a force to a body.","kind":"function","name":"applyForce","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Force","longname":"Phaser.Physics.Matter.Components.Force#applyForce","scope":"instance","___s":true},{"meta":{"filename":"Force.js","lineno":38,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Applies a force to a body from a given position.","kind":"function","name":"applyForceFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The position in which the force comes from.","name":"position"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Force","longname":"Phaser.Physics.Matter.Components.Force#applyForceFrom","scope":"instance","___s":true},{"meta":{"filename":"Force.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the forward position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrust","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Force","longname":"Phaser.Physics.Matter.Components.Force#thrust","scope":"instance","___s":true},{"meta":{"filename":"Force.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the left position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustLeft","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Force","longname":"Phaser.Physics.Matter.Components.Force#thrustLeft","scope":"instance","___s":true},{"meta":{"filename":"Force.js","lineno":102,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the right position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustRight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Force","longname":"Phaser.Physics.Matter.Components.Force#thrustRight","scope":"instance","___s":true},{"meta":{"filename":"Force.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the back position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustBack","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Force","longname":"Phaser.Physics.Matter.Components.Force#thrustBack","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Contains methods for changing the friction of a Game Object's Matter Body. Should be used a mixin, not called directly.","kind":"namespace","name":"Friction","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Friction","scope":"static","___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets new friction values for this Game Object's Matter Body.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.","name":"air"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.","name":"fstatic"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Friction","longname":"Phaser.Physics.Matter.Components.Friction#setFriction","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new air resistance for this Game Object's Matter Body.\nA value of 0 means the Body will never slow as it moves through space.\nThe higher the value, the faster a Body slows when moving through space.","kind":"function","name":"setFrictionAir","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new air resistance for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Friction","longname":"Phaser.Physics.Matter.Components.Friction#setFrictionAir","scope":"instance","___s":true},{"meta":{"filename":"Friction.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new static friction for this Game Object's Matter Body.\nA value of 0 means the Body will never \"stick\" when it is nearly stationary.\nThe higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.","kind":"function","name":"setFrictionStatic","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new static friction for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Friction","longname":"Phaser.Physics.Matter.Components.Friction#setFrictionStatic","scope":"instance","___s":true},{"meta":{"filename":"Gravity.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A component to manipulate world gravity for Matter.js bodies.","kind":"namespace","name":"Gravity","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Gravity","scope":"static","___s":true},{"meta":{"filename":"Gravity.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A togglable function for ignoring world gravity in real-time on the current body.","kind":"function","name":"setIgnoreGravity","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to true to ignore the effect of world gravity, or false to not ignore it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Gravity","longname":"Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"Mass.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Mass.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Allows accessing the mass, density, and center of mass of a Matter-enabled Game Object. Should be used as a mixin and not directly.","kind":"namespace","name":"Mass","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Mass","scope":"static","___s":true},{"meta":{"filename":"Mass.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the mass of the Game Object's Matter Body.","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Mass","longname":"Phaser.Physics.Matter.Components.Mass#setMass","scope":"instance","___s":true},{"meta":{"filename":"Mass.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets density of the body.","kind":"function","name":"setDensity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new density of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Mass","longname":"Phaser.Physics.Matter.Components.Mass#setDensity","scope":"instance","___s":true},{"meta":{"filename":"Mass.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The body's center of mass.\n\nCalling this creates a new `Vector2 each time to avoid mutation.\n\nIf you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.","name":"centerOfMass","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.10.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The center of mass."}],"memberof":"Phaser.Physics.Matter.Components.Mass","longname":"Phaser.Physics.Matter.Components.Mass#centerOfMass","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Sensor.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables a Matter-enabled Game Object to be a sensor. Should be used as a mixin and not directly.","kind":"namespace","name":"Sensor","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Sensor","scope":"static","___s":true},{"meta":{"filename":"Sensor.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body belonging to this Game Object to be a sensor.\nSensors trigger collision events, but don't react with colliding body physically.","kind":"function","name":"setSensor","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as a sensor, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sensor","longname":"Phaser.Physics.Matter.Components.Sensor#setSensor","scope":"instance","___s":true},{"meta":{"filename":"Sensor.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Is the body belonging to this Game Object a sensor or not?","kind":"function","name":"isSensor","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is a sensor, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Components.Sensor","longname":"Phaser.Physics.Matter.Components.Sensor#isSensor","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"SetBody.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Bodies","longname":"Bodies","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetBody.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables a Matter-enabled Game Object to set its Body. Should be used as a mixin and not directly.","kind":"namespace","name":"SetBody","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.SetBody","scope":"static","___s":true},{"meta":{"filename":"SetBody.js","lineno":23,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on a Game Object to a rectangle.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setRectangle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.SetBody","longname":"Phaser.Physics.Matter.Components.SetBody#setRectangle","scope":"instance","___s":true},{"meta":{"filename":"SetBody.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on a Game Object to a circle.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.SetBody","longname":"Phaser.Physics.Matter.Components.SetBody#setCircle","scope":"instance","___s":true},{"meta":{"filename":"SetBody.js","lineno":62,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on the Game Object to a polygon shape.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setPolygon","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number of sides the polygon will have.","name":"sides"},{"type":{"names":["number"]},"description":"The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.SetBody","longname":"Phaser.Physics.Matter.Components.SetBody#setPolygon","scope":"instance","___s":true},{"meta":{"filename":"SetBody.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on the Game Object to a trapezoid shape.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setTrapezoid","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the trapezoid Body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the trapezoid Body.","name":"height"},{"type":{"names":["number"]},"description":"The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.","name":"slope"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.SetBody","longname":"Phaser.Physics.Matter.Components.SetBody#setTrapezoid","scope":"instance","___s":true},{"meta":{"filename":"SetBody.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set this Game Object to use the given existing Matter Body.\n\nThe body is first removed from the world before being added to this Game Object.","kind":"function","name":"setExistingBody","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Body this Game Object should use.","name":"body"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.SetBody","longname":"Phaser.Physics.Matter.Components.SetBody#setExistingBody","scope":"instance","___s":true},{"meta":{"filename":"SetBody.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set this Game Object to create and use a new Body based on the configuration object given.\n\nCalling this method resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setBody","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Physics.Matter.MatterSetBodyConfig"]},"description":"Either a string, such as `circle`, or a Matter Set Body Configuration object.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.SetBody","longname":"Phaser.Physics.Matter.Components.SetBody#setBody","scope":"instance","___s":true},{"meta":{"range":[180,209],"filename":"Sleep.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Events","longname":"Events","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Sleep.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables a Matter-enabled Game Object to be able to go to sleep. Should be used as a mixin and not directly.","kind":"namespace","name":"Sleep","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Sleep","scope":"static","___s":true},{"meta":{"filename":"Sleep.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets this Body to sleep.","kind":"function","name":"setToSleep","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Sleep"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sleep","longname":"Phaser.Physics.Matter.Components.Sleep#setToSleep","scope":"instance","___s":true},{"meta":{"filename":"Sleep.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Wakes this Body if asleep.","kind":"function","name":"setAwake","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Sleep"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sleep","longname":"Phaser.Physics.Matter.Components.Sleep#setAwake","scope":"instance","___s":true},{"meta":{"filename":"Sleep.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).","kind":"function","name":"setSleepThreshold","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Sleep"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sleep","longname":"Phaser.Physics.Matter.Components.Sleep#setSleepThreshold","scope":"instance","___s":true},{"meta":{"filename":"Sleep.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enable sleep and wake events for this body.\n\nBy default when a body goes to sleep, or wakes up, it will not emit any events.\n\nThe events are emitted by the Matter World instance and can be listened to via\nthe `SLEEP_START` and `SLEEP_END` events.","kind":"function","name":"setSleepEvents","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` if you want the sleep start event to be emitted for this body.","name":"start"},{"type":{"names":["boolean"]},"description":"`true` if you want the sleep end event to be emitted for this body.","name":"end"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Sleep"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sleep","longname":"Phaser.Physics.Matter.Components.Sleep#setSleepEvents","scope":"instance","___s":true},{"meta":{"filename":"Sleep.js","lineno":88,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep Start event for this body.","kind":"function","name":"setSleepStartEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Sleep"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sleep","longname":"Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent","scope":"instance","___s":true},{"meta":{"filename":"Sleep.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep End event for this body.","kind":"function","name":"setSleepEndEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Sleep"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Sleep","longname":"Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"Static.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Static.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Provides methods used for getting and setting the static state of a physics body.","kind":"namespace","name":"Static","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Static","scope":"static","___s":true},{"meta":{"filename":"Static.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Changes the physics body to be either static `true` or dynamic `false`.","kind":"function","name":"setStatic","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as being static, or `false` to make it dynamic.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Static","longname":"Phaser.Physics.Matter.Components.Static#setStatic","scope":"instance","___s":true},{"meta":{"filename":"Static.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Returns `true` if the body is static, otherwise `false` for a dynamic body.","kind":"function","name":"isStatic","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is static, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Components.Static","longname":"Phaser.Physics.Matter.Components.Static#isStatic","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"Transform.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Transform.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Provides methods used for getting and setting the position, scale and rotation of a Game Object.","kind":"namespace","name":"Transform","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Transform","scope":"static","___s":true},{"meta":{"filename":"Transform.js","lineno":25,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#scaleX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#scaleY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":146,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Use `angle` to set or get rotation of the physics body associated to this GameObject.\nUnlike rotation, when using set the value can be in degrees, which will be converted to radians internally.","name":"angle","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#angle","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":168,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Use `rotation` to set or get the rotation of the physics body associated with this GameObject.\nThe value when set must be in radians.","name":"rotation","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Transform.js","lineno":192,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the position of the physics body along x and y axes.\nBoth the parameters to this function are optional and if not passed any they default to 0.\nVelocity, angle, force etc. are unchanged.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the body.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical position of the body.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Transform"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#setPosition","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":217,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Immediately sets the angle of the Body.\nAngular velocity, position, force etc. are unchanged.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The angle of the body, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Transform"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#setRotation","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":239,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Setting fixed rotation sets the Body inertia to Infinity, which stops it\nfrom being able to rotate when forces are applied to it.","kind":"function","name":"setFixedRotation","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Transform"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#setFixedRotation","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Immediately sets the angle of the Body.\nAngular velocity, position, force etc. are unchanged.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The angle to set, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Transform"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#setAngle","scope":"instance","___s":true},{"meta":{"filename":"Transform.js","lineno":277,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the x value.","name":"y"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"The point (Vector2) from which scaling will occur.","name":"point"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Components.Transform"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Transform","longname":"Phaser.Physics.Matter.Components.Transform#setScale","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"Velocity.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"name":"Body","longname":"Body","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Velocity.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Contains methods for changing the velocity of a Matter Body. Should be used as a mixin and not called directly.","kind":"namespace","name":"Velocity","since":"3.0.0","memberof":"Phaser.Physics.Matter.Components","longname":"Phaser.Physics.Matter.Components.Velocity","scope":"static","___s":true},{"meta":{"filename":"Velocity.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the angular velocity of the body instantly.\nPosition, angle, force etc. are unchanged.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Velocity","longname":"Phaser.Physics.Matter.Components.Velocity#setAngularVelocity","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Velocity","longname":"Phaser.Physics.Matter.Components.Velocity#setVelocityX","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Velocity","longname":"Phaser.Physics.Matter.Components.Velocity#setVelocityY","scope":"instance","___s":true},{"meta":{"filename":"Velocity.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets both the horizontal and vertical velocity of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value, it can be either positive or negative. If not given, it will be the same as the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Components.Velocity","longname":"Phaser.Physics.Matter.Components.Velocity#setVelocity","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"kind":"namespace","name":"Components","memberof":"Phaser.Physics.Matter","longname":"Phaser.Physics.Matter.Components","scope":"static","___s":true},{"meta":{"filename":"AFTER_ADD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"AfterAddEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"An array of the object(s) that have been added. May be a single body, constraint, composite or a mixture of these.","name":"object"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.AfterAddEvent","scope":"static","___s":true},{"meta":{"filename":"AFTER_ADD_EVENT.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics After Add Event.\n\nThis event is dispatched by a Matter Physics World instance at the end of the process when a new Body\nor Constraint has just been added to the world.\n\nListen to it from a Scene using: `this.matter.world.on('afteradd', listener)`.","kind":"event","name":"AFTER_ADD","since":"3.22.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.AfterAddEvent"]},"description":"The Add Event object.","name":"event"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:AFTER_ADD","scope":"instance","___s":true},{"meta":{"filename":"AFTER_REMOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"AfterRemoveEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"An array of the object(s) that were removed. May be a single body, constraint, composite or a mixture of these.","name":"object"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.AfterRemoveEvent","scope":"static","___s":true},{"meta":{"filename":"AFTER_REMOVE_EVENT.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics After Remove Event.\n\nThis event is dispatched by a Matter Physics World instance at the end of the process when a \nBody or Constraint was removed from the world.\n\nListen to it from a Scene using: `this.matter.world.on('afterremove', listener)`.","kind":"event","name":"AFTER_REMOVE","since":"3.22.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.AfterRemoveEvent"]},"description":"The Remove Event object.","name":"event"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:AFTER_REMOVE","scope":"instance","___s":true},{"meta":{"filename":"AFTER_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"AfterUpdateEvent","type":{"names":["object"]},"properties":[{"type":{"names":["number"]},"description":"The Matter Engine `timing.timestamp` value for the event.","name":"timestamp"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.AfterUpdateEvent","scope":"static","___s":true},{"meta":{"filename":"AFTER_UPDATE_EVENT.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics After Update Event.\n\nThis event is dispatched by a Matter Physics World instance after the engine has updated and all collision events have resolved.\n\nListen to it from a Scene using: `this.matter.world.on('afterupdate', listener)`.","kind":"event","name":"AFTER_UPDATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.AfterUpdateEvent"]},"description":"The Update Event object.","name":"event"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:AFTER_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"BEFORE_ADD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"BeforeAddEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"An array of the object(s) to be added. May be a single body, constraint, composite or a mixture of these.","name":"object"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.BeforeAddEvent","scope":"static","___s":true},{"meta":{"filename":"BEFORE_ADD_EVENT.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Before Add Event.\n\nThis event is dispatched by a Matter Physics World instance at the start of the process when a new Body\nor Constraint is being added to the world.\n\nListen to it from a Scene using: `this.matter.world.on('beforeadd', listener)`.","kind":"event","name":"BEFORE_ADD","since":"3.22.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.BeforeAddEvent"]},"description":"The Add Event object.","name":"event"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:BEFORE_ADD","scope":"instance","___s":true},{"meta":{"filename":"BEFORE_REMOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"BeforeRemoveEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"An array of the object(s) to be removed. May be a single body, constraint, composite or a mixture of these.","name":"object"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.BeforeRemoveEvent","scope":"static","___s":true},{"meta":{"filename":"BEFORE_REMOVE_EVENT.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Before Remove Event.\n\nThis event is dispatched by a Matter Physics World instance at the start of the process when a \nBody or Constraint is being removed from the world.\n\nListen to it from a Scene using: `this.matter.world.on('beforeremove', listener)`.","kind":"event","name":"BEFORE_REMOVE","since":"3.22.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.BeforeRemoveEvent"]},"description":"The Remove Event object.","name":"event"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:BEFORE_REMOVE","scope":"instance","___s":true},{"meta":{"filename":"BEFORE_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"BeforeUpdateEvent","type":{"names":["object"]},"properties":[{"type":{"names":["number"]},"description":"The Matter Engine `timing.timestamp` value for the event.","name":"timestamp"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.BeforeUpdateEvent","scope":"static","___s":true},{"meta":{"filename":"BEFORE_UPDATE_EVENT.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Before Update Event.\n\nThis event is dispatched by a Matter Physics World instance right before all the collision processing takes place.\n\nListen to it from a Scene using: `this.matter.world.on('beforeupdate', listener)`.","kind":"event","name":"BEFORE_UPDATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.BeforeUpdateEvent"]},"description":"The Update Event object.","name":"event"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:BEFORE_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"COLLISION_ACTIVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"CollisionActiveEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"A list of all affected pairs in the collision.","name":"pairs"},{"type":{"names":["number"]},"description":"The Matter Engine `timing.timestamp` value for the event.","name":"timestamp"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.CollisionActiveEvent","scope":"static","___s":true},{"meta":{"filename":"COLLISION_ACTIVE_EVENT.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Collision Active Event.\n\nThis event is dispatched by a Matter Physics World instance after the engine has updated.\nIt provides a list of all pairs that are colliding in the current tick (if any).\n\nListen to it from a Scene using: `this.matter.world.on('collisionactive', listener)`.","kind":"event","name":"COLLISION_ACTIVE","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.CollisionActiveEvent"]},"description":"The Collision Event object.","name":"event"},{"type":{"names":["MatterJS.BodyType"]},"description":"The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.","name":"bodyB"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:COLLISION_ACTIVE","scope":"instance","___s":true},{"meta":{"filename":"COLLISION_END_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"CollisionEndEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"A list of all affected pairs in the collision.","name":"pairs"},{"type":{"names":["number"]},"description":"The Matter Engine `timing.timestamp` value for the event.","name":"timestamp"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.CollisionEndEvent","scope":"static","___s":true},{"meta":{"filename":"COLLISION_END_EVENT.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Collision End Event.\n\nThis event is dispatched by a Matter Physics World instance after the engine has updated.\nIt provides a list of all pairs that have finished colliding in the current tick (if any).\n\nListen to it from a Scene using: `this.matter.world.on('collisionend', listener)`.","kind":"event","name":"COLLISION_END","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.CollisionEndEvent"]},"description":"The Collision Event object.","name":"event"},{"type":{"names":["MatterJS.BodyType"]},"description":"The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.","name":"bodyB"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:COLLISION_END","scope":"instance","___s":true},{"meta":{"filename":"COLLISION_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"CollisionStartEvent","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"description":"A list of all affected pairs in the collision.","name":"pairs"},{"type":{"names":["number"]},"description":"The Matter Engine `timing.timestamp` value for the event.","name":"timestamp"},{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.CollisionStartEvent","scope":"static","___s":true},{"meta":{"filename":"COLLISION_START_EVENT.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Collision Start Event.\n\nThis event is dispatched by a Matter Physics World instance after the engine has updated.\nIt provides a list of all pairs that have started to collide in the current tick (if any).\n\nListen to it from a Scene using: `this.matter.world.on('collisionstart', listener)`.","kind":"event","name":"COLLISION_START","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.CollisionStartEvent"]},"description":"The Collision Event object.","name":"event"},{"type":{"names":["MatterJS.BodyType"]},"description":"The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.","name":"bodyB"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:COLLISION_START","scope":"instance","___s":true},{"meta":{"filename":"DRAG_END_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Drag End Event.\n\nThis event is dispatched by a Matter Physics World instance when a Pointer Constraint\nstops dragging a body.\n\nListen to it from a Scene using: `this.matter.world.on('dragend', listener)`.","kind":"event","name":"DRAG_END","since":"3.16.2","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Body that has stopped being dragged. This is a Matter Body, not a Phaser Game Object.","name":"body"},{"type":{"names":["Phaser.Physics.Matter.PointerConstraint"]},"description":"The Pointer Constraint that was dragging the body.","name":"constraint"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:DRAG_END","scope":"instance","___s":true},{"meta":{"filename":"DRAG_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Drag Event.\n\nThis event is dispatched by a Matter Physics World instance when a Pointer Constraint\nis actively dragging a body. It is emitted each time the pointer moves.\n\nListen to it from a Scene using: `this.matter.world.on('drag', listener)`.","kind":"event","name":"DRAG","since":"3.16.2","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Body that is being dragged. This is a Matter Body, not a Phaser Game Object.","name":"body"},{"type":{"names":["Phaser.Physics.Matter.PointerConstraint"]},"description":"The Pointer Constraint that is dragging the body.","name":"constraint"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:DRAG","scope":"instance","___s":true},{"meta":{"filename":"DRAG_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Drag Start Event.\n\nThis event is dispatched by a Matter Physics World instance when a Pointer Constraint\nstarts dragging a body.\n\nListen to it from a Scene using: `this.matter.world.on('dragstart', listener)`.","kind":"event","name":"DRAG_START","since":"3.16.2","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Body that has started being dragged. This is a Matter Body, not a Phaser Game Object.","name":"body"},{"type":{"names":["MatterJS.BodyType"]},"description":"The part of the body that was clicked on.","name":"part"},{"type":{"names":["Phaser.Physics.Matter.PointerConstraint"]},"description":"The Pointer Constraint that is dragging the body.","name":"constraint"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:DRAG_START","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics World Pause Event.\n\nThis event is dispatched by an Matter Physics World instance when it is paused.\n\nListen to it from a Scene using: `this.matter.world.on('pause', listener)`.","kind":"event","name":"PAUSE","since":"3.0.0","memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:PAUSE","scope":"instance","___s":true},{"meta":{"filename":"RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics World Resume Event.\n\nThis event is dispatched by an Matter Physics World instance when it resumes from a paused state.\n\nListen to it from a Scene using: `this.matter.world.on('resume', listener)`.","kind":"event","name":"RESUME","since":"3.0.0","memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:RESUME","scope":"instance","___s":true},{"meta":{"filename":"SLEEP_END_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"SleepEndEvent","type":{"names":["object"]},"properties":[{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.SleepEndEvent","scope":"static","___s":true},{"meta":{"filename":"SLEEP_END_EVENT.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Sleep End Event.\n\nThis event is dispatched by a Matter Physics World instance when a Body stop sleeping.\n\nListen to it from a Scene using: `this.matter.world.on('sleepend', listener)`.","kind":"event","name":"SLEEP_END","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.SleepEndEvent"]},"description":"The Sleep Event object.","name":"event"},{"type":{"names":["MatterJS.BodyType"]},"description":"The body that has stopped sleeping.","name":"body"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:SLEEP_END","scope":"instance","___s":true},{"meta":{"filename":"SLEEP_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"typedef","name":"SleepStartEvent","type":{"names":["object"]},"properties":[{"type":{"names":["any"]},"description":"The source object of the event.","name":"source"},{"type":{"names":["string"]},"description":"The name of the event.","name":"name"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events.SleepStartEvent","scope":"static","___s":true},{"meta":{"filename":"SLEEP_START_EVENT.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"description":"The Matter Physics Sleep Start Event.\n\nThis event is dispatched by a Matter Physics World instance when a Body goes to sleep.\n\nListen to it from a Scene using: `this.matter.world.on('sleepstart', listener)`.","kind":"event","name":"SLEEP_START","since":"3.0.0","params":[{"type":{"names":["Phaser.Physics.Matter.Events.SleepStartEvent"]},"description":"The Sleep Event object.","name":"event"},{"type":{"names":["MatterJS.BodyType"]},"description":"The body that has gone to sleep.","name":"body"}],"memberof":"Phaser.Physics.Matter.Events","longname":"Phaser.Physics.Matter.Events#event:SLEEP_START","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Physics.Matter","longname":"Phaser.Physics.Matter.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js"},"kind":"namespace","name":"Matter","memberof":"Phaser.Physics","longname":"Phaser.Physics.Matter","scope":"static","___s":true},{"meta":{"filename":"MatterBody.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterBody","type":{"names":["MatterJS.BodyType","Phaser.GameObjects.GameObject","Phaser.Physics.Matter.Image","Phaser.Physics.Matter.Sprite","Phaser.Physics.Matter.TileBody"]},"since":"3.22.0","memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterBody","scope":"static","___s":true},{"meta":{"filename":"MatterBodyConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterBodyConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'Body'","description":"An arbitrary string-based name to help identify this body.","name":"label"},{"type":{"names":["Array."]},"optional":true,"description":"An array of bodies that make up this body. The first body in the array must always be a self reference to the current body instance. All bodies in the `parts` array together form a single rigid compound body.","name":"parts"},{"type":{"names":["any"]},"optional":true,"description":"An object reserved for storing plugin-specific properties.","name":"plugin"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A number specifying the angle of the body, in radians.","name":"angle"},{"type":{"names":["Array."]},"optional":true,"defaultvalue":null,"description":"An array of `Vector` objects that specify the convex hull of the rigid body. These should be provided about the origin `(0, 0)`.","name":"vertices"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"A `Vector` that specifies the current world-space position of the body.","name":"position"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"A `Vector` that specifies the force to apply in the current step. It is zeroed after every `Body.update`. See also `Body.applyForce`.","name":"force"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that specifies the torque (turning force) to apply in the current step. It is zeroed after every `Body.update`.","name":"torque"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"A flag that indicates whether a body is a sensor. Sensor triggers collision events, but doesn't react with colliding body physically.","name":"isSensor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"A flag that indicates whether a body is considered static. A static body can never change position or angle and is completely fixed.","name":"isStatic"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping by the `Matter.Sleeping` module (if sleeping is enabled by the engine).","name":"sleepThreshold"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.001,"description":"A `Number` that defines the density of the body, that is its mass per unit area. If you pass the density via `Body.create` the `mass` property is automatically calculated for you based on the size (area) of the object. This is generally preferable to simply setting mass and allows for more intuitive definition of materials (e.g. rock has a higher density than wood).","name":"density"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that defines the restitution (elasticity) of the body. The value is always positive and is in the range `(0, 1)`.","name":"restitution"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.1,"description":"A `Number` that defines the friction of the body. The value is always positive and is in the range `(0, 1)`. A value of `0` means that the body may slide indefinitely. A value of `1` means the body may come to a stop almost instantly after a force is applied.","name":"friction"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"A `Number` that defines the static friction of the body (in the Coulomb friction model). A value of `0` means the body will never 'stick' when it is nearly stationary and only dynamic `friction` is used. The higher the value (e.g. `10`), the more force it will take to initially get the body moving when nearly stationary. This value is multiplied with the `friction` property to make it easier to change `friction` and maintain an appropriate amount of static friction.","name":"frictionStatic"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.01,"description":"A `Number` that defines the air friction of the body (air resistance). A value of `0` means the body will never slow as it moves through space. The higher the value, the faster a body slows when moving through space.","name":"frictionAir"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterCollisionFilter"]},"optional":true,"description":"An `Object` that specifies the collision filtering properties of this body.","name":"collisionFilter"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.05,"description":"A `Number` that specifies a tolerance on how far a body is allowed to 'sink' or rotate into other bodies. Avoid changing this value unless you understand the purpose of `slop` in physics engines. The default should generally suffice, although very large bodies may require larger values for stable stacking.","name":"slop"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A `Number` that allows per-body time scaling, e.g. a force-field where bodies inside are in slow-motion, while others are at full speed.","name":"timeScale"},{"type":{"names":["number","Array.","Phaser.Types.Physics.Matter.MatterChamferConfig"]},"optional":true,"defaultvalue":null,"description":"A number, or array of numbers, to chamfer the vertices of the body, or a full Chamfer configuration object.","name":"chamfer"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The radius of this body if a circle.","name":"circleRadius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that defines the mass of the body, although it may be more appropriate to specify the `density` property instead. If you modify this value, you must also modify the `body.inverseMass` property (`1 / mass`).","name":"mass"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that defines the inverse mass of the body (`1 / mass`). If you modify this value, you must also modify the `body.mass` property.","name":"inverseMass"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"A `Vector` that specifies the initial scale of the body.","name":"scale"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"A `Vector` that scales the influence of World gravity when applied to this body.","name":"gravityScale"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"A boolean that toggles if this body should ignore world gravity or not.","name":"ignoreGravity"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"A boolean that toggles if this body should ignore pointer / mouse constraints or not.","name":"ignorePointer"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyRenderConfig"]},"optional":true,"description":"The Debug Render configuration object for this body.","name":"render"},{"type":{"names":["function"]},"optional":true,"description":"A callback that is invoked when this Body starts colliding with any other Body. You can register callbacks by providing a function of type `( pair: Matter.Pair) => void`.","name":"onCollideCallback"},{"type":{"names":["function"]},"optional":true,"description":"A callback that is invoked when this Body stops colliding with any other Body. You can register callbacks by providing a function of type `( pair: Matter.Pair) => void`.","name":"onCollideEndCallback"},{"type":{"names":["function"]},"optional":true,"description":"A callback that is invoked for the duration that this Body is colliding with any other Body. You can register callbacks by providing a function of type `( pair: Matter.Pair) => void`.","name":"onCollideActiveCallback"},{"type":{"names":["any"]},"optional":true,"description":"A collision callback dictionary used by the `Body.setOnCollideWith` function.","name":"onCollideWith"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterBodyConfig","scope":"static","___s":true},{"meta":{"filename":"MatterBodyRenderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterBodyRenderConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this body be rendered by the Debug Renderer?","name":"visible"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The opacity of the body and all parts within it.","name":"opacity"},{"type":{"names":["number"]},"optional":true,"description":"The color value of the fill when rendering this body.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"description":"The opacity of the fill when rendering this body, a value between 0 and 1.","name":"fillOpacity"},{"type":{"names":["number"]},"optional":true,"description":"The color value of the line stroke when rendering this body.","name":"lineColor"},{"type":{"names":["number"]},"optional":true,"description":"The opacity of the line when rendering this body, a value between 0 and 1.","name":"lineOpacity"},{"type":{"names":["number"]},"optional":true,"description":"If rendering lines, the thickness of the line.","name":"lineThickness"},{"type":{"names":["object"]},"optional":true,"description":"Controls the offset between the body and the parent Game Object, if it has one.","name":"sprite"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal offset between the body and the parent Game Object texture, if it has one.","name":"sprite.xOffset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical offset between the body and the parent Game Object texture, if it has one.","name":"sprite.yOffset"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterBodyRenderConfig","scope":"static","___s":true},{"meta":{"filename":"MatterBodyTileOptions.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterBodyTileOptions","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not the newly created body should be made static. This defaults to true since typically tiles should not be moved.","name":"isStatic"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to add the newly created body (or existing body if options.body is used) to the Matter world.","name":"addToWorld"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterBodyTileOptions","scope":"static","___s":true},{"meta":{"filename":"MatterChamferConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterChamferConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["number","Array."]},"optional":true,"defaultvalue":8,"description":"A single number, or an array, to specify the radius for each vertex.","name":"radius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":-1,"description":"The quality of the chamfering. -1 means 'auto'.","name":"quality"},{"type":{"names":["number"]},"optional":true,"defaultvalue":2,"description":"The minimum quality of the chamfering. The higher this value, the more vertices are created.","name":"qualityMin"},{"type":{"names":["number"]},"optional":true,"defaultvalue":14,"description":"The maximum quality of the chamfering. The higher this value, the more vertices are created.","name":"qualityMax"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterChamferConfig","scope":"static","___s":true},{"meta":{"filename":"MatterCollisionData.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterCollisionData","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["boolean"]},"description":"Have the pair collided or not?","name":"collided"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the first body involved in the collision.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the second body involved in the collision.","name":"bodyB"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the dominant axis body.","name":"axisBody"},{"type":{"names":["number"]},"description":"The index of the dominant collision axis vector (edge normal)","name":"axisNumber"},{"type":{"names":["number"]},"description":"The depth of the collision on the minimum overlap.","name":"depth"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the parent of Body A, or to Body A itself if it has no parent.","name":"parentA"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the parent of Body B, or to Body B itself if it has no parent.","name":"parentB"},{"type":{"names":["MatterJS.Vector"]},"description":"The collision normal, facing away from Body A.","name":"normal"},{"type":{"names":["MatterJS.Vector"]},"description":"The tangent of the collision normal.","name":"tangent"},{"type":{"names":["MatterJS.Vector"]},"description":"The penetration distances between the two bodies.","name":"penetration"},{"type":{"names":["Array."]},"description":"An array of support points, either exactly one or two points.","name":"supports"},{"type":{"names":["number"]},"description":"The resulting inverse mass from the collision.","name":"inverseMass"},{"type":{"names":["number"]},"description":"The resulting friction from the collision.","name":"friction"},{"type":{"names":["number"]},"description":"The resulting static friction from the collision.","name":"frictionStatic"},{"type":{"names":["number"]},"description":"The resulting restitution from the collision.","name":"restitution"},{"type":{"names":["number"]},"description":"The resulting slop from the collision.","name":"slop"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterCollisionData","scope":"static","___s":true},{"meta":{"filename":"MatterCollisionFilter.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"description":"An `Object` that specifies the collision filtering properties of this body.\n\nCollisions between two bodies will obey the following rules:\n- If the two bodies have the same non-zero value of `collisionFilter.group`,\n they will always collide if the value is positive, and they will never collide\n if the value is negative.\n- If the two bodies have different values of `collisionFilter.group` or if one\n (or both) of the bodies has a value of 0, then the category/mask rules apply as follows:\n\nEach body belongs to a collision category, given by `collisionFilter.category`. This\nvalue is used as a bit field and the category should have only one bit set, meaning that\nthe value of this property is a power of two in the range [1, 2^31]. Thus, there are 32\ndifferent collision categories available.\n\nEach body also defines a collision bitmask, given by `collisionFilter.mask` which specifies\nthe categories it collides with (the value is the bitwise AND value of all these categories).\n\nUsing the category/mask rules, two bodies `A` and `B` collide if each includes the other's\ncategory in its mask, i.e. `(categoryA & maskB) !== 0` and `(categoryB & maskA) !== 0`\nare both true.","kind":"typedef","name":"MatterCollisionFilter","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x0001","description":"A bit field that specifies the collision category this body belongs to. The category value should have only one bit set, for example `0x0001`. This means there are up to 32 unique collision categories available.","name":"category"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xFFFFFFFF","description":"A bit mask that specifies the collision categories this body may collide with.","name":"mask"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"An Integer `Number`, that specifies the collision group this body belongs to.","name":"group"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterCollisionFilter","scope":"static","___s":true},{"meta":{"filename":"MatterCollisionPair.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterCollisionPair","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["string"]},"description":"The unique auto-generated collision pair id. A combination of the body A and B IDs.","name":"id"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the first body involved in the collision.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"description":"A reference to the second body involved in the collision.","name":"bodyB"},{"type":{"names":["Array."]},"description":"An array containing all of the active contacts between bodies A and B.","name":"activeContacts"},{"type":{"names":["number"]},"description":"The amount of separation that occured between bodies A and B.","name":"separation"},{"type":{"names":["boolean"]},"description":"Is the collision still active or not?","name":"isActive"},{"type":{"names":["boolean"]},"description":"Has Matter determined the collision are being active yet?","name":"confirmedActive"},{"type":{"names":["boolean"]},"description":"Is either body A or B a sensor?","name":"isSensor"},{"type":{"names":["number"]},"description":"The timestamp when the collision pair was created.","name":"timeCreated"},{"type":{"names":["number"]},"description":"The timestamp when the collision pair was most recently updated.","name":"timeUpdated"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterCollisionData"]},"description":"The collision data object.","name":"collision"},{"type":{"names":["number"]},"description":"The resulting inverse mass from the collision.","name":"inverseMass"},{"type":{"names":["number"]},"description":"The resulting friction from the collision.","name":"friction"},{"type":{"names":["number"]},"description":"The resulting static friction from the collision.","name":"frictionStatic"},{"type":{"names":["number"]},"description":"The resulting restitution from the collision.","name":"restitution"},{"type":{"names":["number"]},"description":"The resulting slop from the collision.","name":"slop"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterCollisionPair","scope":"static","___s":true},{"meta":{"filename":"MatterConstraintConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterConstraintConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'Constraint'","description":"An arbitrary string-based name to help identify this constraint.","name":"label"},{"type":{"names":["MatterJS.BodyType"]},"optional":true,"description":"The first possible `Body` that this constraint is attached to.","name":"bodyA"},{"type":{"names":["MatterJS.BodyType"]},"optional":true,"description":"The second possible `Body` that this constraint is attached to.","name":"bodyB"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"A `Vector` that specifies the offset of the constraint from center of the `constraint.bodyA` if defined, otherwise a world-space position.","name":"pointA"},{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"optional":true,"description":"A `Vector` that specifies the offset of the constraint from center of the `constraint.bodyB` if defined, otherwise a world-space position.","name":"pointB"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A `Number` that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting `constraint.length`. A value of `1` means the constraint should be very stiff. A value of `0.2` means the constraint acts like a soft spring.","name":"stiffness"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that specifies the angular stiffness of the constraint.","name":"angularStiffness"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The angleA of the constraint. If bodyA is set, the angle of bodyA is used instead.","name":"angleA"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The angleB of the constraint. If bodyB is set, the angle of bodyB is used instead.","name":"angleB"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that specifies the damping of the constraint, i.e. the amount of resistance applied to each body based on their velocities to limit the amount of oscillation. Damping will only be apparent when the constraint also has a very low `stiffness`. A value of `0.1` means the constraint will apply heavy damping, resulting in little to no oscillation. A value of `0` means the constraint will apply no damping.","name":"damping"},{"type":{"names":["number"]},"optional":true,"description":"A `Number` that specifies the target resting length of the constraint. It is calculated automatically in `Constraint.create` from initial positions of the `constraint.bodyA` and `constraint.bodyB`.","name":"length"},{"type":{"names":["any"]},"optional":true,"description":"An object reserved for storing plugin-specific properties.","name":"plugin"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterConstraintRenderConfig"]},"optional":true,"description":"The Debug Render configuration object for this constraint.","name":"render"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterConstraintConfig","scope":"static","___s":true},{"meta":{"filename":"MatterConstraintRenderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterConstraintRenderConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this constraint be rendered by the Debug Renderer?","name":"visible"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If this constraint has anchors, should they be rendered? Pin constraints never have anchors.","name":"anchors"},{"type":{"names":["number"]},"optional":true,"description":"The color value of the line stroke when rendering this constraint.","name":"lineColor"},{"type":{"names":["number"]},"optional":true,"description":"The opacity of the line when rendering this constraint, a value between 0 and 1.","name":"lineOpacity"},{"type":{"names":["number"]},"optional":true,"description":"If rendering lines, the thickness of the line.","name":"lineThickness"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"The size of the circles drawn when rendering pin constraints.","name":"pinSize"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"The size of the circles drawn as the constraint anchors.","name":"anchorSize"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xefefef","description":"The color value of constraint anchors.","name":"anchorColor"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterConstraintRenderConfig","scope":"static","___s":true},{"meta":{"filename":"MatterDebugConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterDebugConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render all of the body axes?","name":"showAxes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render just a single body axis?","name":"showAngleIndicator"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":"0xe81153","description":"The color of the body angle / axes lines.","name":"angleColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render the broadphase grid?","name":"showBroadphase"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":"0xffb400","description":"The color of the broadphase grid.","name":"broadphaseColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render the bounds of the bodies in the world?","name":"showBounds"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":"0xffffff","description":"The color of the body bounds.","name":"boundsColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render the velocity of the bodies in the world?","name":"showVelocity"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":"0x00aeef","description":"The color of the body velocity line.","name":"velocityColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render the collision points and normals for colliding pairs.","name":"showCollisions"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":"0xf5950c","description":"The color of the collision points.","name":"collisionColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render lines showing the separation between bodies.","name":"showSeparation"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":"0xffa500","description":"The color of the body separation line.","name":"separationColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Render the dynamic bodies in the world to the Graphics object?","name":"showBody"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Render the static bodies in the world to the Graphics object?","name":"showStaticBody"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When rendering bodies, render the internal edges as well?","name":"showInternalEdges"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render the bodies using a fill color.","name":"renderFill"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Render the bodies using a line stroke.","name":"renderLine"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x106909","description":"The color value of the fill when rendering dynamic bodies.","name":"fillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The opacity of the fill when rendering dynamic bodies, a value between 0 and 1.","name":"fillOpacity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x28de19","description":"The color value of the line stroke when rendering dynamic bodies.","name":"lineColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The opacity of the line when rendering dynamic bodies, a value between 0 and 1.","name":"lineOpacity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"If rendering lines, the thickness of the line.","name":"lineThickness"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x0d177b","description":"The color value of the fill when rendering static bodies.","name":"staticFillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x1327e4","description":"The color value of the line stroke when rendering static bodies.","name":"staticLineColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Render any sleeping bodies (dynamic or static) in the world to the Graphics object?","name":"showSleeping"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.7,"description":"The amount to multiply the opacity of sleeping static bodies by.","name":"staticBodySleepOpacity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x464646","description":"The color value of the fill when rendering sleeping dynamic bodies.","name":"sleepFillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x999a99","description":"The color value of the line stroke when rendering sleeping dynamic bodies.","name":"sleepLineColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Render bodies or body parts that are flagged as being a sensor?","name":"showSensors"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x0d177b","description":"The fill color when rendering body sensors.","name":"sensorFillColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x1327e4","description":"The line color when rendering body sensors.","name":"sensorLineColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Render the position of non-static bodies?","name":"showPositions"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"The size of the rectangle drawn when rendering the body position.","name":"positionSize"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xe042da","description":"The color value of the rectangle drawn when rendering the body position.","name":"positionColor"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Render all world constraints to the Graphics object?","name":"showJoint"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xe0e042","description":"The color value of joints when `showJoint` is set.","name":"jointColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The line opacity when rendering joints, a value between 0 and 1.","name":"jointLineOpacity"},{"type":{"names":["number"]},"optional":true,"defaultvalue":2,"description":"The line thickness when rendering joints.","name":"jointLineThickness"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"The size of the circles drawn when rendering pin constraints.","name":"pinSize"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0x42e0e0","description":"The color value of the circles drawn when rendering pin constraints.","name":"pinColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xe042e0","description":"The color value of spring constraints.","name":"springColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xefefef","description":"The color value of constraint anchors.","name":"anchorColor"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"The size of the circles drawn as the constraint anchors.","name":"anchorSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"When rendering polygon bodies, render the convex hull as well?","name":"showConvexHulls"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xd703d0","description":"The color value of hulls when `showConvexHulls` is set.","name":"hullColor"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterDebugConfig","scope":"static","___s":true},{"meta":{"filename":"MatterRunnerConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterRunnerConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"A boolean that specifies if the runner should use a fixed timestep (otherwise it is variable). If timing is fixed, then the apparent simulation speed will change depending on the frame rate (but behaviour will be deterministic). If the timing is variable, then the apparent simulation speed will be constant (approximately, but at the cost of determininism).","name":"isFixed"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"A number that specifies the frame rate in seconds. If you don't specify this, but do specify `delta`, those values set the fps rate.","name":"fps"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A number that specifies the time correction factor to apply to the update. This can help improve the accuracy of the simulation in cases where delta is changing between updates.","name":"correction"},{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"The size of the delta smoothing array when `isFixed` is `false`.","name":"deltaSampleSize"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16.666,"description":"A number that specifies the time step between updates in milliseconds. If you set the `fps` property, this value is set based on that. If `isFixed` is set to `true`, then `delta` is fixed. If it is `false`, then `delta` can dynamically change to maintain the correct apparent simulation speed.","name":"delta"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16.666,"description":"A number that specifies the minimum time step between updates in milliseconds.","name":"deltaMin"},{"type":{"names":["number"]},"optional":true,"defaultvalue":33.333,"description":"A number that specifies the maximum time step between updates in milliseconds.","name":"deltaMax"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterRunnerConfig","scope":"static","___s":true},{"meta":{"filename":"MatterSetBodyConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterSetBodyConfig","type":{"names":["object"]},"since":"3.22.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'rectangle'","description":"The shape type. Either `rectangle`, `circle`, `trapezoid`, `polygon`, `fromVertices`, `fromVerts` or `fromPhysicsEditor`.","name":"type"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal world position to place the body at.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical world position to place the body at.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the body.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the body.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The radius of the body. Used by `circle` and `polygon` shapes.","name":"radius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":25,"description":"The max sizes of the body. Used by the `circle` shape.","name":"maxSides"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"Used by the `trapezoid` shape. The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.","name":"slope"},{"type":{"names":["number"]},"optional":true,"defaultvalue":5,"description":"Used by the `polygon` shape. The number of sides the polygon will have.","name":"sides"},{"type":{"names":["string","array"]},"optional":true,"description":"Used by the `fromVerts` shape. The vertices data. Either a path string or an array of vertices.","name":"verts"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Used by the `fromVerts` shape. Flag internal edges (coincident part edges)","name":"flagInternal"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.01,"description":"Used by the `fromVerts` shape. Whether Matter.js will discard collinear edges (to improve performance).","name":"removeCollinear"},{"type":{"names":["number"]},"optional":true,"defaultvalue":10,"description":"Used by the `fromVerts` shape. During decomposition discard parts that have an area less than this.","name":"minimumArea"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the new body be automatically added to the world?","name":"addToWorld"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterSetBodyConfig","scope":"static","___s":true},{"meta":{"filename":"MatterTileOptions.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterTileOptions","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["MatterJS.BodyType"]},"optional":true,"defaultvalue":null,"description":"An existing Matter body to be used instead of creating a new one.","name":"body"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not the newly created body should be made static. This defaults to true since typically tiles should not be moved.","name":"isStatic"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to add the newly created body (or existing body if options.body is used) to the Matter world.","name":"addToWorld"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterTileOptions","scope":"static","___s":true},{"meta":{"filename":"MatterWorldConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"typedef","name":"MatterWorldConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Types.Math.Vector2Like","boolean"]},"optional":true,"description":"Sets {@link Phaser.Physics.Matter.World#gravity}. If `false` Gravity will be set to zero.","name":"gravity"},{"type":{"names":["object","boolean"]},"optional":true,"description":"Should the world have bounds enabled by default?","name":"setBounds"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the world bounds.","name":"setBounds.x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the world bounds.","name":"setBounds.y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the world bounds.","name":"setBounds.width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the world bounds.","name":"setBounds.height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":64,"description":"The thickness of the walls of the world bounds.","name":"setBounds.thickness"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the left-side world bounds wall be created?","name":"setBounds.left"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the right-side world bounds wall be created?","name":"setBounds.right"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the top world bounds wall be created?","name":"setBounds.top"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the bottom world bounds wall be created?","name":"setBounds.bottom"},{"type":{"names":["number"]},"optional":true,"defaultvalue":6,"description":"The number of position iterations to perform each update. The higher the value, the higher quality the simulation will be at the expense of performance.","name":"positionIterations"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"The number of velocity iterations to perform each update. The higher the value, the higher quality the simulation will be at the expense of performance.","name":"velocityIterations"},{"type":{"names":["number"]},"optional":true,"defaultvalue":2,"description":"The number of constraint iterations to perform each update. The higher the value, the higher quality the simulation will be at the expense of performance.","name":"constraintIterations"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"A flag that specifies whether the engine should allow sleeping via the `Matter.Sleeping` module. Sleeping can improve stability and performance, but often at the expense of accuracy.","name":"enableSleeping"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"A `Number` that specifies the current simulation-time in milliseconds starting from `0`. It is incremented on every `Engine.update` by the given `delta` argument.","name":"timing.timestamp"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A `Number` that specifies the global scaling factor of time for all bodies. A value of `0` freezes the simulation. A value of `0.1` gives a slow-motion effect. A value of `1.2` gives a speed-up effect.","name":"timing.timeScale"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the Matter Attractor Plugin be enabled? An attractors plugin that makes it easy to apply continual forces on bodies. It's possible to simulate effects such as wind, gravity and magnetism.","name":"plugins.attractors"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the Matter Wrap Plugin be enabled? A coordinate wrapping plugin that automatically wraps the position of bodies such that they always stay within the given bounds. Upon crossing a boundary the body will appear on the opposite side of the bounds, while maintaining its velocity.","name":"plugins.wrap"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the Matter Collision Events Plugin be enabled?","name":"plugins.collisionevents"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Toggles if the world is enabled or not.","name":"enabled"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"An optional Number that specifies the time correction factor to apply to the update.","name":"correction"},{"type":{"names":["function"]},"optional":true,"description":"This function is called every time the core game loop steps, which is bound to the Request Animation Frame frequency unless otherwise modified.","name":"getDelta"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Automatically call Engine.update every time the game steps.","name":"autoUpdate"},{"type":{"names":["number"]},"optional":true,"defaultvalue":4,"description":"Sets the Resolver resting threshold property.","name":"restingThresh"},{"type":{"names":["number"]},"optional":true,"defaultvalue":6,"description":"Sets the Resolver resting threshold tangent property.","name":"restingThreshTangent"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.9,"description":"Sets the Resolver position dampen property.","name":"positionDampen"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.8,"description":"Sets the Resolver position warming property.","name":"positionWarming"},{"type":{"names":["number"]},"optional":true,"defaultvalue":5,"description":"Sets the Resolver friction normal multiplier property.","name":"frictionNormalMultiplier"},{"type":{"names":["boolean","Phaser.Types.Physics.Matter.MatterDebugConfig"]},"optional":true,"defaultvalue":false,"description":"Controls the Matter Debug Rendering options. If a boolean it will use the default values, otherwise, specify a Debug Config object.","name":"debug"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterRunnerConfig"]},"optional":true,"description":"Sets the Matter Runner options.","name":"runner"}],"memberof":"Phaser.Types.Physics.Matter","longname":"Phaser.Types.Physics.Matter.MatterWorldConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs"},"kind":"namespace","name":"Matter","memberof":"Phaser.Types.Physics","longname":"Phaser.Types.Physics.Matter","scope":"static","___s":true},{"meta":{"range":[215,248],"filename":"BasePlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BasePlugin.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"classdesc":"A Global Plugin is installed just once into the Game owned Plugin Manager.\nIt can listen for Game events and respond to them.","kind":"class","name":"BasePlugin","memberof":"Phaser.Plugins","since":"3.8.0","params":[{"type":{"names":["Phaser.Plugins.PluginManager"]},"description":"A reference to the Plugin Manager.","name":"pluginManager"}],"scope":"static","longname":"Phaser.Plugins.BasePlugin","___s":true},{"meta":{"filename":"BasePlugin.js","lineno":49,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The PluginManager calls this method on a Global Plugin when the plugin is first instantiated.\nIt will never be called again on this instance.\nIn here you can set-up whatever you need for this plugin to run.\nIf a plugin is set to automatically start then `BasePlugin.start` will be called immediately after this.\nOn a Scene Plugin, this method is never called. Use {@link Phaser.Plugins.ScenePlugin#boot} instead.","kind":"function","name":"init","since":"3.8.0","params":[{"type":{"names":["any"]},"optional":true,"nullable":true,"description":"A value specified by the user, if any, from the `data` property of the plugin's configuration object (if started at game boot) or passed in the PluginManager's `install` method (if started manually).","name":"data"}],"memberof":"Phaser.Plugins.BasePlugin","longname":"Phaser.Plugins.BasePlugin#init","scope":"instance","___s":true},{"meta":{"filename":"BasePlugin.js","lineno":65,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The PluginManager calls this method on a Global Plugin when the plugin is started.\nIf a plugin is stopped, and then started again, this will get called again.\nTypically called immediately after `BasePlugin.init`.\nOn a Scene Plugin, this method is never called.","kind":"function","name":"start","since":"3.8.0","memberof":"Phaser.Plugins.BasePlugin","longname":"Phaser.Plugins.BasePlugin#start","scope":"instance","___s":true},{"meta":{"filename":"BasePlugin.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The PluginManager calls this method on a Global Plugin when the plugin is stopped.\nThe game code has requested that your plugin stop doing whatever it does.\nIt is now considered as 'inactive' by the PluginManager.\nHandle that process here (i.e. stop listening for events, etc)\nIf the plugin is started again then `BasePlugin.start` will be called again.\nOn a Scene Plugin, this method is never called.","kind":"function","name":"stop","since":"3.8.0","memberof":"Phaser.Plugins.BasePlugin","longname":"Phaser.Plugins.BasePlugin#stop","scope":"instance","___s":true},{"meta":{"filename":"BasePlugin.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Game instance has been destroyed.\nYou must release everything in here, all references, all objects, free it all up.","kind":"function","name":"destroy","since":"3.8.0","memberof":"Phaser.Plugins.BasePlugin","longname":"Phaser.Plugins.BasePlugin#destroy","scope":"instance","___s":true},{"meta":{"filename":"DefaultPlugins.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"kind":"typedef","name":"DefaultPlugins","type":{"names":["object"]},"properties":[{"type":{"names":["array"]},"description":"These are the Global Managers that are created by the Phaser.Game instance.","name":"Global"},{"type":{"names":["array"]},"description":"These are the core plugins that are installed into every Scene.Systems instance, no matter what.","name":"CoreScene"},{"type":{"names":["array"]},"description":"These plugins are created in Scene.Systems in addition to the CoreScenePlugins.","name":"DefaultScene"}],"memberof":"Phaser.Plugins","longname":"Phaser.Plugins.DefaultPlugins","scope":"static","___s":true},{"meta":{"filename":"DefaultPlugins.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"These are the Global Managers that are created by the Phaser.Game instance.\nThey are referenced from Scene.Systems so that plugins can use them.","name":"Global","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Plugins","longname":"Phaser.Plugins.Global","scope":"static","kind":"member","___s":true},{"meta":{"filename":"DefaultPlugins.js","lineno":38,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"These are the core plugins that are installed into every Scene.Systems instance, no matter what.\nThey are optionally exposed in the Scene as well (see the InjectionMap for details)\n\nThey are created in the order in which they appear in this array and EventEmitter is always first.","name":"CoreScene","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Plugins","longname":"Phaser.Plugins.CoreScene","scope":"static","kind":"member","___s":true},{"meta":{"filename":"DefaultPlugins.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"These plugins are created in Scene.Systems in addition to the CoreScenePlugins.\n\nYou can elect not to have these plugins by either creating a DefaultPlugins object as part\nof the Game Config, by creating a Plugins object as part of a Scene Config, or by modifying this array\nand building your own bundle.\n\nThey are optionally exposed in the Scene as well (see the InjectionMap for details)\n\nThey are always created in the order in which they appear in the array.","name":"DefaultScene","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Plugins","longname":"Phaser.Plugins.DefaultScene","scope":"static","kind":"member","___s":true},{"meta":{"filename":"PluginCache.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"kind":"namespace","name":"PluginCache","memberof":"Phaser.Plugins","longname":"Phaser.Plugins.PluginCache","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":21,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Static method called directly by the Core internal Plugins.\nKey is a reference used to get the plugin from the plugins object (i.e. InputPlugin)\nPlugin is the object to instantiate to create the plugin\nMapping is what the plugin is injected into the Scene.Systems as (i.e. input)","kind":"function","name":"register","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"A reference used to get this plugin from the plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"The plugin to be stored. Should be the core object, not instantiated.","name":"plugin"},{"type":{"names":["string"]},"description":"If this plugin is to be injected into the Scene Systems, this is the property key map used.","name":"mapping"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Core Scene plugin or a Custom Scene plugin?","name":"custom"}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.register","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":42,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Stores a custom plugin in the global plugin cache.\nThe key must be unique, within the scope of the cache.","kind":"function","name":"registerCustom","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"A reference used to get this plugin from the plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"The plugin to be stored. Should be the core object, not instantiated.","name":"plugin"},{"type":{"names":["string"]},"description":"If this plugin is to be injected into the Scene Systems, this is the property key map used.","name":"mapping"},{"type":{"names":["any"]},"nullable":true,"description":"A value to be passed to the plugin's `init` method.","name":"data"}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.registerCustom","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":59,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Checks if the given key is already being used in the core plugin cache.","kind":"function","name":"hasCore","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key to check for.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the key is already in use in the core cache, otherwise `false`."}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.hasCore","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":74,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Checks if the given key is already being used in the custom plugin cache.","kind":"function","name":"hasCustom","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key to check for.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the key is already in use in the custom cache, otherwise `false`."}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.hasCustom","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":89,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Returns the core plugin object from the cache based on the given key.","kind":"function","name":"getCore","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the core plugin to get.","name":"key"}],"returns":[{"type":{"names":["Phaser.Types.Plugins.CorePluginContainer"]},"description":"The core plugin object."}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.getCore","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":104,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Returns the custom plugin object from the cache based on the given key.","kind":"function","name":"getCustom","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the custom plugin to get.","name":"key"}],"returns":[{"type":{"names":["Phaser.Types.Plugins.CustomPluginContainer"]},"description":"The custom plugin object."}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.getCustom","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":119,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Returns an object from the custom cache based on the given key that can be instantiated.","kind":"function","name":"getCustomClass","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the custom plugin to get.","name":"key"}],"returns":[{"type":{"names":["function"]},"description":"The custom plugin object."}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.getCustomClass","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":134,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes a core plugin based on the given key.","kind":"function","name":"remove","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the core plugin to remove.","name":"key"}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.remove","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":150,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes a custom plugin based on the given key.","kind":"function","name":"removeCustom","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the custom plugin to remove.","name":"key"}],"memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.removeCustom","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":166,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes all Core Plugins.\n\nThis includes all of the internal system plugins that Phaser needs, like the Input Plugin and Loader Plugin.\nSo be sure you only call this if you do not wish to run Phaser again.","kind":"function","name":"destroyCorePlugins","since":"3.12.0","memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.destroyCorePlugins","scope":"static","___s":true},{"meta":{"filename":"PluginCache.js","lineno":186,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes all Custom Plugins.","kind":"function","name":"destroyCustomPlugins","since":"3.12.0","memberof":"Phaser.Plugins.PluginCache","longname":"Phaser.Plugins.PluginCache.destroyCustomPlugins","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"PluginManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"PluginManager.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"classdesc":"The PluginManager is responsible for installing and adding plugins to Phaser.\n\nIt is a global system and therefore belongs to the Game instance, not a specific Scene.\n\nIt works in conjunction with the PluginCache. Core internal plugins automatically register themselves \nwith the Cache, but it's the Plugin Manager that is responsible for injecting them into the Scenes.\n\nThere are two types of plugin:\n\n1. A Global Plugin\n2. A Scene Plugin\n\nA Global Plugin is a plugin that lives within the Plugin Manager rather than a Scene. You can get\naccess to it by calling `PluginManager.get` and providing a key. Any Scene that requests a plugin in\nthis way will all get access to the same plugin instance, allowing you to use a single plugin across\nmultiple Scenes.\n\nA Scene Plugin is a plugin dedicated to running within a Scene. These are different to Global Plugins\nin that their instances do not live within the Plugin Manager, but within the Scene Systems class instead.\nAnd that every Scene created is given its own unique instance of a Scene Plugin. Examples of core Scene\nPlugins include the Input Plugin, the Tween Plugin and the physics Plugins.\n\nYou can add a plugin to Phaser in three different ways:\n\n1. Preload it\n2. Include it in your source code and install it via the Game Config\n3. Include it in your source code and install it within a Scene\n\nFor examples of all of these approaches please see the Phaser 3 Examples Repo `plugins` folder.\n\nFor information on creating your own plugin please see the Phaser 3 Plugin Template.","kind":"class","name":"PluginManager","memberof":"Phaser.Plugins","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The game instance that owns this Plugin Manager.","name":"game"}],"scope":"static","longname":"Phaser.Plugins.PluginManager","___s":true},{"meta":{"filename":"PluginManager.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The game instance that owns this Plugin Manager.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PluginManager.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The global plugins currently running and managed by this Plugin Manager.\nA plugin must have been started at least once in order to appear in this list.","name":"plugins","type":{"names":["Array."]},"since":"3.8.0","memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#plugins","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PluginManager.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"A list of plugin keys that should be installed into Scenes as well as the Core Plugins.","name":"scenePlugins","type":{"names":["Array."]},"since":"3.8.0","memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#scenePlugins","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"PluginManager.js","lineno":327,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Installs a new Scene Plugin into the Plugin Manager and optionally adds it\nto the given Scene as well. A Scene Plugin added to the manager in this way\nwill be automatically installed into all new Scenes using the key and mapping given.\n\nThe `key` property is what the plugin is injected into Scene.Systems as.\nThe `mapping` property is optional, and if specified is what the plugin is installed into\nthe Scene as. For example:\n\n```javascript\nthis.plugins.installScenePlugin('powerupsPlugin', pluginCode, 'powerups');\n\n// and from within the scene:\nthis.sys.powerupsPlugin; // key value\nthis.powerups; // mapping value\n```\n\nThis method is called automatically by Phaser if you install your plugins using either the\nGame Configuration object, or by preloading them via the Loader.","kind":"function","name":"installScenePlugin","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The property key that will be used to add this plugin to Scene.Systems.","name":"key"},{"type":{"names":["function"]},"description":"The plugin code. This should be the non-instantiated version.","name":"plugin"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is injected into the Phaser.Scene class, this is the property key to use.","name":"mapping"},{"type":{"names":["Phaser.Scene"]},"optional":true,"description":"Optionally automatically add this plugin to the given Scene.","name":"addToScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this being called by the Loader?","name":"fromLoader"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#installScenePlugin","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":395,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Installs a new Global Plugin into the Plugin Manager and optionally starts it running.\nA global plugin belongs to the Plugin Manager, rather than a specific Scene, and can be accessed\nand used by all Scenes in your game.\n\nThe `key` property is what you use to access this plugin from the Plugin Manager.\n\n```javascript\nthis.plugins.install('powerupsPlugin', pluginCode);\n\n// and from within the scene:\nthis.plugins.get('powerupsPlugin');\n```\n\nThis method is called automatically by Phaser if you install your plugins using either the\nGame Configuration object, or by preloading them via the Loader.\n\nThe same plugin can be installed multiple times into the Plugin Manager by simply giving each\ninstance its own unique key.","kind":"function","name":"install","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The unique handle given to this plugin within the Plugin Manager.","name":"key"},{"type":{"names":["function"]},"description":"The plugin code. This should be the non-instantiated version.","name":"plugin"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Automatically start the plugin running? This is always `true` if you provide a mapping value.","name":"start"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is injected into the Phaser.Scene class, this is the property key to use.","name":"mapping"},{"type":{"names":["any"]},"optional":true,"description":"A value passed to the plugin's `init` method.","name":"data"}],"returns":[{"type":{"names":["Phaser.Plugins.BasePlugin"]},"nullable":true,"description":"The plugin that was started, or `null` if `start` was false, or game isn't yet booted."}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#install","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Checks if the given global plugin, based on its key, is active or not.","kind":"function","name":"isActive","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The unique plugin key.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the plugin is active, otherwise `false`."}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#isActive","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":533,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Starts a global plugin running.\n\nIf the plugin was previously active then calling `start` will reset it to an active state and then\ncall its `start` method.\n\nIf the plugin has never been run before a new instance of it will be created within the Plugin Manager,\nits active state set and then both of its `init` and `start` methods called, in that order.\n\nIf the plugin is already running under the given key then nothing happens.","kind":"function","name":"start","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the plugin to start.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"Run the plugin under a new key. This allows you to run one plugin multiple times.","name":"runAs"}],"returns":[{"type":{"names":["Phaser.Plugins.BasePlugin"]},"nullable":true,"description":"The plugin that was started, or `null` if invalid key given or plugin is already stopped."}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#start","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":610,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Stops a global plugin from running.\n\nIf the plugin is active then its active state will be set to false and the plugins `stop` method\nwill be called.\n\nIf the plugin is not already running, nothing will happen.","kind":"function","name":"stop","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the plugin to stop.","name":"key"}],"returns":[{"type":{"names":["Phaser.Plugins.PluginManager"]},"description":"The Plugin Manager."}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#stop","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":638,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Gets a global plugin from the Plugin Manager based on the given key and returns it.\n\nIf it cannot find an active plugin based on the key, but there is one in the Plugin Cache with the same key,\nthen it will create a new instance of the cached plugin and return that.","kind":"function","name":"get","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the plugin to get.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Automatically start a new instance of the plugin if found in the cache, but not actively running.","name":"autoStart"}],"returns":[{"type":{"names":["Phaser.Plugins.BasePlugin","function"]},"nullable":true,"description":"The plugin, or `null` if no plugin was found matching the key."}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#get","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":681,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Returns the plugin class from the cache.\nUsed internally by the Plugin Manager.","kind":"function","name":"getClass","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the plugin to get.","name":"key"}],"returns":[{"type":{"names":["Phaser.Plugins.BasePlugin"]},"description":"A Plugin object"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#getClass","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":697,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes a global plugin from the Plugin Manager and Plugin Cache.\n\nIt is up to you to remove all references to this plugin that you may hold within your game code.","kind":"function","name":"removeGlobalPlugin","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the plugin to remove.","name":"key"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#removeGlobalPlugin","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":719,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes a scene plugin from the Plugin Manager and Plugin Cache.\n\nThis will not remove the plugin from any active Scenes that are already using it.\n\nIt is up to you to remove all references to this plugin that you may hold within your game code.","kind":"function","name":"removeScenePlugin","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the plugin to remove.","name":"key"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#removeScenePlugin","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":738,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Registers a new type of Game Object with the global Game Object Factory and / or Creator.\nThis is usually called from within your Plugin code and is a helpful short-cut for creating\nnew Game Objects.\n\nThe key is the property that will be injected into the factories and used to create the\nGame Object. For example:\n\n```javascript\nthis.plugins.registerGameObject('clown', clownFactoryCallback, clownCreatorCallback);\n// later in your game code:\nthis.add.clown();\nthis.make.clown();\n```\n\nThe callbacks are what are called when the factories try to create a Game Object\nmatching the given key. It's important to understand that the callbacks are invoked within\nthe context of the GameObjectFactory. In this context there are several properties available\nto use:\n\nthis.scene - A reference to the Scene that owns the GameObjectFactory.\nthis.displayList - A reference to the Display List the Scene owns.\nthis.updateList - A reference to the Update List the Scene owns.\n\nSee the GameObjectFactory and GameObjectCreator classes for more details.\nAny public property or method listed is available from your callbacks under `this`.","kind":"function","name":"registerGameObject","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the Game Object that the given callbacks will create, i.e. `image`, `sprite`.","name":"key"},{"type":{"names":["function"]},"optional":true,"description":"The callback to invoke when the Game Object Factory is called.","name":"factoryCallback"},{"type":{"names":["function"]},"optional":true,"description":"The callback to invoke when the Game Object Creator is called.","name":"creatorCallback"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#registerGameObject","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":787,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Removes a previously registered Game Object from the global Game Object Factory and / or Creator.\nThis is usually called from within your Plugin destruction code to help clean-up after your plugin has been removed.","kind":"function","name":"removeGameObject","since":"3.19.0","params":[{"type":{"names":["string"]},"description":"The key of the Game Object to be removed from the factories.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the Game Object be removed from the Game Object Factory?","name":"removeFromFactory"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the Game Object be removed from the Game Object Creator?","name":"removeFromCreator"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#removeGameObject","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":816,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Registers a new file type with the global File Types Manager, making it available to all Loader\nPlugins created after this.\n\nThis is usually called from within your Plugin code and is a helpful short-cut for creating\nnew loader file types.\n\nThe key is the property that will be injected into the Loader Plugin and used to load the\nfiles. For example:\n\n```javascript\nthis.plugins.registerFileType('wad', doomWadLoaderCallback);\n// later in your preload code:\nthis.load.wad();\n```\n\nThe callback is what is called when the loader tries to load a file matching the given key.\nIt's important to understand that the callback is invoked within\nthe context of the LoaderPlugin. In this context there are several properties / methods available\nto use:\n\nthis.addFile - A method to add the new file to the load queue.\nthis.scene - The Scene that owns the Loader Plugin instance.\n\nSee the LoaderPlugin class for more details. Any public property or method listed is available from\nyour callback under `this`.","kind":"function","name":"registerFileType","since":"3.8.0","params":[{"type":{"names":["string"]},"description":"The key of the Game Object that the given callbacks will create, i.e. `image`, `sprite`.","name":"key"},{"type":{"names":["function"]},"description":"The callback to invoke when the Game Object Factory is called.","name":"callback"},{"type":{"names":["Phaser.Scene"]},"optional":true,"description":"Optionally add this file type into the Loader Plugin owned by the given Scene.","name":"addToScene"}],"memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#registerFileType","scope":"instance","___s":true},{"meta":{"filename":"PluginManager.js","lineno":860,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Destroys this Plugin Manager and all associated plugins.\nIt will iterate all plugins found and call their `destroy` methods.\n\nThe PluginCache will remove all custom plugins.","kind":"function","name":"destroy","since":"3.8.0","memberof":"Phaser.Plugins.PluginManager","longname":"Phaser.Plugins.PluginManager#destroy","scope":"instance","___s":true},{"meta":{"range":[215,251],"filename":"ScenePlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"name":"BasePlugin","longname":"BasePlugin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"classdesc":"A Scene Level Plugin is installed into every Scene and belongs to that Scene.\nIt can listen for Scene events and respond to them.\nIt can map itself to a Scene property, or into the Scene Systems, or both.","kind":"class","name":"ScenePlugin","memberof":"Phaser.Plugins","augments":["Phaser.Plugins.BasePlugin"],"since":"3.8.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that has installed this plugin.","name":"scene"},{"type":{"names":["Phaser.Plugins.PluginManager"]},"description":"A reference to the Plugin Manager.","name":"pluginManager"}],"scope":"static","longname":"Phaser.Plugins.ScenePlugin","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":65,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"This method is called when the Scene boots. It is only ever called once.\n\nBy this point the plugin properties `scene` and `systems` will have already been set.\n\nIn here you can listen for {@link Phaser.Scenes.Events Scene events} and set-up whatever you need for this plugin to run.\nHere are the Scene events you can listen to:\n\n- start\n- ready\n- preupdate\n- update\n- postupdate\n- resize\n- pause\n- resume\n- sleep\n- wake\n- transitioninit\n- transitionstart\n- transitioncomplete\n- transitionout\n- shutdown\n- destroy\n\nAt the very least you should offer a destroy handler for when the Scene closes down, i.e:\n\n```javascript\nvar eventEmitter = this.systems.events;\neventEmitter.once('destroy', this.sceneDestroy, this);\n```","kind":"function","name":"boot","since":"3.8.0","memberof":"Phaser.Plugins.ScenePlugin","longname":"Phaser.Plugins.ScenePlugin#boot","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":104,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"Game instance has been destroyed.\n\nYou must release everything in here, all references, all objects, free it all up.","kind":"function","name":"destroy","since":"3.8.0","memberof":"Phaser.Plugins.ScenePlugin","longname":"Phaser.Plugins.ScenePlugin#destroy","scope":"instance","overrides":"Phaser.Plugins.BasePlugin#destroy","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"kind":"namespace","name":"Plugins","memberof":"Phaser","longname":"Phaser.Plugins","scope":"static","___s":true},{"meta":{"filename":"CorePluginContainer.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins/typedefs"},"kind":"typedef","name":"CorePluginContainer","type":{"names":["object"]},"since":"3.8.0","properties":[{"type":{"names":["string"]},"description":"The unique name of this plugin in the core plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"The plugin to be stored. Should be the source object, not instantiated.","name":"plugin"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Scene Systems, this is the property key map used.","name":"mapping"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Core Scene plugin or a Custom Scene plugin?","name":"custom"}],"memberof":"Phaser.Types.Plugins","longname":"Phaser.Types.Plugins.CorePluginContainer","scope":"static","___s":true},{"meta":{"filename":"CustomPluginContainer.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins/typedefs"},"kind":"typedef","name":"CustomPluginContainer","type":{"names":["object"]},"since":"3.8.0","properties":[{"type":{"names":["string"]},"description":"The unique name of this plugin in the custom plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"The plugin to be stored. Should be the source object, not instantiated.","name":"plugin"}],"memberof":"Phaser.Types.Plugins","longname":"Phaser.Types.Plugins.CustomPluginContainer","scope":"static","___s":true},{"meta":{"filename":"GlobalPlugin.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins/typedefs"},"kind":"typedef","name":"GlobalPlugin","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The unique name of this plugin within the plugin cache.","name":"key"},{"type":{"names":["function"]},"description":"An instance of the plugin.","name":"plugin"},{"type":{"names":["boolean"]},"optional":true,"description":"Is the plugin active or not?","name":"active"},{"type":{"names":["string"]},"optional":true,"description":"If this plugin is to be injected into the Scene Systems, this is the property key map used.","name":"mapping"}],"memberof":"Phaser.Types.Plugins","longname":"Phaser.Types.Plugins.GlobalPlugin","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/plugins/typedefs"},"kind":"namespace","name":"Plugins","memberof":"Phaser.Types","longname":"Phaser.Types.Plugins","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Phaser Blend Modes.","kind":"namespace","name":"BlendModes","since":"3.0.0","memberof":"Phaser","longname":"Phaser.BlendModes","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Skips the Blend Mode check in the renderer.","name":"SKIP_CHECK","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SKIP_CHECK","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":26,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Normal blend mode. For Canvas and WebGL.\nThis is the default setting and draws new shapes on top of the existing canvas content.","name":"NORMAL","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.NORMAL","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Add blend mode. For Canvas and WebGL.\nWhere both shapes overlap the color is determined by adding color values.","name":"ADD","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.ADD","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Multiply blend mode. For Canvas and WebGL.\nThe pixels are of the top layer are multiplied with the corresponding pixel of the bottom layer. A darker picture is the result.","name":"MULTIPLY","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.MULTIPLY","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":59,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Screen blend mode. For Canvas and WebGL.\nThe pixels are inverted, multiplied, and inverted again. A lighter picture is the result (opposite of multiply)","name":"SCREEN","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SCREEN","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Overlay blend mode. For Canvas only.\nA combination of multiply and screen. Dark parts on the base layer become darker, and light parts become lighter.","name":"OVERLAY","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.OVERLAY","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Darken blend mode. For Canvas only.\nRetains the darkest pixels of both layers.","name":"DARKEN","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.DARKEN","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Lighten blend mode. For Canvas only.\nRetains the lightest pixels of both layers.","name":"LIGHTEN","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.LIGHTEN","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Color Dodge blend mode. For Canvas only.\nDivides the bottom layer by the inverted top layer.","name":"COLOR_DODGE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.COLOR_DODGE","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Color Burn blend mode. For Canvas only.\nDivides the inverted bottom layer by the top layer, and then inverts the result.","name":"COLOR_BURN","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.COLOR_BURN","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Hard Light blend mode. For Canvas only.\nA combination of multiply and screen like overlay, but with top and bottom layer swapped.","name":"HARD_LIGHT","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.HARD_LIGHT","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Soft Light blend mode. For Canvas only.\nA softer version of hard-light. Pure black or white does not result in pure black or white.","name":"SOFT_LIGHT","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SOFT_LIGHT","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Difference blend mode. For Canvas only.\nSubtracts the bottom layer from the top layer or the other way round to always get a positive value.","name":"DIFFERENCE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.DIFFERENCE","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Exclusion blend mode. For Canvas only.\nLike difference, but with lower contrast.","name":"EXCLUSION","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.EXCLUSION","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Hue blend mode. For Canvas only.\nPreserves the luma and chroma of the bottom layer, while adopting the hue of the top layer.","name":"HUE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.HUE","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Saturation blend mode. For Canvas only.\nPreserves the luma and hue of the bottom layer, while adopting the chroma of the top layer.","name":"SATURATION","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SATURATION","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Color blend mode. For Canvas only.\nPreserves the luma of the bottom layer, while adopting the hue and chroma of the top layer.","name":"COLOR","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.COLOR","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Luminosity blend mode. For Canvas only.\nPreserves the hue and chroma of the bottom layer, while adopting the luma of the top layer.","name":"LUMINOSITY","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.LUMINOSITY","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Alpha erase blend mode. For Canvas and WebGL.","name":"ERASE","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.ERASE","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":223,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Source-in blend mode. For Canvas only.\nThe new shape is drawn only where both the new shape and the destination canvas overlap. Everything else is made transparent.","name":"SOURCE_IN","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SOURCE_IN","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":234,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Source-out blend mode. For Canvas only.\nThe new shape is drawn where it doesn't overlap the existing canvas content.","name":"SOURCE_OUT","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SOURCE_OUT","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Source-out blend mode. For Canvas only.\nThe new shape is only drawn where it overlaps the existing canvas content.","name":"SOURCE_ATOP","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.SOURCE_ATOP","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Destination-over blend mode. For Canvas only.\nNew shapes are drawn behind the existing canvas content.","name":"DESTINATION_OVER","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.DESTINATION_OVER","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":267,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Destination-in blend mode. For Canvas only.\nThe existing canvas content is kept where both the new shape and existing canvas content overlap. Everything else is made transparent.","name":"DESTINATION_IN","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.DESTINATION_IN","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Destination-out blend mode. For Canvas only.\nThe existing content is kept where it doesn't overlap the new shape.","name":"DESTINATION_OUT","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.DESTINATION_OUT","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":289,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Destination-out blend mode. For Canvas only.\nThe existing canvas is only kept where it overlaps the new shape. The new shape is drawn behind the canvas content.","name":"DESTINATION_ATOP","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.DESTINATION_ATOP","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Lighten blend mode. For Canvas only.\nWhere both shapes overlap the color is determined by adding color values.","name":"LIGHTER","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.LIGHTER","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":311,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Copy blend mode. For Canvas only.\nOnly the new shape is shown.","name":"COPY","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.COPY","scope":"static","___s":true},{"meta":{"filename":"BlendModes.js","lineno":322,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Xor blend mode. For Canvas only.\nShapes are made transparent where both overlap and drawn normal everywhere else.","name":"XOR","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.BlendModes","longname":"Phaser.BlendModes.XOR","scope":"static","___s":true},{"meta":{"filename":"ScaleModes.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Phaser Scale Modes.","kind":"namespace","name":"ScaleModes","since":"3.0.0","memberof":"Phaser","longname":"Phaser.ScaleModes","scope":"static","___s":true},{"meta":{"filename":"ScaleModes.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Default Scale Mode (Linear).","name":"DEFAULT","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.ScaleModes","longname":"Phaser.ScaleModes.DEFAULT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"ScaleModes.js","lineno":26,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Linear Scale Mode.","name":"LINEAR","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.ScaleModes","longname":"Phaser.ScaleModes.LINEAR","scope":"static","kind":"member","___s":true},{"meta":{"filename":"ScaleModes.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"description":"Nearest Scale Mode.","name":"NEAREST","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.ScaleModes","longname":"Phaser.ScaleModes.NEAREST","scope":"static","kind":"member","___s":true},{"meta":{"range":[225,279],"filename":"CanvasRenderer.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"name":"CanvasSnapshot","longname":"CanvasSnapshot","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"classdesc":"The Canvas Renderer is responsible for managing 2D canvas rendering contexts, including the one used by the Game's canvas. It tracks the internal state of a given context and can renderer textured Game Objects to it, taking into account alpha, blending, and scaling.","kind":"class","name":"CanvasRenderer","memberof":"Phaser.Renderer.Canvas","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Phaser Game instance that owns this renderer.","name":"game"}],"scope":"static","longname":"Phaser.Renderer.Canvas.CanvasRenderer","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":33,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The Phaser Game instance that owns this renderer.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"A constant which allows the renderer to be easily identified as a Canvas Renderer.","name":"type","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The total number of Game Objects which were rendered in a frame.","name":"drawCount","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#drawCount","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The width of the canvas being rendered to.","name":"width","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The height of the canvas being rendered to.","name":"height","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The local configuration settings of the CanvasRenderer.","name":"config","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The canvas element which the Game uses.","name":"gameCanvas","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#gameCanvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The canvas context used to render all Cameras in all Scenes during the game loop.","name":"gameContext","type":{"names":["CanvasRenderingContext2D"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#gameContext","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The canvas context currently used by the CanvasRenderer for all rendering operations.","name":"currentContext","type":{"names":["CanvasRenderingContext2D"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#currentContext","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Should the Canvas use Image Smoothing or not when drawing Sprites?","name":"antialias","type":{"names":["boolean"]},"since":"3.20.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#antialias","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The blend modes supported by the Canvas Renderer.\n\nThis object maps the {@link Phaser.BlendModes} to canvas compositing operations.","name":"blendModes","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#blendModes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":146,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Details about the currently scheduled snapshot.\n\nIf a non-null `callback` is set in this object, a snapshot of the canvas will be taken after the current frame is fully rendered.","name":"snapshotState","type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotState"]},"since":"3.16.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#snapshotState","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":209,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Prepares the game canvas for rendering.","kind":"function","name":"init","since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#init","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":224,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"The event handler that manages the `resize` event dispatched by the Scale Manager.","kind":"function","name":"onResize","since":"3.16.0","params":[{"type":{"names":["Phaser.Structs.Size"]},"description":"The default Game Size object. This is the un-modified game dimensions.","name":"gameSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"The base Size object. The game dimensions multiplied by the resolution. The canvas width / height values match this.","name":"baseSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"The display Size object. The size of the canvas style width / height attributes.","name":"displaySize"},{"type":{"names":["number"]},"optional":true,"description":"The Scale Manager resolution setting.","name":"resolution"}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#onResize","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":244,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Resize the main game canvas.","kind":"function","name":"resize","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The new width of the renderer.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The new height of the renderer.","name":"height"}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#resize","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Resets the transformation matrix of the current context to the identity matrix, thus resetting any transformation.","kind":"function","name":"resetTransform","since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#resetTransform","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Sets the blend mode (compositing operation) of the current context.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The new blend mode which should be used.","name":"blendMode"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"This CanvasRenderer object."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#setBlendMode","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Changes the Canvas Rendering Context that all draw operations are performed against.","kind":"function","name":"setContext","since":"3.12.0","params":[{"type":{"names":["CanvasRenderingContext2D"]},"optional":true,"nullable":true,"description":"The new Canvas Rendering Context to draw everything to. Leave empty to reset to the Game Canvas.","name":"ctx"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"The Canvas Renderer instance."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#setContext","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":304,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Sets the global alpha of the current context.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new alpha to use, where 0 is fully transparent and 1 is fully opaque.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"This CanvasRenderer object."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#setAlpha","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Called at the start of the render loop.","kind":"function","name":"preRender","since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#preRender","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Renders the Scene to the given Camera.","kind":"function","name":"render","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to render.","name":"scene"},{"type":{"names":["Phaser.GameObjects.DisplayList"]},"description":"The Game Objects within the Scene to be rendered.","name":"children"},{"type":{"names":["number"]},"description":"The interpolation percentage to apply. Currently unused.","name":"interpolationPercentage"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Scene Camera to render with.","name":"camera"}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#render","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":463,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Restores the game context's global settings and takes a snapshot if one is scheduled.\n\nThe post-render step happens after all Cameras in all Scenes have been rendered.","kind":"function","name":"postRender","since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#postRender","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":487,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Takes a snapshot of the given area of the given canvas.\n\nUnlike the other snapshot methods, this one is processed immediately and doesn't wait for the next render.\n\nSnapshots work by creating an Image object from the canvas data, this is a blocking process, which gets\nmore expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshotCanvas","since":"3.19.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas to grab from.","name":"canvas"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Grab a single pixel as a Color object, or an area as an Image object?","name":"getPixel"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate to grab from.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate to grab from.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"canvas.width","description":"The width of the area to grab.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"canvas.height","description":"The height of the area to grab.","name":"height"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"This Canvas Renderer."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#snapshotCanvas","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":527,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Schedules a snapshot of the entire game viewport to be taken after the current frame is rendered.\n\nTo capture a specific area see the `snapshotArea` method. To capture a specific pixel, see `snapshotPixel`.\n\nOnly one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\ncalling this method will override it.\n\nSnapshots work by creating an Image object from the canvas data, this is a blocking process, which gets\nmore expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshot","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#snapshot","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":552,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Schedules a snapshot of the given area of the game viewport to be taken after the current frame is rendered.\n\nTo capture the whole game viewport see the `snapshot` method. To capture a specific pixel, see `snapshotPixel`.\n\nOnly one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\ncalling this method will override it.\n\nSnapshots work by creating an Image object from the canvas data, this is a blocking process, which gets\nmore expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshotArea","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate to grab from.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate to grab from.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the area to grab.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the area to grab.","name":"height"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#snapshotArea","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":592,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Schedules a snapshot of the given pixel from the game viewport to be taken after the current frame is rendered.\n\nTo capture the whole game viewport see the `snapshot` method. To capture a specific area, see `snapshotArea`.\n\nOnly one snapshot can be active _per frame_. If you have already called `snapshotArea`, for example, then\ncalling this method will override it.\n\nUnlike the other two snapshot methods, this one will return a `Color` object containing the color data for\nthe requested pixel. It doesn't need to create an internal Canvas or Image object, so is a lot faster to execute,\nusing less memory.","kind":"function","name":"snapshotPixel","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel to get.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel to get.","name":"y"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot pixel data is extracted.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#snapshotPixel","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":622,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Takes a Sprite Game Object, or any object that extends it, and draws it to the current context.","kind":"function","name":"batchSprite","since":"3.12.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The texture based Game Object to draw.","name":"sprite"},{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to draw, doesn't have to be that owned by the Game Object.","name":"frame"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to use for the rendering transform.","name":"camera"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The transform matrix of the parent container, if set.","name":"parentTransformMatrix"}],"memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#batchSprite","scope":"instance","___s":true},{"meta":{"filename":"CanvasRenderer.js","lineno":772,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"description":"Destroys all object references in the Canvas Renderer.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Renderer.Canvas.CanvasRenderer","longname":"Phaser.Renderer.Canvas.CanvasRenderer#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas"},"kind":"namespace","name":"Canvas","memberof":"Phaser.Renderer","longname":"Phaser.Renderer.Canvas","scope":"static","___s":true},{"meta":{"range":[180,215],"filename":"GetBlendModes.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas/utils"},"name":"modes","longname":"modes","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetBlendModes.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas/utils"},"description":"Returns an array which maps the default blend modes to supported Canvas blend modes.\n\nIf the browser doesn't support a blend mode, it will default to the normal `source-over` blend mode.","kind":"function","name":"GetBlendModes","since":"3.0.0","returns":[{"type":{"names":["array"]},"description":"Which Canvas blend mode corresponds to which default Phaser blend mode."}],"memberof":"Phaser.Renderer.Canvas","longname":"Phaser.Renderer.Canvas.GetBlendModes","scope":"static","___s":true},{"meta":{"filename":"SetTransform.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/canvas/utils"},"description":"Takes a reference to the Canvas Renderer, a Canvas Rendering Context, a Game Object, a Camera and a parent matrix\nand then performs the following steps:\n\n1. Checks the alpha of the source combined with the Camera alpha. If 0 or less it aborts.\n2. Takes the Camera and Game Object matrix and multiplies them, combined with the parent matrix if given.\n3. Sets the blend mode of the context to be that used by the Game Object.\n4. Sets the alpha value of the context to be that used by the Game Object combined with the Camera.\n5. Saves the context state.\n6. Sets the final matrix values into the context via setTransform.\n7. If Renderer.antialias, or the frame.source.scaleMode is set, then imageSmoothingEnabled is set.\n\nThis function is only meant to be used internally. Most of the Canvas Renderer classes use it.","kind":"function","name":"SetTransform","since":"3.12.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer"]},"description":"A reference to the current active Canvas renderer.","name":"renderer"},{"type":{"names":["CanvasRenderingContext2D"]},"description":"The canvas context to set the transform on.","name":"ctx"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object being rendered. Can be any type that extends the base class.","name":"src"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera that is rendering the Game Object.","name":"camera"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A parent transform matrix to apply to the Game Object before rendering.","name":"parentMatrix"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Game Object context was set, otherwise `false`."}],"memberof":"Phaser.Renderer.Canvas","longname":"Phaser.Renderer.Canvas.SetTransform","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"kind":"namespace","name":"Renderer","memberof":"Phaser","longname":"Phaser.Renderer","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer"},"kind":"namespace","name":"Renderer","memberof":"Phaser.Types","longname":"Phaser.Types.Renderer","scope":"static","___s":true},{"meta":{"range":[180,235],"filename":"CanvasSnapshot.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CanvasSnapshot.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot"},"description":"Takes a snapshot of an area from the current frame displayed by a canvas.\n\nThis is then copied to an Image object. When this loads, the results are sent\nto the callback provided in the Snapshot Configuration object.","kind":"function","name":"Canvas","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas to take a snapshot of.","name":"sourceCanvas"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotState"]},"description":"The snapshot configuration object.","name":"config"}],"memberof":"Phaser.Renderer.Snapshot","longname":"Phaser.Renderer.Snapshot.Canvas","scope":"static","___s":true},{"meta":{"range":[180,235],"filename":"WebGLSnapshot.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WebGLSnapshot.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot"},"description":"Takes a snapshot of an area from the current frame displayed by a WebGL canvas.\n\nThis is then copied to an Image object. When this loads, the results are sent\nto the callback provided in the Snapshot Configuration object.","kind":"function","name":"WebGL","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas to take a snapshot of.","name":"sourceCanvas"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotState"]},"description":"The snapshot configuration object.","name":"config"}],"memberof":"Phaser.Renderer.Snapshot","longname":"Phaser.Renderer.Snapshot.WebGL","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot"},"kind":"namespace","name":"Snapshot","memberof":"Phaser.Renderer","longname":"Phaser.Renderer.Snapshot","scope":"static","___s":true},{"meta":{"filename":"SnapshotCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/typedefs"},"kind":"typedef","name":"SnapshotCallback","type":{"names":["function"]},"since":"3.16.1","params":[{"type":{"names":["Phaser.Display.Color","HTMLImageElement"]},"description":"Either a Color object if a single pixel is being grabbed, or a new Image which contains a snapshot of the canvas contents.","name":"snapshot"}],"memberof":"Phaser.Types.Renderer.Snapshot","longname":"Phaser.Types.Renderer.Snapshot.SnapshotCallback","scope":"static","___s":true},{"meta":{"filename":"SnapshotState.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/typedefs"},"kind":"typedef","name":"SnapshotState","type":{"names":["object"]},"since":"3.16.1","properties":[{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The function to call after the snapshot is taken.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate to start the snapshot from.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate to start the snapshot from.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the snapshot.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the snapshot.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this a snapshot to get a single pixel, or an area?","name":"getPixel"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this snapshot grabbing from a frame buffer or a canvas?","name":"isFramebuffer"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the frame buffer, if a frame buffer grab.","name":"bufferWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the frame buffer, if a frame buffer grab.","name":"bufferHeight"}],"memberof":"Phaser.Types.Renderer.Snapshot","longname":"Phaser.Types.Renderer.Snapshot.SnapshotState","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/typedefs"},"kind":"namespace","name":"Snapshot","memberof":"Phaser.Types.Renderer","longname":"Phaser.Types.Renderer.Snapshot","scope":"static","___s":true},{"meta":{"filename":"Utils.js","lineno":8,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"kind":"namespace","name":"Utils","since":"3.0.0","memberof":"Phaser.Renderer.WebGL","longname":"Phaser.Renderer.WebGL.Utils","scope":"static","___s":true},{"meta":{"filename":"Utils.js","lineno":14,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Packs four floats on a range from 0.0 to 1.0 into a single Uint32","kind":"function","name":"getTintFromFloats","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Red component in a range from 0.0 to 1.0","name":"r"},{"type":{"names":["number"]},"description":"Green component in a range from 0.0 to 1.0","name":"g"},{"type":{"names":["number"]},"description":"Blue component in a range from 0.0 to 1.0","name":"b"},{"type":{"names":["number"]},"description":"Alpha component in a range from 0.0 to 1.0","name":"a"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Renderer.WebGL.Utils","longname":"Phaser.Renderer.WebGL.Utils.getTintFromFloats","scope":"static","___s":true},{"meta":{"filename":"Utils.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Packs a Uint24, representing RGB components, with a Float32, representing\nthe alpha component, with a range between 0.0 and 1.0 and return a Uint32","kind":"function","name":"getTintAppendFloatAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Uint24 representing RGB components","name":"rgb"},{"type":{"names":["number"]},"description":"Float32 representing Alpha component","name":"a"}],"returns":[{"type":{"names":["number"]},"description":"Packed RGBA as Uint32"}],"memberof":"Phaser.Renderer.WebGL.Utils","longname":"Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlpha","scope":"static","___s":true},{"meta":{"filename":"Utils.js","lineno":55,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Packs a Uint24, representing RGB components, with a Float32, representing\nthe alpha component, with a range between 0.0 and 1.0 and return a \nswizzled Uint32","kind":"function","name":"getTintAppendFloatAlphaAndSwap","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Uint24 representing RGB components","name":"rgb"},{"type":{"names":["number"]},"description":"Float32 representing Alpha component","name":"a"}],"returns":[{"type":{"names":["number"]},"description":"Packed RGBA as Uint32"}],"memberof":"Phaser.Renderer.WebGL.Utils","longname":"Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlphaAndSwap","scope":"static","___s":true},{"meta":{"filename":"Utils.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Unpacks a Uint24 RGB into an array of floats of ranges of 0.0 and 1.0","kind":"function","name":"getFloatsFromUintRGB","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"RGB packed as a Uint24","name":"rgb"}],"returns":[{"type":{"names":["array"]},"description":"Array of floats representing each component as a float"}],"memberof":"Phaser.Renderer.WebGL.Utils","longname":"Phaser.Renderer.WebGL.Utils.getFloatsFromUintRGB","scope":"static","___s":true},{"meta":{"filename":"Utils.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Counts how many attributes of 32 bits a vertex has","kind":"function","name":"getComponentCount","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"Array of attributes","name":"attributes"},{"type":{"names":["WebGLRenderingContext"]},"description":"WebGLContext used for check types","name":"glContext"}],"returns":[{"type":{"names":["number"]},"description":"Count of 32 bit attributes in vertex"}],"memberof":"Phaser.Renderer.WebGL.Utils","longname":"Phaser.Renderer.WebGL.Utils.getComponentCount","scope":"static","___s":true},{"meta":{"range":[225,261],"filename":"WebGLPipeline.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"classdesc":"WebGLPipeline is a class that describes the way elements will be renderered\nin WebGL, specially focused on batching vertices (batching is not provided).\nPipelines are mostly used for describing 2D rendering passes but it's\nflexible enough to be used for any type of rendering including 3D.\nInternally WebGLPipeline will handle things like compiling shaders,\ncreating vertex buffers, assigning primitive topology and binding\nvertex attributes.\n\nThe config properties are:\n- game: Current game instance.\n- renderer: Current WebGL renderer.\n- gl: Current WebGL context.\n- topology: This indicates how the primitives are rendered. The default value is GL_TRIANGLES.\n Here is the full list of rendering primitives (https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Constants).\n- vertShader: Source for vertex shader as a string.\n- fragShader: Source for fragment shader as a string.\n- vertexCapacity: The amount of vertices that shall be allocated\n- vertexSize: The size of a single vertex in bytes.\n- vertices: An optional buffer of vertices\n- attributes: An array describing the vertex attributes\n\nThe vertex attributes properties are:\n- name : String - Name of the attribute in the vertex shader\n- size : integer - How many components describe the attribute. For ex: vec3 = size of 3, float = size of 1\n- type : GLenum - WebGL type (gl.BYTE, gl.SHORT, gl.UNSIGNED_BYTE, gl.UNSIGNED_SHORT, gl.FLOAT)\n- normalized : boolean - Is the attribute normalized\n- offset : integer - The offset in bytes to the current attribute in the vertex. Equivalent to offsetof(vertex, attrib) in C\nHere you can find more information of how to describe an attribute:\n- https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/vertexAttribPointer","kind":"class","name":"WebGLPipeline","memberof":"Phaser.Renderer.WebGL","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object for this WebGL Pipeline, as described above.","name":"config"}],"scope":"static","longname":"Phaser.Renderer.WebGL.WebGLPipeline","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Name of the Pipeline. Used for identifying","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The Game which owns this WebGL Pipeline.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The canvas which this WebGL Pipeline renders to.","name":"view","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#view","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Used to store the current game resolution","name":"resolution","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#resolution","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Width of the current viewport","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Height of the current viewport","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL context this WebGL Pipeline uses.","name":"gl","type":{"names":["WebGLRenderingContext"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#gl","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"How many vertices have been fed to the current pipeline.","name":"vertexCount","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCount","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The limit of vertices that the pipeline can hold","name":"vertexCapacity","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL Renderer which owns this WebGL Pipeline.","name":"renderer","type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Raw byte buffer of vertices.","name":"vertexData","type":{"names":["ArrayBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#vertexData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL vertex buffer object.","name":"vertexBuffer","type":{"names":["WebGLBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL program","name":"program","type":{"names":["WebGLProgram"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#program","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Array of objects that describe the vertex attributes","name":"attributes","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#attributes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The size in bytes of the vertex","name":"vertexSize","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#vertexSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The primitive topology which the pipeline will use to submit draw calls","name":"topology","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#topology","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":201,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Uint8 view to the vertex raw buffer. Used for uploading vertex buffer resources\nto the GPU.","name":"bytes","type":{"names":["Uint8Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#bytes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"This will store the amount of components of 32 bit length","name":"vertexComponentCount","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#vertexComponentCount","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is flushing the contents to the GPU.\nWhen the variable is set the flush function will be locked.","name":"flushLocked","type":{"names":["boolean"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#flushLocked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":230,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is active or not for this frame only.\nReset in the onRender method.","name":"active","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#active","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called when the Game has fully booted and the Renderer has finished setting up.\n\nBy this stage all Game level systems are now in place and you can perform any final\ntasks that the pipeline may need that relied on game systems such as the Texture Manager.","kind":"function","name":"boot","since":"3.11.0","memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#boot","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Adds a description of vertex attribute to the pipeline","kind":"function","name":"addAttribute","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"Name of the vertex attribute","name":"name"},{"type":{"names":["integer"]},"description":"Vertex component size","name":"size"},{"type":{"names":["integer"]},"description":"Type of the attribute","name":"type"},{"type":{"names":["boolean"]},"description":"Is the value normalized to a range","name":"normalized"},{"type":{"names":["integer"]},"description":"Byte offset to the beginning of the first element in the vertex","name":"offset"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#addAttribute","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":285,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Check if the current batch of vertices is full.","kind":"function","name":"shouldFlush","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the current batch should be flushed, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Resizes the properties used to describe the viewport","kind":"function","name":"resize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new width of this WebGL Pipeline.","name":"width"},{"type":{"names":["number"]},"description":"The new height of this WebGL Pipeline.","name":"height"},{"type":{"names":["number"]},"description":"The resolution this WebGL Pipeline should be resized to.","name":"resolution"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#resize","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds the pipeline resources, including programs, vertex buffers and binds attributes","kind":"function","name":"bind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#bind","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":358,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set whenever this WebGL Pipeline is bound to a WebGL Renderer.\n\nThis method is called every time the WebGL Pipeline is attempted to be bound, even if it already is the current pipeline.","kind":"function","name":"onBind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#onBind","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":374,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before each frame is rendered, but after the canvas has been cleared.","kind":"function","name":"onPreRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#onPreRender","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":388,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before a Scene's Camera is rendered.","kind":"function","name":"onRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene being rendered.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Scene Camera being rendered with.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#onRender","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":405,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called after each frame has been completely rendered and snapshots have been taken.","kind":"function","name":"onPostRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#onPostRender","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":419,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Uploads the vertex data and emits a draw call\nfor the current batch of vertices.","kind":"function","name":"flush","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#flush","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":454,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes all object references in this WebGL Pipeline and removes its program from the WebGL context.","kind":"function","name":"destroy","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#destroy","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new value of the `float` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec2` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec3` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec3` uniform.","name":"y"},{"type":{"names":["number"]},"description":"The new Z component of the `vec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":533,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["number"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["number"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["number"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1v","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":572,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2v","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3v","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4v","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new value of the `int` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setInt1","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":644,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec2` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setInt2","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":663,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec3` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec3` uniform.","name":"y"},{"type":{"names":["integer"]},"description":"The new Z component of the `ivec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setInt3","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["integer"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["integer"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["integer"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setInt4","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":704,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat2` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat3` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3","scope":"instance","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Should the matrix be transpose","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"Matrix data","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLPipeline","longname":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4","scope":"instance","___s":true},{"meta":{"range":[225,276],"filename":"WebGLRenderer.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"name":"BaseCamera","longname":"BaseCamera","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":27,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"kind":"typedef","name":"WebGLContextCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The WebGL Renderer which owns the context.","name":"renderer"}],"longname":"WebGLContextCallback","scope":"global","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":33,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"classdesc":"WebGLRenderer is a class that contains the needed functionality to keep the\nWebGLRenderingContext state clean. The main idea of the WebGLRenderer is to keep track of\nany context change that happens for WebGL rendering inside of Phaser. This means\nif raw webgl functions are called outside the WebGLRenderer of the Phaser WebGL\nrendering ecosystem they might pollute the current WebGLRenderingContext state producing\nunexpected behavior. It's recommended that WebGL interaction is done through\nWebGLRenderer and/or WebGLPipeline.","kind":"class","name":"WebGLRenderer","memberof":"Phaser.Renderer.WebGL","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Game instance which owns this WebGL Renderer.","name":"game"}],"scope":"static","longname":"Phaser.Renderer.WebGL.WebGLRenderer","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The local configuration settings of this WebGL Renderer.","name":"config","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":90,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The Game instance which owns this WebGL Renderer.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"A constant which allows the renderer to be easily identified as a WebGL Renderer.","name":"type","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The width of the canvas being rendered to.\nThis is populated in the onResize event handler.","name":"width","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The height of the canvas being rendered to.\nThis is populated in the onResize event handler.","name":"height","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The canvas which this WebGL Renderer draws to.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"An array of blend modes supported by the WebGL Renderer.\n\nThis array includes the default blend modes as well as any custom blend modes added through {@link #addBlendMode}.","name":"blendModes","type":{"names":["array"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#blendModes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":149,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Keeps track of any WebGLTexture created with the current WebGLRenderingContext","name":"nativeTextures","type":{"names":["array"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#nativeTextures","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"This property is set to `true` if the WebGL context of the renderer is lost.","name":"contextLost","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#contextLost","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":169,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"This object will store all pipelines created through addPipeline","name":"pipelines","type":{"names":["object"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#pipelines","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":179,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Details about the currently scheduled snapshot.\n\nIf a non-null `callback` is set in this object, a snapshot of the canvas will be taken after the current frame is fully rendered.","name":"snapshotState","type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotState"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#snapshotState","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":204,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Cached value for the last texture unit that was used","name":"currentActiveTextureUnit","type":{"names":["integer"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentActiveTextureUnit","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":213,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"An array of the last texture handles that were bound to the WebGLRenderingContext","name":"currentTextures","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentTextures","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":222,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Current framebuffer in use","name":"currentFramebuffer","type":{"names":["WebGLFramebuffer"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentFramebuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":232,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Current WebGLPipeline in use","name":"currentPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentPipeline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":242,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Current WebGLProgram in use","name":"currentProgram","type":{"names":["WebGLProgram"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentProgram","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":252,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Current WebGLBuffer (Vertex buffer) in use","name":"currentVertexBuffer","type":{"names":["WebGLBuffer"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentVertexBuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":262,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Current WebGLBuffer (Index buffer) in use","name":"currentIndexBuffer","type":{"names":["WebGLBuffer"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentIndexBuffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":272,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Current blend mode in use","name":"currentBlendMode","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentBlendMode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":281,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the the scissor state is enabled in WebGLRenderingContext","name":"currentScissorEnabled","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentScissorEnabled","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":291,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Stores the current scissor data","name":"currentScissor","type":{"names":["Uint32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentScissor","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":300,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Stack of scissor data","name":"scissorStack","type":{"names":["Uint32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#scissorStack","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":309,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handler to invoke when the context is lost.\nThis should not be changed and is set in the boot method.","name":"contextLostHandler","type":{"names":["function"]},"since":"3.19.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#contextLostHandler","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":319,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handler to invoke when the context is restored.\nThis should not be changed and is set in the boot method.","name":"contextRestoredHandler","type":{"names":["function"]},"since":"3.19.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#contextRestoredHandler","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":329,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The underlying WebGL context of the renderer.","name":"gl","type":{"names":["WebGLRenderingContext"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#gl","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":339,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Array of strings that indicate which WebGL extensions are supported by the browser","name":"supportedExtensions","type":{"names":["object"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#supportedExtensions","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":349,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Extensions loaded into the current context","name":"extensions","type":{"names":["object"]},"defaultvalue":"{}","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#extensions","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":359,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Stores the current WebGL component formats for further use","name":"glFormats","type":{"names":["array"]},"defaultvalue":"[]","since":"3.2.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#glFormats","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":369,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Stores the supported WebGL texture compression formats.","name":"compression","type":{"names":["array"]},"since":"3.8.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#compression","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":382,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Cached drawing buffer height to reduce gl calls.","name":"drawingBufferHeight","type":{"names":["number"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#drawingBufferHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":392,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"A blank 32x32 transparent texture, as used by the Graphics system where needed.\nThis is set in the `boot` method.","name":"blankTexture","type":{"names":["WebGLTexture"]},"readonly":true,"since":"3.12.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#blankTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":403,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"A default Camera used in calls when no other camera has been provided.","name":"defaultCamera","type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"since":"3.12.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#defaultCamera","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":452,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The total number of masks currently stacked.","name":"maskCount","type":{"names":["integer"]},"since":"3.17.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#maskCount","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":461,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The mask stack.","name":"maskStack","type":{"names":["Array."]},"since":"3.17.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#maskStack","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":470,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Internal property that tracks the currently set mask.","name":"currentMask","type":{"names":["any"]},"since":"3.17.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentMask","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":479,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Internal property that tracks the currently set camera mask.","name":"currentCameraMask","type":{"names":["any"]},"since":"3.17.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentCameraMask","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":488,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Internal gl function mapping for uniform look-up.\nhttps://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/uniform","name":"glFuncMap","type":{"names":["any"]},"since":"3.17.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#glFuncMap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":498,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The `type` of the Game Object being currently rendered.\nThis can be used by advanced render functions for batching look-ahead.","name":"currentType","type":{"names":["string"]},"since":"3.19.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#currentType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":508,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Is the `type` of the Game Object being currently rendered different than the\ntype of the object before it in the display list? I.e. it's a 'new' type.","name":"newType","type":{"names":["boolean"]},"since":"3.19.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#newType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":518,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Does the `type` of the next Game Object in the display list match that\nof the object being currently rendered?","name":"nextTypeMatch","type":{"names":["boolean"]},"since":"3.19.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#nextTypeMatch","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":528,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The mipmap magFilter to be used when creating textures.\n\nYou can specify this as a string in the game config, i.e.:\n\n`renderer: { mipmapFilter: 'NEAREST_MIPMAP_LINEAR' }`\n\nThe 6 options for WebGL1 are, in order from least to most computationally expensive:\n\nNEAREST (for pixel art)\nLINEAR (the default)\nNEAREST_MIPMAP_NEAREST\nLINEAR_MIPMAP_NEAREST\nNEAREST_MIPMAP_LINEAR\nLINEAR_MIPMAP_LINEAR\n\nMipmaps only work with textures that are fully power-of-two in size.\n\nFor more details see https://webglfundamentals.org/webgl/lessons/webgl-3d-textures.html","name":"mipmapFilter","type":{"names":["GLenum"]},"since":"3.21.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#mipmapFilter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":557,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Creates a new WebGLRenderingContext and initializes all internal state.","kind":"function","name":"init","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object for the renderer.","name":"config"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#init","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":759,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The event handler that manages the `resize` event dispatched by the Scale Manager.","kind":"function","name":"onResize","since":"3.16.0","params":[{"type":{"names":["Phaser.Structs.Size"]},"description":"The default Game Size object. This is the un-modified game dimensions.","name":"gameSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"The base Size object. The game dimensions multiplied by the resolution. The canvas width / height values match this.","name":"baseSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"The display Size object. The size of the canvas style width / height attributes.","name":"displaySize"},{"type":{"names":["number"]},"optional":true,"description":"The Scale Manager resolution setting.","name":"resolution"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#onResize","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":779,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Resizes the drawing buffer to match that required by the Scale Manager.","kind":"function","name":"resize","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The new width of the renderer.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The new height of the renderer.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The new resolution of the renderer.","name":"resolution"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#resize","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":817,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Checks if a WebGL extension is supported","kind":"function","name":"hasExtension","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Name of the WebGL extension","name":"extensionName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the extension is supported, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#hasExtension","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":832,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Loads a WebGL extension","kind":"function","name":"getExtension","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the extension to load.","name":"extensionName"}],"returns":[{"type":{"names":["object"]},"description":"WebGL extension if the extension is supported"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#getExtension","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":854,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Flushes the current pipeline if the pipeline is bound","kind":"function","name":"flush","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#flush","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":868,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Checks if a pipeline is present in the current WebGLRenderer","kind":"function","name":"hasPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the given pipeline is loaded, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#hasPipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":883,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Returns the pipeline by name if the pipeline exists","kind":"function","name":"getPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"The pipeline instance, or `null` if not found."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#getPipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":898,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes a pipeline by name.","kind":"function","name":"removePipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to be removed.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#removePipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":915,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Adds a pipeline instance into the collection of pipelines","kind":"function","name":"addPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"A unique string-based key for the pipeline.","name":"pipelineName"},{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"A pipeline instance which must extend WebGLPipeline.","name":"pipelineInstance"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"The pipeline instance that was passed."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#addPipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":944,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Pushes a new scissor state. This is used to set nested scissor states.","kind":"function","name":"pushScissor","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x position of the scissor.","name":"x"},{"type":{"names":["integer"]},"description":"The y position of the scissor.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the scissor.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the scissor.","name":"height"},{"type":{"names":["integer"]},"optional":true,"description":"Optional drawingBufferHeight override value.","name":"drawingBufferHeight"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing the scissor values."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#pushScissor","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":975,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the current scissor state.","kind":"function","name":"setScissor","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x position of the scissor.","name":"x"},{"type":{"names":["integer"]},"description":"The y position of the scissor.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the scissor.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the scissor.","name":"height"},{"type":{"names":["integer"]},"optional":true,"description":"Optional drawingBufferHeight override value.","name":"drawingBufferHeight"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setScissor","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1016,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Pops the last scissor state and sets it.","kind":"function","name":"popScissor","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#popScissor","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1040,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds a WebGLPipeline and sets it as the current pipeline to be used.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"The pipeline instance to be activated.","name":"pipelineInstance"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"The Game Object that invoked this pipeline, if any.","name":"gameObject"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"The pipeline that was activated."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setPipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1067,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Is there an active stencil mask?","kind":"function","name":"hasActiveStencilMask","since":"3.17.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if there is an active stencil mask, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#hasActiveStencilMask","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1083,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Use this to reset the gl context to the state that Phaser requires to continue rendering.\nCalling this will:\n\n* Disable `DEPTH_TEST`, `CULL_FACE` and `STENCIL_TEST`.\n* Clear the depth buffer and stencil buffers.\n* Reset the viewport size.\n* Reset the blend mode.\n* Bind a blank texture as the active texture on texture unit zero.\n* Rebinds the given pipeline instance.\n\nYou should call this having previously called `clearPipeline` and then wishing to return\ncontrol to Phaser again.","kind":"function","name":"rebindPipeline","since":"3.16.0","params":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"description":"The pipeline instance to be activated.","name":"pipelineInstance"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#rebindPipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Flushes the current WebGLPipeline being used and then clears it, along with the\nthe current shader program and vertex buffer. Then resets the blend mode to NORMAL.\nCall this before jumping to your own gl context handler, and then call `rebindPipeline` when\nyou wish to return control to Phaser again.","kind":"function","name":"clearPipeline","since":"3.16.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#clearPipeline","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1156,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the blend mode to the value given.\n\nIf the current blend mode is different from the one given, the pipeline is flushed and the new\nblend mode is enabled.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The blend mode to be set. Can be a `BlendModes` const or an integer value.","name":"blendModeId"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Force the blend mode to be set, regardless of the currently set blend mode.","name":"force"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the blend mode was changed as a result of this call, forcing a flush, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setBlendMode","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Creates a new custom blend mode for the renderer.\n\nSee https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Constants#Blending_modes","kind":"function","name":"addBlendMode","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array containing the WebGL functions to use for the source and the destination blending factors, respectively. See the possible constants for {@link WebGLRenderingContext#blendFunc()}.","name":"func"},{"type":{"names":["GLenum"]},"description":"The equation to use for combining the RGB and alpha components of a new pixel with a rendered one. See the possible constants for {@link WebGLRenderingContext#blendEquation()}.","name":"equation"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the new blend mode, used for referencing it in the future."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#addBlendMode","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Updates the function bound to a given custom blend mode.","kind":"function","name":"updateBlendMode","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the custom blend mode.","name":"index"},{"type":{"names":["function"]},"description":"The function to use for the blend mode.","name":"func"},{"type":{"names":["function"]},"description":"The equation to use for the blend mode.","name":"equation"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#updateBlendMode","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1248,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes a custom blend mode from the renderer.\nAny Game Objects still using this blend mode will error, so be sure to clear them first.","kind":"function","name":"removeBlendMode","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the custom blend mode to be removed.","name":"index"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#removeBlendMode","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1289,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds a texture at a texture unit. If a texture is already\nbound to that unit it will force a flush on the current pipeline.","kind":"function","name":"setTexture2D","since":"3.0.0","params":[{"type":{"names":["WebGLTexture"]},"description":"The WebGL texture that needs to be bound.","name":"texture"},{"type":{"names":["integer"]},"description":"The texture unit to which the texture will be bound.","name":"textureUnit"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Will the current pipeline be flushed if this is a new texture, or not?","name":"flush"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setTexture2D","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds a framebuffer. If there was another framebuffer already bound it will force a pipeline flush.","kind":"function","name":"setFramebuffer","since":"3.0.0","params":[{"type":{"names":["WebGLFramebuffer"]},"description":"The framebuffer that needs to be bound.","name":"framebuffer"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If a framebuffer is given, set the gl scissor to match the frame buffer size? Or, if `null` given, pop the scissor from the stack.","name":"updateScissor"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFramebuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1388,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds a program. If there was another program already bound it will force a pipeline flush.","kind":"function","name":"setProgram","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The program that needs to be bound.","name":"program"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setProgram","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1414,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Bounds a vertex buffer. If there is a vertex buffer already bound it'll force a pipeline flush.","kind":"function","name":"setVertexBuffer","since":"3.0.0","params":[{"type":{"names":["WebGLBuffer"]},"description":"The buffer that needs to be bound.","name":"vertexBuffer"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setVertexBuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1440,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Bounds a index buffer. If there is a index buffer already bound it'll force a pipeline flush.","kind":"function","name":"setIndexBuffer","since":"3.0.0","params":[{"type":{"names":["WebGLBuffer"]},"description":"The buffer the needs to be bound.","name":"indexBuffer"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setIndexBuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1466,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Creates a texture from an image source. If the source is not valid it creates an empty texture.","kind":"function","name":"createTextureFromSource","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The source of the texture.","name":"source"},{"type":{"names":["integer"]},"description":"The width of the texture.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the texture.","name":"height"},{"type":{"names":["integer"]},"description":"The scale mode to be used by the texture.","name":"scaleMode"}],"returns":[{"type":{"names":["WebGLTexture"]},"nullable":true,"description":"The WebGL Texture that was created, or `null` if it couldn't be created."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createTextureFromSource","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1515,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"A wrapper for creating a WebGLTexture. If no pixel data is passed it will create an empty texture.","kind":"function","name":"createTexture2D","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"Mip level of the texture.","name":"mipLevel"},{"type":{"names":["integer"]},"description":"Filtering of the texture.","name":"minFilter"},{"type":{"names":["integer"]},"description":"Filtering of the texture.","name":"magFilter"},{"type":{"names":["integer"]},"description":"Wrapping mode of the texture.","name":"wrapT"},{"type":{"names":["integer"]},"description":"Wrapping mode of the texture.","name":"wrapS"},{"type":{"names":["integer"]},"description":"Which format does the texture use.","name":"format"},{"type":{"names":["object"]},"nullable":true,"description":"pixel data.","name":"pixels"},{"type":{"names":["integer"]},"description":"Width of the texture in pixels.","name":"width"},{"type":{"names":["integer"]},"description":"Height of the texture in pixels.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Does the texture have premultiplied alpha?","name":"pma"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` it will use the width and height passed to this method, regardless of the pixels dimension.","name":"forceSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets the `UNPACK_FLIP_Y_WEBGL` flag the WebGL Texture uses during upload.","name":"flipY"}],"returns":[{"type":{"names":["WebGLTexture"]},"description":"The WebGLTexture that was created."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createTexture2D","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Wrapper for creating WebGLFramebuffer.","kind":"function","name":"createFramebuffer","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"Width in pixels of the framebuffer","name":"width"},{"type":{"names":["integer"]},"description":"Height in pixels of the framebuffer","name":"height"},{"type":{"names":["WebGLTexture"]},"description":"The color texture to where the color pixels are written","name":"renderTexture"},{"type":{"names":["boolean"]},"description":"Indicates if the current framebuffer support depth and stencil buffers","name":"addDepthStencilBuffer"}],"returns":[{"type":{"names":["WebGLFramebuffer"]},"description":"Raw WebGLFramebuffer"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createFramebuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1642,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Wrapper for creating a WebGLProgram","kind":"function","name":"createProgram","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Source to the vertex shader","name":"vertexShader"},{"type":{"names":["string"]},"description":"Source to the fragment shader","name":"fragmentShader"}],"returns":[{"type":{"names":["WebGLProgram"]},"description":"Raw WebGLProgram"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createProgram","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1686,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Wrapper for creating a vertex buffer.","kind":"function","name":"createVertexBuffer","since":"3.0.0","params":[{"type":{"names":["ArrayBuffer"]},"description":"It's either ArrayBuffer or an integer indicating the size of the vbo","name":"initialDataOrSize"},{"type":{"names":["integer"]},"description":"How the buffer is used. gl.DYNAMIC_DRAW, gl.STATIC_DRAW or gl.STREAM_DRAW","name":"bufferUsage"}],"returns":[{"type":{"names":["WebGLBuffer"]},"description":"Raw vertex buffer"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createVertexBuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1711,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Wrapper for creating a vertex buffer.","kind":"function","name":"createIndexBuffer","since":"3.0.0","params":[{"type":{"names":["ArrayBuffer"]},"description":"Either ArrayBuffer or an integer indicating the size of the vbo.","name":"initialDataOrSize"},{"type":{"names":["integer"]},"description":"How the buffer is used. gl.DYNAMIC_DRAW, gl.STATIC_DRAW or gl.STREAM_DRAW.","name":"bufferUsage"}],"returns":[{"type":{"names":["WebGLBuffer"]},"description":"Raw index buffer"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createIndexBuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1736,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes the given texture from the nativeTextures array and then deletes it from the GPU.","kind":"function","name":"deleteTexture","since":"3.0.0","params":[{"type":{"names":["WebGLTexture"]},"description":"The WebGL Texture to be deleted.","name":"texture"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#deleteTexture","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1766,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Deletes a WebGLFramebuffer from the GL instance.","kind":"function","name":"deleteFramebuffer","since":"3.0.0","params":[{"type":{"names":["WebGLFramebuffer"]},"description":"The Framebuffer to be deleted.","name":"framebuffer"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#deleteFramebuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1783,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Deletes a WebGLProgram from the GL instance.","kind":"function","name":"deleteProgram","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The shader program to be deleted.","name":"program"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#deleteProgram","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1800,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Deletes a WebGLBuffer from the GL instance.","kind":"function","name":"deleteBuffer","since":"3.0.0","params":[{"type":{"names":["WebGLBuffer"]},"description":"The WebGLBuffer to be deleted.","name":"vertexBuffer"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGLRenderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#deleteBuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1817,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Controls the pre-render operations for the given camera.\nHandles any clipping needed by the camera and renders the background color if a color is visible.","kind":"function","name":"preRenderCamera","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to pre-render.","name":"camera"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#preRenderCamera","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1913,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Controls the post-render operations for the given camera.\nRenders the foreground camera effects like flash and fading. It resets the current scissor state.","kind":"function","name":"postRenderCamera","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to post-render.","name":"camera"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#postRenderCamera","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":1981,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Clears the current vertex buffer and updates pipelines.","kind":"function","name":"preRender","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#preRender","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2031,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The core render step for a Scene Camera.\n\nIterates through the given Game Object's array and renders them with the given Camera.\n\nThis is called by the `CameraManager.render` method. The Camera Manager instance belongs to a Scene, and is invoked\nby the Scene Systems.render method.\n\nThis method is not called if `Camera.visible` is `false`, or `Camera.alpha` is zero.","kind":"function","name":"render","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to render.","name":"scene"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object's within the Scene to be rendered.","name":"children"},{"type":{"names":["number"]},"description":"The interpolation percentage to apply. Currently un-used.","name":"interpolationPercentage"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Scene Camera to render with.","name":"camera"}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#render","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The post-render step happens after all Cameras in all Scenes have been rendered.","kind":"function","name":"postRender","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#postRender","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Schedules a snapshot of the entire game viewport to be taken after the current frame is rendered.\n\nTo capture a specific area see the `snapshotArea` method. To capture a specific pixel, see `snapshotPixel`.\n\nOnly one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\ncalling this method will override it.\n\nSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\nIt then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\nwhich is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\nwhich gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshot","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#snapshot","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Schedules a snapshot of the given area of the game viewport to be taken after the current frame is rendered.\n\nTo capture the whole game viewport see the `snapshot` method. To capture a specific pixel, see `snapshotPixel`.\n\nOnly one snapshot can be active _per frame_. If you have already called `snapshotPixel`, for example, then\ncalling this method will override it.\n\nSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\nIt then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\nwhich is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\nwhich gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshotArea","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate to grab from.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate to grab from.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the area to grab.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the area to grab.","name":"height"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#snapshotArea","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2239,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Schedules a snapshot of the given pixel from the game viewport to be taken after the current frame is rendered.\n\nTo capture the whole game viewport see the `snapshot` method. To capture a specific area, see `snapshotArea`.\n\nOnly one snapshot can be active _per frame_. If you have already called `snapshotArea`, for example, then\ncalling this method will override it.\n\nUnlike the other two snapshot methods, this one will return a `Color` object containing the color data for\nthe requested pixel. It doesn't need to create an internal Canvas or Image object, so is a lot faster to execute,\nusing less memory.","kind":"function","name":"snapshotPixel","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel to get.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel to get.","name":"y"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot pixel data is extracted.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#snapshotPixel","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Takes a snapshot of the given area of the given frame buffer.\n\nUnlike the other snapshot methods, this one is processed immediately and doesn't wait for the next render.\n\nSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer into an ArrayBufferView.\nIt then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,\nwhich is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,\nwhich gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.","kind":"function","name":"snapshotFramebuffer","since":"3.19.0","params":[{"type":{"names":["WebGLFramebuffer"]},"description":"The framebuffer to grab from.","name":"framebuffer"},{"type":{"names":["integer"]},"description":"The width of the framebuffer.","name":"bufferWidth"},{"type":{"names":["integer"]},"description":"The height of the framebuffer.","name":"bufferHeight"},{"type":{"names":["Phaser.Types.Renderer.Snapshot.SnapshotCallback"]},"description":"The Function to invoke after the snapshot image is created.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Grab a single pixel as a Color object, or an area as an Image object?","name":"getPixel"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate to grab from.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate to grab from.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"bufferWidth","description":"The width of the area to grab.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"bufferHeight","description":"The height of the area to grab.","name":"height"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"The format of the image to create, usually `image/png` or `image/jpeg`.","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.","name":"encoderOptions"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#snapshotFramebuffer","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2328,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Creates a new WebGL Texture based on the given Canvas Element.\n\nIf the `dstTexture` parameter is given, the WebGL Texture is updated, rather than created fresh.","kind":"function","name":"canvasToTexture","since":"3.0.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas to create the WebGL Texture from","name":"srcCanvas"},{"type":{"names":["WebGLTexture"]},"optional":true,"description":"The destination WebGL Texture to set.","name":"dstTexture"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this canvas be allowed to set `REPEAT` (such as for Text objects?)","name":"noRepeat"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?","name":"flipY"}],"returns":[{"type":{"names":["WebGLTexture"]},"description":"The newly created, or updated, WebGL Texture."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#canvasToTexture","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2358,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Creates a new WebGL Texture based on the given Canvas Element.","kind":"function","name":"createCanvasTexture","since":"3.20.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas to create the WebGL Texture from","name":"srcCanvas"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this canvas be allowed to set `REPEAT` (such as for Text objects?)","name":"noRepeat"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?","name":"flipY"}],"returns":[{"type":{"names":["WebGLTexture"]},"description":"The newly created WebGL Texture."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createCanvasTexture","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2400,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Updates a WebGL Texture based on the given Canvas Element.","kind":"function","name":"updateCanvasTexture","since":"3.20.0","params":[{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas to update the WebGL Texture from.","name":"srcCanvas"},{"type":{"names":["WebGLTexture"]},"description":"The destination WebGL Texture to update.","name":"dstTexture"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?","name":"flipY"}],"returns":[{"type":{"names":["WebGLTexture"]},"description":"The updated WebGL Texture."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#updateCanvasTexture","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2438,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Creates a new WebGL Texture based on the given HTML Video Element.","kind":"function","name":"createVideoTexture","since":"3.20.0","params":[{"type":{"names":["HTMLVideoElement"]},"description":"The Video to create the WebGL Texture from","name":"srcVideo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this canvas be allowed to set `REPEAT`?","name":"noRepeat"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?","name":"flipY"}],"returns":[{"type":{"names":["WebGLTexture"]},"description":"The newly created WebGL Texture."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#createVideoTexture","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2480,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Updates a WebGL Texture based on the given HTML Video Element.","kind":"function","name":"updateVideoTexture","since":"3.20.0","params":[{"type":{"names":["HTMLVideoElement"]},"description":"The Video to update the WebGL Texture with.","name":"srcVideo"},{"type":{"names":["WebGLTexture"]},"description":"The destination WebGL Texture to update.","name":"dstTexture"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y`?","name":"flipY"}],"returns":[{"type":{"names":["WebGLTexture"]},"description":"The updated WebGL Texture."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#updateVideoTexture","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2518,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the minification and magnification filter for a texture.","kind":"function","name":"setTextureFilter","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The texture to set the filter for.","name":"texture"},{"type":{"names":["integer"]},"description":"The filter to set. 0 for linear filtering, 1 for nearest neighbor (blocky) filtering.","name":"filter"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setTextureFilter","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2544,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"[description]","kind":"function","name":"setFloat1","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"[description]","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat1","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2565,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"[description]","kind":"function","name":"setFloat2","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat2","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"[description]","kind":"function","name":"setFloat3","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"description":"[description]","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat3","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2610,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets uniform of a WebGLProgram","kind":"function","name":"setFloat4","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"X component","name":"x"},{"type":{"names":["number"]},"description":"Y component","name":"y"},{"type":{"names":["number"]},"description":"Z component","name":"z"},{"type":{"names":["number"]},"description":"W component","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat4","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2634,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setFloat1v","since":"3.13.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat1v","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2655,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setFloat2v","since":"3.13.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat2v","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2676,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setFloat3v","since":"3.13.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat3v","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2697,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setFloat4v","since":"3.13.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setFloat4v","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2719,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setInt1","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"[description]","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setInt1","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2740,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setInt2","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setInt2","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2762,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setInt3","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component","name":"y"},{"type":{"names":["integer"]},"description":"The new Z component","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setInt3","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2785,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a uniform variable in the given WebGLProgram.","kind":"function","name":"setInt4","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"X component","name":"x"},{"type":{"names":["integer"]},"description":"Y component","name":"y"},{"type":{"names":["integer"]},"description":"Z component","name":"z"},{"type":{"names":["integer"]},"description":"W component","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setInt4","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2809,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets the value of a 2x2 matrix uniform variable in the given WebGLProgram.","kind":"function","name":"setMatrix2","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"The value indicating whether to transpose the matrix. Must be false.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new matrix value.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setMatrix2","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2831,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"[description]","kind":"function","name":"setMatrix3","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"[description]","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"[description]","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setMatrix3","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2853,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Sets uniform of a WebGLProgram","kind":"function","name":"setMatrix4","since":"3.0.0","params":[{"type":{"names":["WebGLProgram"]},"description":"The target WebGLProgram from which the uniform location will be looked-up.","name":"program"},{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Is the matrix transposed","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"Matrix data","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"This WebGL Renderer instance."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#setMatrix4","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2875,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Returns the maximum number of texture units that can be used in a fragment shader.","kind":"function","name":"getMaxTextures","since":"3.8.0","returns":[{"type":{"names":["integer"]},"description":"The maximum number of textures WebGL supports."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#getMaxTextures","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2888,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Returns the largest texture size (either width or height) that can be created.\nNote that VRAM may not allow a texture of any given size, it just expresses\nhardware / driver support for a given size.","kind":"function","name":"getMaxTextureSize","since":"3.8.0","returns":[{"type":{"names":["integer"]},"description":"The maximum supported texture size."}],"memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#getMaxTextureSize","scope":"instance","___s":true},{"meta":{"filename":"WebGLRenderer.js","lineno":2903,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Destroy this WebGLRenderer, cleaning up all related resources such as pipelines, native textures, etc.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.WebGLRenderer","longname":"Phaser.Renderer.WebGL.WebGLRenderer#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"kind":"namespace","name":"WebGL","memberof":"Phaser.Renderer","longname":"Phaser.Renderer.WebGL","scope":"static","___s":true},{"meta":{"range":[225,264],"filename":"BitmapMaskPipeline.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"classdesc":"BitmapMaskPipeline handles all bitmap masking rendering in WebGL. It works by using \nsampling two texture on the fragment shader and using the fragment's alpha to clip the region.\nThe config properties are:\n- game: Current game instance.\n- renderer: Current WebGL renderer.\n- topology: This indicates how the primitives are rendered. The default value is GL_TRIANGLES.\n Here is the full list of rendering primitives (https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Constants).\n- vertShader: Source for vertex shader as a string.\n- fragShader: Source for fragment shader as a string.\n- vertexCapacity: The amount of vertices that shall be allocated\n- vertexSize: The size of a single vertex in bytes.","kind":"class","name":"BitmapMaskPipeline","augments":["Phaser.Renderer.WebGL.WebGLPipeline"],"memberof":"Phaser.Renderer.WebGL.Pipelines","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"Used for overriding shader an pipeline properties if extending this pipeline.","name":"config"}],"scope":"static","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Float32 view of the array buffer containing the pipeline's vertices.","name":"vertexViewF32","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexViewF32","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Size of the batch.","name":"maxQuads","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#maxQuads","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Dirty flag to check if resolution properties need to be updated on the \nmasking shader.","name":"resolutionDirty","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#resolutionDirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Called every time the pipeline needs to be used.\nIt binds all necessary resources.","kind":"function","name":"onBind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onBind","scope":"instance","overrides":"Phaser.Renderer.WebGL.WebGLPipeline#onBind","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":128,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"[description]","kind":"function","name":"resize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"width"},{"type":{"names":["number"]},"description":"[description]","name":"height"},{"type":{"names":["number"]},"description":"[description]","name":"resolution"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#resize","scope":"instance","overrides":"Phaser.Renderer.WebGL.WebGLPipeline#resize","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Binds necessary resources and renders the mask to a separated framebuffer.\nThe framebuffer for the masked object is also bound for further use.","kind":"function","name":"beginMask","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"GameObject used as mask.","name":"mask"},{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"GameObject masked by the mask GameObject.","name":"maskedObject"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"[description]","name":"camera"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#beginMask","scope":"instance","___s":true},{"meta":{"filename":"BitmapMaskPipeline.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"The masked game objects framebuffer is unbound and its texture \nis bound together with the mask texture and the mask shader and \na draw call with a single quad is processed. Here is where the\nmasking effect is applied.","kind":"function","name":"endMask","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"GameObject used as a mask.","name":"mask"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#endMask","scope":"instance","___s":true},{"meta":{"range":[225,264],"filename":"ForwardDiffuseLightPipeline.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"classdesc":"ForwardDiffuseLightPipeline implements a forward rendering approach for 2D lights.\nThis pipeline extends TextureTintPipeline so it implements all it's rendering functions\nand batching system.","kind":"class","name":"ForwardDiffuseLightPipeline","augments":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"],"memberof":"Phaser.Renderer.WebGL.Pipelines","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration of the pipeline, same as the {@link Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline}. The fragment shader will be replaced with the lighting shader.","name":"config"}],"scope":"static","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Called when the Game has fully booted and the Renderer has finished setting up.\n\nBy this stage all Game level systems are now in place and you can perform any final\ntasks that the pipeline may need that relied on game systems such as the Texture Manager.","kind":"function","name":"boot","override":true,"since":"3.11.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#boot","scope":"instance","ignore":true,"___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"This function binds its base class resources and this lights 2D resources.","kind":"function","name":"onBind","override":true,"since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"The Game Object that invoked this pipeline, if any.","name":"gameObject"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#onBind","scope":"instance","ignore":true,"___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":113,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"This function sets all the needed resources for each camera pass.","kind":"function","name":"onRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene being rendered.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Scene Camera being rendered with.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#onRender","scope":"instance","overrides":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onRender","___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Generic function for batching a textured quad","kind":"function","name":"batchTexture","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"Source GameObject","name":"gameObject"},{"type":{"names":["WebGLTexture"]},"description":"Raw WebGLTexture associated with the quad","name":"texture"},{"type":{"names":["integer"]},"description":"Real texture width","name":"textureWidth"},{"type":{"names":["integer"]},"description":"Real texture height","name":"textureHeight"},{"type":{"names":["number"]},"description":"X coordinate of the quad","name":"srcX"},{"type":{"names":["number"]},"description":"Y coordinate of the quad","name":"srcY"},{"type":{"names":["number"]},"description":"Width of the quad","name":"srcWidth"},{"type":{"names":["number"]},"description":"Height of the quad","name":"srcHeight"},{"type":{"names":["number"]},"description":"X component of scale","name":"scaleX"},{"type":{"names":["number"]},"description":"Y component of scale","name":"scaleY"},{"type":{"names":["number"]},"description":"Rotation of the quad","name":"rotation"},{"type":{"names":["boolean"]},"description":"Indicates if the quad is horizontally flipped","name":"flipX"},{"type":{"names":["boolean"]},"description":"Indicates if the quad is vertically flipped","name":"flipY"},{"type":{"names":["number"]},"description":"By which factor is the quad affected by the camera horizontal scroll","name":"scrollFactorX"},{"type":{"names":["number"]},"description":"By which factor is the quad effected by the camera vertical scroll","name":"scrollFactorY"},{"type":{"names":["number"]},"description":"Horizontal origin in pixels","name":"displayOriginX"},{"type":{"names":["number"]},"description":"Vertical origin in pixels","name":"displayOriginY"},{"type":{"names":["number"]},"description":"X coordinate of the texture frame","name":"frameX"},{"type":{"names":["number"]},"description":"Y coordinate of the texture frame","name":"frameY"},{"type":{"names":["number"]},"description":"Width of the texture frame","name":"frameWidth"},{"type":{"names":["number"]},"description":"Height of the texture frame","name":"frameHeight"},{"type":{"names":["integer"]},"description":"Tint for top left","name":"tintTL"},{"type":{"names":["integer"]},"description":"Tint for top right","name":"tintTR"},{"type":{"names":["integer"]},"description":"Tint for bottom left","name":"tintBL"},{"type":{"names":["integer"]},"description":"Tint for bottom right","name":"tintBR"},{"type":{"names":["number"]},"description":"The tint effect (0 for additive, 1 for replacement)","name":"tintEffect"},{"type":{"names":["number"]},"description":"Horizontal offset on texture coordinate","name":"uOffset"},{"type":{"names":["number"]},"description":"Vertical offset on texture coordinate","name":"vOffset"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"Current used camera","name":"camera"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"Parent container","name":"parentTransformMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchTexture","scope":"instance","overrides":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTexture","___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":407,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Sets the Game Objects normal map as the active texture.","kind":"function","name":"setNormalMap","since":"3.11.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to update.","name":"gameObject"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setNormalMap","scope":"instance","___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":439,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Rotates the normal map vectors inversely by the given angle.\nOnly works in 2D space.","kind":"function","name":"setNormalMapRotation","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The angle of rotation in radians.","name":"rotation"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setNormalMapRotation","scope":"instance","___s":true},{"meta":{"filename":"ForwardDiffuseLightPipeline.js","lineno":481,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Takes a Sprite Game Object, or any object that extends it, which has a normal texture and adds it to the batch.","kind":"function","name":"batchSprite","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"The texture-based Game Object to add to the batch.","name":"sprite"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to use for the rendering transform.","name":"camera"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The transform matrix of the parent container, if set.","name":"parentTransformMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchSprite","scope":"instance","overrides":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchSprite","___s":true},{"meta":{"range":[225,264],"filename":"TextureTintPipeline.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"classdesc":"TextureTintPipeline implements the rendering infrastructure\nfor displaying textured objects\nThe config properties are:\n- game: Current game instance.\n- renderer: Current WebGL renderer.\n- topology: This indicates how the primitives are rendered. The default value is GL_TRIANGLES.\n Here is the full list of rendering primitives (https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Constants).\n- vertShader: Source for vertex shader as a string.\n- fragShader: Source for fragment shader as a string.\n- vertexCapacity: The amount of vertices that shall be allocated\n- vertexSize: The size of a single vertex in bytes.","kind":"class","name":"TextureTintPipeline","augments":["Phaser.Renderer.WebGL.WebGLPipeline"],"memberof":"Phaser.Renderer.WebGL.Pipelines","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration options for this Texture Tint Pipeline, as described above.","name":"config"}],"scope":"static","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Float32 view of the array buffer containing the pipeline's vertices.","name":"vertexViewF32","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexViewF32","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Uint32 view of the array buffer containing the pipeline's vertices.","name":"vertexViewU32","type":{"names":["Uint32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexViewU32","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Size of the batch.","name":"maxQuads","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#maxQuads","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Collection of batch information","name":"batches","type":{"names":["array"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batches","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":266,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Called every time the pipeline needs to be used.\nIt binds all necessary resources.","kind":"function","name":"onBind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onBind","scope":"instance","overrides":"Phaser.Renderer.WebGL.WebGLPipeline#onBind","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":284,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Resizes this pipeline and updates the projection.","kind":"function","name":"resize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new width.","name":"width"},{"type":{"names":["number"]},"description":"The new height.","name":"height"},{"type":{"names":["number"]},"description":"The resolution.","name":"resolution"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#resize","scope":"instance","overrides":"Phaser.Renderer.WebGL.WebGLPipeline#resize","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":305,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Assigns a texture to the current batch. If a different texture is already set it creates a new batch object.","kind":"function","name":"setTexture2D","since":"3.1.0","params":[{"type":{"names":["WebGLTexture"]},"optional":true,"description":"WebGLTexture that will be assigned to the current batch. If not given uses blankTexture.","name":"texture"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This pipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setTexture2D","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":329,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Checks if the current batch has the same texture and texture unit, or if we need to create a new batch.","kind":"function","name":"requireTextureBatch","since":"3.16.0","params":[{"type":{"names":["WebGLTexture"]},"description":"WebGLTexture that will be assigned to the current batch. If not given uses blankTexture.","name":"texture"},{"type":{"names":["integer"]},"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline needs to create a new batch, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#requireTextureBatch","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":356,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Creates a new batch object and pushes it to a batch array.\nThe batch object contains information relevant to the current \nvertex batch like the offset in the vertex buffer, vertex count and \nthe textures used by that batch.","kind":"function","name":"pushBatch","since":"3.1.0","params":[{"type":{"names":["WebGLTexture"]},"description":"Optional WebGLTexture that will be assigned to the created batch.","name":"texture"},{"type":{"names":["integer"]},"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#pushBatch","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Uploads the vertex data and emits a draw call for the current batch of vertices.","kind":"function","name":"flush","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#flush","scope":"instance","overrides":"Phaser.Renderer.WebGL.WebGLPipeline#flush","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":506,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Takes a Sprite Game Object, or any object that extends it, and adds it to the batch.","kind":"function","name":"batchSprite","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Image","Phaser.GameObjects.Sprite"]},"description":"The texture based Game Object to add to the batch.","name":"sprite"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to use for the rendering transform.","name":"camera"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The transform matrix of the parent container, if set.","name":"parentTransformMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchSprite","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":659,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the vertices data into the batch and flushes if full.\n\nAssumes 6 vertices in the following arrangement:\n\n```\n0----3\n|\\ B|\n| \\ |\n| \\ |\n| A \\|\n| \\\n1----2\n```\n\nWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3","kind":"function","name":"batchQuad","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The top-left x position.","name":"x0"},{"type":{"names":["number"]},"description":"The top-left y position.","name":"y0"},{"type":{"names":["number"]},"description":"The bottom-left x position.","name":"x1"},{"type":{"names":["number"]},"description":"The bottom-left y position.","name":"y1"},{"type":{"names":["number"]},"description":"The bottom-right x position.","name":"x2"},{"type":{"names":["number"]},"description":"The bottom-right y position.","name":"y2"},{"type":{"names":["number"]},"description":"The top-right x position.","name":"x3"},{"type":{"names":["number"]},"description":"The top-right y position.","name":"y3"},{"type":{"names":["number"]},"description":"UV u0 value.","name":"u0"},{"type":{"names":["number"]},"description":"UV v0 value.","name":"v0"},{"type":{"names":["number"]},"description":"UV u1 value.","name":"u1"},{"type":{"names":["number"]},"description":"UV v1 value.","name":"v1"},{"type":{"names":["number"]},"description":"The top-left tint color value.","name":"tintTL"},{"type":{"names":["number"]},"description":"The top-right tint color value.","name":"tintTR"},{"type":{"names":["number"]},"description":"The bottom-left tint color value.","name":"tintBL"},{"type":{"names":["number"]},"description":"The bottom-right tint color value.","name":"tintBR"},{"type":{"names":["number","boolean"]},"description":"The tint effect for the shader to use.","name":"tintEffect"},{"type":{"names":["WebGLTexture"]},"optional":true,"description":"WebGLTexture that will be assigned to the current batch if a flush occurs.","name":"texture"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if this method caused the batch to flush, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchQuad","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":766,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the vertices data into the batch and flushes if full.\n\nAssumes 3 vertices in the following arrangement:\n\n```\n0\n|\\\n| \\\n| \\\n| \\\n| \\\n1-----2\n```","kind":"function","name":"batchTri","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The bottom-left x position.","name":"x1"},{"type":{"names":["number"]},"description":"The bottom-left y position.","name":"y1"},{"type":{"names":["number"]},"description":"The bottom-right x position.","name":"x2"},{"type":{"names":["number"]},"description":"The bottom-right y position.","name":"y2"},{"type":{"names":["number"]},"description":"The top-right x position.","name":"x3"},{"type":{"names":["number"]},"description":"The top-right y position.","name":"y3"},{"type":{"names":["number"]},"description":"UV u0 value.","name":"u0"},{"type":{"names":["number"]},"description":"UV v0 value.","name":"v0"},{"type":{"names":["number"]},"description":"UV u1 value.","name":"u1"},{"type":{"names":["number"]},"description":"UV v1 value.","name":"v1"},{"type":{"names":["number"]},"description":"The top-left tint color value.","name":"tintTL"},{"type":{"names":["number"]},"description":"The top-right tint color value.","name":"tintTR"},{"type":{"names":["number"]},"description":"The bottom-left tint color value.","name":"tintBL"},{"type":{"names":["number","boolean"]},"description":"The tint effect for the shader to use.","name":"tintEffect"},{"type":{"names":["WebGLTexture"]},"optional":true,"description":"WebGLTexture that will be assigned to the current batch if a flush occurs.","name":"texture"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if this method caused the batch to flush, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTri","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":847,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Generic function for batching a textured quad using argument values instead of a Game Object.","kind":"function","name":"batchTexture","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"Source GameObject.","name":"gameObject"},{"type":{"names":["WebGLTexture"]},"description":"Raw WebGLTexture associated with the quad.","name":"texture"},{"type":{"names":["integer"]},"description":"Real texture width.","name":"textureWidth"},{"type":{"names":["integer"]},"description":"Real texture height.","name":"textureHeight"},{"type":{"names":["number"]},"description":"X coordinate of the quad.","name":"srcX"},{"type":{"names":["number"]},"description":"Y coordinate of the quad.","name":"srcY"},{"type":{"names":["number"]},"description":"Width of the quad.","name":"srcWidth"},{"type":{"names":["number"]},"description":"Height of the quad.","name":"srcHeight"},{"type":{"names":["number"]},"description":"X component of scale.","name":"scaleX"},{"type":{"names":["number"]},"description":"Y component of scale.","name":"scaleY"},{"type":{"names":["number"]},"description":"Rotation of the quad.","name":"rotation"},{"type":{"names":["boolean"]},"description":"Indicates if the quad is horizontally flipped.","name":"flipX"},{"type":{"names":["boolean"]},"description":"Indicates if the quad is vertically flipped.","name":"flipY"},{"type":{"names":["number"]},"description":"By which factor is the quad affected by the camera horizontal scroll.","name":"scrollFactorX"},{"type":{"names":["number"]},"description":"By which factor is the quad effected by the camera vertical scroll.","name":"scrollFactorY"},{"type":{"names":["number"]},"description":"Horizontal origin in pixels.","name":"displayOriginX"},{"type":{"names":["number"]},"description":"Vertical origin in pixels.","name":"displayOriginY"},{"type":{"names":["number"]},"description":"X coordinate of the texture frame.","name":"frameX"},{"type":{"names":["number"]},"description":"Y coordinate of the texture frame.","name":"frameY"},{"type":{"names":["number"]},"description":"Width of the texture frame.","name":"frameWidth"},{"type":{"names":["number"]},"description":"Height of the texture frame.","name":"frameHeight"},{"type":{"names":["integer"]},"description":"Tint for top left.","name":"tintTL"},{"type":{"names":["integer"]},"description":"Tint for top right.","name":"tintTR"},{"type":{"names":["integer"]},"description":"Tint for bottom left.","name":"tintBL"},{"type":{"names":["integer"]},"description":"Tint for bottom right.","name":"tintBR"},{"type":{"names":["number"]},"description":"The tint effect.","name":"tintEffect"},{"type":{"names":["number"]},"description":"Horizontal offset on texture coordinate.","name":"uOffset"},{"type":{"names":["number"]},"description":"Vertical offset on texture coordinate.","name":"vOffset"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"Current used camera.","name":"camera"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"Parent container.","name":"parentTransformMatrix"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip the renderTexture check.","name":"skipFlip"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTexture","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1030,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds a Texture Frame into the batch for rendering.","kind":"function","name":"batchTextureFrame","since":"3.12.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The Texture Frame to be rendered.","name":"frame"},{"type":{"names":["number"]},"description":"The horizontal position to render the texture at.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position to render the texture at.","name":"y"},{"type":{"names":["number"]},"description":"The tint color.","name":"tint"},{"type":{"names":["number"]},"description":"The alpha value.","name":"alpha"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The Transform Matrix to use for the texture.","name":"transformMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A parent Transform Matrix.","name":"parentTransformMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTextureFrame","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a filled rectangle into the vertex batch.\nRectangle has no transform values and isn't transformed into the local space.\nUsed for directly batching untransformed rectangles, such as Camera background colors.","kind":"function","name":"drawFillRect","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Horizontal top left coordinate of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"Vertical top left coordinate of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["number"]},"description":"Color of the rectangle to draw.","name":"color"},{"type":{"names":["number"]},"description":"Alpha value of the rectangle to draw.","name":"alpha"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#drawFillRect","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1115,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a filled rectangle into the vertex batch.\nRectangle factors in the given transform matrices before adding to the batch.","kind":"function","name":"batchFillRect","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Horizontal top left coordinate of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"Vertical top left coordinate of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchFillRect","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a filled triangle into the vertex batch.\nTriangle factors in the given transform matrices before adding to the batch.","kind":"function","name":"batchFillTriangle","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Point 0 x coordinate.","name":"x0"},{"type":{"names":["number"]},"description":"Point 0 y coordinate.","name":"y0"},{"type":{"names":["number"]},"description":"Point 1 x coordinate.","name":"x1"},{"type":{"names":["number"]},"description":"Point 1 y coordinate.","name":"y1"},{"type":{"names":["number"]},"description":"Point 2 x coordinate.","name":"x2"},{"type":{"names":["number"]},"description":"Point 2 y coordinate.","name":"y2"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchFillTriangle","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a stroked triangle into the vertex batch.\nTriangle factors in the given transform matrices before adding to the batch.\nThe triangle is created from 3 lines and drawn using the `batchStrokePath` method.","kind":"function","name":"batchStrokeTriangle","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Point 0 x coordinate.","name":"x0"},{"type":{"names":["number"]},"description":"Point 0 y coordinate.","name":"y0"},{"type":{"names":["number"]},"description":"Point 1 x coordinate.","name":"x1"},{"type":{"names":["number"]},"description":"Point 1 y coordinate.","name":"y1"},{"type":{"names":["number"]},"description":"Point 2 x coordinate.","name":"x2"},{"type":{"names":["number"]},"description":"Point 2 y coordinate.","name":"y2"},{"type":{"names":["number"]},"description":"The width of the line in pixels.","name":"lineWidth"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchStrokeTriangle","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the given path to the vertex batch for rendering.\n\nIt works by taking the array of path data and then passing it through Earcut, which\ncreates a list of polygons. Each polygon is then added to the batch.\n\nThe path is always automatically closed because it's filled.","kind":"function","name":"batchFillPath","since":"3.12.0","params":[{"type":{"names":["array"]},"description":"Collection of points that represent the path.","name":"path"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchFillPath","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1335,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the given path to the vertex batch for rendering.\n\nIt works by taking the array of path data and calling `batchLine` for each section\nof the path.\n\nThe path is optionally closed at the end.","kind":"function","name":"batchStrokePath","since":"3.12.0","params":[{"type":{"names":["array"]},"description":"Collection of points that represent the path.","name":"path"},{"type":{"names":["number"]},"description":"The width of the line segments in pixels.","name":"lineWidth"},{"type":{"names":["boolean"]},"description":"Indicates if the path should be closed or left open.","name":"pathOpen"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchStrokePath","scope":"instance","___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1383,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Creates a quad and adds it to the vertex batch based on the given line values.","kind":"function","name":"batchLine","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"X coordinate to the start of the line","name":"ax"},{"type":{"names":["number"]},"description":"Y coordinate to the start of the line","name":"ay"},{"type":{"names":["number"]},"description":"X coordinate to the end of the line","name":"bx"},{"type":{"names":["number"]},"description":"Y coordinate to the end of the line","name":"by"},{"type":{"names":["number"]},"description":"Width of the start of the line","name":"aLineWidth"},{"type":{"names":["number"]},"description":"Width of the end of the line","name":"bLineWidth"},{"type":{"names":["Float32Array"]},"description":"Parent matrix, generally used by containers","name":"currentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchLine","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Implements a model view projection matrices.\nPipelines can implement this for doing 2D and 3D rendering.","kind":"namespace","name":"ModelViewProjection","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","scope":"static","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Dirty flag for checking if model matrix needs to be updated on GPU.","name":"modelMatrixDirty","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelMatrixDirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":25,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Dirty flag for checking if view matrix needs to be updated on GPU.","name":"viewMatrixDirty","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewMatrixDirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Dirty flag for checking if projection matrix needs to be updated on GPU.","name":"projectionMatrixDirty","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#projectionMatrixDirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Model matrix","name":"modelMatrix","type":{"names":["Float32Array"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelMatrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"View matrix","name":"viewMatrix","type":{"names":["Float32Array"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewMatrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Projection matrix","name":"projectionMatrix","type":{"names":["Float32Array"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#projectionMatrix","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Initializes MVP matrices with an identity matrix","kind":"function","name":"mvpInit","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#mvpInit","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"If dirty flags are set then the matrices are uploaded to the GPU.","kind":"function","name":"mvpUpdate","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#mvpUpdate","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":137,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Loads an identity matrix to the model matrix","kind":"function","name":"modelIdentity","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelIdentity","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Scale model matrix","kind":"function","name":"modelScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x component.","name":"x"},{"type":{"names":["number"]},"description":"The y component.","name":"y"},{"type":{"names":["number"]},"description":"The z component.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelScale","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":203,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Translate model matrix","kind":"function","name":"modelTranslate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x component.","name":"x"},{"type":{"names":["number"]},"description":"The y component.","name":"y"},{"type":{"names":["number"]},"description":"The z component.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelTranslate","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Rotates the model matrix in the X axis.","kind":"function","name":"modelRotateX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to rotate by.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelRotateX","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":267,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Rotates the model matrix in the Y axis.","kind":"function","name":"modelRotateY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to rotate by.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelRotateY","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":305,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Rotates the model matrix in the Z axis.","kind":"function","name":"modelRotateZ","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to rotate by.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#modelRotateZ","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":343,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Loads identity matrix into the view matrix","kind":"function","name":"viewIdentity","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewIdentity","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":377,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Scales view matrix","kind":"function","name":"viewScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x component.","name":"x"},{"type":{"names":["number"]},"description":"The y component.","name":"y"},{"type":{"names":["number"]},"description":"The z component.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewScale","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Translates view matrix","kind":"function","name":"viewTranslate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x component.","name":"x"},{"type":{"names":["number"]},"description":"The y component.","name":"y"},{"type":{"names":["number"]},"description":"The z component.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewTranslate","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":437,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Rotates view matrix in the X axis.","kind":"function","name":"viewRotateX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to rotate by.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewRotateX","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":475,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Rotates view matrix in the Y axis.","kind":"function","name":"viewRotateY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to rotate by.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewRotateY","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Rotates view matrix in the Z axis.","kind":"function","name":"viewRotateZ","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to rotate by.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewRotateZ","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":551,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Loads a 2D view matrix (3x2 matrix) into a 4x4 view matrix","kind":"function","name":"viewLoad2D","since":"3.0.0","params":[{"type":{"names":["Float32Array"]},"description":"The Matrix2D.","name":"matrix2D"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewLoad2D","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":588,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Copies a 4x4 matrix into the view matrix","kind":"function","name":"viewLoad","since":"3.0.0","params":[{"type":{"names":["Float32Array"]},"description":"The Matrix2D.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#viewLoad","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":624,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Loads identity matrix into the projection matrix.","kind":"function","name":"projIdentity","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#projIdentity","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":658,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Sets up an orthographic projection matrix","kind":"function","name":"projOrtho","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The left value.","name":"left"},{"type":{"names":["number"]},"description":"The right value.","name":"right"},{"type":{"names":["number"]},"description":"The bottom value.","name":"bottom"},{"type":{"names":["number"]},"description":"The top value.","name":"top"},{"type":{"names":["number"]},"description":"The near value.","name":"near"},{"type":{"names":["number"]},"description":"The far value.","name":"far"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#projOrtho","scope":"instance","___s":true},{"meta":{"filename":"ModelViewProjection.js","lineno":702,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components"},"description":"Sets up a perspective projection matrix","kind":"function","name":"projPersp","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The fov value.","name":"fovY"},{"type":{"names":["number"]},"description":"The aspectRatio value.","name":"aspectRatio"},{"type":{"names":["number"]},"description":"The near value.","name":"near"},{"type":{"names":["number"]},"description":"The far value.","name":"far"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ModelViewProjection"]},"description":"This Model View Projection."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection","longname":"Phaser.Renderer.WebGL.Pipelines.ModelViewProjection#projPersp","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"kind":"namespace","name":"Pipelines","memberof":"Phaser.Renderer.WebGL","longname":"Phaser.Renderer.WebGL.Pipelines","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"ScaleManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScaleManager.js","lineno":21,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"classdesc":"The Scale Manager handles the scaling, resizing and alignment of the game canvas.\n\nThe way scaling is handled is by setting the game canvas to a fixed size, which is defined in the\ngame configuration. You also define the parent container in the game config. If no parent is given,\nit will default to using the document body. The Scale Manager will then look at the available space\nwithin the _parent_ and scale the canvas accordingly. Scaling is handled by setting the canvas CSS\nwidth and height properties, leaving the width and height of the canvas element itself untouched.\nScaling is therefore achieved by keeping the core canvas the same size and 'stretching'\nit via its CSS properties. This gives the same result and speed as using the `transform-scale` CSS\nproperty, without the need for browser prefix handling.\n\nThe calculations for the scale are heavily influenced by the bounding parent size, which is the computed\ndimensions of the canvas's parent. The CSS rules of the parent element play an important role in the\noperation of the Scale Manager. For example, if the parent has no defined width or height, then actions\nlike auto-centering will fail to achieve the required result. The Scale Manager works in tandem with the\nCSS you set-up on the page hosting your game, rather than taking control of it.\n\n#### Parent and Display canvas containment guidelines:\n\n- Style the Parent element (of the game canvas) to control the Parent size and thus the games size and layout.\n\n- The Parent element's CSS styles should _effectively_ apply maximum (and minimum) bounding behavior.\n\n- The Parent element should _not_ apply a padding as this is not accounted for.\n If a padding is required apply it to the Parent's parent or apply a margin to the Parent.\n If you need to add a border, margin or any other CSS around your game container, then use a parent element and\n apply the CSS to this instead, otherwise you'll be constantly resizing the shape of the game container.\n\n- The Display canvas layout CSS styles (i.e. margins, size) should not be altered / specified as\n they may be updated by the Scale Manager.\n\n#### Scale Modes\n\nThe way the scaling is handled is determined by the `scaleMode` property. The default is `NONE`,\nwhich prevents Phaser from scaling or touching the canvas, or its parent, at all. In this mode, you are\nresponsible for all scaling. The other scaling modes afford you automatic scaling.\n\nIf you wish to scale your game so that it always fits into the available space within the parent, you\nshould use the scale mode `FIT`. Look at the documentation for other scale modes to see what options are\navailable. Here is a basic config showing how to set this scale mode:\n\n```javascript\nscale: {\n parent: 'yourgamediv',\n mode: Phaser.Scale.FIT,\n width: 800,\n height: 600\n}\n```\n\nPlace the `scale` config object within your game config.\n\nIf you wish for the canvas to be resized directly, so that the canvas itself fills the available space\n(i.e. it isn't scaled, it's resized) then use the `RESIZE` scale mode. This will give you a 1:1 mapping\nof canvas pixels to game size. In this mode CSS isn't used to scale the canvas, it's literally adjusted\nto fill all available space within the parent. You should be extremely careful about the size of the\ncanvas you're creating when doing this, as the larger the area, the more work the GPU has to do and it's\nvery easy to hit fill-rate limits quickly.\n\nFor complex, custom-scaling requirements, you should probably consider using the `RESIZE` scale mode,\nwith your own limitations in place re: canvas dimensions and managing the scaling with the game scenes\nyourself. For the vast majority of games, however, the `FIT` mode is likely to be the most used.\n\nPlease appreciate that the Scale Manager cannot perform miracles. All it does is scale your game canvas\nas best it can, based on what it can infer from its surrounding area. There are all kinds of environments\nwhere it's up to you to guide and help the canvas position itself, especially when built into rendering\nframeworks like React and Vue. If your page requires meta tags to prevent user scaling gestures, or such\nlike, then it's up to you to ensure they are present in the html.\n\n#### Centering\n\nYou can also have the game canvas automatically centered. Again, this relies heavily on the parent being\nproperly configured and styled, as the centering offsets are based entirely on the available space\nwithin the parent element. Centering is disabled by default, or can be applied horizontally, vertically,\nor both. Here's an example:\n\n```javascript\nscale: {\n parent: 'yourgamediv',\n autoCenter: Phaser.Scale.CENTER_BOTH,\n width: 800,\n height: 600\n}\n```\n\n#### Fullscreen API\n\nIf the browser supports it, you can send your game into fullscreen mode. In this mode, the game will fill\nthe entire display, removing all browser UI and anything else present on the screen. It will remain in this\nmode until your game either disables it, or until the user tabs out or presses ESCape if on desktop. It's a\ngreat way to achieve a desktop-game like experience from the browser, but it does require a modern browser\nto handle it. Some mobile browsers also support this.","kind":"class","name":"ScaleManager","memberof":"Phaser.Scale","augments":["Phaser.Events.EventEmitter"],"since":"3.16.0","params":[{"type":{"names":["Phaser.Game"]},"description":"A reference to the Phaser.Game instance.","name":"game"}],"scope":"static","longname":"Phaser.Scale.ScaleManager","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"A reference to the Phaser.Game instance.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.15.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"A reference to the HTML Canvas Element that Phaser uses to render the game.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":153,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The DOM bounds of the canvas element.","name":"canvasBounds","type":{"names":["Phaser.Geom.Rectangle"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#canvasBounds","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":162,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The parent object of the Canvas. Often a div, or the browser window, or nothing in non-browser environments.\n\nThis is set in the Game Config as the `parent` property. If undefined (or just not present), it will default\nto use the document body. If specifically set to `null` Phaser will ignore all parent operations.","name":"parent","type":{"names":["any"]},"nullable":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Is the parent element the browser window?","name":"parentIsWindow","type":{"names":["boolean"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#parentIsWindow","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The Parent Size component.","name":"parentSize","type":{"names":["Phaser.Structs.Size"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#parentSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The Game Size component.\n\nThe un-modified game size, as requested in the game config (the raw width / height),\nas used for world bounds, cameras, etc","name":"gameSize","type":{"names":["Phaser.Structs.Size"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#gameSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":204,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The Base Size component.\n\nThe modified game size, which is the gameSize * resolution, used to set the canvas width and height\n(but not the CSS style)","name":"baseSize","type":{"names":["Phaser.Structs.Size"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#baseSize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":216,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The Display Size component.\n\nThe size used for the canvas style, factoring in the scale mode, parent and other values.","name":"displaySize","type":{"names":["Phaser.Structs.Size"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#displaySize","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":227,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The game scale mode.","name":"scaleMode","type":{"names":["Phaser.Scale.ScaleModeType"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#scaleMode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":236,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The canvas resolution.\n\nThis is hard-coded to a value of 1 in the 3.16 release of Phaser and will be enabled at a later date.","name":"resolution","type":{"names":["number"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#resolution","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":247,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The game zoom factor.\n\nThis value allows you to multiply your games base size by the given zoom factor.\nThis is then used when calculating the display size, even in `NONE` situations.\nIf you don't want Phaser to touch the canvas style at all, this value should be 1.\n\nCan also be set to `MAX_ZOOM` in which case the zoom value will be derived based\non the game size and available space within the parent.","name":"zoom","type":{"names":["number"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#zoom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":263,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Internal flag set when the game zoom factor is modified.","name":"_resetZoom","type":{"names":["boolean"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#_resetZoom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":273,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The scale factor between the baseSize and the canvasBounds.","name":"displayScale","type":{"names":["Phaser.Math.Vector2"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#displayScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":282,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"If set, the canvas sizes will be automatically passed through Math.floor.\nThis results in rounded pixel display values, which is important for performance on legacy\nand low powered devices, but at the cost of not achieving a 'perfect' fit in some browser windows.","name":"autoRound","type":{"names":["boolean"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#autoRound","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":293,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Automatically center the canvas within the parent? The different centering modes are:\n\n1. No centering.\n2. Center both horizontally and vertically.\n3. Center horizontally.\n4. Center vertically.\n\nPlease be aware that in order to center the game canvas, you must have specified a parent\nthat has a size set, or the canvas parent is the document.body.","name":"autoCenter","type":{"names":["Phaser.Scale.CenterType"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#autoCenter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":310,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The current device orientation.\n\nOrientation events are dispatched via the Device Orientation API, typically only on mobile browsers.","name":"orientation","type":{"names":["Phaser.Scale.OrientationType"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#orientation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":321,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"A reference to the Device.Fullscreen object.","name":"fullscreen","type":{"names":["Phaser.Device.Fullscreen"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#fullscreen","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":330,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The DOM Element which is sent into fullscreen mode.","name":"fullscreenTarget","type":{"names":["any"]},"nullable":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#fullscreenTarget","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":349,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The dirty state of the Scale Manager.\nSet if there is a change between the parent size and the current size.","name":"dirty","type":{"names":["boolean"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#dirty","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":359,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"How many milliseconds should elapse before checking if the browser size has changed?\n\nMost modern browsers dispatch a 'resize' event, which the Scale Manager will listen for.\nHowever, older browsers fail to do this, or do it consistently, so we fall back to a\nmore traditional 'size check' based on a time interval. You can control how often it is\nchecked here.","name":"resizeInterval","type":{"names":["integer"]},"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#resizeInterval","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":589,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Determines the parent element of the game canvas, if any, based on the game configuration.","kind":"function","name":"getParent","since":"3.16.0","params":[{"type":{"names":["Phaser.Types.Core.GameConfig"]},"description":"The Game configuration object.","name":"config"}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#getParent","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":639,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Calculates the size of the parent bounds and updates the `parentSize` component, if the canvas has a dom parent.","kind":"function","name":"getParentBounds","since":"3.16.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the parent bounds have changed size, otherwise `false`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#getParentBounds","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":681,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Attempts to lock the orientation of the web browser using the Screen Orientation API.\n\nThis API is only available on modern mobile browsers.\nSee https://developer.mozilla.org/en-US/docs/Web/API/Screen/lockOrientation for details.","kind":"function","name":"lockOrientation","since":"3.16.0","params":[{"type":{"names":["string"]},"description":"The orientation you'd like to lock the browser in. Should be an API string such as 'landscape', 'landscape-primary', 'portrait', etc.","name":"orientation"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the orientation was successfully locked, otherwise `false`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#lockOrientation","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":706,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"This method will set the size of the Parent Size component, which is used in scaling\nand centering calculations. You only need to call this method if you have explicitly\ndisabled the use of a parent in your game config, but still wish to take advantage of\nother Scale Manager features.","kind":"function","name":"setParentSize","fires":["Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new width of the parent.","name":"width"},{"type":{"names":["number"]},"description":"The new height of the parent.","name":"height"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"The Scale Manager instance."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#setParentSize","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":728,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"This method will set a new size for your game.\n\nIt should only be used if you're looking to change the base size of your game and are using\none of the Scale Manager scaling modes, i.e. `FIT`. If you're using `NONE` and wish to\nchange the game and canvas size directly, then please use the `resize` method instead.","kind":"function","name":"setGameSize","fires":["Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new width of the game.","name":"width"},{"type":{"names":["number"]},"description":"The new height of the game.","name":"height"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"The Scale Manager instance."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#setGameSize","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":780,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Call this to modify the size of the Phaser canvas element directly.\nYou should only use this if you are using the `NONE` scale mode,\nit will update all internal components completely.\n\nIf all you want to do is change the size of the parent, see the `setParentSize` method.\n\nIf all you want is to change the base size of the game, but still have the Scale Manager\nmanage all the scaling (i.e. you're **not** using `NONE`), then see the `setGameSize` method.\n\nThis method will set the `gameSize`, `baseSize` and `displaySize` components to the given\ndimensions. It will then resize the canvas width and height to the values given, by\ndirectly setting the properties. Finally, if you have set the Scale Manager zoom value\nto anything other than 1 (the default), it will set the canvas CSS width and height to\nbe the given size multiplied by the zoom factor (the canvas pixel size remains untouched).\n\nIf you have enabled `autoCenter`, it is then passed to the `updateCenter` method and\nthe margins are set, allowing the canvas to be centered based on its parent element\nalone. Finally, the `displayScale` is adjusted and the RESIZE event dispatched.","kind":"function","name":"resize","fires":["Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new width of the game.","name":"width"},{"type":{"names":["number"]},"description":"The new height of the game.","name":"height"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"The Scale Manager instance."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#resize","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":863,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Sets the zoom value of the Scale Manager.","kind":"function","name":"setZoom","fires":["Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The new zoom value of the game.","name":"value"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"The Scale Manager instance."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#setZoom","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":882,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Sets the zoom to be the maximum possible based on the _current_ parent size.","kind":"function","name":"setMaxZoom","fires":["Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"The Scale Manager instance."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#setMaxZoom","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":899,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Refreshes the internal scale values, bounds sizes and orientation checks.\n\nOnce finished, dispatches the resize event.\n\nThis is called automatically by the Scale Manager when the browser window size changes,\nas long as it is using a Scale Mode other than 'NONE'.","kind":"function","name":"refresh","fires":["Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The previous width of the game. Only set if the gameSize has changed.","name":"previousWidth"},{"type":{"names":["number"]},"optional":true,"description":"The previous height of the game. Only set if the gameSize has changed.","name":"previousHeight"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"The Scale Manager instance."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#refresh","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":947,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Internal method that checks the current screen orientation, only if the internal check flag is set.\n\nIf the orientation has changed it updates the orientation property and then dispatches the orientation change event.","kind":"function","name":"updateOrientation","fires":["Phaser.Scale.Events#event:ORIENTATION_CHANGE"],"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#updateOrientation","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":973,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Internal method that manages updating the size components based on the scale mode.","kind":"function","name":"updateScale","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#updateScale","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1063,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Calculates and returns the largest possible zoom factor, based on the current\nparent and game sizes. If the parent has no dimensions (i.e. an unstyled div),\nor is smaller than the un-zoomed game, then this will return a value of 1 (no zoom)","kind":"function","name":"getMaxZoom","since":"3.16.0","returns":[{"type":{"names":["integer"]},"description":"The maximum possible zoom factor. At a minimum this value is always at least 1."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#getMaxZoom","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1081,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Calculates and updates the canvas CSS style in order to center it within the\nbounds of its parent. If you have explicitly set parent to be `null` in your\ngame config then this method will likely give incorrect results unless you have called the\n`setParentSize` method first.\n\nIt works by modifying the canvas CSS `marginLeft` and `marginTop` properties.\n\nIf they have already been set by your own style sheet, or code, this will overwrite them.\n\nTo prevent the Scale Manager from centering the canvas, either do not set the\n`autoCenter` property in your game config, or make sure it is set to `NO_CENTER`.","kind":"function","name":"updateCenter","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#updateCenter","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Updates the `canvasBounds` rectangle to match the bounding client rectangle of the\ncanvas element being used to track input events.","kind":"function","name":"updateBounds","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#updateBounds","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Transforms the pageX value into the scaled coordinate space of the Scale Manager.","kind":"function","name":"transformX","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The DOM pageX value.","name":"pageX"}],"returns":[{"type":{"names":["number"]},"description":"The translated value."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#transformX","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Transforms the pageY value into the scaled coordinate space of the Scale Manager.","kind":"function","name":"transformY","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The DOM pageY value.","name":"pageY"}],"returns":[{"type":{"names":["number"]},"description":"The translated value."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#transformY","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Sends a request to the browser to ask it to go in to full screen mode, using the {@link https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API Fullscreen API}.\n\nIf the browser does not support this, a `FULLSCREEN_UNSUPPORTED` event will be emitted.\n\nThis method _must_ be called from a user-input gesture, such as `pointerup`. You cannot launch\ngames fullscreen without this, as most browsers block it. Games within an iframe will also be blocked\nfrom fullscreen unless the iframe has the `allowfullscreen` attribute.\n\nOn touch devices, such as Android and iOS Safari, you should always use `pointerup` and NOT `pointerdown`,\notherwise the request will fail unless the document in which your game is embedded has already received\nsome form of touch input, which you cannot guarantee. Activating fullscreen via `pointerup` circumvents\nthis issue.\n\nPerforming an action that navigates to another page, or opens another tab, will automatically cancel\nfullscreen mode, as will the user pressing the ESC key. To cancel fullscreen mode directly from your game,\ni.e. by clicking an icon, call the `stopFullscreen` method.\n\nA browser can only send one DOM element into fullscreen. You can control which element this is by\nsetting the `fullscreenTarget` property in your game config, or changing the property in the Scale Manager.\nNote that the game canvas _must_ be a child of the target. If you do not give a target, Phaser will\nautomatically create a blank `
` element and move the canvas into it, before going fullscreen.\nWhen it leaves fullscreen, the div will be removed.","kind":"function","name":"startFullscreen","fires":["Phaser.Scale.Events#event:ENTER_FULLSCREEN","Phaser.Scale.Events#event:FULLSCREEN_FAILED","Phaser.Scale.Events#event:FULLSCREEN_UNSUPPORTED","Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["object"]},"optional":true,"description":"The FullscreenOptions dictionary is used to provide configuration options when entering full screen.","name":"fullscreenOptions"}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#startFullscreen","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1294,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"An internal method that gets the target element that is used when entering fullscreen mode.","kind":"function","name":"getFullscreenTarget","since":"3.16.0","returns":[{"type":{"names":["object"]},"description":"The fullscreen target element."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#getFullscreenTarget","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1330,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Removes the fullscreen target that was added to the DOM.","kind":"function","name":"removeFullscreenTarget","since":"3.17.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#removeFullscreenTarget","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1353,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Calling this method will cancel fullscreen mode, if the browser has entered it.","kind":"function","name":"stopFullscreen","fires":["Phaser.Scale.Events#event:LEAVE_FULLSCREEN","Phaser.Scale.Events#event:FULLSCREEN_UNSUPPORTED"],"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#stopFullscreen","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1387,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Toggles the fullscreen mode. If already in fullscreen, calling this will cancel it.\nIf not in fullscreen, this will request the browser to enter fullscreen mode.\n\nIf the browser does not support this, a `FULLSCREEN_UNSUPPORTED` event will be emitted.\n\nThis method _must_ be called from a user-input gesture, such as `pointerdown`. You cannot launch\ngames fullscreen without this, as most browsers block it. Games within an iframe will also be blocked\nfrom fullscreen unless the iframe has the `allowfullscreen` attribute.","kind":"function","name":"toggleFullscreen","fires":["Phaser.Scale.Events#event:ENTER_FULLSCREEN","Phaser.Scale.Events#event:LEAVE_FULLSCREEN","Phaser.Scale.Events#event:FULLSCREEN_UNSUPPORTED","Phaser.Scale.Events#event:RESIZE"],"since":"3.16.0","params":[{"type":{"names":["object"]},"optional":true,"description":"The FullscreenOptions dictionary is used to provide configuration options when entering full screen.","name":"fullscreenOptions"}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#toggleFullscreen","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1418,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"An internal method that starts the different DOM event listeners running.","kind":"function","name":"startListeners","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#startListeners","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1471,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Triggered when a fullscreenchange event is dispatched by the DOM.","kind":"function","name":"onFullScreenChange","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#onFullScreenChange","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1486,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Triggered when a fullscreenerror event is dispatched by the DOM.","kind":"function","name":"onFullScreenError","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#onFullScreenError","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1497,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Internal method, called automatically by the game step.\nMonitors the elapsed time and resize interval to see if a parent bounds check needs to take place.","kind":"function","name":"step","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The time value from the most recent Game step. Typically a high-resolution timer value, or Date.now().","name":"time"},{"type":{"names":["number"]},"description":"The delta value since the last frame. This is smoothed to avoid delta spikes by the TimeStep class.","name":"delta"}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#step","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Stops all DOM event listeners.","kind":"function","name":"stopListeners","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#stopListeners","scope":"instance","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1555,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Destroys this Scale Manager, releasing all references to external resources.\nOnce destroyed, the Scale Manager cannot be used again.","kind":"function","name":"destroy","since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1580,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Is the browser currently in fullscreen mode or not?","name":"isFullscreen","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#isFullscreen","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The game width.\n\nThis is typically the size given in the game configuration.","name":"width","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1616,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"The game height.\n\nThis is typically the size given in the game configuration.","name":"height","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1635,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Is the device in a portrait orientation as reported by the Orientation API?\nThis value is usually only available on mobile devices.","name":"isPortrait","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#isPortrait","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1653,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Is the device in a landscape orientation as reported by the Orientation API?\nThis value is usually only available on mobile devices.","name":"isLandscape","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#isLandscape","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1671,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Are the game dimensions portrait? (i.e. taller than they are wide)\n\nThis is different to the device itself being in a portrait orientation.","name":"isGamePortrait","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#isGamePortrait","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScaleManager.js","lineno":1690,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"description":"Are the game dimensions landscape? (i.e. wider than they are tall)\n\nThis is different to the device itself being in a landscape orientation.","name":"isGameLandscape","type":{"names":["boolean"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#isGameLandscape","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for centering the game canvas.","kind":"namespace","name":"Center","memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.Center","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for centering the game canvas.\n\nTo find out what each mode does please see [Phaser.Scale.Center]{@link Phaser.Scale.Center}.","kind":"typedef","name":"CenterType","type":{"names":["Phaser.Scale.Center"]},"memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.CenterType","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is not centered within the parent by Phaser.\nYou can still center it yourself via CSS.","name":"NO_CENTER","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Center","longname":"Phaser.Scale.Center.NO_CENTER","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":38,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is centered both horizontally and vertically within the parent.\nTo do this, the parent has to have a bounds that can be calculated and not be empty.\n\nCentering is achieved by setting the margin left and top properties of the\ngame canvas, and does not factor in any other CSS styles you may have applied.","name":"CENTER_BOTH","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Center","longname":"Phaser.Scale.Center.CENTER_BOTH","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is centered horizontally within the parent.\nTo do this, the parent has to have a bounds that can be calculated and not be empty.\n\nCentering is achieved by setting the margin left and top properties of the\ngame canvas, and does not factor in any other CSS styles you may have applied.","name":"CENTER_HORIZONTALLY","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Center","longname":"Phaser.Scale.Center.CENTER_HORIZONTALLY","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is centered both vertically within the parent.\nTo do this, the parent has to have a bounds that can be calculated and not be empty.\n\nCentering is achieved by setting the margin left and top properties of the\ngame canvas, and does not factor in any other CSS styles you may have applied.","name":"CENTER_VERTICALLY","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Center","longname":"Phaser.Scale.Center.CENTER_VERTICALLY","scope":"static","___s":true},{"meta":{"filename":"ORIENTATION_CONST.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for orientation.","kind":"namespace","name":"Orientation","memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.Orientation","scope":"static","___s":true},{"meta":{"filename":"ORIENTATION_CONST.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for orientation.\n\nTo find out what each mode does please see [Phaser.Scale.Orientation]{@link Phaser.Scale.Orientation}.","kind":"typedef","name":"OrientationType","type":{"names":["Phaser.Scale.Orientation"]},"memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.OrientationType","scope":"static","___s":true},{"meta":{"filename":"ORIENTATION_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"A landscape orientation.","name":"LANDSCAPE","type":{"names":["string"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Orientation","longname":"Phaser.Scale.Orientation.LANDSCAPE","scope":"static","___s":true},{"meta":{"filename":"ORIENTATION_CONST.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"A portrait orientation.","name":"PORTRAIT","type":{"names":["string"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Orientation","longname":"Phaser.Scale.Orientation.PORTRAIT","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for the different scale modes available.","kind":"namespace","name":"ScaleModes","memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.ScaleModes","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for the different scale modes available.\n\nTo find out what each mode does please see [Phaser.Scale.ScaleModes]{@link Phaser.Scale.ScaleModes}.","kind":"typedef","name":"ScaleModeType","type":{"names":["Phaser.Scale.ScaleModes"]},"memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.ScaleModeType","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"No scaling happens at all. The canvas is set to the size given in the game config and Phaser doesn't change it\nagain from that point on. If you change the canvas size, either via CSS, or directly via code, then you need\nto call the Scale Managers `resize` method to give the new dimensions, or input events will stop working.","name":"NONE","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.ScaleModes","longname":"Phaser.Scale.ScaleModes.NONE","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The height is automatically adjusted based on the width.","name":"WIDTH_CONTROLS_HEIGHT","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.ScaleModes","longname":"Phaser.Scale.ScaleModes.WIDTH_CONTROLS_HEIGHT","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":49,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The width is automatically adjusted based on the height.","name":"HEIGHT_CONTROLS_WIDTH","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.ScaleModes","longname":"Phaser.Scale.ScaleModes.HEIGHT_CONTROLS_WIDTH","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":59,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The width and height are automatically adjusted to fit inside the given target area,\nwhile keeping the aspect ratio. Depending on the aspect ratio there may be some space\ninside the area which is not covered.","name":"FIT","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.ScaleModes","longname":"Phaser.Scale.ScaleModes.FIT","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The width and height are automatically adjusted to make the size cover the entire target\narea while keeping the aspect ratio. This may extend further out than the target size.","name":"ENVELOP","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.ScaleModes","longname":"Phaser.Scale.ScaleModes.ENVELOP","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The Canvas is resized to fit all available _parent_ space, regardless of aspect ratio.","name":"RESIZE","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.ScaleModes","longname":"Phaser.Scale.ScaleModes.RESIZE","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for zoom modes.","kind":"namespace","name":"Zoom","memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.Zoom","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Phaser Scale Manager constants for zoom modes.\n\nTo find out what each mode does please see [Phaser.Scale.Zoom]{@link Phaser.Scale.Zoom}.","kind":"typedef","name":"ZoomType","type":{"names":["Phaser.Scale.Zoom"]},"memberof":"Phaser.Scale","since":"3.16.0","longname":"Phaser.Scale.ZoomType","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas will not be zoomed by Phaser.","name":"NO_ZOOM","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Zoom","longname":"Phaser.Scale.Zoom.NO_ZOOM","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas will be 2x zoomed by Phaser.","name":"ZOOM_2X","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Zoom","longname":"Phaser.Scale.Zoom.ZOOM_2X","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas will be 4x zoomed by Phaser.","name":"ZOOM_4X","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Zoom","longname":"Phaser.Scale.Zoom.ZOOM_4X","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Calculate the zoom value based on the maximum multiplied game size that will\nfit into the parent, or browser window if no parent is set.","name":"MAX_ZOOM","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale.Zoom","longname":"Phaser.Scale.Zoom.MAX_ZOOM","scope":"static","___s":true},{"meta":{"range":[180,362],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ENTER_FULLSCREEN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"description":"The Scale Manager has successfully entered fullscreen mode.","kind":"event","name":"ENTER_FULLSCREEN","since":"3.16.1","memberof":"Phaser.Scale.Events","longname":"Phaser.Scale.Events#event:ENTER_FULLSCREEN","scope":"instance","___s":true},{"meta":{"filename":"FULLSCREEN_FAILED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"description":"The Scale Manager tried to enter fullscreen mode but failed.","kind":"event","name":"FULLSCREEN_FAILED","since":"3.17.0","memberof":"Phaser.Scale.Events","longname":"Phaser.Scale.Events#event:FULLSCREEN_FAILED","scope":"instance","___s":true},{"meta":{"filename":"FULLSCREEN_UNSUPPORTED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"description":"The Scale Manager tried to enter fullscreen mode, but it is unsupported by the browser.","kind":"event","name":"FULLSCREEN_UNSUPPORTED","since":"3.16.1","memberof":"Phaser.Scale.Events","longname":"Phaser.Scale.Events#event:FULLSCREEN_UNSUPPORTED","scope":"instance","___s":true},{"meta":{"filename":"LEAVE_FULLSCREEN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"description":"The Scale Manager was in fullscreen mode, but has since left, either directly via game code,\nor via a user gestured, such as pressing the ESC key.","kind":"event","name":"LEAVE_FULLSCREEN","since":"3.16.1","memberof":"Phaser.Scale.Events","longname":"Phaser.Scale.Events#event:LEAVE_FULLSCREEN","scope":"instance","___s":true},{"meta":{"filename":"ORIENTATION_CHANGE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"description":"The Scale Manager Orientation Change Event.","kind":"event","name":"ORIENTATION_CHANGE","since":"3.16.1","params":[{"type":{"names":["string"]},"description":"-","name":"orientation"}],"memberof":"Phaser.Scale.Events","longname":"Phaser.Scale.Events#event:ORIENTATION_CHANGE","scope":"instance","___s":true},{"meta":{"filename":"RESIZE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"description":"The Scale Manager Resize Event.\n\nThis event is dispatched whenever the Scale Manager detects a resize event from the browser.\nIt sends three parameters to the callback, each of them being Size components. You can read\nthe `width`, `height`, `aspectRatio` and other properties of these components to help with\nscaling your own game content.","kind":"event","name":"RESIZE","since":"3.16.1","params":[{"type":{"names":["Phaser.Structs.Size"]},"description":"A reference to the Game Size component. This is the un-scaled size of your game canvas.","name":"gameSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"A reference to the Base Size component. This is the game size multiplied by resolution.","name":"baseSize"},{"type":{"names":["Phaser.Structs.Size"]},"description":"A reference to the Display Size component. This is the scaled canvas size, after applying zoom and scale mode.","name":"displaySize"},{"type":{"names":["number"]},"description":"The current resolution. Defaults to 1 at the moment.","name":"resolution"},{"type":{"names":["number"]},"description":"If the `gameSize` has changed, this value contains its previous width, otherwise it contains the current width.","name":"previousWidth"},{"type":{"names":["number"]},"description":"If the `gameSize` has changed, this value contains its previous height, otherwise it contains the current height.","name":"previousHeight"}],"memberof":"Phaser.Scale.Events","longname":"Phaser.Scale.Events#event:RESIZE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Scale","longname":"Phaser.Scale.Events","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"name":"Extend","longname":"Extend","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scale"},"kind":"namespace","name":"Scale","memberof":"Phaser","longname":"Phaser.Scale","scope":"static","___s":true},{"meta":{"range":[180,234],"filename":"GetPhysicsPlugins.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetPhysicsPlugins.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Builds an array of which physics plugins should be activated for the given Scene.","kind":"function","name":"GetPhysicsPlugins","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"The scene system to get the physics systems of.","name":"sys"}],"returns":[{"type":{"names":["array"]},"description":"An array of Physics systems to start for this Scene."}],"memberof":"Phaser.Scenes","longname":"Phaser.Scenes.GetPhysicsPlugins","scope":"static","___s":true},{"meta":{"range":[180,234],"filename":"GetScenePlugins.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetScenePlugins.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Builds an array of which plugins (not including physics plugins) should be activated for the given Scene.","kind":"function","name":"GetScenePlugins","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"The Scene Systems object to check for plugins.","name":"sys"}],"returns":[{"type":{"names":["array"]},"description":"An array of all plugins which should be activated, either the default ones or the ones configured in the Scene Systems object."}],"memberof":"Phaser.Scenes","longname":"Phaser.Scenes.GetScenePlugins","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Scene.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Scene.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"classdesc":"A base Phaser.Scene class which can be extended for your own use.\n\nYou can also define the optional methods {@link Phaser.Types.Scenes.SceneInitCallback init()}, {@link Phaser.Types.Scenes.ScenePreloadCallback preload()}, and {@link Phaser.Types.Scenes.SceneCreateCallback create()}.","kind":"class","name":"Scene","memberof":"Phaser","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Scenes.SettingsConfig"]},"description":"Scene specific configuration settings.","name":"config"}],"scope":"static","longname":"Phaser.Scene","___s":true},{"meta":{"filename":"Scene.js","lineno":29,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Scene Systems. You must never overwrite this property, or all hell will break lose.","name":"sys","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#sys","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Phaser.Game instance.\nThis property will only be available if defined in the Scene Injection Map.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Animation Manager.\nThis property will only be available if defined in the Scene Injection Map.","name":"anims","type":{"names":["Phaser.Animations.AnimationManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#anims","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Cache.\nThis property will only be available if defined in the Scene Injection Map.","name":"cache","type":{"names":["Phaser.Cache.CacheManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#cache","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the game level Data Manager.\nThis property will only be available if defined in the Scene Injection Map.","name":"registry","type":{"names":["Phaser.Data.DataManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#registry","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Sound Manager.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"sound","type":{"names":["Phaser.Sound.BaseSoundManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#sound","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Texture Manager.\nThis property will only be available if defined in the Scene Injection Map.","name":"textures","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#textures","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Event Emitter.\nThis property will only be available if defined in the Scene Injection Map.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Camera System.\nThis property will only be available if defined in the Scene Injection Map.","name":"cameras","type":{"names":["Phaser.Cameras.Scene2D.CameraManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#cameras","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Game Object Factory.\nThis property will only be available if defined in the Scene Injection Map.","name":"add","type":{"names":["Phaser.GameObjects.GameObjectFactory"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#add","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Game Object Creator.\nThis property will only be available if defined in the Scene Injection Map.","name":"make","type":{"names":["Phaser.GameObjects.GameObjectCreator"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#make","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene Manager Plugin.\nThis property will only be available if defined in the Scene Injection Map.","name":"scene","type":{"names":["Phaser.Scenes.ScenePlugin"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Game Object Display List.\nThis property will only be available if defined in the Scene Injection Map.","name":"children","type":{"names":["Phaser.GameObjects.DisplayList"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#children","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Lights Manager Plugin.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"lights","type":{"names":["Phaser.GameObjects.LightsManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#lights","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Data Manager Plugin.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Input Manager Plugin.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"input","type":{"names":["Phaser.Input.InputPlugin"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#input","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":188,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Loader Plugin.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"load","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#load","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":198,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Time and Clock Plugin.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"time","type":{"names":["Phaser.Time.Clock"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#time","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":208,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Tween Manager Plugin.\nThis property will only be available if defined in the Scene Injection Map and the plugin is installed.","name":"tweens","type":{"names":["Phaser.Tweens.TweenManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#tweens","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":218,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Arcade Physics Plugin.\nThis property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.","name":"physics","type":{"names":["Phaser.Physics.Arcade.ArcadePhysics"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#physics","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":228,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Impact Physics Plugin.\nThis property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.","name":"impact","type":{"names":["Phaser.Physics.Impact.ImpactPhysics"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#impact","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":238,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Matter Physics Plugin.\nThis property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.","name":"matter","type":{"names":["Phaser.Physics.Matter.MatterPhysics"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#matter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":250,"columnno":12,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A scene level Facebook Instant Games Plugin.\nThis property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.","name":"facebook","type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"since":"3.12.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#facebook","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":261,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Scale Manager.\nThis property will only be available if defined in the Scene Injection Map.","name":"scale","type":{"names":["Phaser.Scale.ScaleManager"]},"since":"3.16.2","memberof":"Phaser.Scene","longname":"Phaser.Scene#scale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":271,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Plugin Manager.\n\nThe Plugin Manager is a global system that allows plugins to register themselves with it, and can then install\nthose plugins into Scenes as required.","name":"plugins","type":{"names":["Phaser.Plugins.PluginManager"]},"since":"3.0.0","memberof":"Phaser.Scene","longname":"Phaser.Scene#plugins","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Scene.js","lineno":284,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Should be overridden by your own Scenes.\nThis method is called once per game step while the scene is running.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Scene","longname":"Phaser.Scene#update","scope":"instance","___s":true},{"meta":{"range":[180,213],"filename":"SceneManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SceneManager.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"classdesc":"The Scene Manager.\n\nThe Scene Manager is a Game level system, responsible for creating, processing and updating all of the\nScenes in a Game instance.","kind":"class","name":"SceneManager","memberof":"Phaser.Scenes","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Phaser.Game instance this Scene Manager belongs to.","name":"game"},{"type":{"names":["object"]},"description":"Scene specific configuration settings.","name":"sceneConfig"}],"scope":"static","longname":"Phaser.Scenes.SceneManager","___s":true},{"meta":{"filename":"SceneManager.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Game that this SceneManager belongs to.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SceneManager.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"An object that maps the keys to the scene so we can quickly get a scene from a key without iteration.","name":"keys","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#keys","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SceneManager.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The array in which all of the scenes are kept.","name":"scenes","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#scenes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SceneManager.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is the Scene Manager actively processing the Scenes list?","name":"isProcessing","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#isProcessing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SceneManager.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Has the Scene Manager properly started?","name":"isBooted","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.4.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#isBooted","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SceneManager.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Do any of the Cameras in any of the Scenes require a custom viewport?\nIf not we can skip scissor tests.","name":"customViewports","type":{"names":["number"]},"defaultvalue":"0","since":"3.12.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#customViewports","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"SceneManager.js","lineno":244,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Process the Scene operations queue.","kind":"function","name":"processQueue","since":"3.0.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#processQueue","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Adds a new Scene into the SceneManager.\nYou must give each Scene a unique key by which you'll identify it.\n\nThe `sceneConfig` can be:\n\n* A `Phaser.Scene` object, or an object that extends it.\n* A plain JavaScript object\n* A JavaScript ES6 Class that extends `Phaser.Scene`\n* A JavaScript ES5 prototype based Class\n* A JavaScript function\n\nIf a function is given then a new Scene will be created by calling it.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.","name":"key"},{"type":{"names":["Phaser.Scene","Phaser.Types.Scenes.SettingsConfig","Phaser.Types.Scenes.CreateSceneFromObjectConfig","function"]},"description":"The config for the Scene","name":"sceneConfig"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the Scene will be started immediately after being added.","name":"autoStart"},{"type":{"names":["object"]},"optional":true,"description":"Optional data object. This will be set as Scene.settings.data and passed to `Scene.init`.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scene"]},"nullable":true,"description":"The added Scene, if it was added immediately, otherwise `null`."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#add","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":388,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Removes a Scene from the SceneManager.\n\nThe Scene is removed from the local scenes array, it's key is cleared from the keys\ncache and Scene.Systems.destroy is then called on it.\n\nIf the SceneManager is processing the Scenes when this method is called it will\nqueue the operation for the next update sequence.","kind":"function","name":"remove","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#remove","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Updates the Scenes.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Time elapsed.","name":"time"},{"type":{"names":["number"]},"description":"Delta time from the last update.","name":"delta"}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#update","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Renders the Scenes.","kind":"function","name":"render","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The renderer to use.","name":"renderer"}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#render","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":834,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Returns an array of all the current Scenes being managed by this Scene Manager.\n\nYou can filter the output by the active state of the Scene and choose to have\nthe array returned in normal or reversed order.","kind":"function","name":"getScenes","since":"3.16.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Only include Scene's that are currently active?","name":"isActive"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Return the array of Scenes in reverse?","name":"inReverse"}],"returns":[{"type":{"names":["Array."]},"description":"An array containing all of the Scenes in the Scene Manager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#getScenes","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":869,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Retrieves a Scene.","kind":"function","name":"getScene","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to retrieve.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scene"]},"nullable":true,"description":"The Scene."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#getScene","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":902,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Determines whether a Scene is running.","kind":"function","name":"isActive","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is running."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#isActive","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":924,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Determines whether a Scene is paused.","kind":"function","name":"isPaused","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is paused."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#isPaused","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":946,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Determines whether a Scene is visible.","kind":"function","name":"isVisible","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is visible."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#isVisible","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":968,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Determines whether a Scene is sleeping.","kind":"function","name":"isSleeping","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is sleeping."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#isSleeping","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":990,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Pauses the given Scene.","kind":"function","name":"pause","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to pause.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted by its pause event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#pause","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1013,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Resumes the given Scene.","kind":"function","name":"resume","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to resume.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted by its resume event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#resume","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1036,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Puts the given Scene to sleep.","kind":"function","name":"sleep","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to put to sleep.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted by its sleep event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#sleep","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1059,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Awakens the given Scene.","kind":"function","name":"wake","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to wake up.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted by its wake event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#wake","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1082,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Runs the given Scene.\n\nIf the given Scene is paused, it will resume it. If sleeping, it will wake it.\nIf not running at all, it will be started.\n\nUse this if you wish to open a modal Scene by calling `pause` on the current\nScene, then `run` on the modal Scene.","kind":"function","name":"run","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"The Scene to run.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed to the Scene on start, wake, or resume.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This Scene Manager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#run","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1133,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Starts the given Scene.","kind":"function","name":"start","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to start.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"Optional data object to pass to Scene.Settings and Scene.init.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#start","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Stops the given Scene.","kind":"function","name":"stop","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to stop.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"Optional data object to pass to Scene.shutdown.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#stop","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Sleeps one one Scene and starts the other.","kind":"function","name":"switch","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to sleep.","name":"from"},{"type":{"names":["string"]},"description":"The Scene to start.","name":"to"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#switch","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Retrieves a Scene by numeric index.","kind":"function","name":"getAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the Scene to retrieve.","name":"index"}],"returns":[{"type":{"names":["Phaser.Scene","undefined"]},"description":"The Scene."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#getAt","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1275,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Retrieves the numeric index of a Scene.","kind":"function","name":"getIndex","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The key of the Scene.","name":"key"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the Scene."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#getIndex","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1292,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Brings a Scene to the top of the Scenes list.\n\nThis means it will render above all other Scenes.","kind":"function","name":"bringToTop","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#bringToTop","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1326,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Sends a Scene to the back of the Scenes list.\n\nThis means it will render below all other Scenes.","kind":"function","name":"sendToBack","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#sendToBack","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1360,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Moves a Scene down one position in the Scenes list.","kind":"function","name":"moveDown","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#moveDown","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1394,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Moves a Scene up one position in the Scenes list.","kind":"function","name":"moveUp","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#moveUp","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1428,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Moves a Scene so it is immediately above another Scene in the Scenes list.\n\nThis means it will render over the top of the other Scene.","kind":"function","name":"moveAbove","since":"3.2.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene that Scene B will be moved above.","name":"keyA"},{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to be moved.","name":"keyB"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#moveAbove","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Moves a Scene so it is immediately below another Scene in the Scenes list.\n\nThis means it will render behind the other Scene.","kind":"function","name":"moveBelow","since":"3.2.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene that Scene B will be moved above.","name":"keyA"},{"type":{"names":["string","Phaser.Scene"]},"description":"The Scene to be moved.","name":"keyB"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#moveBelow","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1543,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Swaps the positions of two Scenes in the Scenes list.","kind":"function","name":"swapPosition","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Scene"]},"description":"The first Scene to swap.","name":"keyA"},{"type":{"names":["string","Phaser.Scene"]},"description":"The second Scene to swap.","name":"keyB"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#swapPosition","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1582,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Dumps debug information about each Scene to the developer console.","kind":"function","name":"dump","since":"3.2.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#dump","scope":"instance","___s":true},{"meta":{"filename":"SceneManager.js","lineno":1606,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Destroy the SceneManager and all of its Scene's systems.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Scenes.SceneManager","longname":"Phaser.Scenes.SceneManager#destroy","scope":"instance","___s":true},{"meta":{"range":[180,212],"filename":"ScenePlugin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"classdesc":"A proxy class to the Global Scene Manager.","kind":"class","name":"ScenePlugin","memberof":"Phaser.Scenes","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that this ScenePlugin belongs to.","name":"scene"}],"scope":"static","longname":"Phaser.Scenes.ScenePlugin","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":30,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Scene that this ScenePlugin belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Scene Systems instance of the Scene that this ScenePlugin belongs to.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The settings of the Scene this ScenePlugin belongs to.","name":"settings","type":{"names":["Phaser.Types.Scenes.SettingsObject"]},"since":"3.0.0","memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#settings","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The key of the Scene this ScenePlugin belongs to.","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":66,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Game's SceneManager.","name":"manager","type":{"names":["Phaser.Scenes.SceneManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"If this Scene is currently transitioning to another, this holds\nthe current percentage of the transition progress, between 0 and 1.","name":"transitionProgress","type":{"names":["number"]},"since":"3.5.0","memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#transitionProgress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":188,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Shutdown this Scene and run the given one.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"start","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to start.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"The Scene data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#start","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":211,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Restarts this Scene.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"restart","since":"3.4.0","params":[{"type":{"names":["object"]},"optional":true,"description":"The Scene data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#restart","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":233,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"This will start a transition from the current Scene to the target Scene given.\n\nThe transition will last for the duration specified in milliseconds.\n\nYou can have the target Scene moved above or below this one in the display list.\n\nYou can specify an update callback. This callback will be invoked _every frame_ for the duration\nof the transition.\n\nThis Scene can either be sent to sleep at the end of the transition, or stopped. The default is to stop.\n\nThere are also 5 transition related events: This scene will emit the event `transitionout` when\nthe transition begins, which is typically the frame after calling this method.\n\nThe target Scene will emit the event `transitioninit` when that Scene's `init` method is called.\nIt will then emit the event `transitionstart` when its `create` method is called.\nIf the Scene was sleeping and has been woken up, it will emit the event `transitionwake` instead of these two,\nas the Scenes `init` and `create` methods are not invoked when a Scene wakes up.\n\nWhen the duration of the transition has elapsed it will emit the event `transitioncomplete`.\nThese events are cleared of all listeners when the Scene shuts down, but not if it is sent to sleep.\n\nIt's important to understand that the duration of the transition begins the moment you call this method.\nIf the Scene you are transitioning to includes delayed processes, such as waiting for files to load, the\ntime still counts down even while that is happening. If the game itself pauses, or something else causes\nthis Scenes update loop to stop, then the transition will also pause for that duration. There are\nchecks in place to prevent you accidentally stopping a transitioning Scene but if you've got code to\noverride this understand that until the target Scene completes it might never be unlocked for input events.","kind":"function","name":"transition","fires":["Phaser.Scenes.Events#event:TRANSITION_OUT"],"since":"3.5.0","params":[{"type":{"names":["Phaser.Types.Scenes.SceneTransitionConfig"]},"description":"The transition configuration object.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` is the transition was started, otherwise `false`."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#transition","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Add the Scene into the Scene Manager and start it if 'autoStart' is true or the Scene config 'active' property is set.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene key.","name":"key"},{"type":{"names":["Phaser.Scene","Phaser.Types.Scenes.SettingsConfig","Phaser.Types.Scenes.CreateSceneFromObjectConfig","function"]},"description":"The config for the Scene.","name":"sceneConfig"},{"type":{"names":["boolean"]},"description":"Whether to start the Scene after it's added.","name":"autoStart"},{"type":{"names":["object"]},"optional":true,"description":"Optional data object. This will be set as Scene.settings.data and passed to `Scene.init`.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scene"]},"description":"An instance of the Scene that was added to the Scene Manager."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#add","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":448,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Launch the given Scene and run it in parallel with this one.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"launch","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to launch.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"The Scene data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#launch","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":471,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Runs the given Scene, but does not change the state of this Scene.\n\nThis will happen at the next Scene Manager update, not immediately.\n\nIf the given Scene is paused, it will resume it. If sleeping, it will wake it.\nIf not running at all, it will be started.\n\nUse this if you wish to open a modal Scene by calling `pause` on the current\nScene, then `run` on the modal Scene.","kind":"function","name":"run","since":"3.10.0","params":[{"type":{"names":["string"]},"description":"The Scene to run.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed to the Scene and emitted in its ready, wake, or resume events.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#run","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":500,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Pause the Scene - this stops the update step from happening but it still renders.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"pause","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to pause.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted in its pause event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#pause","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":522,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Resume the Scene - starts the update loop again.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"resume","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to resume.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted in its resume event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#resume","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":544,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Makes the Scene sleep (no update, no render) but doesn't shutdown.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"sleep","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to put to sleep.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted in its sleep event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#sleep","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":566,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Makes the Scene wake-up (starts update and render)\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"wake","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to wake up.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted in its wake event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#wake","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":588,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Makes this Scene sleep then starts the Scene given.\n\nThis will happen at the next Scene Manager update, not immediately.","kind":"function","name":"switch","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to start.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#switch","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":610,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Shutdown the Scene, clearing display list, timers, etc.\n\nThis happens at the next Scene Manager update, not immediately.","kind":"function","name":"stop","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to stop.","name":"key"},{"type":{"names":["any"]},"optional":true,"description":"Optional data object to pass to Scene.Systems.shutdown.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#stop","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Sets the active state of the given Scene.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"If `true` the Scene will be resumed. If `false` it will be paused.","name":"value"},{"type":{"names":["string"]},"optional":true,"description":"The Scene to set the active state of.","name":"key"},{"type":{"names":["object"]},"optional":true,"description":"An optional data object that will be passed to the Scene and emitted with its events.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#setActive","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":658,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Sets the visible state of the given Scene.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible value.","name":"value"},{"type":{"names":["string"]},"optional":true,"description":"The Scene to set the visible state for.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#setVisible","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Checks if the given Scene is sleeping or not?","kind":"function","name":"isSleeping","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is sleeping."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#isSleeping","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":700,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Checks if the given Scene is running or not?","kind":"function","name":"isActive","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is running."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#isActive","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Checks if the given Scene is paused or not?","kind":"function","name":"isPaused","since":"3.17.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is paused."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#isPaused","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":734,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Checks if the given Scene is visible or not?","kind":"function","name":"isVisible","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the Scene is visible."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#isVisible","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":751,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Swaps the position of two scenes in the Scenes list.\n\nThis controls the order in which they are rendered and updated.","kind":"function","name":"swapPosition","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The first Scene to swap.","name":"keyA"},{"type":{"names":["string"]},"optional":true,"description":"The second Scene to swap. If none is given it defaults to this Scene.","name":"keyB"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#swapPosition","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":776,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Swaps the position of two scenes in the Scenes list, so that Scene B is directly above Scene A.\n\nThis controls the order in which they are rendered and updated.","kind":"function","name":"moveAbove","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The Scene that Scene B will be moved to be above.","name":"keyA"},{"type":{"names":["string"]},"optional":true,"description":"The Scene to be moved. If none is given it defaults to this Scene.","name":"keyB"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#moveAbove","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":801,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Swaps the position of two scenes in the Scenes list, so that Scene B is directly below Scene A.\n\nThis controls the order in which they are rendered and updated.","kind":"function","name":"moveBelow","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The Scene that Scene B will be moved to be below.","name":"keyA"},{"type":{"names":["string"]},"optional":true,"description":"The Scene to be moved. If none is given it defaults to this Scene.","name":"keyB"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#moveBelow","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":826,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Removes a Scene from the SceneManager.\n\nThe Scene is removed from the local scenes array, it's key is cleared from the keys\ncache and Scene.Systems.destroy is then called on it.\n\nIf the SceneManager is processing the Scenes when this method is called it will\nqueue the operation for the next update sequence.","kind":"function","name":"remove","since":"3.2.0","params":[{"type":{"names":["string","Phaser.Scene"]},"optional":true,"description":"The Scene to be removed.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.SceneManager"]},"description":"This SceneManager."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#remove","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":851,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Moves a Scene up one position in the Scenes list.","kind":"function","name":"moveUp","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#moveUp","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":870,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Moves a Scene down one position in the Scenes list.","kind":"function","name":"moveDown","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#moveDown","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":889,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Brings a Scene to the top of the Scenes list.\n\nThis means it will render above all other Scenes.","kind":"function","name":"bringToTop","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#bringToTop","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":910,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Sends a Scene to the back of the Scenes list.\n\nThis means it will render below all other Scenes.","kind":"function","name":"sendToBack","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The Scene to move.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scenes.ScenePlugin"]},"description":"This ScenePlugin object."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#sendToBack","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":931,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Retrieve a Scene.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The Scene to retrieve.","name":"key"}],"returns":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#get","scope":"instance","___s":true},{"meta":{"filename":"ScenePlugin.js","lineno":946,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Retrieves the numeric index of a Scene in the Scenes list.","kind":"function","name":"getIndex","since":"3.7.0","params":[{"type":{"names":["string","Phaser.Scene"]},"optional":true,"description":"The Scene to get the index of.","name":"key"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the Scene."}],"memberof":"Phaser.Scenes.ScenePlugin","longname":"Phaser.Scenes.ScenePlugin#getIndex","scope":"instance","___s":true},{"meta":{"range":[180,206],"filename":"Settings.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Settings.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"kind":"namespace","name":"Settings","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.Settings","scope":"static","___s":true},{"meta":{"filename":"Settings.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Takes a Scene configuration object and returns a fully formed System Settings object.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Scenes.SettingsConfig"]},"description":"The Scene configuration object used to create this Scene Settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Types.Scenes.SettingsObject"]},"description":"The Scene Settings object created as a result of the config and default settings."}],"memberof":"Phaser.Scenes.Settings","longname":"Phaser.Scenes.Settings.create","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Systems.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Systems.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"classdesc":"The Scene Systems class.\n\nThis class is available from within a Scene under the property `sys`.\nIt is responsible for managing all of the plugins a Scene has running, including the display list, and\nhandling the update step and renderer. It also contains references to global systems belonging to Game.","kind":"class","name":"Systems","memberof":"Phaser.Scenes","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that owns this Systems instance.","name":"scene"},{"type":{"names":["string","Phaser.Types.Scenes.SettingsConfig"]},"description":"Scene specific configuration settings.","name":"config"}],"scope":"static","longname":"Phaser.Scenes.Systems","___s":true},{"meta":{"filename":"Systems.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene that these Systems belong to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Phaser Game instance.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to either the Canvas or WebGL Renderer that this Game is using.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.17.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":67,"columnno":12,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Facebook Instant Games Plugin.","name":"facebook","type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"since":"3.12.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#facebook","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Scene Configuration object, as passed in when creating the Scene.","name":"config","type":{"names":["string","Phaser.Types.Scenes.SettingsConfig"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#config","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"The Scene Settings. This is the parsed output based on the Scene configuration.","name":"settings","type":{"names":["Phaser.Types.Scenes.SettingsObject"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#settings","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A handy reference to the Scene canvas / context.","name":"canvas","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Canvas Rendering Context being used by the renderer.","name":"context","type":{"names":["CanvasRenderingContext2D"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Animations Manager.\n\nIn the default set-up you can access this from within a Scene via the `this.anims` property.","name":"anims","type":{"names":["Phaser.Animations.AnimationManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#anims","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Cache. The Cache stores all files bought in to Phaser via\nthe Loader, with the exception of images. Images are stored in the Texture Manager.\n\nIn the default set-up you can access this from within a Scene via the `this.cache` property.","name":"cache","type":{"names":["Phaser.Cache.CacheManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#cache","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Plugins Manager.\n\nIn the default set-up you can access this from within a Scene via the `this.plugins` property.","name":"plugins","type":{"names":["Phaser.Plugins.PluginManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#plugins","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":149,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global registry. This is a game-wide instance of the Data Manager, allowing\nyou to exchange data between Scenes via a universal and shared point.\n\nIn the default set-up you can access this from within a Scene via the `this.registry` property.","name":"registry","type":{"names":["Phaser.Data.DataManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#registry","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Scale Manager.\n\nIn the default set-up you can access this from within a Scene via the `this.scale` property.","name":"scale","type":{"names":["Phaser.Scale.ScaleManager"]},"since":"3.15.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#scale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":172,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Sound Manager.\n\nIn the default set-up you can access this from within a Scene via the `this.sound` property.","name":"sound","type":{"names":["Phaser.Sound.NoAudioSoundManager","Phaser.Sound.HTML5AudioSoundManager","Phaser.Sound.WebAudioSoundManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#sound","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the global Texture Manager.\n\nIn the default set-up you can access this from within a Scene via the `this.textures` property.","name":"textures","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#textures","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene's Game Object Factory.\n\nUse this to quickly and easily create new Game Object's.\n\nIn the default set-up you can access this from within a Scene via the `this.add` property.","name":"add","type":{"names":["Phaser.GameObjects.GameObjectFactory"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#add","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":209,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene's Camera Manager.\n\nUse this to manipulate and create Cameras for this specific Scene.\n\nIn the default set-up you can access this from within a Scene via the `this.cameras` property.","name":"cameras","type":{"names":["Phaser.Cameras.Scene2D.CameraManager"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#cameras","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":222,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene's Display List.\n\nUse this to organize the children contained in the display list.\n\nIn the default set-up you can access this from within a Scene via the `this.children` property.","name":"displayList","type":{"names":["Phaser.GameObjects.DisplayList"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#displayList","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":235,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene's Event Manager.\n\nUse this to listen for Scene specific events, such as `pause` and `shutdown`.\n\nIn the default set-up you can access this from within a Scene via the `this.events` property.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#events","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":248,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene's Game Object Creator.\n\nUse this to quickly and easily create new Game Object's. The difference between this and the\nGame Object Factory, is that the Creator just creates and returns Game Object instances, it\ndoesn't then add them to the Display List or Update List.\n\nIn the default set-up you can access this from within a Scene via the `this.make` property.","name":"make","type":{"names":["Phaser.GameObjects.GameObjectCreator"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#make","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":263,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene Manager Plugin.\n\nUse this to manipulate both this and other Scene's in your game, for example to launch a parallel Scene,\nor pause or resume a Scene, or switch from this Scene to another.\n\nIn the default set-up you can access this from within a Scene via the `this.scene` property.","name":"scenePlugin","type":{"names":["Phaser.Scenes.ScenePlugin"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#scenePlugin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":277,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A reference to the Scene's Update List.\n\nUse this to organize the children contained in the update list.\n\nThe Update List is responsible for managing children that need their `preUpdate` methods called,\nin order to process so internal components, such as Sprites with Animations.\n\nIn the default set-up there is no reference to this from within the Scene itself.","name":"updateList","type":{"names":["Phaser.GameObjects.UpdateList"]},"since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#updateList","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Systems.js","lineno":362,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"A single game step. Called automatically by the Scene Manager as a result of a Request Animation\nFrame or Set Timeout call to the main Game instance.","kind":"function","name":"step","fires":["Phaser.Scenes.Events#event:PRE_UPDATE","Phaser.Scenes.Events#event:_UPDATE","Phaser.Scenes.Events#event:POST_UPDATE"],"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The time value from the most recent Game step. Typically a high-resolution timer value, or Date.now().","name":"time"},{"type":{"names":["number"]},"description":"The delta value since the last frame. This is smoothed to avoid delta spikes by the TimeStep class.","name":"delta"}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#step","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":386,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Called automatically by the Scene Manager.\nInstructs the Scene to render itself via its Camera Manager to the renderer given.","kind":"function","name":"render","fires":["Phaser.Scenes.Events#event:RENDER"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The renderer that invoked the render call.","name":"renderer"}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#render","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":407,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Force a sort of the display list on the next render.","kind":"function","name":"queueDepthSort","since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#queueDepthSort","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":418,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Immediately sorts the display list if the flag is set.","kind":"function","name":"depthSort","since":"3.0.0","memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#depthSort","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":429,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Pause this Scene.\nA paused Scene still renders, it just doesn't run ANY of its update handlers or systems.","kind":"function","name":"pause","fires":["Phaser.Scenes.Events#event:PAUSE"],"since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed in the 'pause' event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"This Systems object."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#pause","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":455,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Resume this Scene from a paused state.","kind":"function","name":"resume","fires":["Phaser.Scenes.Events#event:RESUME"],"since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed in the 'resume' event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"This Systems object."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#resume","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":480,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Send this Scene to sleep.\n\nA sleeping Scene doesn't run its update step or render anything, but it also isn't shut down\nor has any of its systems or children removed, meaning it can be re-activated at any point and\nwill carry on from where it left off. It also keeps everything in memory and events and callbacks\nfrom other Scenes may still invoke changes within it, so be careful what is left active.","kind":"function","name":"sleep","fires":["Phaser.Scenes.Events#event:SLEEP"],"since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed in the 'sleep' event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"This Systems object."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#sleep","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":508,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Wake-up this Scene if it was previously asleep.","kind":"function","name":"wake","fires":["Phaser.Scenes.Events#event:WAKE"],"since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed in the 'wake' event.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"This Systems object."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#wake","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":538,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Returns any data that was sent to this Scene by another Scene.\n\nThe data is also passed to `Scene.init` and in various Scene events, but\nyou can access it at any point via this method.","kind":"function","name":"getData","since":"3.22.0","returns":[{"type":{"names":["any"]}}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#getData","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene sleeping?","kind":"function","name":"isSleeping","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is asleep, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isSleeping","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":567,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene running?","kind":"function","name":"isActive","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is running, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isActive","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":580,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene paused?","kind":"function","name":"isPaused","since":"3.13.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is paused, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isPaused","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":593,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene currently transitioning out to, or in from another Scene?","kind":"function","name":"isTransitioning","since":"3.5.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is currently transitioning, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isTransitioning","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":606,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene currently transitioning out from itself to another Scene?","kind":"function","name":"isTransitionOut","since":"3.5.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is in transition to another Scene, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isTransitionOut","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":619,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene currently transitioning in from another Scene?","kind":"function","name":"isTransitionIn","since":"3.5.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is transitioning in from another Scene, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isTransitionIn","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Is this Scene visible and rendering?","kind":"function","name":"isVisible","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Scene is visible, otherwise `false`."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#isVisible","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":645,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Sets the visible state of this Scene.\nAn invisible Scene will not render, but will still process updates.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to render this Scene, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"This Systems object."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#setVisible","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":663,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Set the active state of this Scene.\n\nAn active Scene will run its core update loop.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"If `true` the Scene will be resumed, if previously paused. If `false` it will be paused.","name":"value"},{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed in the 'resume' or 'pause' events.","name":"data"}],"returns":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"This Systems object."}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#setActive","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":688,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Start this Scene running and rendering.\nCalled automatically by the SceneManager.","kind":"function","name":"start","fires":["Phaser.Scenes.Events#event:START","Phaser.Scenes.Events#event:READY"],"since":"3.0.0","params":[{"type":{"names":["object"]},"description":"Optional data object that may have been passed to this Scene from another.","name":"data"}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#start","scope":"instance","___s":true},{"meta":{"filename":"Systems.js","lineno":718,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Shutdown this Scene and send a shutdown event to all of its systems.\nA Scene that has been shutdown will not run its update loop or render, but it does\nnot destroy any of its plugins or references. It is put into hibernation for later use.\nIf you don't ever plan to use this Scene again, then it should be destroyed instead\nto free-up resources.","kind":"function","name":"shutdown","fires":["Phaser.Scenes.Events#event:SHUTDOWN"],"since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"A data object that will be passed in the 'shutdown' event.","name":"data"}],"memberof":"Phaser.Scenes.Systems","longname":"Phaser.Scenes.Systems#shutdown","scope":"instance","___s":true},{"meta":{"range":[221,1790],"filename":"const.js","lineno":13,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene consts.","ignore":true,"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"PENDING","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.PENDING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":25,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"INIT","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.INIT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"START","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.START","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"LOADING","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.LOADING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":55,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"CREATING","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.CREATING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":65,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"RUNNING","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.RUNNING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":75,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"PAUSED","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.PAUSED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":85,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"SLEEPING","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.SLEEPING","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":95,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"SHUTDOWN","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.SHUTDOWN","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"description":"Scene state.","name":"DESTROYED","readonly":true,"type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.DESTROYED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"BOOT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Boot Event.\n\nThis event is dispatched by a Scene during the Scene Systems boot process. Primarily used by Scene Plugins.\n\nListen to it from a Scene using `this.scene.events.on('boot', listener)`.","kind":"event","name":"BOOT","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:BOOT","scope":"instance","___s":true},{"meta":{"filename":"CREATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Create Event.\n\nThis event is dispatched by a Scene after it has been created by the Scene Manager.\n\nIf a Scene has a `create` method then this event is emitted _after_ that has run.\n\nIf there is a transition, this event will be fired after the `TRANSITION_START` event.\n\nListen to it from a Scene using `this.scene.events.on('create', listener)`.","kind":"event","name":"CREATE","since":"3.17.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that emitted this event.","name":"scene"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:CREATE","scope":"instance","___s":true},{"meta":{"filename":"DESTROY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Destroy Event.\n\nThis event is dispatched by a Scene during the Scene Systems destroy process.\n\nListen to it from a Scene using `this.scene.events.on('destroy', listener)`.\n\nYou should destroy any resources that may be in use by your Scene in this event handler.","kind":"event","name":"DESTROY","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:DESTROY","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Pause Event.\n\nThis event is dispatched by a Scene when it is paused, either directly via the `pause` method, or as an\naction from another Scene.\n\nListen to it from a Scene using `this.scene.events.on('pause', listener)`.","kind":"event","name":"PAUSE","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["any"]},"optional":true,"description":"An optional data object that was passed to this Scene when it was paused.","name":"data"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:PAUSE","scope":"instance","___s":true},{"meta":{"filename":"POST_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Post Update Event.\n\nThis event is dispatched by a Scene during the main game loop step.\n\nThe event flow for a single step of a Scene is as follows:\n\n1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\n2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\n3. The `Scene.update` method is called, if it exists\n4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\n5. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\n\nListen to it from a Scene using `this.scene.events.on('postupdate', listener)`.\n\nA Scene will only run its step if it is active.","kind":"event","name":"POST_UPDATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:POST_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"PRE_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Pre Update Event.\n\nThis event is dispatched by a Scene during the main game loop step.\n\nThe event flow for a single step of a Scene is as follows:\n\n1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\n2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\n3. The `Scene.update` method is called, if it exists\n4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\n5. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\n\nListen to it from a Scene using `this.scene.events.on('preupdate', listener)`.\n\nA Scene will only run its step if it is active.","kind":"event","name":"PRE_UPDATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:PRE_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"READY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Ready Event.\n\nThis event is dispatched by a Scene during the Scene Systems start process.\nBy this point in the process the Scene is now fully active and rendering.\nThis event is meant for your game code to use, as all plugins have responded to the earlier 'start' event.\n\nListen to it from a Scene using `this.scene.events.on('ready', listener)`.","kind":"event","name":"READY","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["any"]},"optional":true,"description":"An optional data object that was passed to this Scene when it was started.","name":"data"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:READY","scope":"instance","___s":true},{"meta":{"filename":"RENDER_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Render Event.\n\nThis event is dispatched by a Scene during the main game loop step.\n\nThe event flow for a single step of a Scene is as follows:\n\n1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\n2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\n3. The `Scene.update` method is called, if it exists\n4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\n5. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\n\nListen to it from a Scene using `this.scene.events.on('render', listener)`.\n\nA Scene will only render if it is visible and active.\nBy the time this event is dispatched, the Scene will have already been rendered.","kind":"event","name":"RENDER","since":"3.0.0","params":[{"type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"description":"The renderer that rendered the Scene.","name":"renderer"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:RENDER","scope":"instance","___s":true},{"meta":{"filename":"RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Resume Event.\n\nThis event is dispatched by a Scene when it is resumed from a paused state, either directly via the `resume` method,\nor as an action from another Scene.\n\nListen to it from a Scene using `this.scene.events.on('resume', listener)`.","kind":"event","name":"RESUME","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["any"]},"optional":true,"description":"An optional data object that was passed to this Scene when it was resumed.","name":"data"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:RESUME","scope":"instance","___s":true},{"meta":{"filename":"SHUTDOWN_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Shutdown Event.\n\nThis event is dispatched by a Scene during the Scene Systems shutdown process.\n\nListen to it from a Scene using `this.scene.events.on('shutdown', listener)`.\n\nYou should free-up any resources that may be in use by your Scene in this event handler, on the understanding\nthat the Scene may, at any time, become active again. A shutdown Scene is not 'destroyed', it's simply not\ncurrently active. Use the [DESTROY]{@linkcode Phaser.Scenes.Events#event:DESTROY} event to completely clear resources.","kind":"event","name":"SHUTDOWN","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["any"]},"optional":true,"description":"An optional data object that was passed to this Scene when it was shutdown.","name":"data"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:SHUTDOWN","scope":"instance","___s":true},{"meta":{"filename":"SLEEP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Sleep Event.\n\nThis event is dispatched by a Scene when it is sent to sleep, either directly via the `sleep` method,\nor as an action from another Scene.\n\nListen to it from a Scene using `this.scene.events.on('sleep', listener)`.","kind":"event","name":"SLEEP","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["any"]},"optional":true,"description":"An optional data object that was passed to this Scene when it was sent to sleep.","name":"data"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:SLEEP","scope":"instance","___s":true},{"meta":{"filename":"START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Start Event.\n\nThis event is dispatched by a Scene during the Scene Systems start process. Primarily used by Scene Plugins.\n\nListen to it from a Scene using `this.scene.events.on('start', listener)`.","kind":"event","name":"START","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:START","scope":"instance","___s":true},{"meta":{"filename":"TRANSITION_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Transition Complete Event.\n\nThis event is dispatched by the Target Scene of a transition.\n\nIt happens when the transition process has completed. This occurs when the duration timer equals or exceeds the duration\nof the transition.\n\nListen to it from a Scene using `this.scene.events.on('transitioncomplete', listener)`.\n\nThe Scene Transition event flow is as follows:\n\n1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\n2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\n3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\n4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\n5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.","kind":"event","name":"TRANSITION_COMPLETE","since":"3.5.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene on which the transitioned completed.","name":"scene"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:TRANSITION_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"TRANSITION_INIT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Transition Init Event.\n\nThis event is dispatched by the Target Scene of a transition.\n\nIt happens immediately after the `Scene.init` method is called. If the Scene does not have an `init` method,\nthis event is not dispatched.\n\nListen to it from a Scene using `this.scene.events.on('transitioninit', listener)`.\n\nThe Scene Transition event flow is as follows:\n\n1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\n2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\n3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\n4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\n5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.","kind":"event","name":"TRANSITION_INIT","since":"3.5.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that is being transitioned from.","name":"from"},{"type":{"names":["number"]},"description":"The duration of the transition in ms.","name":"duration"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:TRANSITION_INIT","scope":"instance","___s":true},{"meta":{"filename":"TRANSITION_OUT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Transition Out Event.\n\nThis event is dispatched by a Scene when it initiates a transition to another Scene.\n\nListen to it from a Scene using `this.scene.events.on('transitionout', listener)`.\n\nThe Scene Transition event flow is as follows:\n\n1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\n2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\n3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\n4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\n5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.","kind":"event","name":"TRANSITION_OUT","since":"3.5.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that is being transitioned to.","name":"target"},{"type":{"names":["number"]},"description":"The duration of the transition in ms.","name":"duration"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:TRANSITION_OUT","scope":"instance","___s":true},{"meta":{"filename":"TRANSITION_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Transition Start Event.\n\nThis event is dispatched by the Target Scene of a transition, only if that Scene was not asleep.\n\nIt happens immediately after the `Scene.create` method is called. If the Scene does not have a `create` method,\nthis event is dispatched anyway.\n\nIf the Target Scene was sleeping then the [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} event is\ndispatched instead of this event.\n\nListen to it from a Scene using `this.scene.events.on('transitionstart', listener)`.\n\nThe Scene Transition event flow is as follows:\n\n1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\n2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\n3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\n4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\n5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.","kind":"event","name":"TRANSITION_START","since":"3.5.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that is being transitioned from.","name":"from"},{"type":{"names":["number"]},"description":"The duration of the transition in ms.","name":"duration"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:TRANSITION_START","scope":"instance","___s":true},{"meta":{"filename":"TRANSITION_WAKE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Transition Wake Event.\n\nThis event is dispatched by the Target Scene of a transition, only if that Scene was asleep before\nthe transition began. If the Scene was not asleep the [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} event is dispatched instead.\n\nListen to it from a Scene using `this.scene.events.on('transitionwake', listener)`.\n\nThe Scene Transition event flow is as follows:\n\n1. [TRANSITION_OUT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_OUT} - the Scene that started the transition will emit this event.\n2. [TRANSITION_INIT]{@linkcode Phaser.Scenes.Events#event:TRANSITION_INIT} - the Target Scene will emit this event if it has an `init` method.\n3. [TRANSITION_START]{@linkcode Phaser.Scenes.Events#event:TRANSITION_START} - the Target Scene will emit this event after its `create` method is called, OR ...\n4. [TRANSITION_WAKE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_WAKE} - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.\n5. [TRANSITION_COMPLETE]{@linkcode Phaser.Scenes.Events#event:TRANSITION_COMPLETE} - the Target Scene will emit this event when the transition finishes.","kind":"event","name":"TRANSITION_WAKE","since":"3.5.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"A reference to the Scene that is being transitioned from.","name":"from"},{"type":{"names":["number"]},"description":"The duration of the transition in ms.","name":"duration"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:TRANSITION_WAKE","scope":"instance","___s":true},{"meta":{"filename":"UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Update Event.\n\nThis event is dispatched by a Scene during the main game loop step.\n\nThe event flow for a single step of a Scene is as follows:\n\n1. [PRE_UPDATE]{@linkcode Phaser.Scenes.Events#event:PRE_UPDATE}\n2. [UPDATE]{@linkcode Phaser.Scenes.Events#event:UPDATE}\n3. The `Scene.update` method is called, if it exists\n4. [POST_UPDATE]{@linkcode Phaser.Scenes.Events#event:POST_UPDATE}\n5. [RENDER]{@linkcode Phaser.Scenes.Events#event:RENDER}\n\nListen to it from a Scene using `this.scene.events.on('update', listener)`.\n\nA Scene will only run its step if it is active.","kind":"event","name":"UPDATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:UPDATE","scope":"instance","___s":true},{"meta":{"filename":"WAKE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"description":"The Scene Systems Wake Event.\n\nThis event is dispatched by a Scene when it is woken from sleep, either directly via the `wake` method,\nor as an action from another Scene.\n\nListen to it from a Scene using `this.scene.events.on('wake', listener)`.","kind":"event","name":"WAKE","since":"3.0.0","params":[{"type":{"names":["Phaser.Scenes.Systems"]},"description":"A reference to the Scene Systems class of the Scene that emitted this event.","name":"sys"},{"type":{"names":["any"]},"optional":true,"description":"An optional data object that was passed to this Scene when it was woken up.","name":"data"}],"memberof":"Phaser.Scenes.Events","longname":"Phaser.Scenes.Events#event:WAKE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Scenes","longname":"Phaser.Scenes.Events","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene"},"kind":"namespace","name":"Scenes","memberof":"Phaser","longname":"Phaser.Scenes","scope":"static","___s":true},{"meta":{"filename":"CreateSceneFromObjectConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"kind":"typedef","name":"CreateSceneFromObjectConfig","type":{"names":["object"]},"since":"3.17.0","properties":[{"type":{"names":["Phaser.Types.Scenes.SceneInitCallback"]},"optional":true,"description":"The scene's init callback.","name":"init"},{"type":{"names":["Phaser.Types.Scenes.ScenePreloadCallback"]},"optional":true,"description":"The scene's preload callback.","name":"preload"},{"type":{"names":["Phaser.Types.Scenes.SceneCreateCallback"]},"optional":true,"description":"The scene's create callback.","name":"create"},{"type":{"names":["function"]},"optional":true,"description":"The scene's update callback. See {@link Phaser.Scene#update}.","name":"update"},{"type":{"names":["any"]},"optional":true,"description":"Any additional properties, which will be copied to the Scene after it's created (except `data` or `sys`).","name":"extend"},{"type":{"names":["any"]},"optional":true,"description":"Any values, which will be merged into the Scene's Data Manager store.","name":"extend.data"}],"memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.CreateSceneFromObjectConfig","scope":"static","___s":true},{"meta":{"filename":"SceneCreateCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"description":"Can be defined on your own Scenes. Use it to create your game objects.\nThis method is called by the Scene Manager when the scene starts, after `init()` and `preload()`.\nIf the LoaderPlugin started after `preload()`, then this method is called only after loading is complete.","kind":"typedef","name":"SceneCreateCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["object"]},"description":"Any data passed via `ScenePlugin.add()` or `ScenePlugin.start()`. Same as Scene.settings.data.","name":"data"}],"memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.SceneCreateCallback","scope":"static","___s":true},{"meta":{"filename":"SceneInitCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"description":"Can be defined on your own Scenes.\nThis method is called by the Scene Manager when the scene starts, before `preload()` and `create()`.","kind":"typedef","name":"SceneInitCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["object"]},"description":"Any data passed via `ScenePlugin.add()` or `ScenePlugin.start()`. Same as Scene.settings.data.","name":"data"}],"memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.SceneInitCallback","scope":"static","___s":true},{"meta":{"filename":"ScenePreloadCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"description":"Can be defined on your own Scenes. Use it to load assets.\nThis method is called by the Scene Manager, after `init()` and before `create()`, only if the Scene has a LoaderPlugin.\nAfter this method completes, if the LoaderPlugin's queue isn't empty, the LoaderPlugin will start automatically.","kind":"typedef","name":"ScenePreloadCallback","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.ScenePreloadCallback","scope":"static","___s":true},{"meta":{"filename":"SceneTransitionConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"kind":"typedef","name":"SceneTransitionConfig","type":{"names":["object"]},"since":"3.5.0","properties":[{"type":{"names":["string"]},"description":"The Scene key to transition to.","name":"target"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1000,"description":"The duration, in ms, for the transition to last.","name":"duration"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Will the Scene responsible for the transition be sent to sleep on completion (`true`), or stopped? (`false`)","name":"sleep"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Will the Scenes Input system be able to process events while it is transitioning in or out?","name":"allowInput"},{"type":{"names":["boolean"]},"optional":true,"description":"Move the target Scene to be above this one before the transition starts.","name":"moveAbove"},{"type":{"names":["boolean"]},"optional":true,"description":"Move the target Scene to be below this one before the transition starts.","name":"moveBelow"},{"type":{"names":["function"]},"optional":true,"description":"This callback is invoked every frame for the duration of the transition.","name":"onUpdate"},{"type":{"names":["any"]},"optional":true,"description":"The context in which the callback is invoked.","name":"onUpdateScope"},{"type":{"names":["any"]},"optional":true,"description":"An object containing any data you wish to be passed to the target Scenes init / create methods.","name":"data"}],"memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.SceneTransitionConfig","scope":"static","___s":true},{"meta":{"filename":"SettingsConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"kind":"typedef","name":"SettingsConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"The unique key of this Scene. Must be unique within the entire Game instance.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Does the Scene start as active or not? An active Scene updates each step.","name":"active"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Does the Scene start as visible or not? A visible Scene renders each step.","name":"visible"},{"type":{"names":["false","Phaser.Types.Loader.FileTypes.PackFileConfig"]},"optional":true,"defaultvalue":false,"description":"An optional Loader Packfile to be loaded before the Scene begins.","name":"pack"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.JSONCamera","Array."]},"optional":true,"nullable":true,"defaultvalue":null,"description":"An optional Camera configuration object.","name":"cameras"},{"type":{"names":["Object."]},"optional":true,"description":"Overwrites the default injection map for a scene.","name":"map"},{"type":{"names":["Object."]},"optional":true,"description":"Extends the injection map for a scene.","name":"mapAdd"},{"type":{"names":["Phaser.Types.Core.PhysicsConfig"]},"optional":true,"defaultvalue":"{}","description":"The physics configuration object for the Scene.","name":"physics"},{"type":{"names":["Phaser.Types.Core.LoaderConfig"]},"optional":true,"defaultvalue":"{}","description":"The loader configuration object for the Scene.","name":"loader"},{"type":{"names":["false","*"]},"optional":true,"defaultvalue":false,"description":"The plugin configuration object for the Scene.","name":"plugins"}],"memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.SettingsConfig","scope":"static","___s":true},{"meta":{"filename":"SettingsObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"kind":"typedef","name":"SettingsObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"description":"The current status of the Scene. Maps to the Scene constants.","name":"status"},{"type":{"names":["string"]},"description":"The unique key of this Scene. Unique within the entire Game instance.","name":"key"},{"type":{"names":["boolean"]},"description":"The active state of this Scene. An active Scene updates each step.","name":"active"},{"type":{"names":["boolean"]},"description":"The visible state of this Scene. A visible Scene renders each step.","name":"visible"},{"type":{"names":["boolean"]},"description":"Has the Scene finished booting?","name":"isBooted"},{"type":{"names":["boolean"]},"description":"Is the Scene in a state of transition?","name":"isTransition"},{"type":{"names":["Phaser.Scene"]},"nullable":true,"description":"The Scene this Scene is transitioning from, if set.","name":"transitionFrom"},{"type":{"names":["integer"]},"description":"The duration of the transition, if set.","name":"transitionDuration"},{"type":{"names":["boolean"]},"description":"Is this Scene allowed to receive input during transitions?","name":"transitionAllowInput"},{"type":{"names":["object"]},"description":"a data bundle passed to this Scene from the Scene Manager.","name":"data"},{"type":{"names":["false","Phaser.Types.Loader.FileTypes.PackFileConfig"]},"description":"The Loader Packfile to be loaded before the Scene begins.","name":"pack"},{"type":{"names":["Phaser.Types.Cameras.Scene2D.JSONCamera","Array."]},"nullable":true,"description":"The Camera configuration object.","name":"cameras"},{"type":{"names":["Object."]},"description":"The Scene's Injection Map.","name":"map"},{"type":{"names":["Phaser.Types.Core.PhysicsConfig"]},"description":"The physics configuration object for the Scene.","name":"physics"},{"type":{"names":["Phaser.Types.Core.LoaderConfig"]},"description":"The loader configuration object for the Scene.","name":"loader"},{"type":{"names":["false","*"]},"description":"The plugin configuration object for the Scene.","name":"plugins"}],"memberof":"Phaser.Types.Scenes","longname":"Phaser.Types.Scenes.SettingsObject","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/scene/typedefs"},"kind":"namespace","name":"Scenes","memberof":"Phaser.Types","longname":"Phaser.Types.Scenes","scope":"static","___s":true},{"meta":{"range":[266,299],"filename":"BaseSound.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BaseSound.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"classdesc":"Class containing all the shared state and behavior of a sound object, independent of the implementation.","kind":"class","name":"BaseSound","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"Reference to the current sound manager instance.","name":"manager"},{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"scope":"static","longname":"Phaser.Sound.BaseSound","___s":true},{"meta":{"filename":"BaseSound.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Asset key for the sound.","name":"key","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently playing.","name":"isPlaying","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#isPlaying","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently paused.","name":"isPaused","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#isPaused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A property that holds the value of sound's actual playback rate,\nafter its rate and detune values has been combined with global\nrate and detune values.","name":"totalRate","type":{"names":["number"]},"defaultvalue":"1","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#totalRate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A value representing the duration, in seconds.\nIt could be total sound duration or a marker duration.","name":"duration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"The total duration of the sound in seconds.","name":"totalDuration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#totalDuration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Object containing markers definitions.","name":"markers","type":{"names":["Object."]},"defaultvalue":"{}","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#markers","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Currently playing marker.\n'null' if whole sound is playing.","name":"currentMarker","type":{"names":["Phaser.Types.Sound.SoundMarker"]},"defaultvalue":"null","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#currentMarker","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSound.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\nThis allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.","kind":"function","name":"addMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was added successfully."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#addMarker","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Updates previously added marker.","kind":"function","name":"updateMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object with updated values.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was updated successfully."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#updateMarker","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a marker from the sound.","kind":"function","name":"removeMarker","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the marker to remove.","name":"markerName"}],"returns":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"nullable":true,"description":"Removed marker object or 'null' if there was no marker with provided name."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#removeMarker","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":283,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Play this sound, or a marked section of it.\nIt always plays the sound from the start. If you want to start playback from a specific time\nyou can set 'seek' setting of the config object, provided to this call, to that value.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"''","description":"If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.","name":"markerName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#play","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":342,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Pauses the sound.","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was paused successfully."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#pause","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":363,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Resumes the sound.","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was resumed successfully."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#resume","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Stop playing this sound.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was stopped successfully."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#stop","scope":"instance","___s":true},{"meta":{"filename":"BaseSound.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Destroys this sound and all associated events and marks it for removal from the sound manager.","kind":"function","name":"destroy","fires":["Phaser.Sound.Events#event:DESTROY"],"since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"range":[266,299],"filename":"BaseSoundManager.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"classdesc":"The sound manager is responsible for playing back audio via Web Audio API or HTML Audio tag as fallback.\nThe audio file type and the encoding of those files are extremely important.\n\nNot all browsers can play all audio formats.\n\nThere is a good guide to what's supported [here](https://developer.mozilla.org/en-US/Apps/Fundamentals/Audio_and_video_delivery/Cross-browser_audio_basics#Audio_Codec_Support).","kind":"class","name":"BaseSoundManager","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"Reference to the current game instance.","name":"game"}],"scope":"static","longname":"Phaser.Sound.BaseSoundManager","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to game.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to the JSON Cache, as used by Audio Sprites.","name":"jsonCache","type":{"names":["Phaser.Cache.BaseCache"]},"readonly":true,"since":"3.7.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#jsonCache","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global mute setting.","name":"mute","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#mute","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global volume setting.","name":"volume","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#volume","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sounds should be paused when game looses focus,\nfor instance when user switches to another tab/program/app.","name":"pauseOnBlur","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#pauseOnBlur","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Mobile devices require sounds to be triggered from an explicit user action,\nsuch as a tap, before any sound can be loaded/played on a web page.\nSet to true if the audio system is currently locked awaiting user interaction.","name":"locked","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#locked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new sound into the sound manager.","kind":"function","name":"add","override":true,"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The new sound instance."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#add","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new audio sprite sound into the sound manager.\nAudio Sprites are a combination of audio files and a JSON configuration.\nThe JSON follows the format of that created by https://github.com/tonistiigi/audiosprite","kind":"function","name":"addAudioSprite","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound","Phaser.Sound.WebAudioSound"]},"description":"The new audio sprite sound instance."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#addAudioSprite","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new sound to the sound manager and plays it.\nThe sound will be automatically removed (destroyed) once playback ends.\nThis lets you play a new sound on the fly without the need to keep a reference to it.","kind":"function","name":"play","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig","Phaser.Types.Sound.SoundMarker"]},"optional":true,"description":"An optional additional object containing settings to be applied to the sound. It could be either config or marker object.","name":"extra"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#play","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Enables playing audio sprite sound on the fly without the need to keep a reference to it.\nSound will auto destroy once its playback ends.","kind":"function","name":"playAudioSprite","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["string"]},"description":"The name of the sound sprite to play.","name":"spriteName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the audio sprite sound started playing successfully."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#playAudioSprite","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a sound from the sound manager.\nThe removed sound is destroyed before removal.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The sound object to remove.","name":"sound"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the sound was removed successfully, otherwise false."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#remove","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes all sounds from the sound manager that have an asset key matching the given value.\nThe removed sounds are destroyed before removal.","kind":"function","name":"removeByKey","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key to match when removing sound objects.","name":"key"}],"returns":[{"type":{"names":["number"]},"description":"The number of matching sound objects that were removed."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#removeByKey","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Pauses all the sounds in the game.","kind":"function","name":"pauseAll","fires":["Phaser.Sound.Events#event:PAUSE_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#pauseAll","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Resumes all the sounds in the game.","kind":"function","name":"resumeAll","fires":["Phaser.Sound.Events#event:RESUME_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#resumeAll","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Stops all the sounds in the game.","kind":"function","name":"stopAll","fires":["Phaser.Sound.Events#event:STOP_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#stopAll","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Destroys all the sounds in the game and all associated events.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global playback rate at which all the sounds will be played.\n\nFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","kind":"function","name":"setRate","fires":["Phaser.Sound.Events#event:GLOBAL_RATE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"Global playback rate at which all the sounds will be played.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#setRate","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global playback rate at which all the sounds will be played.\nValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audio's playback speed.","name":"rate","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#rate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","kind":"function","name":"setDetune","fires":["Phaser.Sound.Events#event:GLOBAL_DETUNE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#setDetune","scope":"instance","___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"detune","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#detune","scope":"instance","kind":"member","___s":true},{"meta":{"range":[266,332],"filename":"SoundManagerCreator.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"name":"HTML5AudioSoundManager","longname":"HTML5AudioSoundManager","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SoundManagerCreator.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Creates a Web Audio, HTML5 Audio or No Audio Sound Manager based on config and device settings.\n\nBe aware of https://developers.google.com/web/updates/2017/09/autoplay-policy-changes","kind":"function","name":"SoundManagerCreator","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"Reference to the current game instance.","name":"game"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager","Phaser.Sound.WebAudioSoundManager","Phaser.Sound.NoAudioSoundManager"]},"description":"The Sound Manager instance that was created."}],"memberof":"Phaser.Sound","longname":"Phaser.Sound.SoundManagerCreator","scope":"static","___s":true},{"meta":{"filename":"COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Complete Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they complete playback.\n\nListen to it from a Sound instance using `Sound.on('complete', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('complete', listener);\nmusic.play();\n```","kind":"event","name":"COMPLETE","since":"3.16.1","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"DECODED_ALL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Audio Data Decoded All Event.\n\nThis event is dispatched by the Web Audio Sound Manager as a result of calling the `decodeAudio` method,\nonce all files passed to the method have been decoded (or errored).\n\nUse `Phaser.Sound.Events#DECODED` to listen for single sounds being decoded, and `DECODED_ALL` to\nlisten for them all completing.\n\nListen to it from the Sound Manager in a Scene using `this.sound.on('decodedall', listener)`, i.e.:\n\n```javascript\nthis.sound.once('decodedall', handler);\nthis.sound.decodeAudio([ audioFiles ]);\n```","kind":"event","name":"DECODED_ALL","since":"3.18.0","memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:DECODED_ALL","scope":"instance","___s":true},{"meta":{"filename":"DECODED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Audio Data Decoded Event.\n\nThis event is dispatched by the Web Audio Sound Manager as a result of calling the `decodeAudio` method.\n\nListen to it from the Sound Manager in a Scene using `this.sound.on('decoded', listener)`, i.e.:\n\n```javascript\nthis.sound.on('decoded', handler);\nthis.sound.decodeAudio(key, audioData);\n```","kind":"event","name":"DECODED","since":"3.18.0","params":[{"type":{"names":["string"]},"description":"The key of the audio file that was decoded and added to the audio cache.","name":"key"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:DECODED","scope":"instance","___s":true},{"meta":{"filename":"DESTROY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Destroy Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are destroyed, either\ndirectly or via a Sound Manager.\n\nListen to it from a Sound instance using `Sound.on('destroy', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('destroy', listener);\nmusic.destroy();\n```","kind":"event","name":"DESTROY","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:DESTROY","scope":"instance","___s":true},{"meta":{"filename":"DETUNE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Detune Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their detune value changes.\n\nListen to it from a Sound instance using `Sound.on('detune', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('detune', listener);\nmusic.play();\nmusic.setDetune(200);\n```","kind":"event","name":"DETUNE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"},{"type":{"names":["number"]},"description":"The new detune value of the Sound.","name":"detune"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:DETUNE","scope":"instance","___s":true},{"meta":{"filename":"GLOBAL_DETUNE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Manager Global Detune Event.\n\nThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\nor the HTML5 Audio Manager. It is dispatched when the `detune` property of the Sound Manager is changed, which globally\nadjusts the detuning of all active sounds.\n\nListen to it from a Scene using: `this.sound.on('rate', listener)`.","kind":"event","name":"GLOBAL_DETUNE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"},{"type":{"names":["number"]},"description":"The updated detune value.","name":"detune"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:GLOBAL_DETUNE","scope":"instance","___s":true},{"meta":{"filename":"GLOBAL_MUTE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Manager Global Mute Event.\n\nThis event is dispatched by the Sound Manager when its `mute` property is changed, either directly\nor via the `setMute` method. This changes the mute state of all active sounds.\n\nListen to it from a Scene using: `this.sound.on('mute', listener)`.","kind":"event","name":"GLOBAL_MUTE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager","Phaser.Sound.HTML5AudioSoundManager"]},"description":"A reference to the Sound Manager that emitted the event.","name":"soundManager"},{"type":{"names":["boolean"]},"description":"The mute value. `true` if the Sound Manager is now muted, otherwise `false`.","name":"mute"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:GLOBAL_MUTE","scope":"instance","___s":true},{"meta":{"filename":"GLOBAL_RATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Manager Global Rate Event.\n\nThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\nor the HTML5 Audio Manager. It is dispatched when the `rate` property of the Sound Manager is changed, which globally\nadjusts the playback rate of all active sounds.\n\nListen to it from a Scene using: `this.sound.on('rate', listener)`.","kind":"event","name":"GLOBAL_RATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"},{"type":{"names":["number"]},"description":"The updated rate value.","name":"rate"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:GLOBAL_RATE","scope":"instance","___s":true},{"meta":{"filename":"GLOBAL_VOLUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Manager Global Volume Event.\n\nThis event is dispatched by the Sound Manager when its `volume` property is changed, either directly\nor via the `setVolume` method. This changes the volume of all active sounds.\n\nListen to it from a Scene using: `this.sound.on('volume', listener)`.","kind":"event","name":"GLOBAL_VOLUME","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager","Phaser.Sound.HTML5AudioSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"},{"type":{"names":["number"]},"description":"The new global volume of the Sound Manager.","name":"volume"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:GLOBAL_VOLUME","scope":"instance","___s":true},{"meta":{"filename":"LOOPED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Looped Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they loop during playback.\n\nListen to it from a Sound instance using `Sound.on('looped', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('looped', listener);\nmusic.setLoop(true);\nmusic.play();\n```\n\nThis is not to be confused with the [LOOP]{@linkcode Phaser.Sound.Events#event:LOOP} event, which only emits when the loop state of a Sound is changed.","kind":"event","name":"LOOPED","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:LOOPED","scope":"instance","___s":true},{"meta":{"filename":"LOOP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Loop Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their loop state is changed.\n\nListen to it from a Sound instance using `Sound.on('loop', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('loop', listener);\nmusic.setLoop(true);\n```\n\nThis is not to be confused with the [LOOPED]{@linkcode Phaser.Sound.Events#event:LOOPED} event, which emits each time a Sound loops during playback.","kind":"event","name":"LOOP","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"},{"type":{"names":["boolean"]},"description":"The new loop value. `true` if the Sound will loop, otherwise `false`.","name":"loop"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:LOOP","scope":"instance","___s":true},{"meta":{"filename":"MUTE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Mute Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their mute state changes.\n\nListen to it from a Sound instance using `Sound.on('mute', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('mute', listener);\nmusic.play();\nmusic.setMute(true);\n```","kind":"event","name":"MUTE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"},{"type":{"names":["boolean"]},"description":"The mute value. `true` if the Sound is now muted, otherwise `false`.","name":"mute"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:MUTE","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_ALL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Pause All Sounds Event.\n\nThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\nor the HTML5 Audio Manager. It is dispatched when the `pauseAll` method is invoked and after all current Sounds\nhave been paused.\n\nListen to it from a Scene using: `this.sound.on('pauseall', listener)`.","kind":"event","name":"PAUSE_ALL","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:PAUSE_ALL","scope":"instance","___s":true},{"meta":{"filename":"PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Pause Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are paused.\n\nListen to it from a Sound instance using `Sound.on('pause', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('pause', listener);\nmusic.play();\nmusic.pause();\n```","kind":"event","name":"PAUSE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:PAUSE","scope":"instance","___s":true},{"meta":{"filename":"PLAY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Play Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are played.\n\nListen to it from a Sound instance using `Sound.on('play', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('play', listener);\nmusic.play();\n```","kind":"event","name":"PLAY","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:PLAY","scope":"instance","___s":true},{"meta":{"filename":"RATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Rate Change Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their rate changes.\n\nListen to it from a Sound instance using `Sound.on('rate', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('rate', listener);\nmusic.play();\nmusic.setRate(0.5);\n```","kind":"event","name":"RATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"},{"type":{"names":["number"]},"description":"The new rate of the Sound.","name":"rate"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:RATE","scope":"instance","___s":true},{"meta":{"filename":"RESUME_ALL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Resume All Sounds Event.\n\nThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\nor the HTML5 Audio Manager. It is dispatched when the `resumeAll` method is invoked and after all current Sounds\nhave been resumed.\n\nListen to it from a Scene using: `this.sound.on('resumeall', listener)`.","kind":"event","name":"RESUME_ALL","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:RESUME_ALL","scope":"instance","___s":true},{"meta":{"filename":"RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Resume Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are resumed from a paused state.\n\nListen to it from a Sound instance using `Sound.on('resume', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('resume', listener);\nmusic.play();\nmusic.pause();\nmusic.resume();\n```","kind":"event","name":"RESUME","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:RESUME","scope":"instance","___s":true},{"meta":{"filename":"SEEK_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Seek Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are seeked to a new position.\n\nListen to it from a Sound instance using `Sound.on('seek', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('seek', listener);\nmusic.play();\nmusic.setSeek(5000);\n```","kind":"event","name":"SEEK","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"},{"type":{"names":["number"]},"description":"The new detune value of the Sound.","name":"detune"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:SEEK","scope":"instance","___s":true},{"meta":{"filename":"STOP_ALL_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Stop All Sounds Event.\n\nThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\nor the HTML5 Audio Manager. It is dispatched when the `stopAll` method is invoked and after all current Sounds\nhave been stopped.\n\nListen to it from a Scene using: `this.sound.on('stopall', listener)`.","kind":"event","name":"STOP_ALL","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:STOP_ALL","scope":"instance","___s":true},{"meta":{"filename":"STOP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Stop Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are stopped.\n\nListen to it from a Sound instance using `Sound.on('stop', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('stop', listener);\nmusic.play();\nmusic.stop();\n```","kind":"event","name":"STOP","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:STOP","scope":"instance","___s":true},{"meta":{"filename":"UNLOCKED_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Manager Unlocked Event.\n\nThis event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,\nor the HTML5 Audio Manager. It is dispatched during the update loop when the Sound Manager becomes unlocked. For\nWeb Audio this is on the first user gesture on the page.\n\nListen to it from a Scene using: `this.sound.on('unlocked', listener)`.","kind":"event","name":"UNLOCKED","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"A reference to the sound manager that emitted the event.","name":"soundManager"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:UNLOCKED","scope":"instance","___s":true},{"meta":{"filename":"VOLUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"description":"The Sound Volume Event.\n\nThis event is dispatched by both Web Audio and HTML5 Audio Sound objects when their volume changes.\n\nListen to it from a Sound instance using `Sound.on('volume', listener)`, i.e.:\n\n```javascript\nvar music = this.sound.add('key');\nmusic.on('volume', listener);\nmusic.play();\nmusic.setVolume(0.5);\n```","kind":"event","name":"VOLUME","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSound","Phaser.Sound.HTML5AudioSound"]},"description":"A reference to the Sound that emitted the event.","name":"sound"},{"type":{"names":["number"]},"description":"The new volume of the Sound.","name":"volume"}],"memberof":"Phaser.Sound.Events","longname":"Phaser.Sound.Events#event:VOLUME","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Sound","longname":"Phaser.Sound.Events","scope":"static","___s":true},{"meta":{"range":[266,301],"filename":"HTML5AudioSound.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"name":"BaseSound","longname":"BaseSound","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"classdesc":"HTML5 Audio implementation of the sound.","kind":"class","name":"HTML5AudioSound","augments":["Phaser.Sound.BaseSound"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"Reference to the current sound manager instance.","name":"manager"},{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"{}","description":"An optional config object containing default sound settings.","name":"config"}],"scope":"static","longname":"Phaser.Sound.HTML5AudioSound","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Play this sound, or a marked section of it.\nIt always plays the sound from the start. If you want to start playback from a specific time\nyou can set 'seek' setting of the config object, provided to this call, to that value.","kind":"function","name":"play","fires":["Phaser.Sound.Events#event:PLAY"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"''","description":"If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.","name":"markerName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#play","scope":"instance","overrides":"Phaser.Sound.BaseSound#play","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":133,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Pauses the sound.","kind":"function","name":"pause","fires":["Phaser.Sound.Events#event:PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was paused successfully."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#pause","scope":"instance","overrides":"Phaser.Sound.BaseSound#pause","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Resumes the sound.","kind":"function","name":"resume","fires":["Phaser.Sound.Events#event:RESUME"],"since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was resumed successfully."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#resume","scope":"instance","overrides":"Phaser.Sound.BaseSound#resume","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Stop playing this sound.","kind":"function","name":"stop","fires":["Phaser.Sound.Events#event:STOP"],"since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was stopped successfully."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#stop","scope":"instance","overrides":"Phaser.Sound.BaseSound#stop","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":510,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Calls Phaser.Sound.BaseSound#destroy method\nand cleans up all HTML5 Audio related stuff.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#destroy","scope":"instance","overrides":"Phaser.Sound.BaseSound#destroy","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":576,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Boolean indicating whether the sound is muted or not.\nGets or sets the muted state of this sound.","name":"mute","type":{"names":["boolean"]},"defaultvalue":"false","fires":["Phaser.Sound.Events#event:MUTE"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#mute","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the muted state of this Sound.","kind":"function","name":"setMute","fires":["Phaser.Sound.Events#event:MUTE"],"since":"3.4.0","params":[{"type":{"names":["boolean"]},"description":"`true` to mute this sound, `false` to unmute it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#setMute","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Gets or sets the volume of this sound, a value between 0 (silence) and 1 (full volume).","name":"volume","type":{"names":["number"]},"defaultvalue":"1","fires":["Phaser.Sound.Events#event:VOLUME"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#volume","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":657,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the volume of this Sound.","kind":"function","name":"setVolume","fires":["Phaser.Sound.Events#event:VOLUME"],"since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The volume of the sound.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#setVolume","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":675,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Rate at which this Sound will be played.\nValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","name":"rate","type":{"names":["number"]},"defaultvalue":"1","fires":["Phaser.Sound.Events#event:RATE"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#rate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":711,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the playback rate of this Sound.\n\nFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","kind":"function","name":"setRate","fires":["Phaser.Sound.Events#event:RATE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The playback rate at of this Sound.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"This Sound."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#setRate","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":732,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"The detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"detune","type":{"names":["number"]},"defaultvalue":"0","fires":["Phaser.Sound.Events#event:DETUNE"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#detune","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":767,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","kind":"function","name":"setDetune","fires":["Phaser.Sound.Events#event:DETUNE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"This Sound."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#setDetune","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":786,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Property representing the position of playback for this sound, in seconds.\nSetting it to a specific value moves current playback to that position.\nThe value given is clamped to the range 0 to current marker duration.\nSetting seek of a stopped sound has no effect.","name":"seek","type":{"names":["number"]},"fires":["Phaser.Sound.Events#event:SEEK"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#seek","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":846,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Seeks to a specific point in this sound.","kind":"function","name":"setSeek","fires":["Phaser.Sound.Events#event:SEEK"],"since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The point in the sound to seek to.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#setSeek","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":864,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Flag indicating whether or not the sound or current sound marker will loop.","name":"loop","type":{"names":["boolean"]},"defaultvalue":"false","fires":["Phaser.Sound.Events#event:LOOP"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#loop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSound.js","lineno":899,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the loop state of this Sound.","kind":"function","name":"setLoop","fires":["Phaser.Sound.Events#event:LOOP"],"since":"3.4.0","params":[{"type":{"names":["boolean"]},"description":"`true` to loop this sound, `false` to not loop it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#setLoop","scope":"instance","___s":true},{"meta":{"range":[266,315],"filename":"HTML5AudioSoundManager.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"name":"BaseSoundManager","longname":"BaseSoundManager","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[982,12710],"filename":"HTML5AudioSoundManager.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"HTML5 Audio implementation of the Sound Manager.\n\nNote: To play multiple instances of the same HTML5 Audio sound, you need to provide an `instances` value when\nloading the sound with the Loader:\n\n```javascript\nthis.load.audio('explosion', 'explosion.mp3', {\n instances: 2\n});\n```","kind":"class","classdesc":"HTML5AudioSoundManager","augments":["Phaser.Sound.BaseSoundManager"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"Reference to the current game instance.","name":"game"}],"name":"HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager","scope":"static","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Flag indicating whether if there are no idle instances of HTML5 Audio tag,\nfor any particular sound, if one of the used tags should be hijacked and used\nfor succeeding playback or if succeeding Phaser.Sound.HTML5AudioSound#play\ncall should be ignored.","name":"override","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#override","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Value representing time difference, in seconds, between calling\nplay method on an audio tag and when it actually starts playing.\nIt is used to achieve more accurate delayed sound playback.\n\nYou might need to tweak this value to get the desired results\nsince audio play delay varies depending on the browser/platform.","name":"audioPlayDelay","type":{"names":["number"]},"defaultvalue":"0.1","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#audioPlayDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"A value by which we should offset the loop end marker of the\nlooping sound to compensate for lag, caused by changing audio\ntag playback position, in order to achieve gapless looping.\n\nYou might need to tweak this value to get the desired results\nsince loop lag varies depending on the browser/platform.","name":"loopEndOffset","type":{"names":["number"]},"defaultvalue":"0.05","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#loopEndOffset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":138,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Adds a new sound into the sound manager.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"The new sound instance."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#add","scope":"instance","overrides":"Phaser.Sound.BaseSoundManager#add","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Unlocks HTML5 Audio loading and playback on mobile\ndevices on the initial explicit user interaction.","kind":"function","name":"unlock","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#unlock","scope":"instance","overrides":"Phaser.Sound.BaseSoundManager#unlock","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Calls Phaser.Sound.BaseSoundManager#destroy method\nand cleans up all HTML5 Audio related stuff.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#destroy","scope":"instance","overrides":"Phaser.Sound.BaseSoundManager#destroy","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the muted state of all this Sound Manager.","kind":"function","name":"setMute","fires":["Phaser.Sound.Events#event:GLOBAL_MUTE"],"since":"3.3.0","params":[{"type":{"names":["boolean"]},"description":"`true` to mute all sounds, `false` to unmute them.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#setMute","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"name":"mute","type":{"names":["boolean"]},"fires":["Phaser.Sound.Events#event:GLOBAL_MUTE"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#mute","scope":"instance","kind":"member","overrides":"Phaser.Sound.BaseSoundManager#mute","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":412,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"description":"Sets the volume of this Sound Manager.","kind":"function","name":"setVolume","fires":["Phaser.Sound.Events#event:GLOBAL_VOLUME"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The global volume of this Sound Manager.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#setVolume","scope":"instance","___s":true},{"meta":{"filename":"HTML5AudioSoundManager.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/html5"},"name":"volume","type":{"names":["number"]},"fires":["Phaser.Sound.Events#event:GLOBAL_VOLUME"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#volume","scope":"instance","kind":"member","overrides":"Phaser.Sound.BaseSoundManager#volume","___s":true},{"meta":{"filename":"index.js","lineno":8,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"kind":"namespace","name":"Sound","memberof":"Phaser","longname":"Phaser.Sound","scope":"static","___s":true},{"meta":{"range":[266,301],"filename":"NoAudioSound.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/noaudio"},"name":"BaseSound","longname":"BaseSound","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NoAudioSound.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/noaudio"},"classdesc":"No audio implementation of the sound. It is used if audio has been\ndisabled in the game config or the device doesn't support any audio.\n\nIt represents a graceful degradation of sound logic that provides\nminimal functionality and prevents Phaser projects that use audio from\nbreaking on devices that don't support any audio playback technologies.","kind":"class","name":"NoAudioSound","augments":["Phaser.Sound.BaseSound"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"Reference to the current sound manager instance.","name":"manager"},{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"{}","description":"An optional config object containing default sound settings.","name":"config"}],"scope":"static","longname":"Phaser.Sound.NoAudioSound","___s":true},{"meta":{"range":[266,315],"filename":"NoAudioSoundManager.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/noaudio"},"name":"BaseSoundManager","longname":"BaseSoundManager","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NoAudioSoundManager.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/noaudio"},"classdesc":"No audio implementation of the sound manager. It is used if audio has been\ndisabled in the game config or the device doesn't support any audio.\n\nIt represents a graceful degradation of sound manager logic that provides\nminimal functionality and prevents Phaser projects that use audio from\nbreaking on devices that don't support any audio playback technologies.","kind":"class","name":"NoAudioSoundManager","augments":["Phaser.Sound.BaseSoundManager"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"Reference to the current game instance.","name":"game"}],"scope":"static","longname":"Phaser.Sound.NoAudioSoundManager","___s":true},{"meta":{"filename":"AudioSpriteSound.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/typedefs"},"description":"Audio sprite sound type.","kind":"typedef","name":"AudioSpriteSound","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["object"]},"description":"Local reference to 'spritemap' object form json file generated by audiosprite tool.","name":"spritemap"}],"memberof":"Phaser.Types.Sound","longname":"Phaser.Types.Sound.AudioSpriteSound","scope":"static","___s":true},{"meta":{"filename":"DecodeAudioConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/typedefs"},"description":"A Audio Data object.\n\nYou can pass an array of these objects to the WebAudioSoundManager `decodeAudio` method to have it decode\nthem all at once.","kind":"typedef","name":"DecodeAudioConfig","type":{"names":["object"]},"since":"3.18.0","properties":[{"type":{"names":["string"]},"description":"The string-based key to be used to reference the decoded audio in the audio cache.","name":"key"},{"type":{"names":["ArrayBuffer","string"]},"description":"The audio data, either a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance.","name":"data"}],"memberof":"Phaser.Types.Sound","longname":"Phaser.Types.Sound.DecodeAudioConfig","scope":"static","___s":true},{"meta":{"filename":"EachActiveSoundCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/typedefs"},"kind":"typedef","name":"EachActiveSoundCallback","type":{"names":["function"]},"since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"The SoundManager","name":"manager"},{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The current active Sound","name":"sound"},{"type":{"names":["number"]},"description":"The index of the current active Sound","name":"index"},{"type":{"names":["Array."]},"description":"All sounds","name":"sounds"}],"memberof":"Phaser.Types.Sound","longname":"Phaser.Types.Sound.EachActiveSoundCallback","scope":"static","___s":true},{"meta":{"filename":"SoundConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/typedefs"},"description":"Config object containing various sound settings.","kind":"typedef","name":"SoundConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Boolean indicating whether the sound should be muted or not.","name":"mute"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"A value between 0 (silence) and 1 (full volume).","name":"volume"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"Defines the speed at which the sound should be played.","name":"rate"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Represents detuning of sound in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).","name":"detune"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Position of playback for this sound, in seconds.","name":"seek"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Whether or not the sound or current sound marker should loop.","name":"loop"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time, in seconds, that should elapse before the sound actually starts its playback.","name":"delay"}],"memberof":"Phaser.Types.Sound","longname":"Phaser.Types.Sound.SoundConfig","scope":"static","___s":true},{"meta":{"filename":"SoundMarker.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/typedefs"},"description":"Marked section of a sound represented by name, and optionally start time, duration, and config object.","kind":"typedef","name":"SoundMarker","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"Unique identifier of a sound marker.","name":"name"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Sound position offset at witch playback should start.","name":"start"},{"type":{"names":["number"]},"optional":true,"description":"Playback duration of this marker.","name":"duration"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default marker settings.","name":"config"}],"memberof":"Phaser.Types.Sound","longname":"Phaser.Types.Sound.SoundMarker","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/typedefs"},"kind":"namespace","name":"Sound","memberof":"Phaser.Types","longname":"Phaser.Types.Sound","scope":"static","___s":true},{"meta":{"range":[266,301],"filename":"WebAudioSound.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"name":"BaseSound","longname":"BaseSound","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"classdesc":"Web Audio API implementation of the sound.","kind":"class","name":"WebAudioSound","augments":["Phaser.Sound.BaseSound"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"Reference to the current sound manager instance.","name":"manager"},{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"{}","description":"An optional config object containing default sound settings.","name":"config"}],"scope":"static","longname":"Phaser.Sound.WebAudioSound","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":177,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Play this sound, or a marked section of it.\n\nIt always plays the sound from the start. If you want to start playback from a specific time\nyou can set 'seek' setting of the config object, provided to this call, to that value.","kind":"function","name":"play","fires":["Phaser.Sound.Events#event:PLAY"],"since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"''","description":"If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.","name":"markerName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#play","scope":"instance","overrides":"Phaser.Sound.BaseSound#play","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Pauses the sound.","kind":"function","name":"pause","fires":["Phaser.Sound.Events#event:PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was paused successfully."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#pause","scope":"instance","overrides":"Phaser.Sound.BaseSound#pause","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Resumes the sound.","kind":"function","name":"resume","fires":["Phaser.Sound.Events#event:RESUME"],"since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was resumed successfully."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#resume","scope":"instance","overrides":"Phaser.Sound.BaseSound#resume","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":267,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Stop playing this sound.","kind":"function","name":"stop","fires":["Phaser.Sound.Events#event:STOP"],"since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was stopped successfully."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#stop","scope":"instance","overrides":"Phaser.Sound.BaseSound#stop","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":479,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Calls Phaser.Sound.BaseSound#destroy method\nand cleans up all Web Audio API related stuff.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#destroy","scope":"instance","overrides":"Phaser.Sound.BaseSound#destroy","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":585,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Rate at which this Sound will be played.\nValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","name":"rate","type":{"names":["number"]},"defaultvalue":"1","fires":["Phaser.Sound.Events#event:RATE"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#rate","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":614,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the playback rate of this Sound.\n\nFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","kind":"function","name":"setRate","fires":["Phaser.Sound.Events#event:RATE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The playback rate at of this Sound.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"This Sound."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#setRate","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":635,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"The detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"detune","type":{"names":["number"]},"defaultvalue":"0","fires":["Phaser.Sound.Events#event:DETUNE"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#detune","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":663,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the detune value of this Sound, given in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","kind":"function","name":"setDetune","fires":["Phaser.Sound.Events#event:DETUNE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"This Sound."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#setDetune","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":682,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Boolean indicating whether the sound is muted or not.\nGets or sets the muted state of this sound.","name":"mute","type":{"names":["boolean"]},"defaultvalue":"false","fires":["Phaser.Sound.Events#event:MUTE"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#mute","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":709,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the muted state of this Sound.","kind":"function","name":"setMute","fires":["Phaser.Sound.Events#event:MUTE"],"since":"3.4.0","params":[{"type":{"names":["boolean"]},"description":"`true` to mute this sound, `false` to unmute it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#setMute","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":727,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Gets or sets the volume of this sound, a value between 0 (silence) and 1 (full volume).","name":"volume","type":{"names":["number"]},"defaultvalue":"1","fires":["Phaser.Sound.Events#event:VOLUME"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#volume","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":752,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the volume of this Sound.","kind":"function","name":"setVolume","fires":["Phaser.Sound.Events#event:VOLUME"],"since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The volume of the sound.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#setVolume","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":770,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Property representing the position of playback for this sound, in seconds.\nSetting it to a specific value moves current playback to that position.\nThe value given is clamped to the range 0 to current marker duration.\nSetting seek of a stopped sound has no effect.","name":"seek","type":{"names":["number"]},"fires":["Phaser.Sound.Events#event:SEEK"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#seek","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":828,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Seeks to a specific point in this sound.","kind":"function","name":"setSeek","fires":["Phaser.Sound.Events#event:SEEK"],"since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The point in the sound to seek to.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#setSeek","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":846,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Flag indicating whether or not the sound or current sound marker will loop.","name":"loop","type":{"names":["boolean"]},"defaultvalue":"false","fires":["Phaser.Sound.Events#event:LOOP"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#loop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"WebAudioSound.js","lineno":880,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the loop state of this Sound.","kind":"function","name":"setLoop","fires":["Phaser.Sound.Events#event:LOOP"],"since":"3.4.0","params":[{"type":{"names":["boolean"]},"description":"`true` to loop this sound, `false` to not loop it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"This Sound instance."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#setLoop","scope":"instance","___s":true},{"meta":{"range":[266,337],"filename":"WebAudioSoundManager.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"name":"Base64ToArrayBuffer","longname":"Base64ToArrayBuffer","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"classdesc":"Web Audio API implementation of the sound manager.","kind":"class","name":"WebAudioSoundManager","augments":["Phaser.Sound.BaseSoundManager"],"memberof":"Phaser.Sound","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"Reference to the current game instance.","name":"game"}],"scope":"static","longname":"Phaser.Sound.WebAudioSoundManager","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"This method takes a new AudioContext reference and then sets\nthis Sound Manager to use that context for all playback.\n\nAs part of this call it also disconnects the master mute and volume\nnodes and then re-creates them on the new given context.","kind":"function","name":"setAudioContext","since":"3.21.0","params":[{"type":{"names":["AudioContext"]},"description":"Reference to an already created AudioContext instance.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"The WebAudioSoundManager instance."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#setAudioContext","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":161,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Adds a new sound into the sound manager.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"The new sound instance."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#add","scope":"instance","overrides":"Phaser.Sound.BaseSoundManager#add","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Decode audio data into a format ready for playback via Web Audio.\n\nThe audio data can be a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance.\n\nThe `audioKey` is the key that will be used to save the decoded audio to the audio cache.\n\nInstead of passing a single entry you can instead pass an array of `Phaser.Types.Sound.DecodeAudioConfig`\nobjects as the first and only argument.\n\nDecoding is an async process, so be sure to listen for the events to know when decoding has completed.\n\nOnce the audio has decoded it can be added to the Sound Manager or played via its key.","kind":"function","name":"decodeAudio","fires":["Phaser.Sound.Events#event:DECODED","Phaser.Sound.Events#event:DECODED_ALL"],"since":"3.18.0","params":[{"type":{"names":["Array.","string"]},"optional":true,"description":"The string-based key to be used to reference the decoded audio in the audio cache, or an array of audio config objects.","name":"audioKey"},{"type":{"names":["ArrayBuffer","string"]},"optional":true,"description":"The audio data, either a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance.","name":"audioData"}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#decodeAudio","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":262,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Unlocks Web Audio API on the initial input event.\n\nRead more about how this issue is handled here in [this article](https://medium.com/@pgoloskokovic/unlocking-web-audio-the-smarter-way-8858218c0e09).","kind":"function","name":"unlock","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#unlock","scope":"instance","overrides":"Phaser.Sound.BaseSoundManager#unlock","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":339,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Calls Phaser.Sound.BaseSoundManager#destroy method\nand cleans up all Web Audio API related stuff.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#destroy","scope":"instance","overrides":"Phaser.Sound.BaseSoundManager#destroy","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":371,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the muted state of all this Sound Manager.","kind":"function","name":"setMute","fires":["Phaser.Sound.Events#event:GLOBAL_MUTE"],"since":"3.3.0","params":[{"type":{"names":["boolean"]},"description":"`true` to mute all sounds, `false` to unmute them.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#setMute","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":389,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"name":"mute","type":{"names":["boolean"]},"fires":["Phaser.Sound.Events#event:GLOBAL_MUTE"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#mute","scope":"instance","kind":"member","overrides":"Phaser.Sound.BaseSoundManager#mute","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"description":"Sets the volume of this Sound Manager.","kind":"function","name":"setVolume","fires":["Phaser.Sound.Events#event:GLOBAL_VOLUME"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The global volume of this Sound Manager.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#setVolume","scope":"instance","___s":true},{"meta":{"filename":"WebAudioSoundManager.js","lineno":429,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound/webaudio"},"name":"volume","type":{"names":["number"]},"fires":["Phaser.Sound.Events#event:GLOBAL_VOLUME"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#volume","scope":"instance","kind":"member","overrides":"Phaser.Sound.BaseSoundManager#volume","___s":true},{"meta":{"range":[180,218],"filename":"List.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"name":"ArrayUtils","longname":"ArrayUtils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"List.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"kind":"typedef","name":"EachListCallback","type":{"names":["function"]},"params":[{"type":{"names":["I"]},"description":"The item which is currently being processed.","name":"item"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"longname":"EachListCallback","scope":"global","___s":true},{"meta":{"filename":"List.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"classdesc":"List is a generic implementation of an ordered list which contains utility methods for retrieving, manipulating, and iterating items.","kind":"class","name":"List","memberof":"Phaser.Structs","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The parent of this list.","name":"parent"}],"scope":"static","longname":"Phaser.Structs.List","___s":true},{"meta":{"filename":"List.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The parent of this list.","name":"parent","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The objects that belong to this collection.","name":"list","type":{"names":["Array.<*>"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#list","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The index of the current element.\n\nThis is used internally when iterating through the list with the {@link #first}, {@link #last}, {@link #get}, and {@link #previous} properties.","name":"position","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#position","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"A callback that is invoked every time a child is added to this list.","name":"addCallback","type":{"names":["function"]},"since":"3.4.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#addCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"A callback that is invoked every time a child is removed from this list.","name":"removeCallback","type":{"names":["function"]},"since":"3.4.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#removeCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The property key to sort by.","name":"_sortKey","type":{"names":["string"]},"since":"3.4.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#_sortKey","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":99,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Adds the given item to the end of the list. Each item must be unique.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["*","Array.<*>"]},"description":"The item, or array of items, to add to the list.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip calling the List.addCallback if this child is added successfully.","name":"skipCallback"}],"returns":[{"type":{"names":["*"]},"description":"The list's underlying array."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#add","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":124,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Adds an item to list, starting at a specified index. Each item must be unique within the list.","kind":"function","name":"addAt","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item, or array of items, to add to the list.","name":"child"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The index in the list at which the element(s) will be inserted.","name":"index"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip calling the List.addCallback if this child is added successfully.","name":"skipCallback"}],"returns":[{"type":{"names":["*"]},"description":"The List's underlying array."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#addAt","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":150,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Retrieves the item at a given position inside the List.","kind":"function","name":"getAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the item.","name":"index"}],"returns":[{"type":{"names":["*"]},"description":"The retrieved item, or `undefined` if it's outside the List's bounds."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#getAt","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Locates an item within the List and returns its index.","kind":"function","name":"getIndex","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to locate.","name":"child"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the item within the List, or -1 if it's not in the List."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#getIndex","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sort the contents of this List so the items are in order based on the given property.\nFor example, `sort('alpha')` would sort the List contents based on the value of their `alpha` property.","kind":"function","name":"sort","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The property to lexically sort by.","name":"property"},{"type":{"names":["function"]},"optional":true,"description":"Provide your own custom handler function. Will receive 2 children which it should compare and return a boolean.","name":"handler"}],"returns":[{"type":{"names":["Phaser.Structs.List"]},"description":"This List object."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#sort","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":219,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Searches for the first instance of a child with its `name`\nproperty matching the given argument. Should more than one child have\nthe same name only the first is returned.","kind":"function","name":"getByName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to search for.","name":"name"}],"returns":[{"type":{"names":["*"]},"nullable":true,"description":"The first child with a matching name, or null if none were found."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#getByName","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns a random child from the group.","kind":"function","name":"getRandom","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Offset from the front of the group (lowest child).","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"(to top)","description":"Restriction on the number of values you want to randomly select from.","name":"length"}],"returns":[{"type":{"names":["*"]},"nullable":true,"description":"A random child of this Group."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#getRandom","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns the first element in a given part of the List which matches a specific criterion.","kind":"function","name":"getFirst","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the property to test or a falsey value to have no criterion.","name":"property"},{"type":{"names":["*"]},"description":"The value to test the `property` against, or `undefined` to allow any value and only check for existence.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The position in the List to start the search at.","name":"startIndex"},{"type":{"names":["number"]},"optional":true,"description":"The position in the List to optionally stop the search at. It won't be checked.","name":"endIndex"}],"returns":[{"type":{"names":["*"]},"nullable":true,"description":"The first item which matches the given criterion, or `null` if no such item exists."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#getFirst","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":276,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns all children in this List.\n\nYou can optionally specify a matching criteria using the `property` and `value` arguments.\n\nFor example: `getAll('parent')` would return only children that have a property called `parent`.\n\nYou can also specify a value to compare the property to:\n\n`getAll('visible', true)` would return only children that have their visible property set to `true`.\n\nOptionally you can specify a start and end index. For example if this List had 100 children,\nand you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\nthe first 50 children in the List.","kind":"function","name":"getAll","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"An optional property to test against the value argument.","name":"property"},{"type":{"names":["*"]},"optional":true,"description":"If property is set then Child.property must strictly equal this value to be included in the results.","name":"value"},{"type":{"names":["integer"]},"optional":true,"description":"The first child index to start the search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"The last child index to search up until.","name":"endIndex"}],"returns":[{"type":{"names":["Array.<*>"]},"description":"All items of the List which match the given criterion, if any."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#getAll","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":309,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns the total number of items in the List which have a property matching the given value.","kind":"function","name":"count","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The property to test on each item.","name":"property"},{"type":{"names":["*"]},"description":"The value to test the property against.","name":"value"}],"returns":[{"type":{"names":["integer"]},"description":"The total number of matching elements."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#count","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":327,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Swaps the positions of two items in the list.","kind":"function","name":"swap","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The first item to swap.","name":"child1"},{"type":{"names":["*"]},"description":"The second item to swap.","name":"child2"}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#swap","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":343,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Moves an item in the List to a new position.","kind":"function","name":"moveTo","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to move.","name":"child"},{"type":{"names":["integer"]},"description":"Moves an item in the List to a new position.","name":"index"}],"returns":[{"type":{"names":["*"]},"description":"The item that was moved."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#moveTo","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":361,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes one or many items from the List.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item, or array of items, to remove.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip calling the List.removeCallback.","name":"skipCallback"}],"returns":[{"type":{"names":["*"]},"description":"The item, or array of items, which were successfully removed from the List."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#remove","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":386,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes the item at the given position in the List.","kind":"function","name":"removeAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The position to remove the item from.","name":"index"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip calling the List.removeCallback.","name":"skipCallback"}],"returns":[{"type":{"names":["*"]},"description":"The item that was removed."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#removeAt","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes the items within the given range in the List.","kind":"function","name":"removeBetween","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The index to start removing from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"The position to stop removing at. The item at this position won't be removed.","name":"endIndex"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip calling the List.removeCallback.","name":"skipCallback"}],"returns":[{"type":{"names":["Array.<*>"]},"description":"An array of the items which were removed."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#removeBetween","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":437,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes all the items.","kind":"function","name":"removeAll","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip calling the List.removeCallback.","name":"skipCallback"}],"returns":[{"type":{"names":["Phaser.Structs.List"]},"description":"This List object."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#removeAll","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":461,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Brings the given child to the top of this List.","kind":"function","name":"bringToTop","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to bring to the top of the List.","name":"child"}],"returns":[{"type":{"names":["*"]},"description":"The item which was moved."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#bringToTop","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":478,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sends the given child to the bottom of this List.","kind":"function","name":"sendToBack","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to send to the back of the list.","name":"child"}],"returns":[{"type":{"names":["*"]},"description":"The item which was moved."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#sendToBack","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":495,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Moves the given child up one place in this group unless it's already at the top.","kind":"function","name":"moveUp","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to move up.","name":"child"}],"returns":[{"type":{"names":["*"]},"description":"The item which was moved."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#moveUp","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":514,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Moves the given child down one place in this group unless it's already at the bottom.","kind":"function","name":"moveDown","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to move down.","name":"child"}],"returns":[{"type":{"names":["*"]},"description":"The item which was moved."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#moveDown","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":533,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Reverses the order of all children in this List.","kind":"function","name":"reverse","since":"3.0.0","returns":[{"type":{"names":["Phaser.Structs.List"]},"description":"This List object."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#reverse","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":550,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Shuffles the items in the list.","kind":"function","name":"shuffle","since":"3.0.0","returns":[{"type":{"names":["Phaser.Structs.List"]},"description":"This List object."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#shuffle","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":567,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Replaces a child of this List with the given newChild. The newChild cannot be a member of this List.","kind":"function","name":"replace","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The child in this List that will be replaced.","name":"oldChild"},{"type":{"names":["*"]},"description":"The child to be inserted into this List.","name":"newChild"}],"returns":[{"type":{"names":["*"]},"description":"Returns the oldChild that was replaced within this group."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#replace","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":585,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Checks if an item exists within the List.","kind":"function","name":"exists","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to check for the existence of.","name":"child"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the item is found in the list, otherwise `false`."}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#exists","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":602,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets the property `key` to the given value on all members of this List.","kind":"function","name":"setAll","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the property to set.","name":"property"},{"type":{"names":["*"]},"description":"The value to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"description":"The first child index to start the search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"The last child index to search up until.","name":"endIndex"}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#setAll","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":622,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Passes all children to the given callback.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["EachListCallback"]},"description":"The function to call.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"Value to use as `this` when executing callback.","name":"context"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#each","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":651,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Clears the List and recreates its internal array.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#shutdown","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":664,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Destroys this List.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#destroy","scope":"instance","___s":true},{"meta":{"filename":"List.js","lineno":679,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The number of items inside the List.","name":"length","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#length","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":696,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The first item in the List or `null` for an empty List.","name":"first","type":{"names":["*"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#first","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The last item in the List, or `null` for an empty List.","name":"last","type":{"names":["*"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#last","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":750,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The next item in the List, or `null` if the entire List has been traversed.\n\nThis property can be read successively after reading {@link #first} or manually setting the {@link #position} to iterate the List.","name":"next","type":{"names":["*"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#next","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"List.js","lineno":779,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The previous item in the List, or `null` if the entire List has been traversed.\n\nThis property can be read successively after reading {@link #last} or manually setting the {@link #position} to iterate the List backwards.","name":"previous","type":{"names":["*"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Structs.List","longname":"Phaser.Structs.List#previous","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,213],"filename":"Map.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Map.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"kind":"typedef","name":"EachMapCallback","type":{"names":["function"]},"params":[{"type":{"names":["string"]},"description":"The key of the Map entry.","name":"key"},{"type":{"names":["E"]},"description":"The value of the Map entry.","name":"entry"}],"returns":[{"type":{"names":["boolean"]},"nullable":true,"description":"The callback result."}],"longname":"EachMapCallback","scope":"global","___s":true},{"meta":{"filename":"Map.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"classdesc":"The keys of a Map can be arbitrary values.\n\n```javascript\nvar map = new Map([\n [ 1, 'one' ],\n [ 2, 'two' ],\n [ 3, 'three' ]\n]);\n```","kind":"class","name":"Map","memberof":"Phaser.Structs","since":"3.0.0","params":[{"type":{"names":["Array.<*>"]},"description":"An optional array of key-value pairs to populate this Map with.","name":"elements"}],"scope":"static","longname":"Phaser.Structs.Map","___s":true},{"meta":{"filename":"Map.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The entries in this Map.","name":"entries","type":{"names":["Object."]},"defaultvalue":"{}","since":"3.0.0","memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#entries","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Map.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The number of key / value pairs in this Map.","name":"size","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#size","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Map.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Adds an element with a specified `key` and `value` to this Map.\nIf the `key` already exists, the value will be replaced.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the element to be added to this Map.","name":"key"},{"type":{"names":["*"]},"description":"The value of the element to be added to this Map.","name":"value"}],"returns":[{"type":{"names":["Phaser.Structs.Map"]},"description":"This Map object."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#set","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns the value associated to the `key`, or `undefined` if there is none.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the element to return from the `Map` object.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The element associated with the specified key or `undefined` if the key can't be found in this Map object."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#get","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns an `Array` of all the values stored in this Map.","kind":"function","name":"getArray","since":"3.0.0","returns":[{"type":{"names":["Array.<*>"]},"description":"An array of the values stored in this Map."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#getArray","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":150,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns a boolean indicating whether an element with the specified key exists or not.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the element to test for presence of in this Map.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if an element with the specified key exists in this Map, otherwise `false`."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#has","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Delete the specified element from this Map.","kind":"function","name":"delete","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the element to delete from this Map.","name":"key"}],"returns":[{"type":{"names":["Phaser.Structs.Map"]},"description":"This Map object."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#delete","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Delete all entries from this Map.","kind":"function","name":"clear","since":"3.0.0","returns":[{"type":{"names":["Phaser.Structs.Map"]},"description":"This Map object."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#clear","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":214,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns all entries keys in this Map.","kind":"function","name":"keys","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"Array containing entries' keys."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#keys","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns an `Array` of all entries.","kind":"function","name":"values","since":"3.0.0","returns":[{"type":{"names":["Array.<*>"]},"description":"An `Array` of entries."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#values","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Dumps the contents of this Map to the console via `console.group`.","kind":"function","name":"dump","since":"3.0.0","memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#dump","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Passes all entries in this Map to the given callback.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["EachMapCallback"]},"description":"The callback which will receive the keys and entries held in this Map.","name":"callback"}],"returns":[{"type":{"names":["Phaser.Structs.Map"]},"description":"This Map object."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#each","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":302,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns `true` if the value exists within this Map. Otherwise, returns `false`.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The value to search for.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the value is found, otherwise `false`."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#contains","scope":"instance","___s":true},{"meta":{"filename":"Map.js","lineno":329,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Merges all new keys from the given Map into this one.\nIf it encounters a key that already exists it will be skipped unless override is set to `true`.","kind":"function","name":"merge","since":"3.0.0","params":[{"type":{"names":["Phaser.Structs.Map"]},"description":"The Map to merge in to this Map.","name":"map"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Set to `true` to replace values in this Map with those from the source map, or `false` to skip them.","name":"override"}],"returns":[{"type":{"names":["Phaser.Structs.Map"]},"description":"This Map object."}],"memberof":"Phaser.Structs.Map","longname":"Phaser.Structs.Map#merge","scope":"instance","___s":true},{"meta":{"range":[180,213],"filename":"ProcessQueue.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"classdesc":"A Process Queue maintains three internal lists.\n\nThe `pending` list is a selection of items which are due to be made 'active' in the next update.\nThe `active` list is a selection of items which are considered active and should be updated.\nThe `destroy` list is a selection of items that were active and are awaiting being destroyed in the next update.\n\nWhen new items are added to a Process Queue they are put in the pending list, rather than being added\nimmediately the active list. Equally, items that are removed are put into the destroy list, rather than\nbeing destroyed immediately. This allows the Process Queue to carefully process each item at a specific, fixed\ntime, rather than at the time of the request from the API.","kind":"class","name":"ProcessQueue","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Structs","since":"3.0.0","scope":"static","longname":"Phaser.Structs.ProcessQueue","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Adds a new item to the Process Queue.\n\nThe item is added to the pending list and made active in the next update.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to add to the queue.","name":"item"}],"returns":[{"type":{"names":["*"]},"description":"The item that was added."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#add","scope":"instance","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes an item from the Process Queue.\n\nThe item is added to the pending destroy and fully removed in the next update.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The item to be removed from the queue.","name":"item"}],"returns":[{"type":{"names":["*"]},"description":"The item that was removed."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#remove","scope":"instance","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":141,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes all active items from this Process Queue.\n\nAll the items are marked as 'pending destroy' and fully removed in the next update.","kind":"function","name":"removeAll","since":"3.20.0","returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"This Process Queue object."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#removeAll","scope":"instance","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Update this queue. First it will process any items awaiting destruction, and remove them.\n\nThen it will check to see if there are any items pending insertion, and move them to an\nactive state. Finally, it will return a list of active items for further processing.","kind":"function","name":"update","since":"3.0.0","returns":[{"type":{"names":["Array.<*>"]},"description":"A list of active items."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#update","scope":"instance","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":233,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns the current list of active items.\n\nThis method returns a reference to the active list array, not a copy of it.\nTherefore, be careful to not modify this array outside of the ProcessQueue.","kind":"function","name":"getActive","since":"3.0.0","returns":[{"type":{"names":["Array.<*>"]},"description":"A list of active items."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#getActive","scope":"instance","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":251,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The number of entries in the active list.","name":"length","type":{"names":["integer"]},"readonly":true,"since":"3.20.0","memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#length","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ProcessQueue.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Immediately destroys this process queue, clearing all of its internal arrays and resetting the process totals.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"range":[216,267],"filename":"RTree.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"name":"quickselect","longname":"quickselect","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RTree.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"classdesc":"RBush is a high-performance JavaScript library for 2D spatial indexing of points and rectangles.\nIt's based on an optimized R-tree data structure with bulk insertion support.\n\nSpatial index is a special data structure for points and rectangles that allows you to perform queries like\n\"all items within this bounding box\" very efficiently (e.g. hundreds of times faster than looping over all items).\n\nThis version of RBush uses a fixed min/max accessor structure of `[ '.left', '.top', '.right', '.bottom' ]`.\nThis is to avoid the eval like function creation that the original library used, which caused CSP policy violations.\n\nrbush is forked from https://github.com/mourner/rbush by Vladimir Agafonkin","kind":"class","name":"RTree","memberof":"Phaser.Structs","since":"3.0.0","scope":"static","longname":"Phaser.Structs.RTree","___s":true},{"meta":{"range":[180,213],"filename":"Set.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Set.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"kind":"typedef","name":"EachSetCallback","type":{"names":["function"]},"params":[{"type":{"names":["E"]},"description":"The Set entry.","name":"entry"},{"type":{"names":["number"]},"description":"The index of the entry within the Set.","name":"index"}],"returns":[{"type":{"names":["boolean"]},"nullable":true,"description":"The callback result."}],"longname":"EachSetCallback","scope":"global","___s":true},{"meta":{"filename":"Set.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"classdesc":"A Set is a collection of unique elements.","kind":"class","name":"Set","memberof":"Phaser.Structs","since":"3.0.0","params":[{"type":{"names":["Array.<*>"]},"optional":true,"description":"An optional array of elements to insert into this Set.","name":"elements"}],"scope":"static","longname":"Phaser.Structs.Set","___s":true},{"meta":{"filename":"Set.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The entries of this Set. Stored internally as an array.","name":"entries","type":{"names":["Array.<*>"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#entries","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Set.js","lineno":59,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Inserts the provided value into this Set. If the value is already contained in this Set this method will have no effect.","kind":"function","name":"set","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The value to insert into this Set.","name":"value"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"This Set object."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#set","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Get an element of this Set which has a property of the specified name, if that property is equal to the specified value.\nIf no elements of this Set satisfy the condition then this method will return `null`.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The property name to check on the elements of this Set.","name":"property"},{"type":{"names":["*"]},"description":"The value to check for.","name":"value"}],"returns":[{"type":{"names":["*"]},"description":"The first element of this Set that meets the required condition, or `null` if this Set contains no elements that meet the condition."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#get","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":109,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns an array containing all the values in this Set.","kind":"function","name":"getArray","since":"3.0.0","returns":[{"type":{"names":["Array.<*>"]},"description":"An array containing all the values in this Set."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#getArray","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":124,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Removes the given value from this Set if this Set contains that value.","kind":"function","name":"delete","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The value to remove from the Set.","name":"value"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"This Set object."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#delete","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Dumps the contents of this Set to the console via `console.group`.","kind":"function","name":"dump","since":"3.0.0","memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#dump","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Passes each value in this Set to the given callback.\nUse this function when you know this Set will be modified during the iteration, otherwise use `iterate`.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["EachSetCallback"]},"description":"The callback to be invoked and passed each value this Set contains.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"The scope of the callback.","name":"callbackScope"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"This Set object."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#each","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Passes each value in this Set to the given callback.\nFor when you absolutely know this Set won't be modified during the iteration.","kind":"function","name":"iterate","since":"3.0.0","params":[{"type":{"names":["EachSetCallback"]},"description":"The callback to be invoked and passed each value this Set contains.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"The scope of the callback.","name":"callbackScope"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"This Set object."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#iterate","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Goes through each entry in this Set and invokes the given function on them, passing in the arguments.","kind":"function","name":"iterateLocal","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the function to be invoked on each Set entry.","name":"callbackKey"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"This Set object."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#iterateLocal","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":294,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Clears this Set so that it no longer contains any values.","kind":"function","name":"clear","since":"3.0.0","returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"This Set object."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#clear","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":311,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns `true` if this Set contains the given value, otherwise returns `false`.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["*"]},"description":"The value to check for in this Set.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the given value was found in this Set, otherwise `false`."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#contains","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":328,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns a new Set containing all values that are either in this Set or in the Set provided as an argument.","kind":"function","name":"union","since":"3.0.0","params":[{"type":{"names":["Phaser.Structs.Set"]},"description":"The Set to perform the union with.","name":"set"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"A new Set containing all the values in this Set and the Set provided as an argument."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#union","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":357,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns a new Set that contains only the values which are in this Set and that are also in the given Set.","kind":"function","name":"intersect","since":"3.0.0","params":[{"type":{"names":["Phaser.Structs.Set"]},"description":"The Set to intersect this set with.","name":"set"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"The result of the intersection, as a new Set."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#intersect","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns a new Set containing all the values in this Set which are *not* also in the given Set.","kind":"function","name":"difference","since":"3.0.0","params":[{"type":{"names":["Phaser.Structs.Set"]},"description":"The Set to perform the difference with.","name":"set"}],"returns":[{"type":{"names":["Phaser.Structs.Set"]},"description":"A new Set containing all the values in this Set that are not also in the Set provided as an argument to this method."}],"memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#difference","scope":"instance","___s":true},{"meta":{"filename":"Set.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The size of this Set. This is the number of entries within it.\nChanging the size will truncate the Set if the given value is smaller than the current size.\nIncreasing the size larger than the current size has no effect.","name":"size","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Structs.Set","longname":"Phaser.Structs.Set#size","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,212],"filename":"Size.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"name":"Clamp","longname":"Clamp","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Size.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"classdesc":"The Size component allows you to set `width` and `height` properties and define the relationship between them.\n\nThe component can automatically maintain the aspect ratios between the two values, and clamp them\nto a defined min-max range. You can also control the dominant axis. When dimensions are given to the Size component\nthat would cause it to exceed its min-max range, the dimensions are adjusted based on the dominant axis.","kind":"class","name":"Size","memberof":"Phaser.Structs","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height of the Size component. If not given, it will use the `width`.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The aspect mode of the Size component. Defaults to 0, no mode.","name":"aspectMode"},{"type":{"names":["any"]},"optional":true,"defaultvalue":null,"description":"The parent of this Size component. Can be any object with public `width` and `height` properties. Dimensions are clamped to keep them within the parent bounds where possible.","name":"parent"}],"scope":"static","longname":"Phaser.Structs.Size","___s":true},{"meta":{"filename":"Size.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The aspect mode this Size component will use when calculating its dimensions.\nThis property is read-only. To change it use the `setAspectMode` method.","name":"aspectMode","type":{"names":["integer"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#aspectMode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":82,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The proportional relationship between the width and height.\n\nThis property is read-only and is updated automatically when either the `width` or `height` properties are changed,\ndepending on the aspect mode.","name":"aspectRatio","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#aspectRatio","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The minimum allowed width.\nCannot be less than zero.\nThis value is read-only. To change it see the `setMin` method.","name":"minWidth","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#minWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The minimum allowed height.\nCannot be less than zero.\nThis value is read-only. To change it see the `setMin` method.","name":"minHeight","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#minHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The maximum allowed width.\nThis value is read-only. To change it see the `setMax` method.","name":"maxWidth","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#maxWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The maximum allowed height.\nThis value is read-only. To change it see the `setMax` method.","name":"maxHeight","type":{"names":["number"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#maxHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"A Vector2 containing the horizontal and vertical snap values, which the width and height are snapped to during resizing.\n\nBy default this is disabled.\n\nThis property is read-only. To change it see the `setSnap` method.","name":"snapTo","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#snapTo","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":156,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets the aspect mode of this Size component.\n\nThe aspect mode controls what happens when you modify the `width` or `height` properties, or call `setSize`.\n\nIt can be a number from 0 to 4, or a Size constant:\n\n0. NONE = Do not make the size fit the aspect ratio. Change the ratio when the size changes.\n1. WIDTH_CONTROLS_HEIGHT = The height is automatically adjusted based on the width.\n2. HEIGHT_CONTROLS_WIDTH = The width is automatically adjusted based on the height.\n3. FIT = The width and height are automatically adjusted to fit inside the given target area, while keeping the aspect ratio. Depending on the aspect ratio there may be some space inside the area which is not covered.\n4. ENVELOP = The width and height are automatically adjusted to make the size cover the entire target area while keeping the aspect ratio. This may extend further out than the target size.\n\nCalling this method automatically recalculates the `width` and the `height`, if required.","kind":"function","name":"setAspectMode","since":"3.16.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The aspect mode value.","name":"value"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setAspectMode","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":187,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"By setting a Snap To value when this Size component is modified its dimensions will automatically\nby snapped to the nearest grid slice, using floor. For example, if you have snap value of 16,\nand the width changes to 68, then it will snap down to 64 (the closest multiple of 16 when floored)\n\nNote that snapping takes place before adjustments by the parent, or the min / max settings. If these\nvalues are not multiples of the given snap values, then this can result in un-snapped dimensions.\n\nCall this method with no arguments to reset the snap values.\n\nCalling this method automatically recalculates the `width` and the `height`, if required.","kind":"function","name":"setSnap","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The amount to snap the width to. If you don't want to snap the width, pass a value of zero.","name":"snapWidth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"snapWidth","description":"The amount to snap the height to. If not provided it will use the `snapWidth` value. If you don't want to snap the height, pass a value of zero.","name":"snapHeight"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setSnap","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":217,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets, or clears, the parent of this Size component.\n\nTo clear the parent call this method with no arguments.\n\nThe parent influences the maximum extents to which this Size component can expand,\nbased on the aspect mode:\n\nNONE - The parent clamps both the width and height.\nWIDTH_CONTROLS_HEIGHT - The parent clamps just the width.\nHEIGHT_CONTROLS_WIDTH - The parent clamps just the height.\nFIT - The parent clamps whichever axis is required to ensure the size fits within it.\nENVELOP - The parent is used to ensure the size fully envelops the parent.\n\nCalling this method automatically calls `setSize`.","kind":"function","name":"setParent","since":"3.16.0","params":[{"type":{"names":["any"]},"optional":true,"description":"Sets the parent of this Size component. Don't provide a value to clear an existing parent.","name":"parent"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setParent","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":247,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Set the minimum width and height values this Size component will allow.\n\nThe minimum values can never be below zero, or greater than the maximum values.\n\nSetting this will automatically adjust both the `width` and `height` properties to ensure they are within range.\n\nNote that based on the aspect mode, and if this Size component has a parent set or not, the minimums set here\n_can_ be exceed in some situations.","kind":"function","name":"setMin","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The minimum allowed width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The minimum allowed height of the Size component. If not given, it will use the `width`.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setMin","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":276,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Set the maximum width and height values this Size component will allow.\n\nSetting this will automatically adjust both the `width` and `height` properties to ensure they are within range.\n\nNote that based on the aspect mode, and if this Size component has a parent set or not, the maximums set here\n_can_ be exceed in some situations.","kind":"function","name":"setMax","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":"Number.MAX_VALUE","description":"The maximum allowed width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The maximum allowed height of the Size component. If not given, it will use the `width`.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setMax","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":303,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets the width and height of this Size component based on the aspect mode.\n\nIf the aspect mode is 'none' then calling this method will change the aspect ratio, otherwise the current\naspect ratio is honored across all other modes.\n\nIf snapTo values have been set then the given width and height are snapped first, prior to any further\nadjustment via min/max values, or a parent.\n\nIf minimum and/or maximum dimensions have been specified, the values given to this method will be clamped into\nthat range prior to adjustment, but may still exceed them depending on the aspect mode.\n\nIf this Size component has a parent set, and the aspect mode is `fit` or `envelop`, then the given sizes will\nbe clamped to the range specified by the parent.","kind":"function","name":"setSize","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The new width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The new height of the Size component. If not given, it will use the `width`.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setSize","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":361,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets a new aspect ratio, overriding what was there previously.\n\nIt then calls `setSize` immediately using the current dimensions.","kind":"function","name":"setAspectRatio","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new aspect ratio.","name":"ratio"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setAspectRatio","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":380,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets a new width and height for this Size component and updates the aspect ratio based on them.\n\nIt _doesn't_ change the `aspectMode` and still factors in size limits such as the min max and parent bounds.","kind":"function","name":"resize","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The new height of the Size component. If not given, it will use the `width`.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#resize","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Takes a new width and passes it through the min/max clamp and then checks it doesn't exceed the parent width.","kind":"function","name":"getNewWidth","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The value to clamp and check.","name":"value"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Check the given value against the parent, if set.","name":"checkParent"}],"returns":[{"type":{"names":["number"]},"description":"The modified width value."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#getNewWidth","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":427,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Takes a new height and passes it through the min/max clamp and then checks it doesn't exceed the parent height.","kind":"function","name":"getNewHeight","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The value to clamp and check.","name":"value"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Check the given value against the parent, if set.","name":"checkParent"}],"returns":[{"type":{"names":["number"]},"description":"The modified height value."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#getNewHeight","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":452,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The current `width` and `height` are adjusted to fit inside the given dimensions, while keeping the aspect ratio.\n\nIf `fit` is true there may be some space inside the target area which is not covered if its aspect ratio differs.\nIf `fit` is false the size may extend further out than the target area if the aspect ratios differ.\n\nIf this Size component has a parent set, then the width and height passed to this method will be clamped so\nit cannot exceed that of the parent.","kind":"function","name":"constrain","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The new width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The new height of the Size component. If not given, it will use the width value.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Perform a `fit` (true) constraint, or an `envelop` (false) constraint.","name":"fit"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#constrain","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":521,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The current `width` and `height` are adjusted to fit inside the given dimensions, while keeping the aspect ratio.\n\nThere may be some space inside the target area which is not covered if its aspect ratio differs.\n\nIf this Size component has a parent set, then the width and height passed to this method will be clamped so\nit cannot exceed that of the parent.","kind":"function","name":"fitTo","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The new width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The new height of the Size component. If not given, it will use the width value.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#fitTo","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":542,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The current `width` and `height` are adjusted so that they fully envelope the given dimensions, while keeping the aspect ratio.\n\nThe size may extend further out than the target area if the aspect ratios differ.\n\nIf this Size component has a parent set, then the values are clamped so that it never exceeds the parent\non the longest axis.","kind":"function","name":"envelop","since":"3.16.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The new width of the Size component.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The new height of the Size component. If not given, it will use the width value.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#envelop","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":563,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets the width of this Size component.\n\nDepending on the aspect mode, changing the width may also update the height and aspect ratio.","kind":"function","name":"setWidth","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new width of the Size component.","name":"width"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setWidth","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":580,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets the height of this Size component.\n\nDepending on the aspect mode, changing the height may also update the width and aspect ratio.","kind":"function","name":"setHeight","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The new height of the Size component.","name":"height"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"This Size component instance."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setHeight","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Returns a string representation of this Size component.","kind":"function","name":"toString","since":"3.16.0","returns":[{"type":{"names":["string"]},"description":"A string representation of this Size component."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#toString","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":610,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Sets the values of this Size component to the `element.style.width` and `height`\nproperties of the given DOM Element. The properties are set as `px` values.","kind":"function","name":"setCSS","since":"3.17.0","params":[{"type":{"names":["HTMLElement"]},"description":"The DOM Element to set the CSS style on.","name":"element"}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#setCSS","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":628,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Copies the aspect mode, aspect ratio, width and height from this Size component\nto the given Size component. Note that the parent, if set, is not copied across.","kind":"function","name":"copy","since":"3.16.0","params":[{"type":{"names":["Phaser.Structs.Size"]},"description":"The Size component to copy the values to.","name":"destination"}],"returns":[{"type":{"names":["Phaser.Structs.Size"]},"description":"The updated destination Size component."}],"memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#copy","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":648,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Destroys this Size component.\n\nThis clears the local properties and any parent object, if set.\n\nA destroyed Size component cannot be re-used.","kind":"function","name":"destroy","since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#destroy","scope":"instance","___s":true},{"meta":{"filename":"Size.js","lineno":664,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The width of this Size component.\n\nThis value is clamped to the range specified by `minWidth` and `maxWidth`, if enabled.\n\nA width can never be less than zero.\n\nChanging this value will automatically update the `height` if the aspect ratio lock is enabled.\nYou can also use the `setWidth` and `getWidth` methods.","name":"width","type":{"names":["number"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":692,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The height of this Size component.\n\nThis value is clamped to the range specified by `minHeight` and `maxHeight`, if enabled.\n\nA height can never be less than zero.\n\nChanging this value will automatically update the `width` if the aspect ratio lock is enabled.\nYou can also use the `setHeight` and `getHeight` methods.","name":"height","type":{"names":["number"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Size.js","lineno":722,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"Do not make the size fit the aspect ratio. Change the ratio when the size changes.","name":"NONE","kind":"constant","type":{"names":["integer"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size.NONE","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":732,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The height is automatically adjusted based on the width.","name":"WIDTH_CONTROLS_HEIGHT","kind":"constant","type":{"names":["integer"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size.WIDTH_CONTROLS_HEIGHT","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":742,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The width is automatically adjusted based on the height.","name":"HEIGHT_CONTROLS_WIDTH","kind":"constant","type":{"names":["integer"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size.HEIGHT_CONTROLS_WIDTH","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":752,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The width and height are automatically adjusted to fit inside the given target area, while keeping the aspect ratio. Depending on the aspect ratio there may be some space inside the area which is not covered.","name":"FIT","kind":"constant","type":{"names":["integer"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size.FIT","scope":"static","___s":true},{"meta":{"filename":"Size.js","lineno":762,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"description":"The width and height are automatically adjusted to make the size cover the entire target area while keeping the aspect ratio. This may extend further out than the target size.","name":"ENVELOP","kind":"constant","type":{"names":["integer"]},"since":"3.16.0","memberof":"Phaser.Structs.Size","longname":"Phaser.Structs.Size.ENVELOP","scope":"static","___s":true},{"meta":{"filename":"PROCESS_QUEUE_ADD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs/events"},"description":"The Process Queue Add Event.\n\nThis event is dispatched by a Process Queue when a new item is successfully moved to its active list.\n\nYou will most commonly see this used by a Scene's Update List when a new Game Object has been added.\n\nIn that instance, listen to this event from within a Scene using: `this.sys.updateList.on('add', listener)`.","kind":"event","name":"PROCESS_QUEUE_ADD","since":"3.20.0","params":[{"type":{"names":["*"]},"description":"The item that was added to the Process Queue.","name":"item"}],"memberof":"Phaser.Structs.Events","longname":"Phaser.Structs.Events#event:PROCESS_QUEUE_ADD","scope":"instance","___s":true},{"meta":{"filename":"PROCESS_QUEUE_REMOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs/events"},"description":"The Process Queue Remove Event.\n\nThis event is dispatched by a Process Queue when a new item is successfully removed from its active list.\n\nYou will most commonly see this used by a Scene's Update List when a Game Object has been removed.\n\nIn that instance, listen to this event from within a Scene using: `this.sys.updateList.on('remove', listener)`.","kind":"event","name":"PROCESS_QUEUE_REMOVE","since":"3.20.0","params":[{"type":{"names":["*"]},"description":"The item that was removed from the Process Queue.","name":"item"}],"memberof":"Phaser.Structs.Events","longname":"Phaser.Structs.Events#event:PROCESS_QUEUE_REMOVE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Structs","longname":"Phaser.Structs.Events","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/structs"},"kind":"namespace","name":"Structs","memberof":"Phaser","longname":"Phaser.Structs","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"CanvasTexture.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"classdesc":"A Canvas Texture is a special kind of Texture that is backed by an HTML Canvas Element as its source.\n\nYou can use the properties of this texture to draw to the canvas element directly, using all of the standard\ncanvas operations available in the browser. Any Game Object can be given this texture and will render with it.\n\nNote: When running under WebGL the Canvas Texture needs to re-generate its base WebGLTexture and reupload it to\nthe GPU every time you modify it, otherwise the changes you make to this texture will not be visible. To do this\nyou should call `CanvasTexture.refresh()` once you are finished with your changes to the canvas. Try and keep\nthis to a minimum, especially on large canvas sizes, or you may inadvertently thrash the GPU by constantly uploading\ntexture data to it. This restriction does not apply if using the Canvas Renderer.\n\nIt starts with only one frame that covers the whole of the canvas. You can add further frames, that specify\nsections of the canvas using the `add` method.\n\nShould you need to resize the canvas use the `setSize` method so that it accurately updates all of the underlying\ntexture data as well. Forgetting to do this (i.e. by changing the canvas size directly from your code) could cause\ngraphical errors.","kind":"class","name":"CanvasTexture","augments":["Phaser.Textures.Texture"],"memberof":"Phaser.Textures","since":"3.7.0","params":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"A reference to the Texture Manager this Texture belongs to.","name":"manager"},{"type":{"names":["string"]},"description":"The unique string-based key of this Texture.","name":"key"},{"type":{"names":["HTMLCanvasElement"]},"description":"The canvas element that is used as the base of this texture.","name":"source"},{"type":{"names":["integer"]},"description":"The width of the canvas.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the canvas.","name":"height"}],"scope":"static","longname":"Phaser.Textures.CanvasTexture","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The source Canvas Element.","name":"canvas","readonly":true,"type":{"names":["HTMLCanvasElement"]},"since":"3.7.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#canvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The 2D Canvas Rendering Context.","name":"context","readonly":true,"type":{"names":["CanvasRenderingContext2D"]},"since":"3.7.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#context","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The width of the Canvas.\nThis property is read-only, if you wish to change it use the `setSize` method.","name":"width","readonly":true,"type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The height of the Canvas.\nThis property is read-only, if you wish to change it use the `setSize` method.","name":"height","readonly":true,"type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The context image data.\nUse the `update` method to populate this when the canvas changes.","name":"imageData","type":{"names":["ImageData"]},"since":"3.13.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#imageData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"A Uint8ClampedArray view into the `buffer`.\nUse the `update` method to populate this when the canvas changes.\nNote that this is unavailable in some browsers, such as Epic Browser, due to their security restrictions.","name":"data","type":{"names":["Uint8ClampedArray"]},"since":"3.13.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An Uint32Array view into the `buffer`.","name":"pixels","type":{"names":["Uint32Array"]},"since":"3.13.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#pixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":145,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An ArrayBuffer the same size as the context ImageData.","name":"buffer","type":{"names":["ArrayBuffer"]},"since":"3.13.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#buffer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"This re-creates the `imageData` from the current context.\nIt then re-builds the ArrayBuffer, the `data` Uint8ClampedArray reference and the `pixels` Int32Array.\n\nWarning: This is a very expensive operation, so use it sparingly.","kind":"function","name":"update","since":"3.13.0","returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"This CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#update","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Draws the given Image or Canvas element to this CanvasTexture, then updates the internal\nImageData buffer and arrays.","kind":"function","name":"draw","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate to draw the source at.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate to draw the source at.","name":"y"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement"]},"description":"The element to draw to this canvas.","name":"source"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"This CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#draw","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":233,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Draws the given texture frame to this CanvasTexture, then updates the internal\nImageData buffer and arrays.","kind":"function","name":"drawFrame","since":"3.16.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from the Texture.","name":"frame"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate to draw the source at.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate to draw the source at.","name":"y"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"This CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#drawFrame","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets a pixel in the CanvasTexture to the given color and alpha values.\n\nThis is an expensive operation to run in large quantities, so use sparingly.","kind":"function","name":"setPixel","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"y"},{"type":{"names":["integer"]},"description":"The red color value. A number between 0 and 255.","name":"red"},{"type":{"names":["integer"]},"description":"The green color value. A number between 0 and 255.","name":"green"},{"type":{"names":["integer"]},"description":"The blue color value. A number between 0 and 255.","name":"blue"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":255,"description":"The alpha value. A number between 0 and 255.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"This CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#setPixel","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Puts the ImageData into the context of this CanvasTexture at the given coordinates.","kind":"function","name":"putData","since":"3.16.0","params":[{"type":{"names":["ImageData"]},"description":"The ImageData to put at the given location.","name":"imageData"},{"type":{"names":["integer"]},"description":"The x coordinate to put the imageData. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate to put the imageData. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Horizontal position (x coordinate) of the top-left corner from which the image data will be extracted.","name":"dirtyX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Vertical position (x coordinate) of the top-left corner from which the image data will be extracted.","name":"dirtyY"},{"type":{"names":["integer"]},"optional":true,"description":"Width of the rectangle to be painted. Defaults to the width of the image data.","name":"dirtyWidth"},{"type":{"names":["integer"]},"optional":true,"description":"Height of the rectangle to be painted. Defaults to the height of the image data.","name":"dirtyHeight"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"This CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#putData","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Gets an ImageData region from this CanvasTexture from the position and size specified.\nYou can write this back using `CanvasTexture.putData`, or manipulate it.","kind":"function","name":"getData","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the top-left of the area to get the ImageData from. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the top-left of the area to get the ImageData from. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the rectangle from which the ImageData will be extracted. Positive values are to the right, and negative to the left.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the rectangle from which the ImageData will be extracted. Positive values are down, and negative are up.","name":"height"}],"returns":[{"type":{"names":["ImageData"]},"description":"The ImageData extracted from this CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getData","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":375,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Get the color of a specific pixel from this texture and store it in a Color object.\n\nIf you have drawn anything to this CanvasTexture since it was created you must call `CanvasTexture.update` to refresh the array buffer,\notherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.","kind":"function","name":"getPixel","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"y"},{"type":{"names":["Phaser.Display.Color"]},"optional":true,"description":"A Color object to store the pixel values in. If not provided a new Color object will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"description":"An object with the red, green, blue and alpha values set in the r, g, b and a properties."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getPixel","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":414,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns an array containing all of the pixels in the given region.\n\nIf the requested region extends outside the bounds of this CanvasTexture,\nthe region is truncated to fit.\n\nIf you have drawn anything to this CanvasTexture since it was created you must call `CanvasTexture.update` to refresh the array buffer,\notherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.","kind":"function","name":"getPixels","since":"3.16.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the top-left of the region. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the top-left of the region. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the region to get. Must be an integer. Defaults to the canvas width if not given.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the region to get. Must be an integer. If not given will be set to the `width`.","name":"height"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Pixel objects."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getPixels","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":469,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns the Image Data index for the given pixel in this CanvasTexture.\n\nThe index can be used to read directly from the `this.data` array.\n\nThe index points to the red value in the array. The subsequent 3 indexes\npoint to green, blue and alpha respectively.","kind":"function","name":"getIndex","since":"3.16.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel to get. Must lay within the dimensions of this CanvasTexture and be an integer.","name":"y"}],"returns":[{"type":{"names":["integer"]}}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getIndex","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":500,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"This should be called manually if you are running under WebGL.\nIt will refresh the WebGLTexture from the Canvas source. Only call this if you know that the\ncanvas has changed, as there is a significant GPU texture allocation cost involved in doing so.","kind":"function","name":"refresh","since":"3.7.0","returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"This CanvasTexture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#refresh","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":517,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Gets the Canvas Element.","kind":"function","name":"getCanvas","since":"3.7.0","returns":[{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas DOM element this texture is using."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getCanvas","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":530,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Gets the 2D Canvas Rendering Context.","kind":"function","name":"getContext","since":"3.7.0","returns":[{"type":{"names":["CanvasRenderingContext2D"]},"description":"The Canvas Rendering Context this texture is using."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getContext","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":543,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Clears the given region of this Canvas Texture, resetting it back to transparent.\nIf no region is given, the whole Canvas Texture is cleared.","kind":"function","name":"clear","since":"3.7.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the top-left of the region to clear.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the top-left of the region to clear.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the region.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the region.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"The Canvas Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#clear","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":569,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Changes the size of this Canvas Texture.","kind":"function","name":"setSize","since":"3.7.0","params":[{"type":{"names":["integer"]},"description":"The new width of the Canvas.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The new height of the Canvas. If not given it will use the width as the height.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"description":"The Canvas Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#setSize","scope":"instance","___s":true},{"meta":{"filename":"CanvasTexture.js","lineno":604,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Destroys this Texture and releases references to its sources and frames.","kind":"function","name":"destroy","since":"3.16.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#destroy","scope":"instance","overrides":"Phaser.Textures.Texture#destroy","___s":true},{"meta":{"range":[180,213],"filename":"Frame.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Frame.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"classdesc":"A Frame is a section of a Texture.","kind":"class","name":"Frame","memberof":"Phaser.Textures","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"The Texture this Frame is a part of.","name":"texture"},{"type":{"names":["integer","string"]},"description":"The name of this Frame. The name is unique within the Texture.","name":"name"},{"type":{"names":["integer"]},"description":"The index of the TextureSource that this Frame is a part of.","name":"sourceIndex"},{"type":{"names":["number"]},"description":"The x coordinate of the top-left of this Frame.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of this Frame.","name":"y"},{"type":{"names":["number"]},"description":"The width of this Frame.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Frame.","name":"height"}],"scope":"static","longname":"Phaser.Textures.Frame","___s":true},{"meta":{"filename":"Frame.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Texture this Frame is a part of.","name":"texture","type":{"names":["Phaser.Textures.Texture"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The name of this Frame.\nThe name is unique within the Texture.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The TextureSource this Frame is part of.","name":"source","type":{"names":["Phaser.Textures.TextureSource"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The index of the TextureSource in the Texture sources array.","name":"sourceIndex","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#sourceIndex","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"A reference to the Texture Source WebGL Texture that this Frame is using.","name":"glTexture","type":{"names":["WebGLTexture"]},"nullable":true,"defaultvalue":"null","since":"3.11.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#glTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"X position within the source image to cut from.","name":"cutX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#cutX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":90,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Y position within the source image to cut from.","name":"cutY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#cutY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The width of the area in the source image to cut.","name":"cutWidth","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#cutWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The height of the area in the source image to cut.","name":"cutHeight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#cutHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The X rendering offset of this Frame, taking trim into account.","name":"x","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Y rendering offset of this Frame, taking trim into account.","name":"y","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The rendering width of this Frame, taking trim into account.","name":"width","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":146,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The rendering height of this Frame, taking trim into account.","name":"height","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Half the width, floored.\nPrecalculated for the renderer.","name":"halfWidth","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#halfWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Half the height, floored.\nPrecalculated for the renderer.","name":"halfHeight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#halfHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":175,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The x center of this frame, floored.","name":"centerX","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#centerX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":184,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The y center of this frame, floored.","name":"centerY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#centerY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":193,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The horizontal pivot point of this Frame.","name":"pivotX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#pivotX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":203,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The vertical pivot point of this Frame.","name":"pivotY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#pivotY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":213,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Does this Frame have a custom pivot point?","name":"customPivot","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#customPivot","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":223,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"**CURRENTLY UNSUPPORTED**\n\nIs this frame is rotated or not in the Texture?\nRotation allows you to use rotated frames in texture atlas packing.\nIt has nothing to do with Sprite rotation.","name":"rotated","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#rotated","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":237,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Over-rides the Renderer setting.\n-1 = use Renderer Setting\n0 = No rounding\n1 = Round","name":"autoRound","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#autoRound","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":250,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Any Frame specific custom data can be stored here.","name":"customData","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#customData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":259,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"WebGL UV u0 value.","name":"u0","type":{"names":["number"]},"defaultvalue":"0","since":"3.11.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#u0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":269,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"WebGL UV v0 value.","name":"v0","type":{"names":["number"]},"defaultvalue":"0","since":"3.11.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#v0","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":279,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"WebGL UV u1 value.","name":"u1","type":{"names":["number"]},"defaultvalue":"0","since":"3.11.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#u1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":289,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"WebGL UV v1 value.","name":"v1","type":{"names":["number"]},"defaultvalue":"0","since":"3.11.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#v1","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":341,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the width, height, x and y of this Frame.\n\nThis is called automatically by the constructor\nand should rarely be changed on-the-fly.","kind":"function","name":"setSize","since":"3.7.0","params":[{"type":{"names":["integer"]},"description":"The width of the frame before being trimmed.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the frame before being trimmed.","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The x coordinate of the top-left of this Frame.","name":"x"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The y coordinate of the top-left of this Frame.","name":"y"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"This Frame object."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#setSize","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":404,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"If the frame was trimmed when added to the Texture Atlas, this records the trim and source data.","kind":"function","name":"setTrim","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the frame before being trimmed.","name":"actualWidth"},{"type":{"names":["number"]},"description":"The height of the frame before being trimmed.","name":"actualHeight"},{"type":{"names":["number"]},"description":"The destination X position of the trimmed frame for display.","name":"destX"},{"type":{"names":["number"]},"description":"The destination Y position of the trimmed frame for display.","name":"destY"},{"type":{"names":["number"]},"description":"The destination width of the trimmed frame for display.","name":"destWidth"},{"type":{"names":["number"]},"description":"The destination height of the trimmed frame for display.","name":"destHeight"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"This Frame object."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#setTrim","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":454,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes a crop data object and, based on the rectangular region given, calculates the\nrequired UV coordinates in order to crop this Frame for WebGL and Canvas rendering.\n\nThis is called directly by the Game Object Texture Components `setCrop` method.\nPlease use that method to crop a Game Object.","kind":"function","name":"setCropUVs","since":"3.11.0","params":[{"type":{"names":["object"]},"description":"The crop data object. This is the `GameObject._crop` property.","name":"crop"},{"type":{"names":["number"]},"description":"The x coordinate to start the crop from. Cannot be negative or exceed the Frame width.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to start the crop from. Cannot be negative or exceed the Frame height.","name":"y"},{"type":{"names":["number"]},"description":"The width of the crop rectangle. Cannot exceed the Frame width.","name":"width"},{"type":{"names":["number"]},"description":"The height of the crop rectangle. Cannot exceed the Frame height.","name":"height"},{"type":{"names":["boolean"]},"description":"Does the parent Game Object have flipX set?","name":"flipX"},{"type":{"names":["boolean"]},"description":"Does the parent Game Object have flipY set?","name":"flipY"}],"returns":[{"type":{"names":["object"]},"description":"The updated crop data object."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#setCropUVs","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":595,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes a crop data object and recalculates the UVs based on the dimensions inside the crop object.\nCalled automatically by `setFrame`.","kind":"function","name":"updateCropUVs","since":"3.11.0","params":[{"type":{"names":["object"]},"description":"The crop data object. This is the `GameObject._crop` property.","name":"crop"},{"type":{"names":["boolean"]},"description":"Does the parent Game Object have flipX set?","name":"flipX"},{"type":{"names":["boolean"]},"description":"Does the parent Game Object have flipY set?","name":"flipY"}],"returns":[{"type":{"names":["object"]},"description":"The updated crop data object."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#updateCropUVs","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":613,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Updates the internal WebGL UV cache and the drawImage cache.","kind":"function","name":"updateUVs","since":"3.0.0","returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"This Frame object."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#updateUVs","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":649,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Updates the internal WebGL UV cache.","kind":"function","name":"updateUVsInverted","since":"3.0.0","returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"This Frame object."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#updateUVsInverted","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":671,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Clones this Frame into a new Frame object.","kind":"function","name":"clone","since":"3.0.0","returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"A clone of this Frame."}],"memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#clone","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":709,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Destroys this Frame by nulling its reference to the parent Texture and and data objects.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#destroy","scope":"instance","___s":true},{"meta":{"filename":"Frame.js","lineno":724,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The width of the Frame in its un-trimmed, un-padded state, as prepared in the art package,\nbefore being packed.","name":"realWidth","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#realWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The height of the Frame in its un-trimmed, un-padded state, as prepared in the art package,\nbefore being packed.","name":"realHeight","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#realHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":760,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The radius of the Frame (derived from sqrt(w * w + h * h) / 2)","name":"radius","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#radius","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":777,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Is the Frame trimmed or not?","name":"trimmed","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#trimmed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Frame.js","lineno":794,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Canvas drawImage data object.","name":"canvasData","type":{"names":["object"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Textures.Frame","longname":"Phaser.Textures.Frame#canvasData","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,213],"filename":"Texture.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Texture.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"classdesc":"A Texture consists of a source, usually an Image from the Cache, and a collection of Frames.\nThe Frames represent the different areas of the Texture. For example a texture atlas\nmay have many Frames, one for each element within the atlas. Where-as a single image would have\njust one frame, that encompasses the whole image.\n\nEvery Texture, no matter where it comes from, always has at least 1 frame called the `__BASE` frame.\nThis frame represents the entirety of the source image.\n\nTextures are managed by the global TextureManager. This is a singleton class that is\nresponsible for creating and delivering Textures and their corresponding Frames to Game Objects.\n\nSprites and other Game Objects get the texture data they need from the TextureManager.","kind":"class","name":"Texture","memberof":"Phaser.Textures","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"A reference to the Texture Manager this Texture belongs to.","name":"manager"},{"type":{"names":["string"]},"description":"The unique string-based key of this Texture.","name":"key"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"description":"An array of sources that are used to create the texture. Usually Images, but can also be a Canvas.","name":"source"},{"type":{"names":["number"]},"optional":true,"description":"The width of the Texture. This is optional and automatically derived from the source images.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the Texture. This is optional and automatically derived from the source images.","name":"height"}],"scope":"static","longname":"Phaser.Textures.Texture","___s":true},{"meta":{"filename":"Texture.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"A reference to the Texture Manager this Texture belongs to.","name":"manager","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The unique string-based key of this Texture.","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#key","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An array of TextureSource instances.\nThese are unique to this Texture and contain the actual Image (or Canvas) data.","name":"source","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An array of TextureSource data instances.\nUsed to store additional data images, such as normal maps or specular maps.","name":"dataSource","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#dataSource","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"A key-value object pair associating the unique Frame keys with the Frames objects.","name":"frames","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#frames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Any additional data that was set in the source JSON (if any),\nor any extra data you'd like to store relating to this texture","name":"customData","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#customData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The name of the first frame of the Texture.","name":"firstFrame","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#firstFrame","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The total number of Frames in this Texture, including the `__BASE` frame.\n\nA Texture will always contain at least 1 frame because every Texture contains a `__BASE` frame by default,\nin addition to any extra frames that have been added to it, such as when parsing a Sprite Sheet or Texture Atlas.","name":"frameTotal","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#frameTotal","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Texture.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a new Frame to this Texture.\n\nA Frame is a rectangular region of a TextureSource with a unique index or string-based key.\n\nThe name given must be unique within this Texture. If it already exists, this method will return `null`.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["integer","string"]},"description":"The name of this Frame. The name is unique within the Texture.","name":"name"},{"type":{"names":["integer"]},"description":"The index of the TextureSource that this Frame is a part of.","name":"sourceIndex"},{"type":{"names":["number"]},"description":"The x coordinate of the top-left of this Frame.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of this Frame.","name":"y"},{"type":{"names":["number"]},"description":"The width of this Frame.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Frame.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"nullable":true,"description":"The Frame that was added to this Texture, or `null` if the given name already exists."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#add","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Removes the given Frame from this Texture. The Frame is destroyed immediately.\n\nAny Game Objects using this Frame should stop using it _before_ you remove it,\nas it does not happen automatically.","kind":"function","name":"remove","since":"3.19.0","params":[{"type":{"names":["string"]},"description":"The key of the Frame to remove.","name":"name"}],"returns":[{"type":{"names":["boolean"]},"description":"True if a Frame with the matching key was removed from this Texture."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#remove","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":209,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Checks to see if a Frame matching the given key exists within this Texture.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Frame to check for.","name":"name"}],"returns":[{"type":{"names":["boolean"]},"description":"True if a Frame with the matching key exists in this Texture."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#has","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":224,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Gets a Frame from this Texture based on either the key or the index of the Frame.\n\nIn a Texture Atlas Frames are typically referenced by a key.\nIn a Sprite Sheet Frames are referenced by an index.\nPassing no value for the name returns the base texture.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from this Texture.","name":"name"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The Texture Frame."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#get","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes the given TextureSource and returns the index of it within this Texture.\nIf it's not in this Texture, it returns -1.\nUnless this Texture has multiple TextureSources, such as with a multi-atlas, this\nmethod will always return zero or -1.","kind":"function","name":"getTextureSourceIndex","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.TextureSource"]},"description":"The TextureSource to check.","name":"source"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the TextureSource within this Texture, or -1 if not in this Texture."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#getTextureSourceIndex","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":284,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns an array of all the Frames in the given TextureSource.","kind":"function","name":"getFramesFromTextureSource","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the TextureSource to get the Frames from.","name":"sourceIndex"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Include the `__BASE` Frame in the output array?","name":"includeBase"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Texture Frames."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#getFramesFromTextureSource","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns an array with all of the names of the Frames in this Texture.\n\nUseful if you want to randomly assign a Frame to a Game Object, as you can\npick a random element from the returned array.","kind":"function","name":"getFrameNames","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Include the `__BASE` Frame in the output array?","name":"includeBase"}],"returns":[{"type":{"names":["Array."]},"description":"An array of all Frame names in this Texture."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#getFrameNames","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Given a Frame name, return the source image it uses to render with.\n\nThis will return the actual DOM Image or Canvas element.","kind":"function","name":"getSourceImage","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from this Texture.","name":"name"}],"returns":[{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Phaser.GameObjects.RenderTexture"]},"description":"The DOM Image, Canvas Element or Render Texture."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#getSourceImage","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Given a Frame name, return the data source image it uses to render with.\nYou can use this to get the normal map for an image for example.\n\nThis will return the actual DOM Image.","kind":"function","name":"getDataSourceImage","since":"3.7.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from this Texture.","name":"name"}],"returns":[{"type":{"names":["HTMLImageElement","HTMLCanvasElement"]},"description":"The DOM Image or Canvas Element."}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#getDataSourceImage","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":421,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a data source image to this Texture.\n\nAn example of a data source image would be a normal map, where all of the Frames for this Texture\nequally apply to the normal map.","kind":"function","name":"setDataSource","since":"3.0.0","params":[{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"description":"The source image.","name":"data"}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#setDataSource","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":447,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the Filter Mode for this Texture.\n\nThe mode can be either Linear, the default, or Nearest.\n\nFor pixel-art you should use Nearest.\n\nThe mode applies to the entire Texture, not just a specific Frame of it.","kind":"function","name":"setFilter","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.FilterMode"]},"description":"The Filter Mode.","name":"filterMode"}],"memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#setFilter","scope":"instance","___s":true},{"meta":{"filename":"Texture.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Destroys this Texture and releases references to its sources and frames.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Textures.Texture","longname":"Phaser.Textures.Texture#destroy","scope":"instance","___s":true},{"meta":{"range":[180,232],"filename":"TextureManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextureManager.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"kind":"typedef","name":"EachTextureCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"Each texture in Texture Manager.","name":"texture"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"longname":"EachTextureCallback","scope":"global","___s":true},{"meta":{"filename":"TextureManager.js","lineno":27,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"classdesc":"Textures are managed by the global TextureManager. This is a singleton class that is\nresponsible for creating and delivering Textures and their corresponding Frames to Game Objects.\n\nSprites and other Game Objects get the texture data they need from the TextureManager.\n\nAccess it via `scene.textures`.","kind":"class","name":"TextureManager","augments":["Phaser.Events.EventEmitter"],"memberof":"Phaser.Textures","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"The Phaser.Game instance this Texture Manager belongs to.","name":"game"}],"scope":"static","longname":"Phaser.Textures.TextureManager","___s":true},{"meta":{"filename":"TextureManager.js","lineno":54,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Game that this TextureManager belongs to.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureManager.js","lineno":63,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The name of this manager.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureManager.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An object that has all of textures that Texture Manager creates.\nTextures are assigned to keys so we can access to any texture that this object has directly by key value without iteration.","name":"list","type":{"names":["object"]},"defaultvalue":"{}","since":"3.0.0","memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#list","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureManager.js","lineno":157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Checks the given texture key and throws a console.warn if the key is already in use, then returns false.\nIf you wish to avoid the console.warn then use `TextureManager.exists` instead.","kind":"function","name":"checkKey","since":"3.7.0","params":[{"type":{"names":["string"]},"description":"The texture key to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if it's safe to use the texture key, otherwise `false`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#checkKey","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":181,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Removes a Texture from the Texture Manager and destroys it. This will immediately\nclear all references to it from the Texture Manager, and if it has one, destroy its\nWebGLTexture. This will emit a `removetexture` event.\n\nNote: If you have any Game Objects still using this texture they will start throwing\nerrors the next time they try to render. Make sure that removing the texture is the final\nstep when clearing down to avoid this.","kind":"function","name":"remove","fires":["Phaser.Textures.Events#event:REMOVE"],"since":"3.7.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the Texture to remove, or a reference to it.","name":"key"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"The Texture Manager."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#remove","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":224,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Removes a key from the Texture Manager but does not destroy the Texture that was using the key.","kind":"function","name":"removeKey","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The key to remove from the texture list.","name":"key"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"The Texture Manager."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#removeKey","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":244,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a new Texture to the Texture Manager created from the given Base64 encoded data.","kind":"function","name":"addBase64","fires":["Phaser.Textures.Events#event:ADD","Phaser.Textures.Events#event:ERROR","Phaser.Textures.Events#event:LOAD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["*"]},"description":"The Base64 encoded data.","name":"data"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"This Texture Manager instance."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addBase64","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":288,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Gets an existing texture frame and converts it into a base64 encoded image and returns the base64 data.\n\nYou can also provide the image type and encoder options.\n\nThis will only work with bitmap based texture frames, such as those created from Texture Atlases.\nIt will not work with GL Texture objects, such as Shaders, or Render Textures. For those please\nsee the WebGL Snapshot function instead.","kind":"function","name":"getBase64","since":"3.12.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from the Texture.","name":"frame"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'image/png'","description":"[description]","name":"type"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0.92,"description":"[description]","name":"encoderOptions"}],"returns":[{"type":{"names":["string"]},"description":"The base64 encoded data, or an empty string if the texture frame could not be found."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#getBase64","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":347,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a new Texture to the Texture Manager created from the given Image element.","kind":"function","name":"addImage","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement"]},"optional":true,"description":"An optional data Image element.","name":"dataSource"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addImage","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":381,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes a WebGL Texture and creates a Phaser Texture from it, which is added to the Texture Manager using the given key.\n\nThis allows you to then use the Texture as a normal texture for texture based Game Objects like Sprites.\n\nThis is a WebGL only feature.","kind":"function","name":"addGLTexture","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.19.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["WebGLTexture"]},"description":"The source Render Texture.","name":"glTexture"},{"type":{"names":["number"]},"description":"The new width of the Texture.","name":"width"},{"type":{"names":["number"]},"description":"The new height of the Texture.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addGLTexture","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":415,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Render Texture to the Texture Manager using the given key.\nThis allows you to then use the Render Texture as a normal texture for texture based Game Objects like Sprites.","kind":"function","name":"addRenderTexture","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.12.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"The source Render Texture.","name":"renderTexture"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addRenderTexture","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":444,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Creates a new Texture using the given config values.\nGenerated textures consist of a Canvas element to which the texture data is drawn.\nSee the Phaser.Create function for the more direct way to create textures.","kind":"function","name":"generate","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["object"]},"description":"The configuration object needed to generate the texture.","name":"config"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#generate","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":475,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Creates a new Texture using a blank Canvas element of the size given.\n\nCanvas elements are automatically pooled and calling this method will\nextract a free canvas from the CanvasPool, or create one if none are available.","kind":"function","name":"createCanvas","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":256,"description":"The width of the Canvas element.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":256,"description":"The height of the Canvas element.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"nullable":true,"description":"The Canvas Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#createCanvas","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Creates a new Canvas Texture object from an existing Canvas element\nand adds it to this Texture Manager, unless `skipCache` is true.","kind":"function","name":"addCanvas","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLCanvasElement"]},"description":"The Canvas element to form the base of the new Texture.","name":"source"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Skip adding this Texture into the Cache?","name":"skipCache"}],"returns":[{"type":{"names":["Phaser.Textures.CanvasTexture"]},"nullable":true,"description":"The Canvas Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addCanvas","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a new Texture Atlas to this Texture Manager.\nIt can accept either JSON Array or JSON Hash formats, as exported by Texture Packer and similar software.","kind":"function","name":"addAtlas","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["object"]},"description":"The Texture Atlas data.","name":"data"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"optional":true,"description":"An optional data Image element.","name":"dataSource"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addAtlas","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Texture Atlas to this Texture Manager.\nThe frame data of the atlas must be stored in an Array within the JSON.\nThis is known as a JSON Array in software such as Texture Packer.","kind":"function","name":"addAtlasJSONArray","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement","Array."]},"description":"The source Image element/s.","name":"source"},{"type":{"names":["object","Array."]},"description":"The Texture Atlas data/s.","name":"data"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"optional":true,"description":"An optional data Image element.","name":"dataSource"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addAtlasJSONArray","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":621,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Texture Atlas to this Texture Manager.\nThe frame data of the atlas must be stored in an Object within the JSON.\nThis is known as a JSON Hash in software such as Texture Packer.","kind":"function","name":"addAtlasJSONHash","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["object"]},"description":"The Texture Atlas data.","name":"data"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"optional":true,"description":"An optional data Image element.","name":"dataSource"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addAtlasJSONHash","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":668,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Texture Atlas to this Texture Manager, where the atlas data is given\nin the XML format.","kind":"function","name":"addAtlasXML","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.7.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["object"]},"description":"The Texture Atlas XML data.","name":"data"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"optional":true,"description":"An optional data Image element.","name":"dataSource"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addAtlasXML","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":704,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Unity Texture Atlas to this Texture Manager.\nThe data must be in the form of a Unity YAML file.","kind":"function","name":"addUnityAtlas","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["object"]},"description":"The Texture Atlas data.","name":"data"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"optional":true,"description":"An optional data Image element.","name":"dataSource"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addUnityAtlas","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":740,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Sprite Sheet to this Texture Manager.\n\nIn Phaser terminology a Sprite Sheet is a texture containing different frames, but each frame is the exact\nsame size and cannot be trimmed or rotated.","kind":"function","name":"addSpriteSheet","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["Phaser.Types.Textures.SpriteSheetConfig"]},"description":"The configuration object for this Sprite Sheet.","name":"config"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addSpriteSheet","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":775,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a Sprite Sheet to this Texture Manager, where the Sprite Sheet exists as a Frame within a Texture Atlas.\n\nIn Phaser terminology a Sprite Sheet is a texture containing different frames, but each frame is the exact\nsame size and cannot be trimmed or rotated.","kind":"function","name":"addSpriteSheetFromAtlas","fires":["Phaser.Textures.Events#event:ADD"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["Phaser.Types.Textures.SpriteSheetFromAtlasConfig"]},"description":"The configuration object for this Sprite Sheet.","name":"config"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addSpriteSheetFromAtlas","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":828,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Creates a new Texture using the given source and dimensions.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["HTMLImageElement"]},"description":"The source Image element.","name":"source"},{"type":{"names":["integer"]},"description":"The width of the Texture.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the Texture.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"description":"The Texture that was created, or `null` if the key is already in use."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#create","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":855,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Checks the given key to see if a Texture using it exists within this Texture Manager.","kind":"function","name":"exists","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if a Texture matching the given key exists in this Texture Manager."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#exists","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":870,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns a Texture from the Texture Manager that matches the given key.\n\nIf the key is `undefined` it will return the `__DEFAULT` Texture.\n\nIf the key is an instance of a Texture, it will return the key directly.\n\nFinally. if the key is given, but not found and not a Texture instance, it will return the `__MISSING` Texture.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The unique string-based key of the Texture, or a Texture instance.","name":"key"}],"returns":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"The Texture that was created."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#get","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":904,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes a Texture key and Frame name and returns a clone of that Frame if found.","kind":"function","name":"cloneFrame","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"description":"The string or index of the Frame to be cloned.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"A Clone of the given Frame."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#cloneFrame","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":923,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes a Texture key and Frame name and returns a reference to that Frame, if found.","kind":"function","name":"getFrame","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"A Texture Frame object."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#getFrame","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":942,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns an array with all of the keys of all Textures in this Texture Manager.\nThe output array will exclude the `__DEFAULT` and `__MISSING` keys.","kind":"function","name":"getTextureKeys","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"An array containing all of the Texture keys stored in this Texture Manager."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#getTextureKeys","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":966,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Given a Texture and an `x` and `y` coordinate this method will return a new\nColor object that has been populated with the color and alpha values of the pixel\nat that location in the Texture.","kind":"function","name":"getPixel","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel within the Texture.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel within the Texture.","name":"y"},{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The string or index of the Frame.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Display.Color"]},"nullable":true,"description":"A Color object populated with the color values of the requested pixel,\nor `null` if the coordinates were out of bounds."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#getPixel","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":1013,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Given a Texture and an `x` and `y` coordinate this method will return a value between 0 and 255\ncorresponding to the alpha value of the pixel at that location in the Texture. If the coordinate\nis out of bounds it will return null.","kind":"function","name":"getPixelAlpha","since":"3.10.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the pixel within the Texture.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of the pixel within the Texture.","name":"y"},{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The string or index of the Frame.","name":"frame"}],"returns":[{"type":{"names":["integer"]},"description":"A value between 0 and 255, or `null` if the coordinates were out of bounds."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#getPixelAlpha","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":1059,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the given Game Objects `texture` and `frame` properties so that it uses\nthe Texture and Frame specified in the `key` and `frame` arguments to this method.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the texture would be set on.","name":"gameObject"},{"type":{"names":["string"]},"description":"The unique string-based key of the Texture.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The string or index of the Frame.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object the texture was set on."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#setTexture","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":1083,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Changes the key being used by a Texture to the new key provided.\n\nThe old key is removed, allowing it to be re-used.\n\nGame Objects are linked to Textures by a reference to the Texture object, so\nall existing references will be retained.","kind":"function","name":"renameTexture","since":"3.12.0","params":[{"type":{"names":["string"]},"description":"The current string-based key of the Texture you wish to rename.","name":"currentKey"},{"type":{"names":["string"]},"description":"The new unique string-based key to use for the Texture.","name":"newKey"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the Texture key was successfully renamed, otherwise `false`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#renameTexture","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":1117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Passes all Textures to the given callback.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["EachTextureCallback"]},"description":"The callback function to be sent the Textures.","name":"callback"},{"type":{"names":["object"]},"description":"The value to use as `this` when executing the callback.","name":"scope"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#each","scope":"instance","___s":true},{"meta":{"filename":"TextureManager.js","lineno":1144,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Destroys the Texture Manager and all Textures stored within it.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"range":[180,232],"filename":"TextureSource.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"name":"CanvasPool","longname":"CanvasPool","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TextureSource.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"classdesc":"A Texture Source is the encapsulation of the actual source data for a Texture.\n\nThis is typically an Image Element, loaded from the file system or network, a Canvas Element or a Video Element.\n\nA Texture can contain multiple Texture Sources, which only happens when a multi-atlas is loaded.","kind":"class","name":"TextureSource","memberof":"Phaser.Textures","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"The Texture this TextureSource belongs to.","name":"texture"},{"type":{"names":["HTMLImageElement","HTMLCanvasElement","HTMLVideoElement","Phaser.GameObjects.RenderTexture","WebGLTexture"]},"description":"The source image data.","name":"source"},{"type":{"names":["integer"]},"optional":true,"description":"Optional width of the source image. If not given it's derived from the source itself.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"Optional height of the source image. If not given it's derived from the source itself.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Sets the `UNPACK_FLIP_Y_WEBGL` flag the WebGL Texture uses during upload.","name":"flipY"}],"scope":"static","longname":"Phaser.Textures.TextureSource","___s":true},{"meta":{"filename":"TextureSource.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Texture this TextureSource belongs to.","name":"renderer","type":{"names":["Phaser.Renderer.Canvas.CanvasRenderer","Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.7.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#renderer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Texture this TextureSource belongs to.","name":"texture","type":{"names":["Phaser.Textures.Texture"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#texture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The source of the image data.\n\nThis is either an Image Element, a Canvas Element, a Video Element, a RenderTexture or a WebGLTexture.","name":"source","type":{"names":["HTMLImageElement","HTMLCanvasElement","HTMLVideoElement","Phaser.GameObjects.RenderTexture","WebGLTexture"]},"since":"3.12.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#source","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The image data.\n\nThis is either an Image element, Canvas element or a Video Element.","name":"image","type":{"names":["HTMLImageElement","HTMLCanvasElement","HTMLVideoElement"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#image","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Currently un-used.","name":"compressionAlgorithm","type":{"names":["integer"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#compressionAlgorithm","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The resolution of the source image.","name":"resolution","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#resolution","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The width of the source image. If not specified in the constructor it will check\nthe `naturalWidth` and then `width` properties of the source image.","name":"width","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The height of the source image. If not specified in the constructor it will check\nthe `naturalHeight` and then `height` properties of the source image.","name":"height","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The Scale Mode the image will use when rendering.\nEither Linear or Nearest.","name":"scaleMode","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#scaleMode","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Is the source image a Canvas Element?","name":"isCanvas","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#isCanvas","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":140,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Is the source image a Video Element?","name":"isVideo","type":{"names":["boolean"]},"since":"3.20.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#isVideo","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":149,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Is the source image a Render Texture?","name":"isRenderTexture","type":{"names":["boolean"]},"since":"3.12.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#isRenderTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Is the source image a WebGLTexture?","name":"isGLTexture","type":{"names":["boolean"]},"since":"3.19.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#isGLTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Are the source image dimensions a power of two?","name":"isPowerOf2","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#isPowerOf2","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":176,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The WebGL Texture of the source image. If this TextureSource is driven from a WebGLTexture\nalready, then this is a reference to that WebGLTexture.","name":"glTexture","type":{"names":["WebGLTexture"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#glTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the `UNPACK_FLIP_Y_WEBGL` flag the WebGL Texture uses during upload.","name":"flipY","type":{"names":["boolean"]},"since":"3.20.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#flipY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TextureSource.js","lineno":199,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Creates a WebGL Texture, if required, and sets the Texture filter mode.","kind":"function","name":"init","since":"3.0.0","params":[{"type":{"names":["Phaser.Game"]},"description":"A reference to the Phaser Game instance.","name":"game"}],"memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#init","scope":"instance","___s":true},{"meta":{"filename":"TextureSource.js","lineno":248,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the Filter Mode for this Texture.\n\nThe mode can be either Linear, the default, or Nearest.\n\nFor pixel-art you should use Nearest.","kind":"function","name":"setFilter","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.FilterMode"]},"description":"The Filter Mode.","name":"filterMode"}],"memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#setFilter","scope":"instance","___s":true},{"meta":{"filename":"TextureSource.js","lineno":270,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the `UNPACK_FLIP_Y_WEBGL` flag for the WebGL Texture during texture upload.","kind":"function","name":"setFlipY","since":"3.20.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the WebGL Texture be flipped on the Y axis on texture upload or not?","name":"value"}],"memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#setFlipY","scope":"instance","___s":true},{"meta":{"filename":"TextureSource.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"If this TextureSource is backed by a Canvas and is running under WebGL,\nit updates the WebGLTexture using the canvas data.","kind":"function","name":"update","since":"3.7.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#update","scope":"instance","___s":true},{"meta":{"filename":"TextureSource.js","lineno":308,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Destroys this Texture Source and nulls the references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Textures.TextureSource","longname":"Phaser.Textures.TextureSource#destroy","scope":"instance","___s":true},{"meta":{"filename":"const.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Filter Types.","kind":"namespace","name":"FilterMode","memberof":"Phaser.Textures","since":"3.0.0","longname":"Phaser.Textures.FilterMode","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Linear filter type.","name":"LINEAR","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Textures.FilterMode","longname":"Phaser.Textures.FilterMode.LINEAR","scope":"static","___s":true},{"meta":{"filename":"const.js","lineno":26,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Nearest neighbor filter type.","name":"NEAREST","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Textures.FilterMode","longname":"Phaser.Textures.FilterMode.NEAREST","scope":"static","___s":true},{"meta":{"filename":"ADD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/events"},"description":"The Texture Add Event.\n\nThis event is dispatched by the Texture Manager when a texture is added to it.\n\nListen to this event from within a Scene using: `this.textures.on('addtexture', listener)`.","kind":"event","name":"ADD","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture that was added to the Texture Manager.","name":"key"},{"type":{"names":["Phaser.Textures.Texture"]},"description":"A reference to the Texture that was added to the Texture Manager.","name":"texture"}],"memberof":"Phaser.Textures.Events","longname":"Phaser.Textures.Events#event:ADD","scope":"instance","___s":true},{"meta":{"filename":"ERROR_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/events"},"description":"The Texture Load Error Event.\n\nThis event is dispatched by the Texture Manager when a texture it requested to load failed.\nThis only happens when base64 encoded textures fail. All other texture types are loaded via the Loader Plugin.\n\nListen to this event from within a Scene using: `this.textures.on('onerror', listener)`.","kind":"event","name":"ERROR","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture that failed to load into the Texture Manager.","name":"key"}],"memberof":"Phaser.Textures.Events","longname":"Phaser.Textures.Events#event:ERROR","scope":"instance","___s":true},{"meta":{"filename":"LOAD_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/events"},"description":"The Texture Load Event.\n\nThis event is dispatched by the Texture Manager when a texture has finished loading on it.\nThis only happens for base64 encoded textures. All other texture types are loaded via the Loader Plugin.\n\nListen to this event from within a Scene using: `this.textures.on('onload', listener)`.\n\nThis event is dispatched after the [ADD]{@linkcode Phaser.Textures.Events#event:ADD} event.","kind":"event","name":"LOAD","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture that was loaded by the Texture Manager.","name":"key"},{"type":{"names":["Phaser.Textures.Texture"]},"description":"A reference to the Texture that was loaded by the Texture Manager.","name":"texture"}],"memberof":"Phaser.Textures.Events","longname":"Phaser.Textures.Events#event:LOAD","scope":"instance","___s":true},{"meta":{"filename":"READY_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/events"},"description":"This internal event signifies that the Texture Manager is now ready and the Game can continue booting.\n\nWhen a Phaser Game instance is booting for the first time, the Texture Manager has to wait on a couple of non-blocking\nasync events before it's fully ready to carry on. When those complete the Texture Manager emits this event via the Game\ninstance, which tells the Game to carry on booting.","kind":"event","name":"READY","since":"3.16.1","memberof":"Phaser.Textures.Events","longname":"Phaser.Textures.Events#event:READY","scope":"instance","___s":true},{"meta":{"filename":"REMOVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/events"},"description":"The Texture Remove Event.\n\nThis event is dispatched by the Texture Manager when a texture is removed from it.\n\nListen to this event from within a Scene using: `this.textures.on('removetexture', listener)`.\n\nIf you have any Game Objects still using the removed texture, they will start throwing\nerrors the next time they try to render. Be sure to clear all use of the texture in this event handler.","kind":"event","name":"REMOVE","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Texture that was removed from the Texture Manager.","name":"key"}],"memberof":"Phaser.Textures.Events","longname":"Phaser.Textures.Events#event:REMOVE","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Textures","longname":"Phaser.Textures.Events","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"name":"Extend","longname":"Extend","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"kind":"namespace","name":"Textures","memberof":"Phaser","longname":"Phaser.Textures","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Linear filter type.","name":"LINEAR","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Textures","longname":"Phaser.Textures.LINEAR","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":23,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Nearest Neighbor filter type.","name":"NEAREST","type":{"names":["integer"]},"kind":"constant","since":"3.0.0","memberof":"Phaser.Textures","longname":"Phaser.Textures.NEAREST","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"JSONArray.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures/parsers"},"name":"Clone","longname":"Clone","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,223],"filename":"JSONHash.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures/parsers"},"name":"Clone","longname":"Clone","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,237],"filename":"SpriteSheet.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures/parsers"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,237],"filename":"SpriteSheetFromAtlas.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures/parsers"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,195],"filename":"UnityYAML.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures/parsers"},"name":"imageHeight","longname":"imageHeight","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/parsers"},"kind":"namespace","name":"Parsers","memberof":"Phaser.Textures","longname":"Phaser.Textures.Parsers","scope":"static","___s":true},{"meta":{"filename":"PixelConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/typedefs"},"description":"An object containing the position and color data for a single pixel in a CanvasTexture.","kind":"typedef","name":"PixelConfig","type":{"names":["object"]},"since":"3.16.0","properties":[{"type":{"names":["integer"]},"description":"The x-coordinate of the pixel.","name":"x"},{"type":{"names":["integer"]},"description":"The y-coordinate of the pixel.","name":"y"},{"type":{"names":["integer"]},"description":"The color of the pixel, not including the alpha channel.","name":"color"},{"type":{"names":["number"]},"description":"The alpha of the pixel, between 0 and 1.","name":"alpha"}],"memberof":"Phaser.Types.Textures","longname":"Phaser.Types.Textures.PixelConfig","scope":"static","___s":true},{"meta":{"filename":"SpriteSheetConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/typedefs"},"kind":"typedef","name":"SpriteSheetConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["integer"]},"description":"The fixed width of each frame.","name":"frameWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The fixed height of each frame. If not set it will use the frameWidth as the height.","name":"frameHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Skip a number of frames. Useful when there are multiple sprite sheets in one Texture.","name":"startFrame"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":-1,"description":"The total number of frames to extract from the Sprite Sheet. The default value of -1 means \"extract all frames\".","name":"endFrame"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If the frames have been drawn with a margin, specify the amount here.","name":"margin"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If the frames have been drawn with spacing between them, specify the amount here.","name":"spacing"}],"memberof":"Phaser.Types.Textures","longname":"Phaser.Types.Textures.SpriteSheetConfig","scope":"static","___s":true},{"meta":{"filename":"SpriteSheetFromAtlasConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/typedefs"},"kind":"typedef","name":"SpriteSheetFromAtlasConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"description":"The key of the Texture Atlas in which this Sprite Sheet can be found.","name":"atlas"},{"type":{"names":["string"]},"description":"The key of the Texture Atlas Frame in which this Sprite Sheet can be found.","name":"frame"},{"type":{"names":["integer"]},"description":"The fixed width of each frame.","name":"frameWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The fixed height of each frame. If not set it will use the frameWidth as the height.","name":"frameHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Skip a number of frames. Useful when there are multiple sprite sheets in one Texture.","name":"startFrame"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":-1,"description":"The total number of frames to extract from the Sprite Sheet. The default value of -1 means \"extract all frames\".","name":"endFrame"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If the frames have been drawn with a margin, specify the amount here.","name":"margin"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If the frames have been drawn with spacing between them, specify the amount here.","name":"spacing"}],"memberof":"Phaser.Types.Textures","longname":"Phaser.Types.Textures.SpriteSheetFromAtlasConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/textures/typedefs"},"kind":"namespace","name":"Textures","memberof":"Phaser.Types","longname":"Phaser.Types.Textures","scope":"static","___s":true},{"meta":{"filename":"Formats.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"kind":"namespace","name":"Formats","memberof":"Phaser.Tilemaps","longname":"Phaser.Tilemaps.Formats","scope":"static","___s":true},{"meta":{"filename":"Formats.js","lineno":13,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"CSV Map Type","name":"CSV","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Formats","longname":"Phaser.Tilemaps.Formats.CSV","scope":"static","kind":"member","___s":true},{"meta":{"filename":"Formats.js","lineno":22,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Tiled JSON Map Type","name":"TILED_JSON","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Formats","longname":"Phaser.Tilemaps.Formats.TILED_JSON","scope":"static","kind":"member","___s":true},{"meta":{"filename":"Formats.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"2D Array Map Type","name":"ARRAY_2D","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Formats","longname":"Phaser.Tilemaps.Formats.ARRAY_2D","scope":"static","kind":"member","___s":true},{"meta":{"filename":"Formats.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Weltmeister (Impact.js) Map Type","name":"WELTMEISTER","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Formats","longname":"Phaser.Tilemaps.Formats.WELTMEISTER","scope":"static","kind":"member","___s":true},{"meta":{"range":[180,213],"filename":"ImageCollection.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ImageCollection.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"classdesc":"An Image Collection is a special Tile Set containing multiple images, with no slicing into each image.\n\nImage Collections are normally created automatically when Tiled data is loaded.","kind":"class","name":"ImageCollection","memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the image collection in the map data.","name":"name"},{"type":{"names":["integer"]},"description":"The first image index this image collection contains.","name":"firstgid"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"Width of widest image (in pixels).","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"Height of tallest image (in pixels).","name":"height"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The margin around all images in the collection (in pixels).","name":"margin"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The spacing between each image in the collection (in pixels).","name":"spacing"},{"type":{"names":["object"]},"optional":true,"defaultvalue":"{}","description":"Custom Image Collection properties.","name":"properties"}],"scope":"static","longname":"Phaser.Tilemaps.ImageCollection","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The name of the Image Collection.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The Tiled firstgid value.\nThis is the starting index of the first image index this Image Collection contains.","name":"firstgid","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#firstgid","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The width of the widest image (in pixels).","name":"imageWidth","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#imageWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The height of the tallest image (in pixels).","name":"imageHeight","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#imageHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The margin around the images in the collection (in pixels).\nUse `setSpacing` to change.","name":"imageMarge","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#imageMarge","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The spacing between each image in the collection (in pixels).\nUse `setSpacing` to change.","name":"imageSpacing","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#imageSpacing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":100,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Image Collection-specific properties that are typically defined in the Tiled editor.","name":"properties","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#properties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":109,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The cached images that are a part of this collection.","name":"images","type":{"names":["array"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#images","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The total number of images in the image collection.","name":"total","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#total","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":130,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Returns true if and only if this image collection contains the given image index.","kind":"function","name":"containsImageIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The image index to search for.","name":"imageIndex"}],"returns":[{"type":{"names":["boolean"]},"description":"True if this Image Collection contains the given index."}],"memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#containsImageIndex","scope":"instance","___s":true},{"meta":{"filename":"ImageCollection.js","lineno":145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Add an image to this Image Collection.","kind":"function","name":"addImage","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The gid of the image in the Image Collection.","name":"gid"},{"type":{"names":["string"]},"description":"The the key of the image in the Image Collection and in the cache.","name":"image"}],"returns":[{"type":{"names":["Phaser.Tilemaps.ImageCollection"]},"description":"This ImageCollection object."}],"memberof":"Phaser.Tilemaps.ImageCollection","longname":"Phaser.Tilemaps.ImageCollection#addImage","scope":"instance","___s":true},{"meta":{"range":[180,210],"filename":"ParseToTilemap.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"Formats","longname":"Formats","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseToTilemap.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Create a Tilemap from the given key or data. If neither is given, make a blank Tilemap. When\nloading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing from\na map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map data. For\nan empty map, you should specify tileWidth, tileHeight, width & height.","kind":"function","name":"ParseToTilemap","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Tilemap belongs.","name":"scene"},{"type":{"names":["string"]},"optional":true,"description":"The key in the Phaser cache that corresponds to the loaded tilemap data.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The width of a tile in pixels.","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The height of a tile in pixels.","name":"tileHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The width of the map in tiles.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The height of the map in tiles.","name":"height"},{"type":{"names":["Array.>"]},"optional":true,"description":"Instead of loading from the cache, you can also load directly from\na 2D array of tile indexes.","name":"data"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Controls how empty tiles, tiles with an index of -1, in the\nmap data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]}}],"memberof":"Phaser.Tilemaps","longname":"Phaser.Tilemaps.ParseToTilemap","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Tile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Tile.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"classdesc":"A Tile is a representation of a single tile within the Tilemap. This is a lightweight data\nrepresentation, so its position information is stored without factoring in scroll, layer\nscale or layer position.","kind":"class","name":"Tile","memberof":"Phaser.Tilemaps","since":"3.0.0","augments":["Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.Visible"],"params":[{"type":{"names":["Phaser.Tilemaps.LayerData"]},"description":"The LayerData object in the Tilemap that this tile belongs to.","name":"layer"},{"type":{"names":["integer"]},"description":"The unique index of this tile within the map.","name":"index"},{"type":{"names":["integer"]},"description":"The x coordinate of this tile in tile coordinates.","name":"x"},{"type":{"names":["integer"]},"description":"The y coordinate of this tile in tile coordinates.","name":"y"},{"type":{"names":["integer"]},"description":"Width of the tile in pixels.","name":"width"},{"type":{"names":["integer"]},"description":"Height of the tile in pixels.","name":"height"},{"type":{"names":["integer"]},"description":"The base width a tile in the map (in pixels). Tiled maps support\nmultiple tileset sizes within one map, but they are still placed at intervals of the base\ntile width.","name":"baseWidth"},{"type":{"names":["integer"]},"description":"The base height of the tile in pixels (in pixels). Tiled maps\nsupport multiple tileset sizes within one map, but they are still placed at intervals of the\nbase tile height.","name":"baseHeight"}],"scope":"static","longname":"Phaser.Tilemaps.Tile","___s":true},{"meta":{"filename":"Tile.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The LayerData in the Tilemap data that this tile belongs to.","name":"layer","type":{"names":["Phaser.Tilemaps.LayerData"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#layer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The index of this tile within the map data corresponding to the tileset, or -1 if this\nrepresents a blank tile.","name":"index","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#index","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The x map coordinate of this tile in tile units.","name":"x","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The y map coordinate of this tile in tile units.","name":"y","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The width of the tile in pixels.","name":"width","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The height of the tile in pixels.","name":"height","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The map's base width of a tile in pixels. Tiled maps support multiple tileset sizes\nwithin one map, but they are still placed at intervals of the base tile size.","name":"baseWidth","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#baseWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The map's base height of a tile in pixels. Tiled maps support multiple tileset sizes\nwithin one map, but they are still placed at intervals of the base tile size.","name":"baseHeight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#baseHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The x coordinate of the top left of this tile in pixels. This is relative to the top left\nof the layer this tile is being rendered within. This property does NOT factor in camera\nscroll, layer scale or layer position.","name":"pixelX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#pixelX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The y coordinate of the top left of this tile in pixels. This is relative to the top left\nof the layer this tile is being rendered within. This property does NOT factor in camera\nscroll, layer scale or layer position.","name":"pixelY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#pixelY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":150,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Tile specific properties. These usually come from Tiled.","name":"properties","type":{"names":["any"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#properties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The rotation angle of this tile.","name":"rotation","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#rotation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile should collide with any object on the left side.","name":"collideLeft","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collideLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile should collide with any object on the right side.","name":"collideRight","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collideRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":186,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile should collide with any object on the top side.","name":"collideUp","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collideUp","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":195,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile should collide with any object on the bottom side.","name":"collideDown","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collideDown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":204,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile's left edge is interesting for collisions.","name":"faceLeft","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#faceLeft","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":213,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile's right edge is interesting for collisions.","name":"faceRight","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#faceRight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":222,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile's top edge is interesting for collisions.","name":"faceTop","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#faceTop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":231,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Whether the tile's bottom edge is interesting for collisions.","name":"faceBottom","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#faceBottom","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":240,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Tile collision callback.","name":"collisionCallback","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collisionCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":249,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The context in which the collision callback will be called.","name":"collisionCallbackContext","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collisionCallbackContext","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":258,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The tint to apply to this tile. Note: tint is currently a single color value instead of\nthe 4 corner tint component on other GameObjects.","name":"tint","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#tint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":269,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"An empty object where physics-engine specific information (e.g. bodies) may be stored.","name":"physics","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#physics","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":279,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Check if the given x and y world coordinates are within this Tile. This does not factor in\ncamera scroll, layer scale or layer position.","kind":"function","name":"containsPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to test.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to test.","name":"y"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the coordinates are within this Tile, otherwise false."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#containsPoint","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":296,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Copies the tile data & properties from the given tile to this tile. This copies everything\nexcept for position and interesting faces.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile to copy from.","name":"tile"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#copy","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":326,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The collision group for this Tile, defined within the Tileset. This returns a reference to\nthe collision group stored within the Tileset, so any modification of the returned object\nwill impact all tiles that have the same index as this tile.","kind":"function","name":"getCollisionGroup","since":"3.0.0","returns":[{"type":{"names":["object"]},"nullable":true,"description":"tileset"}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":341,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The tile data for this Tile, defined within the Tileset. This typically contains Tiled\ncollision data, tile animations and terrain information. This returns a reference to the tile\ndata stored within the Tileset, so any modification of the returned object will impact all\ntiles that have the same index as this tile.","kind":"function","name":"getTileData","since":"3.0.0","returns":[{"type":{"names":["object"]},"nullable":true,"description":"tileset"}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getTileData","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":357,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world X position of the left side of the tile, factoring in the layers position,\nscale and scroll.","kind":"function","name":"getLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getLeft","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":375,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world X position of the right side of the tile, factoring in the layer's position,\nscale and scroll.","kind":"function","name":"getRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getRight","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":393,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world Y position of the top side of the tile, factoring in the layer's position,\nscale and scroll.","kind":"function","name":"getTop","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getTop","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":416,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world Y position of the bottom side of the tile, factoring in the layer's position,\nscale and scroll.","kind":"function","name":"getBottom","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getBottom","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":436,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world rectangle bounding box for the tile, factoring in the layers position,\nscale and scroll.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"},{"type":{"names":["object"]},"optional":true,"description":"[description]","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getBounds","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world X position of the center of the tile, factoring in the layer's position,\nscale and scroll.","kind":"function","name":"getCenterX","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getCenterX","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the world Y position of the center of the tile, factoring in the layer's position,\nscale and scroll.","kind":"function","name":"getCenterY","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to use to perform the check.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#getCenterY","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":492,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Clean up memory.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#destroy","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Check for intersection with this tile. This does not factor in camera scroll, layer scale or\nlayer position.","kind":"function","name":"intersects","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x axis in pixels.","name":"x"},{"type":{"names":["number"]},"description":"The y axis in pixels.","name":"y"},{"type":{"names":["number"]},"description":"The right point.","name":"right"},{"type":{"names":["number"]},"description":"The bottom point.","name":"bottom"}],"returns":[{"type":{"names":["boolean"]}}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#intersects","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":527,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Checks if the tile is interesting.","kind":"function","name":"isInteresting","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"If true, will consider the tile interesting if it collides on any side.","name":"collides"},{"type":{"names":["boolean"]},"description":"If true, will consider the tile interesting if it has an interesting face.","name":"faces"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Tile is interesting, otherwise false."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#isInteresting","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":546,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Reset collision status flags.","kind":"function","name":"resetCollision","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate interesting faces for this tile and its neighbors.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#resetCollision","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":583,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Reset faces.","kind":"function","name":"resetFaces","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#resetFaces","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":601,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the collision flags for each side of this tile and updates the interesting faces list.","kind":"function","name":"setCollision","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Indicating collide with any object on the left.","name":"left"},{"type":{"names":["boolean"]},"optional":true,"description":"Indicating collide with any object on the right.","name":"right"},{"type":{"names":["boolean"]},"optional":true,"description":"Indicating collide with any object on the top.","name":"up"},{"type":{"names":["boolean"]},"optional":true,"description":"Indicating collide with any object on the bottom.","name":"down"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate interesting faces\nfor this tile and its neighbors.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setCollision","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":646,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Set a callback to be called when this tile is hit by an object. The callback must true for\ncollision processing to take place.","kind":"function","name":"setCollisionCallback","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"Callback function.","name":"callback"},{"type":{"names":["object"]},"description":"Callback will be called within this context.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setCollisionCallback","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":674,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the size of the tile and updates its pixelX and pixelY.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The width of the tile in pixels.","name":"tileWidth"},{"type":{"names":["integer"]},"description":"The height of the tile in pixels.","name":"tileHeight"},{"type":{"names":["integer"]},"description":"The base width a tile in the map (in pixels).","name":"baseWidth"},{"type":{"names":["integer"]},"description":"The base height of the tile in pixels (in pixels).","name":"baseHeight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setSize","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":699,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Used internally. Updates the tile's world XY position based on the current tile size.","kind":"function","name":"updatePixelXY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Tile object."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#updatePixelXY","scope":"instance","___s":true},{"meta":{"filename":"Tile.js","lineno":720,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"True if this tile can collide on any of its faces or has a collision callback set.","name":"canCollide","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#canCollide","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":735,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"True if this tile can collide on any of its faces.","name":"collides","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#collides","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":750,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"True if this tile has any interesting faces.","name":"hasInterestingFace","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#hasInterestingFace","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":765,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The tileset that contains this Tile. This is null if accessed from a LayerData instance\nbefore the tile is placed in a StaticTilemapLayer or DynamicTilemapLayer, or if the tile has\nan index that doesn't correspond to any of the map's tilesets.","name":"tileset","type":{"names":["Phaser.Tilemaps.Tileset"]},"nullable":true,"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#tileset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":796,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The tilemap layer that contains this Tile. This will only return null if accessed from a\nLayerData instance before the tile is placed within a StaticTilemapLayer or\nDynamicTilemapLayer.","name":"tilemapLayer","type":{"names":["Phaser.Tilemaps.StaticTilemapLayer","Phaser.Tilemaps.DynamicTilemapLayer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#tilemapLayer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tile.js","lineno":813,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The tilemap that contains this Tile. This will only return null if accessed from a LayerData\ninstance before the tile is placed within a StaticTilemapLayer or DynamicTilemapLayer.","name":"tilemap","type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#tilemap","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,213],"filename":"Tilemap.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Tilemap.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"kind":"typedef","name":"TilemapFilterCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"An object found in the filtered area.","name":"value"},{"type":{"names":["number"]},"description":"The index of the object within the array.","name":"index"},{"type":{"names":["Array."]},"description":"An array of all the objects found.","name":"array"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The object."}],"longname":"TilemapFilterCallback","scope":"global","___s":true},{"meta":{"filename":"Tilemap.js","lineno":30,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"kind":"typedef","name":"TilemapFindCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"An object found.","name":"value"},{"type":{"names":["number"]},"description":"The index of the object within the array.","name":"index"},{"type":{"names":["Array."]},"description":"An array of all the objects found.","name":"array"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the callback should be invoked, otherwise `false`."}],"longname":"TilemapFindCallback","scope":"global","___s":true},{"meta":{"filename":"Tilemap.js","lineno":40,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"classdesc":"A Tilemap is a container for Tilemap data. This isn't a display object, rather, it holds data\nabout the map and allows you to add tilesets and tilemap layers to it. A map can have one or\nmore tilemap layers (StaticTilemapLayer or DynamicTilemapLayer), which are the display\nobjects that actually render tiles.\n\nThe Tilemap data be parsed from a Tiled JSON file, a CSV file or a 2D array. Tiled is a free\nsoftware package specifically for creating tile maps, and is available from:\nhttp://www.mapeditor.org\n\nA Tilemap has handy methods for getting & manipulating the tiles within a layer. You can only\nuse the methods that change tiles (e.g. removeTileAt) on a DynamicTilemapLayer.\n\nNote that all Tilemaps use a base tile size to calculate dimensions from, but that a\nStaticTilemapLayer or DynamicTilemapLayer may have its own unique tile size that overrides\nit.\n\nAs of Phaser 3.21.0, if your tilemap includes layer groups (a feature of Tiled 1.2.0+) these\nwill be traversed and the following properties will affect children:\n- opacity (blended with parent) and visibility (parent overrides child)\n- Vertical and horizontal offset\nThe grouping hierarchy is not preserved and all layers will be flattened into a single array.\nGroup layers are parsed during Tilemap construction but are discarded after parsing so dynamic\nlayers will NOT continue to be affected by a parent.\n\nTo avoid duplicate layer names, a layer that is a child of a group layer will have its parent\ngroup name prepended with a '/'. For example, consider a group called 'ParentGroup' with a\nchild called 'Layer 1'. In the Tilemap object, 'Layer 1' will have the name\n'ParentGroup/Layer 1'.","kind":"class","name":"Tilemap","memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Tilemap belongs.","name":"scene"},{"type":{"names":["Phaser.Tilemaps.MapData"]},"description":"A MapData instance containing Tilemap data.","name":"mapData"}],"scope":"static","longname":"Phaser.Tilemaps.Tilemap","___s":true},{"meta":{"filename":"Tilemap.js","lineno":85,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The base width of a tile in pixels. Note that individual layers may have a different tile\nwidth.","name":"tileWidth","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#tileWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The base height of a tile in pixels. Note that individual layers may have a different\ntile height.","name":"tileHeight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#tileHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The width of the map (in tiles).","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The height of the map (in tiles).","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The orientation of the map data (as specified in Tiled), usually 'orthogonal'.","name":"orientation","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#orientation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":139,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The render (draw) order of the map data (as specified in Tiled), usually 'right-down'.\n\nThe draw orders are:\n\nright-down\nleft-down\nright-up\nleft-up\n\nThis can be changed via the `setRenderOrder` method.","name":"renderOrder","type":{"names":["string"]},"since":"3.12.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#renderOrder","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The format of the map data.","name":"format","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#format","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The version of the map data (as specified in Tiled, usually 1).","name":"version","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#version","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":175,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Map specific properties as specified in Tiled.","name":"properties","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#properties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":184,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The width of the map in pixels based on width * tileWidth.","name":"widthInPixels","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#widthInPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":193,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The height of the map in pixels based on height * tileHeight.","name":"heightInPixels","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#heightInPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":202,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"imageCollections","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#imageCollections","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":210,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"An array of Tiled Image Layers.","name":"images","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#images","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":219,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"An array of Tilemap layer data.","name":"layers","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#layers","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":228,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"An array of Tilesets used in the map.","name":"tilesets","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#tilesets","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":237,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"An array of ObjectLayer instances parsed from Tiled object layers.","name":"objects","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#objects","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":246,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The index of the currently selected LayerData object.","name":"currentLayerIndex","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#currentLayerIndex","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the rendering (draw) order of the tiles in this map.\n\nThe default is 'right-down', meaning it will order the tiles starting from the top-left,\ndrawing to the right and then moving down to the next row.\n\nThe draw orders are:\n\n0 = right-down\n1 = left-down\n2 = right-up\n3 = left-up\n\nSetting the render order does not change the tiles or how they are stored in the layer,\nit purely impacts the order in which they are rendered.\n\nYou can provide either an integer (0 to 3), or the string version of the order.\n\nCalling this method _after_ creating Static or Dynamic Tilemap Layers will **not** automatically\nupdate them to use the new render order. If you call this method after creating layers, use their\nown `setRenderOrder` methods to change them as needed.","kind":"function","name":"setRenderOrder","since":"3.12.0","params":[{"type":{"names":["integer","string"]},"description":"The render (draw) order value. Either an integer between 0 and 3, or a string: 'right-down', 'left-down', 'right-up' or 'left-up'.","name":"renderOrder"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"This Tilemap object."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setRenderOrder","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":302,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Adds an image to the map to be used as a tileset. A single map may use multiple tilesets.\nNote that the tileset name can be found in the JSON file exported from Tiled, or in the Tiled\neditor.","kind":"function","name":"addTilesetImage","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tileset as specified in the map data.","name":"tilesetName"},{"type":{"names":["string"]},"optional":true,"description":"The key of the Phaser.Cache image used for this tileset. If\n`undefined` or `null` it will look for an image with a key matching the tilesetName parameter.","name":"key"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the tile (in pixels) in the Tileset Image. If not\ngiven it will default to the map's tileWidth value, or the tileWidth specified in the Tiled\nJSON file.","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the tiles (in pixels) in the Tileset Image. If\nnot given it will default to the map's tileHeight value, or the tileHeight specified in the\nTiled JSON file.","name":"tileHeight"},{"type":{"names":["integer"]},"optional":true,"description":"The margin around the tiles in the sheet (in pixels). If not\nspecified, it will default to 0 or the value specified in the Tiled JSON file.","name":"tileMargin"},{"type":{"names":["integer"]},"optional":true,"description":"The spacing between each the tile in the sheet (in pixels).\nIf not specified, it will default to 0 or the value specified in the Tiled JSON file.","name":"tileSpacing"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"If adding multiple tilesets to a blank map, specify the starting\nGID this set will use here.","name":"gid"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tileset"]},"nullable":true,"description":"Returns the Tileset object that was created or updated, or null if it\nfailed."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#addTilesetImage","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":376,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Turns the DynamicTilemapLayer associated with the given layer into a StaticTilemapLayer. If\nno layer specified, the map's current layer is used. This is useful if you want to manipulate\na map at the start of a scene, but then make it non-manipulable and optimize it for speed.\nNote: the DynamicTilemapLayer passed in is destroyed, so make sure to store the value\nreturned from this method if you want to manipulate the new StaticTilemapLayer.","kind":"function","name":"convertLayerToStatic","since":"3.0.0","params":[{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer"]},"optional":true,"description":"The name of the layer from Tiled, the\nindex of the layer in the map, or a DynamicTilemapLayer.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"nullable":true,"description":"Returns the new layer that was created, or null if it\nfailed."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#convertLayerToStatic","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":421,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Copies the tiles in the source rectangular area to a new destination (all specified in tile\ncoordinates) within the layer. This copies all tile properties & recalculates collision\ninformation in the destination region.\n\nIf no layer specified, the map's current layer is used. This cannot be applied to StaticTilemapLayers.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the area to copy from, in tiles, not pixels.","name":"srcTileX"},{"type":{"names":["integer"]},"description":"The y coordinate of the area to copy from, in tiles, not pixels.","name":"srcTileY"},{"type":{"names":["integer"]},"description":"The width of the area to copy, in tiles, not pixels.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the area to copy, in tiles, not pixels.","name":"height"},{"type":{"names":["integer"]},"description":"The x coordinate of the area to copy to, in tiles, not pixels.","name":"destTileX"},{"type":{"names":["integer"]},"description":"The y coordinate of the area to copy to, in tiles, not pixels.","name":"destTileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#copy","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a new and empty DynamicTilemapLayer. The currently selected layer in the map is set to this new layer.","kind":"function","name":"createBlankDynamicLayer","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of this layer. Must be unique within the map.","name":"name"},{"type":{"names":["string","Array.","Phaser.Tilemaps.Tileset","Array."]},"description":"The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.","name":"tileset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world x position where the top left of this layer will be placed.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world y position where the top left of this layer will be placed.","name":"y"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the layer in tiles. If not specified, it will default to the map's width.","name":"width"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the layer in tiles. If not specified, it will default to the map's height.","name":"height"},{"type":{"names":["integer"]},"optional":true,"description":"The width of the tiles the layer uses for calculations. If not specified, it will default to the map's tileWidth.","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The height of the tiles the layer uses for calculations. If not specified, it will default to the map's tileHeight.","name":"tileHeight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"nullable":true,"description":"Returns the new layer that was created, or `null` if it failed."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#createBlankDynamicLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":534,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a new DynamicTilemapLayer that renders the LayerData associated with the given\n`layerID`. The currently selected layer in the map is set to this new layer.\n\nThe `layerID` is important. If you've created your map in Tiled then you can get this by\nlooking in Tiled and looking at the layer name. Or you can open the JSON file it exports and\nlook at the layers[].name value. Either way it must match.\n\nUnlike a static layer, a dynamic layer can be modified. See DynamicTilemapLayer for more\ninformation.","kind":"function","name":"createDynamicLayer","since":"3.0.0","params":[{"type":{"names":["integer","string"]},"description":"The layer array index value, or if a string is given, the layer name from Tiled.","name":"layerID"},{"type":{"names":["string","Array.","Phaser.Tilemaps.Tileset","Array."]},"description":"The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.","name":"tileset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position to place the layer in the world. If not specified, it will default to the layer offset from Tiled or 0.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position to place the layer in the world. If not specified, it will default to the layer offset from Tiled or 0.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"nullable":true,"description":"Returns the new layer was created, or null if it failed."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#createDynamicLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":603,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a Sprite for every object matching the given gid in the map data. All properties from\nthe map data objectgroup are copied into the `spriteConfig`, so you can use this as an easy\nway to configure Sprite properties from within the map editor. For example giving an object a\nproperty of alpha: 0.5 in the map editor will duplicate that when the Sprite is created.\n\nCustom object properties not sharing names with the Sprite's own properties are copied to the\nSprite's {@link Phaser.GameObjects.Sprite#data data store}.","kind":"function","name":"createFromObjects","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the object layer (from Tiled) to create Sprites from.","name":"name"},{"type":{"names":["integer","string"]},"description":"Either the id (object), gid (tile object) or name (object or\ntile object) from Tiled. Ids are unique in Tiled, but a gid is shared by all tile objects\nwith the same graphic. The same name can be used on multiple objects.","name":"id"},{"type":{"names":["Phaser.Types.GameObjects.Sprite.SpriteConfig"]},"description":"The config object to pass into the Sprite creator (i.e.\nscene.make.sprite).","name":"spriteConfig"},{"type":{"names":["Phaser.Scene"]},"optional":true,"defaultvalue":"the scene the map is within","description":"The Scene to create the Sprites within.","name":"scene"}],"returns":[{"type":{"names":["Array."]},"description":"An array of the Sprites that were created."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#createFromObjects","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":714,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a Sprite for every object matching the given tile indexes in the layer. You can\noptionally specify if each tile will be replaced with a new tile after the Sprite has been\ncreated. This is useful if you want to lay down special tiles in a level that are converted to\nSprites, but want to replace the tile itself with a floor tile or similar once converted.","kind":"function","name":"createFromTiles","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"The tile index, or array of indexes, to create Sprites from.","name":"indexes"},{"type":{"names":["integer","array"]},"description":"The tile index, or array of indexes, to change a converted\ntile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a\none-to-one mapping with the indexes array.","name":"replacements"},{"type":{"names":["Phaser.Types.GameObjects.Sprite.SpriteConfig"]},"description":"The config object to pass into the Sprite creator (i.e. scene.make.sprite).","name":"spriteConfig"},{"type":{"names":["Phaser.Scene"]},"optional":true,"defaultvalue":"scene the map is within","description":"The Scene to create the Sprites within.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Array."]},"nullable":true,"description":"Returns an array of Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#createFromTiles","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":743,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a new StaticTilemapLayer that renders the LayerData associated with the given\n`layerID`. The currently selected layer in the map is set to this new layer.\n\nThe `layerID` is important. If you've created your map in Tiled then you can get this by\nlooking in Tiled and looking at the layer name. Or you can open the JSON file it exports and\nlook at the layers[].name value. Either way it must match.\n\nIt's important to remember that a static layer cannot be modified. See StaticTilemapLayer for\nmore information.","kind":"function","name":"createStaticLayer","since":"3.0.0","params":[{"type":{"names":["integer","string"]},"description":"The layer array index value, or if a string is given, the layer name from Tiled.","name":"layerID"},{"type":{"names":["string","Array.","Phaser.Tilemaps.Tileset","Array."]},"description":"The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.","name":"tileset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position to place the layer in the world. If not specified, it will default to the layer offset from Tiled or 0.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position to place the layer in the world. If not specified, it will default to the layer offset from Tiled or 0.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"nullable":true,"description":"Returns the new layer was created, or null if it failed."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#createStaticLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":802,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Removes all layer data from this Tilemap and nulls the scene reference. This will destroy any\nStaticTilemapLayers or DynamicTilemapLayers that have been linked to LayerData.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#destroy","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":817,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the tiles in the given rectangular area (in tile coordinates) of the layer with the\nspecified index. Tiles will be set to collide if the given index is a colliding index.\nCollision information in the region will be recalculated.\n\nIf no layer specified, the map's current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"fill","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The tile index to fill the area with.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#fill","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":851,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"For each object in the given object layer, run the given filter callback function. Any\nobjects that pass the filter test (i.e. where the callback returns true) will returned as a\nnew array. Similar to Array.prototype.Filter in vanilla JS.","kind":"function","name":"filterObjects","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.ObjectLayer","string"]},"description":"The name of an object layer (from Tiled) or an ObjectLayer instance.","name":"objectLayer"},{"type":{"names":["TilemapFilterCallback"]},"description":"The callback. Each object in the given area will be passed to this callback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"}],"returns":[{"type":{"names":["Array."]},"nullable":true,"description":"An array of object that match the search, or null if the objectLayer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#filterObjects","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":883,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\nfilter callback function. Any tiles that pass the filter test (i.e. where the callback returns\ntrue) will returned as a new array. Similar to Array.prototype.Filter in vanilla JS.\nIf no layer specified, the map's current layer is used.","kind":"function","name":"filterTiles","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"The callback. Each tile in the given area will be passed to this\ncallback as the first and only parameter. The callback should return true for tiles that pass the\nfilter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Array."]},"nullable":true,"description":"Returns an array of Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#filterTiles","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":914,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Searches the entire map layer for the first tile matching the given index, then returns that Tile\nobject. If no match is found, it returns null. The search starts from the top-left tile and\ncontinues horizontally until it hits the end of the row, then it drops down to the next column.\nIf the reverse boolean is true, it scans starting from the bottom-right corner traveling up to\nthe top-left.\nIf no layer specified, the map's current layer is used.","kind":"function","name":"findByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The tile index value to search for.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The number of times to skip a matching tile before returning.","name":"skip"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left.","name":"reverse"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#findByIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":941,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Find the first object in the given object layer that satisfies the provided testing function.\nI.e. finds the first object for which `callback` returns true. Similar to\nArray.prototype.find in vanilla JS.","kind":"function","name":"findObject","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.ObjectLayer","string"]},"description":"The name of an object layer (from Tiled) or an ObjectLayer instance.","name":"objectLayer"},{"type":{"names":["TilemapFindCallback"]},"description":"The callback. Each object in the given area will be passed to this callback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"nullable":true,"description":"An object that matches the search, or null if no object found."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#findObject","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":973,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Find the first tile in the given rectangular area (in tile coordinates) of the layer that\nsatisfies the provided testing function. I.e. finds the first tile for which `callback` returns\ntrue. Similar to Array.prototype.find in vanilla JS.\nIf no layer specified, the maps current layer is used.","kind":"function","name":"findTile","since":"3.0.0","params":[{"type":{"names":["FindTileCallback"]},"description":"The callback. Each tile in the given area will be passed to this callback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The Tile layer to run the search on. If not provided will use the current layer.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#findTile","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1002,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\ncallback. Similar to Array.prototype.forEach in vanilla JS.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"forEachTile","since":"3.0.0","params":[{"type":{"names":["EachTileCallback"]},"description":"The callback. Each tile in the given area will be passed to this callback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The Tile layer to run the search on. If not provided will use the current layer.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#forEachTile","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1033,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the image layer index based on its name.","kind":"function","name":"getImageIndex","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the image to get.","name":"name"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the image in this tilemap, or null if not found."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getImageIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1048,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Return a list of all valid imagelayer names loaded in this Tilemap.","kind":"function","name":"getImageLayerNames","since":"3.21.0","returns":[{"type":{"names":["Array."]},"description":"Array of valid imagelayer names / IDs loaded into this Tilemap."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getImageLayerNames","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1069,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Internally used. Returns the index of the object in one of the Tilemaps arrays whose name\nproperty matches the given `name`.","kind":"function","name":"getIndex","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The Tilemap array to search.","name":"location"},{"type":{"names":["string"]},"description":"The name of the array element to get.","name":"name"}],"returns":[{"type":{"names":["number"]},"description":"The index of the element in the array, or null if not found."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1094,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the LayerData from this.layers that is associated with `layer`, or null if an invalid\n`layer` is given.","kind":"function","name":"getLayer","since":"3.0.0","params":[{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The name of the\nlayer from Tiled, the index of the layer in the map, a DynamicTilemapLayer or a\nStaticTilemapLayer. If not given will default to the maps current layer index.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.LayerData"]},"description":"The corresponding LayerData within this.layers."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the ObjectLayer from this.objects that has the given `name`, or null if no ObjectLayer\nis found with that name.","kind":"function","name":"getObjectLayer","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The name of the object layer from Tiled.","name":"name"}],"returns":[{"type":{"names":["Phaser.Tilemaps.ObjectLayer"]},"nullable":true,"description":"The corresponding ObjectLayer within this.objects or null."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getObjectLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Return a list of all valid objectgroup names loaded in this Tilemap.","kind":"function","name":"getObjectLayerNames","since":"3.21.0","returns":[{"type":{"names":["Array."]},"description":"Array of valid objectgroup names / IDs loaded into this Tilemap."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getObjectLayerNames","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1153,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the LayerData index of the given `layer` within this.layers, or null if an invalid\n`layer` is given.","kind":"function","name":"getLayerIndex","since":"3.0.0","params":[{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The name of the\nlayer from Tiled, the index of the layer in the map, a DynamicTilemapLayer or a\nStaticTilemapLayer. If not given will default to the map's current layer index.","name":"layer"}],"returns":[{"type":{"names":["integer"]},"description":"The LayerData index within this.layers."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getLayerIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the index of the LayerData within this.layers that has the given `name`, or null if an\ninvalid `name` is given.","kind":"function","name":"getLayerIndexByName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the layer to get.","name":"name"}],"returns":[{"type":{"names":["integer"]},"description":"The LayerData index within this.layers."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getLayerIndexByName","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets a tile at the given tile coordinates from the given layer.\nIf no layer specified, the map's current layer is used.","kind":"function","name":"getTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"X position to get the tile from (given in tile units, not pixels).","name":"tileX"},{"type":{"names":["integer"]},"description":"Y position to get the tile from (given in tile units, not pixels).","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true getTile won't return null for empty tiles, but a Tile object with an index of -1.","name":"nonNull"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tile, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTileAt","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets a tile at the given world coordinates from the given layer.\nIf no layer specified, the map's current layer is used.","kind":"function","name":"getTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"X position to get the tile from (given in pixels)","name":"worldX"},{"type":{"names":["number"]},"description":"Y position to get the tile from (given in pixels)","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, function won't return null for empty tiles, but a Tile object with an index of -1.","name":"nonNull"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tile, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1253,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Return a list of all valid tilelayer names loaded in this Tilemap.","kind":"function","name":"getTileLayerNames","since":"3.21.0","returns":[{"type":{"names":["Array."]},"description":"Array of valid tilelayer names / IDs loaded into this Tilemap."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTileLayerNames","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the tiles in the given rectangular area (in tile coordinates) of the layer.\nIf no layer specified, the maps current layer is used.","kind":"function","name":"getTilesWithin","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Array."]},"nullable":true,"description":"Returns an array of Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTilesWithin","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1299,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the tiles that overlap with the given shape in the given layer. The shape must be a Circle,\nLine, Rectangle or Triangle. The shape should be in world coordinates.\nIf no layer specified, the maps current layer is used.","kind":"function","name":"getTilesWithinShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle","Phaser.Geom.Line","Phaser.Geom.Rectangle","Phaser.Geom.Triangle"]},"description":"A shape in world (pixel) coordinates","name":"shape"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Array."]},"nullable":true,"description":"Returns an array of Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTilesWithinShape","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1323,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the tiles in the given rectangular area (in world coordinates) of the layer.\nIf no layer specified, the maps current layer is used.","kind":"function","name":"getTilesWithinWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The world x coordinate for the top-left of the area.","name":"worldX"},{"type":{"names":["number"]},"description":"The world y coordinate for the top-left of the area.","name":"worldY"},{"type":{"names":["number"]},"description":"The width of the area.","name":"width"},{"type":{"names":["number"]},"description":"The height of the area.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Array."]},"nullable":true,"description":"Returns an array of Tiles, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTilesWithinWorldXY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the Tileset that has the given `name`, or null if an invalid `name` is given.","kind":"function","name":"getTileset","since":"3.14.0","params":[{"type":{"names":["string"]},"description":"The name of the Tileset to get.","name":"name"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tileset"]},"nullable":true,"description":"The Tileset, or `null` if no matching named tileset was found."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTileset","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1366,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Gets the index of the Tileset within this.tilesets that has the given `name`, or null if an\ninvalid `name` is given.","kind":"function","name":"getTilesetIndex","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the Tileset to get.","name":"name"}],"returns":[{"type":{"names":["integer"]},"description":"The Tileset index within this.tilesets."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#getTilesetIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1382,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns\nfalse if there is no tile or if the tile at that location has an index of -1.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"hasTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["boolean"]},"nullable":true,"description":"Returns a boolean, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#hasTileAt","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1406,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns\nfalse if there is no tile or if the tile at that location has an index of -1.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"hasTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate, in pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate, in pixels.","name":"worldY"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["boolean"]},"nullable":true,"description":"Returns a boolean, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#hasTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The LayerData object that is currently selected in the map. You can set this property using\nany type supported by setLayer.","name":"layer","type":{"names":["Phaser.Tilemaps.LayerData"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#layer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Puts a tile at the given tile coordinates in the specified layer. You can pass in either an index\nor a Tile object. If you pass in a Tile, all attributes will be copied over to the specified\nlocation. If you pass in an index, only the index at the specified location will be changed.\nCollision information will be recalculated at the specified location.\n\nIf no layer specified, the maps current layer is used.\n\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"putTileAt","since":"3.0.0","params":[{"type":{"names":["integer","Phaser.Tilemaps.Tile"]},"description":"The index of this tile to set or a Tile object.","name":"tile"},{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tile, or null if the layer given was invalid or the coordinates were out of bounds."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#putTileAt","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Puts a tile at the given world coordinates (pixels) in the specified layer. You can pass in either\nan index or a Tile object. If you pass in a Tile, all attributes will be copied over to the\nspecified location. If you pass in an index, only the index at the specified location will be\nchanged. Collision information will be recalculated at the specified location.\n\nIf no layer specified, the maps current layer is used. This\ncannot be applied to StaticTilemapLayers.","kind":"function","name":"putTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["integer","Phaser.Tilemaps.Tile"]},"description":"The index of this tile to set or a Tile object.","name":"tile"},{"type":{"names":["number"]},"description":"The x coordinate, in pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate, in pixels.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tile, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#putTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1515,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Puts an array of tiles or a 2D array of tiles at the given tile coordinates in the specified\nlayer. The array can be composed of either tile indexes or Tile objects. If you pass in a Tile,\nall attributes will be copied over to the specified location. If you pass in an index, only the\nindex at the specified location will be changed. Collision information will be recalculated\nwithin the region tiles were changed.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"putTilesAt","since":"3.0.0","params":[{"type":{"names":["Array.","Array.>","Array.","Array.>"]},"description":"A row (array) or grid (2D array) of Tiles or tile indexes to place.","name":"tile"},{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#putTilesAt","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1549,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\nspecified layer. Each tile will receive a new index. If an array of indexes is passed in, then\nthose will be used for randomly assigning new tile indexes. If an array is not provided, the\nindexes found within the region (excluding -1) will be used for randomly assigning new tile\nindexes. This method only modifies tile indexes and does not change collision information.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"randomize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Array."]},"optional":true,"description":"An array of indexes to randomly draw from during randomization.","name":"indexes"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#randomize","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1584,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Calculates interesting faces at the given tile coordinates of the specified layer. Interesting\nfaces are used internally for optimizing collisions against tiles. This method is mostly used\ninternally to optimize recalculating faces when only one tile has been changed.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"calculateFacesAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#calculateFacesAt","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1611,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Calculates interesting faces within the rectangular area specified (in tile coordinates) of the\nlayer. Interesting faces are used internally for optimizing collisions against tiles. This method\nis mostly used internally.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"calculateFacesWithin","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#calculateFacesWithin","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1640,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Removes the given TilemapLayer from this Tilemap without destroying it.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"removeLayer","since":"3.17.0","params":[{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to be removed.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#removeLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1680,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Destroys the given TilemapLayer and removes it from this Tilemap.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"destroyLayer","since":"3.17.0","params":[{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to be destroyed.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Returns this, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#destroyLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Removes all layers from this Tilemap and destroys any associated StaticTilemapLayers or\nDynamicTilemapLayers.","kind":"function","name":"removeAllLayers","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"This Tilemap object."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#removeAllLayers","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1746,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Removes the given Tile, or an array of Tiles, from the layer to which they belong,\nand optionally recalculates the collision information.\n\nThis cannot be applied to Tiles that belong to Static Tilemap Layers.","kind":"function","name":"removeTile","since":"3.17.0","params":[{"type":{"names":["Phaser.Tilemaps.Tile","Array."]},"description":"The Tile to remove, or an array of Tiles.","name":"tiles"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":-1,"description":"After removing the Tile, insert a brand new Tile into its location with the given index. Leave as -1 to just remove the tile.","name":"replaceIndex"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Array."]},"description":"Returns an array of Tiles that were removed."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#removeTile","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1788,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Removes the tile at the given tile coordinates in the specified layer and updates the layer's\ncollision information.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"removeTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.","name":"replaceWithNull"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns the Tile that was removed, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#removeTileAt","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1817,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Removes the tile at the given world coordinates in the specified layer and updates the layer's\ncollision information.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"removeTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate, in pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate, in pixels.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.","name":"replaceWithNull"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true,"description":"Returns a Tile, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#removeTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1847,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Draws a debug representation of the layer to the given Graphics. This is helpful when you want to\nget a quick idea of which of your tiles are colliding and which have interesting faces. The tiles\nare drawn starting at (0, 0) in the Graphics, allowing you to place the debug representation\nwherever you want on the screen.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"renderDebug","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The target Graphics object to draw upon.","name":"graphics"},{"type":{"names":["Phaser.Types.Tilemaps.StyleConfig"]},"description":"An object specifying the colors to use for the debug drawing.","name":"styleConfig"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#renderDebug","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1875,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Draws a debug representation of all layers within this Tilemap to the given Graphics object.\n\nThis is helpful when you want to get a quick idea of which of your tiles are colliding and which\nhave interesting faces. The tiles are drawn starting at (0, 0) in the Graphics, allowing you to\nplace the debug representation wherever you want on the screen.","kind":"function","name":"renderDebugFull","since":"3.17.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The target Graphics object to draw upon.","name":"graphics"},{"type":{"names":["Phaser.Types.Tilemaps.StyleConfig"]},"description":"An object specifying the colors to use for the debug drawing.","name":"styleConfig"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#renderDebugFull","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1904,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\n`findIndex` and updates their index to match `newIndex`. This only modifies the index and does\nnot change collision information.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"replaceByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the tile to search for.","name":"findIndex"},{"type":{"names":["integer"]},"description":"The index of the tile to replace it with.","name":"newIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#replaceByIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1938,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets collision on the given tile or tiles within a layer by index. You can pass in either a\nsingle numeric index or an array of indexes: [2, 3, 15, 20]. The `collides` parameter controls if\ncollision will be enabled (true) or disabled (false).\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setCollision","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"Either a single tile index, or an array of tile indexes.","name":"indexes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, updates the current tiles on the layer. Set to false if no tiles have been placed for significant performance boost.","name":"updateLayer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setCollision","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1967,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets collision on a range of tiles in a layer whose index is between the specified `start` and\n`stop` (inclusive). Calling this with a start value of 10 and a stop value of 14 would set\ncollision for tiles 10, 11, 12, 13 and 14. The `collides` parameter controls if collision will be\nenabled (true) or disabled (false).\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setCollisionBetween","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The first index of the tile to be set for collision.","name":"start"},{"type":{"names":["integer"]},"description":"The last index of the tile to be set for collision.","name":"stop"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setCollisionBetween","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":1997,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets collision on the tiles within a layer by checking tile properties. If a tile has a property\nthat matches the given properties object, its collision flag will be set. The `collides`\nparameter controls if collision will be enabled (true) or disabled (false). Passing in\n`{ collides: true }` would update the collision flag on any tiles with a \"collides\" property that\nhas a value of true. Any tile that doesn't have \"collides\" set to true will be ignored. You can\nalso use an array of values, e.g. `{ types: [\"stone\", \"lava\", \"sand\" ] }`. If a tile has a\n\"types\" property that matches any of those values, its collision flag will be updated.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setCollisionByProperty","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"An object with tile properties and corresponding values that should be checked.","name":"properties"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setCollisionByProperty","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2029,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets collision on all tiles in the given layer, except for tiles that have an index specified in\nthe given array. The `collides` parameter controls if collision will be enabled (true) or\ndisabled (false).\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setCollisionByExclusion","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of the tile indexes to not be counted for collision.","name":"indexes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setCollisionByExclusion","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2057,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets collision on the tiles within a layer by checking each tile's collision group data\n(typically defined in Tiled within the tileset collision editor). If any objects are found within\na tile's collision group, the tile's colliding information will be set. The `collides` parameter\ncontrols if collision will be enabled (true) or disabled (false).\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setCollisionFromCollisionGroup","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setCollisionFromCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2085,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets a global collision callback for the given tile index within the layer. This will affect all\ntiles on this layer that have the same index. If a callback is already set for the tile index it\nwill be replaced. Set the callback to null to remove it. If you want to set a callback for a tile\nat a specific location on the map then see setTileLocationCallback.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setTileIndexCallback","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"Either a single tile index, or an array of tile indexes to have a collision callback set for.","name":"indexes"},{"type":{"names":["function"]},"description":"The callback that will be invoked when the tile is collided with.","name":"callback"},{"type":{"names":["object"]},"description":"The context under which the callback is called.","name":"callbackContext"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setTileIndexCallback","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets a collision callback for the given rectangular area (in tile coordinates) within the layer.\nIf a callback is already set for the tile index it will be replaced. Set the callback to null to\nremove it.\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setTileLocationCallback","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["function"]},"description":"The callback that will be invoked when the tile is collided with.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback is called.","name":"callbackContext"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setTileLocationCallback","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2145,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the current layer to the LayerData associated with `layer`.","kind":"function","name":"setLayer","since":"3.0.0","params":[{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The name of the\nlayer from Tiled, the index of the layer in the map, a DynamicTilemapLayer or a\nStaticTilemapLayer. If not given will default to the map's current layer index.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"This Tilemap object."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setLayer","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the base tile size for the map. Note: this does not necessarily match the tileWidth and\ntileHeight for all layers. This also updates the base size on all tiles across all layers.","kind":"function","name":"setBaseTileSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The width of the tiles the map uses for calculations.","name":"tileWidth"},{"type":{"names":["integer"]},"description":"The height of the tiles the map uses for calculations.","name":"tileHeight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"This Tilemap object."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setBaseTileSize","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the tile size for a specific `layer`. Note: this does not necessarily match the map's\ntileWidth and tileHeight for all layers. This will set the tile size for the layer and any\ntiles the layer has.","kind":"function","name":"setLayerTileSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The width of the tiles (in pixels) in the layer.","name":"tileWidth"},{"type":{"names":["integer"]},"description":"The height of the tiles (in pixels) in the layer.","name":"tileHeight"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The name of the\nlayer from Tiled, the index of the layer in the map, a DynamicTilemapLayer or a\nStaticTilemapLayer. If not given will default to the map's current layer index.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"This Tilemap object."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#setLayerTileSize","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Shuffles the tiles in a rectangular region (specified in tile coordinates) within the given\nlayer. It will only randomize the tiles in that area, so if they're all the same nothing will\nappear to have changed! This method only modifies tile indexes and does not change collision\ninformation.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"shuffle","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#shuffle","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2293,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\n`indexA` and swaps then with `indexB`. This only modifies the index and does not change collision\ninformation.\n\nIf no layer specified, the maps current layer is used.\nThis cannot be applied to StaticTilemapLayers.","kind":"function","name":"swapByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"First tile index.","name":"tileA"},{"type":{"names":["integer"]},"description":"Second tile index.","name":"tileB"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#swapByIndex","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2327,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Converts from tile X coordinates (tile units) to world X coordinates (pixels), factoring in the\nlayers position, scale and scroll.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"tileToWorldX","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["number"]},"nullable":true,"description":"Returns a number, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#tileToWorldX","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Converts from tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\nlayers position, scale and scroll.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"tileToWorldY","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer\nto use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["number"]},"nullable":true,"description":"Returns a number, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#tileToWorldY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2376,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Converts from tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\nlayers position, scale and scroll. This will return a new Vector2 object or update the given\n`point` object.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"tileToWorldXY","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the coordinates in. If not given a new Vector2 is created.","name":"point"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"nullable":true,"description":"Returns a point, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#tileToWorldXY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2403,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\nspecified layer. Each tile will receive a new index. New indexes are drawn from the given\nweightedIndexes array. An example weighted array:\n\n[\n { index: 6, weight: 4 }, // Probability of index 6 is 4 / 8\n { index: 7, weight: 2 }, // Probability of index 7 would be 2 / 8\n { index: 8, weight: 1.5 }, // Probability of index 8 would be 1.5 / 8\n { index: 26, weight: 0.5 } // Probability of index 27 would be 0.5 / 8\n]\n\nThe probability of any index being choose is (the index's weight) / (sum of all weights). This\nmethod only modifies tile indexes and does not change collision information.\n\nIf no layer specified, the map's current layer is used. This\ncannot be applied to StaticTilemapLayers.","kind":"function","name":"weightedRandomize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Array."]},"optional":true,"description":"An array of objects to randomly draw from during\nrandomization. They should be in the form: { index: 0, weight: 4 } or\n{ index: [0, 1], weight: 4 } if you wish to draw from multiple tile indexes.","name":"weightedIndexes"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#weightedRandomize","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2448,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Converts from world X coordinates (pixels) to tile X coordinates (tile units), factoring in the\nlayers position, scale and scroll.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"worldToTileX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to be converted, in pixels, not tiles.","name":"worldX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the nearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer\nto use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["number"]},"nullable":true,"description":"Returns a number, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#worldToTileX","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2474,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Converts from world Y coordinates (pixels) to tile Y coordinates (tile units), factoring in the\nlayers position, scale and scroll.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"worldToTileY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The y coordinate to be converted, in pixels, not tiles.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the nearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["number"]},"nullable":true,"description":"Returns a number, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#worldToTileY","scope":"instance","___s":true},{"meta":{"filename":"Tilemap.js","lineno":2499,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Converts from world XY coordinates (pixels) to tile XY coordinates (tile units), factoring in the\nlayers position, scale and scroll. This will return a new Vector2 object or update the given\n`point` object.\n\nIf no layer specified, the maps current layer is used.","kind":"function","name":"worldToTileXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to be converted, in pixels, not tiles.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate to be converted, in pixels, not tiles.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the nearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the coordinates in. If not given a new Vector2 is created.","name":"point"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"},{"type":{"names":["string","integer","Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"optional":true,"description":"The tile layer to use. If not given the current layer is used.","name":"layer"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"nullable":true,"description":"Returns a point, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.Tilemap","longname":"Phaser.Tilemaps.Tilemap#worldToTileXY","scope":"instance","___s":true},{"meta":{"range":[180,243],"filename":"TilemapCreator.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"GameObjectCreator","longname":"GameObjectCreator","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TilemapCreator.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided.\nWhen loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing\nfrom a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map\ndata. For an empty map, you should specify tileWidth, tileHeight, width & height.","kind":"function","name":"tilemap","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tilemaps.TilemapConfig"]},"optional":true,"description":"The config options for the Tilemap.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]}}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#tilemap","scope":"instance","___s":true},{"meta":{"range":[180,243],"filename":"TilemapFactory.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"GameObjectFactory","longname":"GameObjectFactory","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TilemapFactory.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided.\nWhen loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing\nfrom a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map\ndata. For an empty map, you should specify tileWidth, tileHeight, width & height.","kind":"function","name":"tilemap","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"description":"The key in the Phaser cache that corresponds to the loaded tilemap data.","name":"key"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The width of a tile in pixels. Pass in `null` to leave as the\ndefault.","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The height of a tile in pixels. Pass in `null` to leave as the\ndefault.","name":"tileHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The width of the map in tiles. Pass in `null` to leave as the\ndefault.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The height of the map in tiles. Pass in `null` to leave as the\ndefault.","name":"height"},{"type":{"names":["Array.>"]},"optional":true,"description":"Instead of loading from the cache, you can also load directly from\na 2D array of tile indexes. Pass in `null` for no data.","name":"data"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Controls how empty tiles, tiles with an index of -1, in the\nmap data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]}}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#tilemap","scope":"instance","___s":true},{"meta":{"range":[180,213],"filename":"Tileset.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Tileset.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"classdesc":"A Tileset is a combination of an image containing the tiles and a container for data about\neach tile.","kind":"class","name":"Tileset","memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tileset in the map data.","name":"name"},{"type":{"names":["integer"]},"description":"The first tile index this tileset contains.","name":"firstgid"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"Width of each tile (in pixels).","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"Height of each tile (in pixels).","name":"tileHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The margin around all tiles in the sheet (in pixels).","name":"tileMargin"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The spacing between each tile in the sheet (in pixels).","name":"tileSpacing"},{"type":{"names":["object"]},"optional":true,"defaultvalue":"{}","description":"Custom properties defined per tile in the Tileset.\nThese typically are custom properties created in Tiled when editing a tileset.","name":"tileProperties"},{"type":{"names":["object"]},"optional":true,"defaultvalue":"{}","description":"Data stored per tile. These typically are created in Tiled\nwhen editing a tileset, e.g. from Tiled's tile collision editor or terrain editor.","name":"tileData"}],"scope":"static","longname":"Phaser.Tilemaps.Tileset","___s":true},{"meta":{"filename":"Tileset.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The name of the Tileset.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The starting index of the first tile index this Tileset contains.","name":"firstgid","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#firstgid","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The width of each tile (in pixels). Use setTileSize to change.","name":"tileWidth","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#tileWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":71,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The height of each tile (in pixels). Use setTileSize to change.","name":"tileHeight","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#tileHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The margin around the tiles in the sheet (in pixels). Use `setSpacing` to change.","name":"tileMargin","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#tileMargin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The spacing between each the tile in the sheet (in pixels). Use `setSpacing` to change.","name":"tileSpacing","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#tileSpacing","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Tileset-specific properties per tile that are typically defined in the Tiled editor in the\nTileset editor.","name":"tileProperties","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#tileProperties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Tileset-specific data per tile that are typically defined in the Tiled editor, e.g. within\nthe Tileset collision editor. This is where collision objects and terrain are stored.","name":"tileData","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#tileData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The cached image that contains the individual tiles. Use setImage to set.","name":"image","type":{"names":["Phaser.Textures.Texture"]},"nullable":true,"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#image","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The gl texture used by the WebGL renderer.","name":"glTexture","type":{"names":["WebGLTexture"]},"nullable":true,"readonly":true,"since":"3.11.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#glTexture","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The number of tile rows in the the tileset.","name":"rows","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#rows","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The number of tile columns in the tileset.","name":"columns","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#columns","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The total number of tiles in the tileset.","name":"total","type":{"names":["integer"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#total","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":171,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"The look-up table to specific tile image texture coordinates (UV in pixels). Each element\ncontains the coordinates for a tile in an object of the form {x, y}.","name":"texCoordinates","type":{"names":["Array."]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#texCoordinates","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tileset.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Get a tiles properties that are stored in the Tileset. Returns null if tile index is not\ncontained in this Tileset. This is typically defined in Tiled under the Tileset editor.","kind":"function","name":"getTileProperties","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The unique id of the tile across all tilesets in the map.","name":"tileIndex"}],"returns":[{"type":{"names":["object","undefined"]},"nullable":true}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#getTileProperties","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Get a tile's data that is stored in the Tileset. Returns null if tile index is not contained\nin this Tileset. This is typically defined in Tiled and will contain both Tileset collision\ninfo and terrain mapping.","kind":"function","name":"getTileData","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The unique id of the tile across all tilesets in the map.","name":"tileIndex"}],"returns":[{"type":{"names":["object","undefined"]}}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#getTileData","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Get a tile's collision group that is stored in the Tileset. Returns null if tile index is not\ncontained in this Tileset. This is typically defined within Tiled's tileset collision editor.","kind":"function","name":"getTileCollisionGroup","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The unique id of the tile across all tilesets in the map.","name":"tileIndex"}],"returns":[{"type":{"names":["object"]},"nullable":true}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#getTileCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":238,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Returns true if and only if this Tileset contains the given tile index.","kind":"function","name":"containsTileIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The unique id of the tile across all tilesets in the map.","name":"tileIndex"}],"returns":[{"type":{"names":["boolean"]}}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#containsTileIndex","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Returns the texture coordinates (UV in pixels) in the Tileset image for the given tile index.\nReturns null if tile index is not contained in this Tileset.","kind":"function","name":"getTileTextureCoordinates","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The unique id of the tile across all tilesets in the map.","name":"tileIndex"}],"returns":[{"type":{"names":["object"]},"nullable":true,"description":"Object in the form { x, y } representing the top-left UV coordinate\nwithin the Tileset image."}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#getTileTextureCoordinates","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":275,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the image associated with this Tileset and updates the tile data (rows, columns, etc.).","kind":"function","name":"setImage","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Texture"]},"description":"The image that contains the tiles.","name":"texture"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tileset"]},"description":"This Tileset object."}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#setImage","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":296,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the tile width & height and updates the tile data (rows, columns, etc.).","kind":"function","name":"setTileSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The width of a tile in pixels.","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"description":"The height of a tile in pixels.","name":"tileHeight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tileset"]},"description":"This Tileset object."}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#setTileSize","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":320,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Sets the tile margin & spacing and updates the tile data (rows, columns, etc.).","kind":"function","name":"setSpacing","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The margin around the tiles in the sheet (in pixels).","name":"margin"},{"type":{"names":["integer"]},"optional":true,"description":"The spacing between the tiles in the sheet (in pixels).","name":"spacing"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tileset"]},"description":"This Tileset object."}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#setSpacing","scope":"instance","___s":true},{"meta":{"filename":"Tileset.js","lineno":344,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"description":"Updates tile texture coordinates and tileset data.","kind":"function","name":"updateTileData","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The (expected) width of the image to slice.","name":"imageWidth"},{"type":{"names":["integer"]},"description":"The (expected) height of the image to slice.","name":"imageHeight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tileset"]},"description":"This Tileset object."}],"memberof":"Phaser.Tilemaps.Tileset","longname":"Phaser.Tilemaps.Tileset#updateTileData","scope":"instance","___s":true},{"meta":{"range":[180,214],"filename":"CalculateFacesAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTileAt","longname":"GetTileAt","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,214],"filename":"CalculateFacesWithin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTileAt","longname":"GetTileAt","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"Copy.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,220],"filename":"CreateFromTiles.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"TileToWorldX","longname":"TileToWorldX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"CullTiles.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"SnapFloor","longname":"SnapFloor","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"Fill.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"FilterTiles.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"FindTile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FindTile.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"kind":"typedef","name":"FindTileCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The Tile.","name":"value"},{"type":{"names":["integer"]},"description":"The index of the tile.","name":"index"},{"type":{"names":["Array."]},"description":"An array of Tile objects.","name":"array"}],"returns":[{"type":{"names":["boolean"]},"description":"Return `true` if the callback should run, otherwise `false`."}],"longname":"FindTileCallback","scope":"global","___s":true},{"meta":{"range":[180,224],"filename":"ForEachTile.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ForEachTile.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"kind":"typedef","name":"EachTileCallback","type":{"names":["function"]},"params":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The Tile.","name":"value"},{"type":{"names":["integer"]},"description":"The index of the tile.","name":"index"},{"type":{"names":["Array."]},"description":"An array of Tile objects.","name":"array"}],"longname":"EachTileCallback","scope":"global","___s":true},{"meta":{"range":[180,226],"filename":"GetTileAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"IsInLayerBounds","longname":"IsInLayerBounds","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,214],"filename":"GetTileAtWorldXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTileAt","longname":"GetTileAt","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,237],"filename":"GetTilesWithin.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,209],"filename":"GetTilesWithinShape.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"Geom","longname":"Geom","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"GetTilesWithinWorldXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,226],"filename":"HasTileAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"IsInLayerBounds","longname":"IsInLayerBounds","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,214],"filename":"HasTileAtWorldXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"HasTileAt","longname":"HasTileAt","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,205],"filename":"PutTileAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"Tile","longname":"Tile","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,214],"filename":"PutTileAtWorldXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"PutTileAt","longname":"PutTileAt","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,236],"filename":"PutTilesAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"CalculateFacesWithin","longname":"CalculateFacesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"Randomize.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,205],"filename":"RemoveTileAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"Tile","longname":"Tile","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,220],"filename":"RemoveTileAtWorldXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"RemoveTileAt","longname":"RemoveTileAt","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"RenderDebug.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"ReplaceByIndex.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"SetCollision.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"SetTileCollision","longname":"SetTileCollision","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"SetCollisionBetween.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"SetTileCollision","longname":"SetTileCollision","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"SetCollisionByExclusion.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"SetTileCollision","longname":"SetTileCollision","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"SetCollisionByProperty.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"SetTileCollision","longname":"SetTileCollision","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,228],"filename":"SetCollisionFromCollisionGroup.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"SetTileCollision","longname":"SetTileCollision","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"SetTileLocationCallback.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"Shuffle.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"SwapByIndex.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,220],"filename":"TileToWorldXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"TileToWorldX","longname":"TileToWorldX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,224],"filename":"WeightedRandomize.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"GetTilesWithin","longname":"GetTilesWithin","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,220],"filename":"WorldToTileXY.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"name":"WorldToTileX","longname":"WorldToTileX","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/components"},"kind":"namespace","name":"Components","memberof":"Phaser.Tilemaps","longname":"Phaser.Tilemaps.Components","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"DynamicTilemapLayer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"classdesc":"A Dynamic Tilemap Layer is a Game Object that renders LayerData from a Tilemap when used in combination\nwith one, or more, Tilesets.\n\nA Dynamic Tilemap Layer trades some speed for being able to apply powerful effects. Unlike a\nStatic Tilemap Layer, you can apply per-tile effects like tint or alpha, and you can change the\ntiles in a DynamicTilemapLayer.\n\nUse this over a Static Tilemap Layer when you need those features.","kind":"class","name":"DynamicTilemapLayer","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.ScrollFactor","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible"],"memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs.","name":"scene"},{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"The Tilemap this layer is a part of.","name":"tilemap"},{"type":{"names":["integer"]},"description":"The index of the LayerData associated with this layer.","name":"layerIndex"},{"type":{"names":["string","Array.","Phaser.Tilemaps.Tileset","Array."]},"description":"The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.","name":"tileset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world x position where the top left of this layer will be placed.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world y position where the top left of this layer will be placed.","name":"y"}],"scope":"static","longname":"Phaser.Tilemaps.DynamicTilemapLayer","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Used internally by physics system to perform fast type checks.","name":"isTilemap","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#isTilemap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The Tilemap that this layer is a part of.","name":"tilemap","type":{"names":["Phaser.Tilemaps.Tilemap"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tilemap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The index of the LayerData associated with this layer.","name":"layerIndex","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#layerIndex","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The LayerData associated with this layer. LayerData can only be associated with one\ntilemap layer.","name":"layer","type":{"names":["Phaser.Tilemaps.LayerData"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#layer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The Tileset/s associated with this layer.\n\nAs of Phaser 3.14 this property is now an array of Tileset objects, previously it was a single reference.","name":"tileset","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tileset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Used internally with the canvas render. This holds the tiles that are visible within the\ncamera.","name":"culledTiles","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#culledTiles","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"You can control if the Cameras should cull tiles before rendering them or not.\nBy default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.\n\nHowever, there are some instances when you may wish to disable this, and toggling this flag allows\nyou to do so. Also see `setSkipCull` for a chainable method that does the same thing.","name":"skipCull","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#skipCull","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":149,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The total number of tiles drawn by the renderer in the last frame.","name":"tilesDrawn","type":{"names":["integer"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tilesDrawn","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The total number of tiles in this layer. Updated every frame.","name":"tilesTotal","type":{"names":["integer"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tilesTotal","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":169,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The amount of extra tiles to add into the cull rectangle when calculating its horizontal size.\n\nSee the method `setCullPadding` for more details.","name":"cullPaddingX","type":{"names":["integer"]},"defaultvalue":"1","since":"3.11.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#cullPaddingX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":181,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The amount of extra tiles to add into the cull rectangle when calculating its vertical size.\n\nSee the method `setCullPadding` for more details.","name":"cullPaddingY","type":{"names":["integer"]},"defaultvalue":"1","since":"3.11.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#cullPaddingY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":193,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"The callback that is invoked when the tiles are culled.\n\nBy default it will call `TilemapComponents.CullTiles` but you can override this to call any function you like.\n\nIt will be sent 3 arguments:\n\n1. The Phaser.Tilemaps.LayerData object for this Layer\n2. The Camera that is culling the layer. You can check its `dirty` property to see if it has changed since the last cull.\n3. A reference to the `culledTiles` array, which should be used to store the tiles you want rendered.\n\nSee the `TilemapComponents.CullTiles` source code for details on implementing your own culling system.","name":"cullCallback","type":{"names":["function"]},"since":"3.11.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#cullCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":235,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"An array holding the mapping between the tile indexes and the tileset they belong to.","name":"gidMap","type":{"names":["Array."]},"since":"3.14.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#gidMap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":299,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets the rendering (draw) order of the tiles in this layer.\n\nThe default is 'right-down', meaning it will order the tiles starting from the top-left,\ndrawing to the right and then moving down to the next row.\n\nThe draw orders are:\n\n0 = right-down\n1 = left-down\n2 = right-up\n3 = left-up\n\nSetting the render order does not change the tiles or how they are stored in the layer,\nit purely impacts the order in which they are rendered.\n\nYou can provide either an integer (0 to 3), or the string version of the order.","kind":"function","name":"setRenderOrder","since":"3.12.0","params":[{"type":{"names":["integer","string"]},"description":"The render (draw) order value. Either an integer between 0 and 3, or a string: 'right-down', 'left-down', 'right-up' or 'left-up'.","name":"renderOrder"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setRenderOrder","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":341,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Calculates interesting faces at the given tile coordinates of the specified layer. Interesting\nfaces are used internally for optimizing collisions against tiles. This method is mostly used\ninternally to optimize recalculating faces when only one tile has been changed.","kind":"function","name":"calculateFacesAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate.","name":"tileY"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#calculateFacesAt","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":361,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Calculates interesting faces within the rectangular area specified (in tile coordinates) of the\nlayer. Interesting faces are used internally for optimizing collisions against tiles. This method\nis mostly used internally.","kind":"function","name":"calculateFacesWithin","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#calculateFacesWithin","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":383,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Creates a Sprite for every object matching the given tile indexes in the layer. You can\noptionally specify if each tile will be replaced with a new tile after the Sprite has been\ncreated. This is useful if you want to lay down special tiles in a level that are converted to\nSprites, but want to replace the tile itself with a floor tile or similar once converted.","kind":"function","name":"createFromTiles","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"The tile index, or array of indexes, to create Sprites from.","name":"indexes"},{"type":{"names":["integer","array"]},"description":"The tile index, or array of indexes, to change a converted\ntile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a\none-to-one mapping with the indexes array.","name":"replacements"},{"type":{"names":["Phaser.Types.GameObjects.Sprite.SpriteConfig"]},"description":"The config object to pass into the Sprite creator (i.e.\nscene.make.sprite).","name":"spriteConfig"},{"type":{"names":["Phaser.Scene"]},"optional":true,"defaultvalue":"scene the map is within","description":"The Scene to create the Sprites within.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when determining the world XY","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of the Sprites that were created."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#createFromTiles","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":408,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Returns the tiles in the given layer that are within the cameras viewport.\nThis is used internally.","kind":"function","name":"cull","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to run the cull check against.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#cull","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":424,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Copies the tiles in the source rectangular area to a new destination (all specified in tile\ncoordinates) within the layer. This copies all tile properties & recalculates collision\ninformation in the destination region.","kind":"function","name":"copy","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate of the area to copy from, in tiles, not pixels.","name":"srcTileX"},{"type":{"names":["integer"]},"description":"The y coordinate of the area to copy from, in tiles, not pixels.","name":"srcTileY"},{"type":{"names":["integer"]},"description":"The width of the area to copy, in tiles, not pixels.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the area to copy, in tiles, not pixels.","name":"height"},{"type":{"names":["integer"]},"description":"The x coordinate of the area to copy to, in tiles, not pixels.","name":"destTileX"},{"type":{"names":["integer"]},"description":"The y coordinate of the area to copy to, in tiles, not pixels.","name":"destTileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#copy","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Destroys this DynamicTilemapLayer and removes its link to the associated LayerData.","kind":"function","name":"destroy","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Remove this layer from the parent Tilemap?","name":"removeFromTilemap"}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#destroy","scope":"instance","overrides":"Phaser.GameObjects.GameObject#destroy","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":489,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets the tiles in the given rectangular area (in tile coordinates) of the layer with the\nspecified index. Tiles will be set to collide if the given index is a colliding index.\nCollision information in the region will be recalculated.","kind":"function","name":"fill","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The tile index to fill the area with.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#fill","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\nfilter callback function. Any tiles that pass the filter test (i.e. where the callback returns\ntrue) will returned as a new array. Similar to Array.prototype.Filter in vanilla JS.","kind":"function","name":"filterTiles","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"The callback. Each tile in the given area will be passed to this\ncallback as the first and only parameter. The callback should return true for tiles that pass the\nfilter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#filterTiles","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":538,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Searches the entire map layer for the first tile matching the given index, then returns that Tile\nobject. If no match is found, it returns null. The search starts from the top-left tile and\ncontinues horizontally until it hits the end of the row, then it drops down to the next column.\nIf the reverse boolean is true, it scans starting from the bottom-right corner traveling up to\nthe top-left.","kind":"function","name":"findByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The tile index value to search for.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The number of times to skip a matching tile before returning.","name":"skip"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true it will scan the layer in reverse, starting at the\nbottom-right. Otherwise it scans from the top-left.","name":"reverse"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"A Tile object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#findByIndex","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":560,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Find the first tile in the given rectangular area (in tile coordinates) of the layer that\nsatisfies the provided testing function. I.e. finds the first tile for which `callback` returns\ntrue. Similar to Array.prototype.find in vanilla JS.","kind":"function","name":"findTile","since":"3.0.0","params":[{"type":{"names":["FindTileCallback"]},"description":"The callback. Each tile in the given area will be passed to this callback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#findTile","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":583,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\ncallback. Similar to Array.prototype.forEach in vanilla JS.","kind":"function","name":"forEachTile","since":"3.0.0","params":[{"type":{"names":["EachTileCallback"]},"description":"The callback. Each tile in the given area will be passed to this callback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area to search.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#forEachTile","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":607,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Gets a tile at the given tile coordinates from the given layer.","kind":"function","name":"getTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"X position to get the tile from (given in tile units, not pixels).","name":"tileX"},{"type":{"names":["integer"]},"description":"Y position to get the tile from (given in tile units, not pixels).","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true getTile won't return null for empty tiles, but a Tile object with an index of -1.","name":"nonNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile at the given coordinates or null if no tile was found or the coordinates were invalid."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTileAt","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":624,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Gets a tile at the given world coordinates from the given layer.","kind":"function","name":"getTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"X position to get the tile from (given in pixels)","name":"worldX"},{"type":{"names":["number"]},"description":"Y position to get the tile from (given in pixels)","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, function won't return null for empty tiles, but a Tile object with an index of -1.","name":"nonNull"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile at the given coordinates or null if no tile was found or the coordinates\nwere invalid."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":643,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Gets the tiles in the given rectangular area (in tile coordinates) of the layer.","kind":"function","name":"getTilesWithin","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTilesWithin","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":662,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Gets the tiles that overlap with the given shape in the given layer. The shape must be a Circle,\nLine, Rectangle or Triangle. The shape should be in world coordinates.","kind":"function","name":"getTilesWithinShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle","Phaser.Geom.Line","Phaser.Geom.Rectangle","Phaser.Geom.Triangle"]},"description":"A shape in world (pixel) coordinates","name":"shape"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTilesWithinShape","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":680,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Gets the tiles in the given rectangular area (in world coordinates) of the layer.","kind":"function","name":"getTilesWithinWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The world x coordinate for the top-left of the area.","name":"worldX"},{"type":{"names":["number"]},"description":"The world y coordinate for the top-left of the area.","name":"worldY"},{"type":{"names":["number"]},"description":"The width of the area.","name":"width"},{"type":{"names":["number"]},"description":"The height of the area.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTilesWithinWorldXY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":700,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns\nfalse if there is no tile or if the tile at that location has an index of -1.","kind":"function","name":"hasTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if a tile was found at the given location, otherwise `false`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#hasTileAt","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns\nfalse if there is no tile or if the tile at that location has an index of -1.","kind":"function","name":"hasTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate, in pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate, in pixels.","name":"worldY"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if a tile was found at the given location, otherwise `false`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#hasTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":735,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Puts a tile at the given tile coordinates in the specified layer. You can pass in either an index\nor a Tile object. If you pass in a Tile, all attributes will be copied over to the specified\nlocation. If you pass in an index, only the index at the specified location will be changed.\nCollision information will be recalculated at the specified location.","kind":"function","name":"putTileAt","since":"3.0.0","params":[{"type":{"names":["integer","Phaser.Tilemaps.Tile"]},"description":"The index of this tile to set or a Tile object.","name":"tile"},{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"A Tile object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#putTileAt","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":756,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Puts a tile at the given world coordinates (pixels) in the specified layer. You can pass in either\nan index or a Tile object. If you pass in a Tile, all attributes will be copied over to the\nspecified location. If you pass in an index, only the index at the specified location will be\nchanged. Collision information will be recalculated at the specified location.","kind":"function","name":"putTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["integer","Phaser.Tilemaps.Tile"]},"description":"The index of this tile to set or a Tile object.","name":"tile"},{"type":{"names":["number"]},"description":"The x coordinate, in pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate, in pixels.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"A Tile object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#putTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":778,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Puts an array of tiles or a 2D array of tiles at the given tile coordinates in the specified\nlayer. The array can be composed of either tile indexes or Tile objects. If you pass in a Tile,\nall attributes will be copied over to the specified location. If you pass in an index, only the\nindex at the specified location will be changed. Collision information will be recalculated\nwithin the region tiles were changed.","kind":"function","name":"putTilesAt","since":"3.0.0","params":[{"type":{"names":["Array.","Array.>","Array.","Array.>"]},"description":"A row (array) or grid (2D array) of Tiles or tile indexes to place.","name":"tile"},{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#putTilesAt","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":802,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\nspecified layer. Each tile will receive a new index. If an array of indexes is passed in, then\nthose will be used for randomly assigning new tile indexes. If an array is not provided, the\nindexes found within the region (excluding -1) will be used for randomly assigning new tile\nindexes. This method only modifies tile indexes and does not change collision information.","kind":"function","name":"randomize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Array."]},"optional":true,"description":"An array of indexes to randomly draw from during randomization.","name":"indexes"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#randomize","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":827,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Removes the tile at the given tile coordinates in the specified layer and updates the layer's\ncollision information.","kind":"function","name":"removeTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.","name":"replaceWithNull"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"A Tile object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#removeTileAt","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":846,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Removes the tile at the given world coordinates in the specified layer and updates the layer's\ncollision information.","kind":"function","name":"removeTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate, in pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate, in pixels.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.","name":"replaceWithNull"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if the faces data should be recalculated.","name":"recalculateFaces"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"A Tile object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#removeTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":866,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Draws a debug representation of the layer to the given Graphics. This is helpful when you want to\nget a quick idea of which of your tiles are colliding and which have interesting faces. The tiles\nare drawn starting at (0, 0) in the Graphics, allowing you to place the debug representation\nwherever you want on the screen.","kind":"function","name":"renderDebug","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The target Graphics object to draw upon.","name":"graphics"},{"type":{"names":["Phaser.Types.Tilemaps.StyleConfig"]},"description":"An object specifying the colors to use for the debug drawing.","name":"styleConfig"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#renderDebug","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":887,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\n`findIndex` and updates their index to match `newIndex`. This only modifies the index and does\nnot change collision information.","kind":"function","name":"replaceByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the tile to search for.","name":"findIndex"},{"type":{"names":["integer"]},"description":"The index of the tile to replace it with.","name":"newIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#replaceByIndex","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":911,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"You can control if the Cameras should cull tiles before rendering them or not.\nBy default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.\n\nHowever, there are some instances when you may wish to disable this.","kind":"function","name":"setSkipCull","since":"3.11.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Set to `true` to stop culling tiles. Set to `false` to enable culling again.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setSkipCull","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":933,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"When a Camera culls the tiles in this layer it does so using its view into the world, building up a\nrectangle inside which the tiles must exist or they will be culled. Sometimes you may need to expand the size\nof this 'cull rectangle', especially if you plan on rotating the Camera viewing the layer. Do so\nby providing the padding values. The values given are in tiles, not pixels. So if the tile width was 32px\nand you set `paddingX` to be 4, it would add 32px x 4 to the cull rectangle (adjusted for scale)","kind":"function","name":"setCullPadding","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The amount of extra horizontal tiles to add to the cull check padding.","name":"paddingX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The amount of extra vertical tiles to add to the cull check padding.","name":"paddingY"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setCullPadding","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":959,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets collision on the given tile or tiles within a layer by index. You can pass in either a\nsingle numeric index or an array of indexes: [2, 3, 15, 20]. The `collides` parameter controls if\ncollision will be enabled (true) or disabled (false).\n\nIf no layer specified, the map's current layer is used.","kind":"function","name":"setCollision","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"Either a single tile index, or an array of tile indexes.","name":"indexes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, updates the current tiles on the layer. Set to\nfalse if no tiles have been placed for significant performance boost.","name":"updateLayer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"nullable":true,"description":"Return this Tilemap object, or null if the layer given was invalid."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setCollision","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":984,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets collision on a range of tiles in a layer whose index is between the specified `start` and\n`stop` (inclusive). Calling this with a start value of 10 and a stop value of 14 would set\ncollision for tiles 10, 11, 12, 13 and 14. The `collides` parameter controls if collision will be\nenabled (true) or disabled (false).","kind":"function","name":"setCollisionBetween","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The first index of the tile to be set for collision.","name":"start"},{"type":{"names":["integer"]},"description":"The last index of the tile to be set for collision.","name":"stop"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setCollisionBetween","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1007,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets collision on the tiles within a layer by checking tile properties. If a tile has a property\nthat matches the given properties object, its collision flag will be set. The `collides`\nparameter controls if collision will be enabled (true) or disabled (false). Passing in\n`{ collides: true }` would update the collision flag on any tiles with a \"collides\" property that\nhas a value of true. Any tile that doesn't have \"collides\" set to true will be ignored. You can\nalso use an array of values, e.g. `{ types: [\"stone\", \"lava\", \"sand\" ] }`. If a tile has a\n\"types\" property that matches any of those values, its collision flag will be updated.","kind":"function","name":"setCollisionByProperty","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"An object with tile properties and corresponding values that should be checked.","name":"properties"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setCollisionByProperty","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1032,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets collision on all tiles in the given layer, except for tiles that have an index specified in\nthe given array. The `collides` parameter controls if collision will be enabled (true) or\ndisabled (false).","kind":"function","name":"setCollisionByExclusion","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of the tile indexes to not be counted for collision.","name":"indexes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setCollisionByExclusion","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1053,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets collision on the tiles within a layer by checking each tiles collision group data\n(typically defined in Tiled within the tileset collision editor). If any objects are found within\na tiles collision group, the tile's colliding information will be set. The `collides` parameter\ncontrols if collision will be enabled (true) or disabled (false).","kind":"function","name":"setCollisionFromCollisionGroup","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear collision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the update.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setCollisionFromCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1074,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets a global collision callback for the given tile index within the layer. This will affect all\ntiles on this layer that have the same index. If a callback is already set for the tile index it\nwill be replaced. Set the callback to null to remove it. If you want to set a callback for a tile\nat a specific location on the map then see setTileLocationCallback.","kind":"function","name":"setTileIndexCallback","since":"3.0.0","params":[{"type":{"names":["integer","Array."]},"description":"Either a single tile index, or an array of tile indexes to have a collision callback set for.","name":"indexes"},{"type":{"names":["function"]},"description":"The callback that will be invoked when the tile is collided with.","name":"callback"},{"type":{"names":["object"]},"description":"The context under which the callback is called.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setTileIndexCallback","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1096,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Sets a collision callback for the given rectangular area (in tile coordinates) within the layer.\nIf a callback is already set for the tile index it will be replaced. Set the callback to null to\nremove it.","kind":"function","name":"setTileLocationCallback","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["function"]},"optional":true,"description":"The callback that will be invoked when the tile is collided with.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback is called.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setTileLocationCallback","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Shuffles the tiles in a rectangular region (specified in tile coordinates) within the given\nlayer. It will only randomize the tiles in that area, so if they're all the same nothing will\nappear to have changed! This method only modifies tile indexes and does not change collision\ninformation.","kind":"function","name":"shuffle","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#shuffle","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1143,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Scans the given rectangular area (given in tile coordinates) for tiles with an index matching\n`indexA` and swaps then with `indexB`. This only modifies the index and does not change collision\ninformation.","kind":"function","name":"swapByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"First tile index.","name":"tileA"},{"type":{"names":["integer"]},"description":"Second tile index.","name":"tileB"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#swapByIndex","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Converts from tile X coordinates (tile units) to world X coordinates (pixels), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"tileToWorldX","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tileToWorldX","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Converts from tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"tileToWorldY","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tileToWorldY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Converts from tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\nlayers position, scale and scroll. This will return a new Vector2 object or update the given\n`point` object.","kind":"function","name":"tileToWorldXY","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate, in tiles, not pixels.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate, in tiles, not pixels.","name":"tileY"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the coordinates in. If not given a new Vector2 is created.","name":"point"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tileToWorldXY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the\nspecified layer. Each tile will receive a new index. New indexes are drawn from the given\nweightedIndexes array. An example weighted array:\n\n[\n { index: 6, weight: 4 }, // Probability of index 6 is 4 / 8\n { index: 7, weight: 2 }, // Probability of index 7 would be 2 / 8\n { index: 8, weight: 1.5 }, // Probability of index 8 would be 1.5 / 8\n { index: 26, weight: 0.5 } // Probability of index 27 would be 0.5 / 8\n]\n\nThe probability of any index being choose is (the index's weight) / (sum of all weights). This\nmethod only modifies tile indexes and does not change collision information.","kind":"function","name":"weightedRandomize","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Array."]},"optional":true,"description":"An array of objects to randomly draw from during\nrandomization. They should be in the form: { index: 0, weight: 4 } or\n{ index: [0, 1], weight: 4 } if you wish to draw from multiple tile indexes.","name":"weightedIndexes"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#weightedRandomize","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1256,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Converts from world X coordinates (pixels) to tile X coordinates (tile units), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"worldToTileX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to be converted, in pixels, not tiles.","name":"worldX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the nearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#worldToTileX","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Converts from world Y coordinates (pixels) to tile Y coordinates (tile units), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"worldToTileY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The y coordinate to be converted, in pixels, not tiles.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the nearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#worldToTileY","scope":"instance","___s":true},{"meta":{"filename":"DynamicTilemapLayer.js","lineno":1292,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"description":"Converts from world XY coordinates (pixels) to tile XY coordinates (tile units), factoring in the\nlayers position, scale and scroll. This will return a new Vector2 object or update the given\n`point` object.","kind":"function","name":"worldToTileXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to be converted, in pixels, not tiles.","name":"worldX"},{"type":{"names":["number"]},"description":"The y coordinate to be converted, in pixels, not tiles.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the nearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the coordinates in. If not given a new Vector2 is created.","name":"point"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#worldToTileXY","scope":"instance","___s":true},{"meta":{"range":[180,221],"filename":"DynamicTilemapLayerRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"range":[180,225],"filename":"DynamicTilemapLayerWebGLRenderer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer"},"name":"Utils","longname":"Utils","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps"},"kind":"namespace","name":"Tilemaps","memberof":"Phaser","longname":"Phaser.Tilemaps","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"LayerData.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"LayerData.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"classdesc":"A class for representing data about about a layer in a map. Maps are parsed from CSV, Tiled,\netc. into this format. Tilemap, StaticTilemapLayer and DynamicTilemapLayer have a reference\nto this data and use it to look up and perform operations on tiles.","kind":"class","name":"LayerData","memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["object"]},"optional":true,"description":"[description]","name":"config"}],"scope":"static","longname":"Phaser.Tilemaps.LayerData","___s":true},{"meta":{"filename":"LayerData.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The name of the layer, if specified in Tiled.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The x offset of where to draw from the top left","name":"x","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#x","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The y offset of where to draw from the top left","name":"y","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#y","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The width in tile of the layer.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The height in tiles of the layer.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The pixel width of the tiles.","name":"tileWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#tileWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":85,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The pixel height of the tiles.","name":"tileHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#tileHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"baseTileWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#baseTileWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"baseTileHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#baseTileHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The width in pixels of the entire layer.","name":"widthInPixels","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#widthInPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The height in pixels of the entire layer.","name":"heightInPixels","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#heightInPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#alpha","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":139,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#visible","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"Layer specific properties (can be specified in Tiled)","name":"properties","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#properties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"indexes","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#indexes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"collideIndexes","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#collideIndexes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":175,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"callbacks","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#callbacks","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":184,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"bodies","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#bodies","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":193,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An array of the tile indexes","name":"data","type":{"names":["Array.>"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"LayerData.js","lineno":202,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"tilemapLayer","type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer","Phaser.Tilemaps.StaticTilemapLayer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.LayerData","longname":"Phaser.Tilemaps.LayerData#tilemapLayer","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"MapData.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MapData.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"classdesc":"A class for representing data about a map. Maps are parsed from CSV, Tiled, etc. into this\nformat. A Tilemap object get a copy of this data and then unpacks the needed properties into\nitself.","kind":"class","name":"MapData","memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tilemaps.MapDataConfig"]},"optional":true,"description":"The Map configuration object.","name":"config"}],"scope":"static","longname":"Phaser.Tilemaps.MapData","___s":true},{"meta":{"filename":"MapData.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The key in the Phaser cache that corresponds to the loaded tilemap data.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The width of the entire tilemap.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#width","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The height of the entire tilemap.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#height","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"If the map is infinite or not.","name":"infinite","type":{"names":["boolean"]},"since":"3.17.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#infinite","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The width of the tiles.","name":"tileWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#tileWidth","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The height of the tiles.","name":"tileHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#tileHeight","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":85,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The width in pixels of the entire tilemap.","name":"widthInPixels","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#widthInPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The height in pixels of the entire tilemap.","name":"heightInPixels","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#heightInPixels","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":103,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"format","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#format","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The orientation of the map data (i.e. orthogonal, isometric, hexagonal), default 'orthogonal'.","name":"orientation","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#orientation","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":121,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"Determines the draw order of tilemap. Default is right-down\n\n0, or 'right-down'\n1, or 'left-down'\n2, or 'right-up'\n3, or 'left-up'","name":"renderOrder","type":{"names":["string"]},"since":"3.12.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#renderOrder","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The version of the map data (as specified in Tiled).","name":"version","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#version","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"Map specific properties (can be specified in Tiled)","name":"properties","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#properties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":153,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An array with all the layers configured to the MapData.","name":"layers","type":{"names":["Array.","Phaser.Tilemaps.ObjectLayer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#layers","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":162,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An array of Tiled Image Layers.","name":"images","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#images","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":171,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An object of Tiled Object Layers.","name":"objects","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#objects","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":180,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An object of collision data. Must be created as physics object or will return undefined.","name":"collision","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#collision","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":189,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An array of Tilesets.","name":"tilesets","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#tilesets","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":198,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The collection of images the map uses(specified in Tiled)","name":"imageCollections","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#imageCollections","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"MapData.js","lineno":207,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"[description]","name":"tiles","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.MapData","longname":"Phaser.Tilemaps.MapData#tiles","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,216],"filename":"ObjectLayer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"classdesc":"A class for representing a Tiled object layer in a map. This mirrors the structure of a Tiled\nobject layer, except:\n - \"x\" & \"y\" properties are ignored since these cannot be changed in Tiled.\n - \"offsetx\" & \"offsety\" are applied to the individual object coordinates directly, so they\n are ignored as well.\n - \"draworder\" is ignored.","kind":"class","name":"ObjectLayer","memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tilemaps.ObjectLayerConfig"]},"optional":true,"description":"The data for the layer from the Tiled JSON object.","name":"config"}],"scope":"static","longname":"Phaser.Tilemaps.ObjectLayer","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The name of the Object Layer.","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The opacity of the layer, between 0 and 1.","name":"opacity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#opacity","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The custom properties defined on the Object Layer, keyed by their name.","name":"properties","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#properties","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The type of each custom property defined on the Object Layer, keyed by its name.","name":"propertyTypes","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#propertyTypes","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"The type of the layer, which should be `objectgroup`.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#type","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"Whether the layer is shown (`true`) or hidden (`false`).","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#visible","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"ObjectLayer.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata"},"description":"An array of all objects on this Object Layer.\n\nEach Tiled object corresponds to a JavaScript object in this array. It has an `id` (unique),\n`name` (as assigned in Tiled), `type` (as assigned in Tiled), `rotation` (in clockwise degrees),\n`properties` (if any), `visible` state (`true` if visible, `false` otherwise),\n`x` and `y` coordinates (in pixels, relative to the tilemap), and a `width` and `height` (in pixels).\n\nAn object tile has a `gid` property (GID of the represented tile), a `flippedHorizontal` property,\na `flippedVertical` property, and `flippedAntiDiagonal` property.\nThe {@link http://docs.mapeditor.org/en/latest/reference/tmx-map-format/|Tiled documentation} contains\ninformation on flipping and rotation.\n\nPolylines have a `polyline` property, which is an array of objects corresponding to points,\nwhere each point has an `x` property and a `y` property. Polygons have an identically structured\narray in their `polygon` property. Text objects have a `text` property with the text's properties.\n\nRectangles and ellipses have a `rectangle` or `ellipse` property set to `true`.","name":"objects","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.ObjectLayer","longname":"Phaser.Tilemaps.ObjectLayer#objects","scope":"instance","kind":"member","___s":true},{"meta":{"range":[180,211],"filename":"Parse.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"name":"Formats","longname":"Formats","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Parse.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"description":"Parses raw data of a given Tilemap format into a new MapData object. If no recognized data format\nis found, returns `null`. When loading from CSV or a 2D array, you should specify the tileWidth &\ntileHeight. When parsing from a map from Tiled, the tileWidth & tileHeight will be pulled from\nthe map data.","kind":"function","name":"Parse","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tilemap, used to set the name on the MapData.","name":"name"},{"type":{"names":["integer"]},"description":"See ../Formats.js.","name":"mapFormat"},{"type":{"names":["Array.>","string","object"]},"description":"2D array, CSV string or Tiled JSON object.","name":"data"},{"type":{"names":["integer"]},"description":"The width of a tile in pixels. Required for 2D array and CSV, but\nignored for Tiled JSON.","name":"tileWidth"},{"type":{"names":["integer"]},"description":"The height of a tile in pixels. Required for 2D array and CSV, but\nignored for Tiled JSON.","name":"tileHeight"},{"type":{"names":["boolean"]},"description":"Controls how empty tiles, tiles with an index of -1, in the map\ndata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.MapData"]},"description":"The created `MapData` object."}],"memberof":"Phaser.Tilemaps.Parsers","longname":"Phaser.Tilemaps.Parsers.Parse","scope":"static","___s":true},{"meta":{"range":[180,211],"filename":"Parse2DArray.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"name":"Formats","longname":"Formats","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Parse2DArray.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"description":"Parses a 2D array of tile indexes into a new MapData object with a single layer.","kind":"function","name":"Parse2DArray","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tilemap, used to set the name on the MapData.","name":"name"},{"type":{"names":["Array.>"]},"description":"2D array, CSV string or Tiled JSON object.","name":"data"},{"type":{"names":["integer"]},"description":"The width of a tile in pixels.","name":"tileWidth"},{"type":{"names":["integer"]},"description":"The height of a tile in pixels.","name":"tileHeight"},{"type":{"names":["boolean"]},"description":"Controls how empty tiles, tiles with an index of -1, in the map\ndata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.MapData"]},"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers","longname":"Phaser.Tilemaps.Parsers.Parse2DArray","scope":"static","___s":true},{"meta":{"range":[180,211],"filename":"ParseCSV.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"name":"Formats","longname":"Formats","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseCSV.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"description":"Parses a CSV string of tile indexes into a new MapData object with a single layer.","kind":"function","name":"ParseCSV","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tilemap, used to set the name on the MapData.","name":"name"},{"type":{"names":["string"]},"description":"CSV string of tile indexes.","name":"data"},{"type":{"names":["integer"]},"description":"The width of a tile in pixels.","name":"tileWidth"},{"type":{"names":["integer"]},"description":"The height of a tile in pixels.","name":"tileHeight"},{"type":{"names":["boolean"]},"description":"Controls how empty tiles, tiles with an index of -1, in the map\ndata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.MapData"]},"description":"The resulting MapData object."}],"memberof":"Phaser.Tilemaps.Parsers","longname":"Phaser.Tilemaps.Parsers.ParseCSV","scope":"static","___s":true},{"meta":{"range":[180,226],"filename":"ParseTileLayers.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"name":"LayerData","longname":"LayerData","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseTileLayers.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"description":"[description]","kind":"function","name":"ParseTileLayers","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"[description]","name":"json"},{"type":{"names":["boolean"]},"description":"[description]","name":"insertNull"}],"returns":[{"type":{"names":["array"]},"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers.Impact","longname":"Phaser.Tilemaps.Parsers.Impact.ParseTileLayers","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"ParseTilesets.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"name":"Tileset","longname":"Tileset","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseTilesets.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"description":"[description]","kind":"function","name":"ParseTilesets","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"[description]","name":"json"}],"returns":[{"type":{"names":["array"]},"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers.Impact","longname":"Phaser.Tilemaps.Parsers.Impact.ParseTilesets","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"ParseWeltmeister.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"name":"Formats","longname":"Formats","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseWeltmeister.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"description":"Parses a Weltmeister JSON object into a new MapData object.","kind":"function","name":"ParseWeltmeister","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tilemap, used to set the name on the MapData.","name":"name"},{"type":{"names":["object"]},"description":"The Weltmeister JSON object.","name":"json"},{"type":{"names":["boolean"]},"description":"Controls how empty tiles, tiles with an index of -1, in the map\ndata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["object"]},"nullable":true,"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers.Impact","longname":"Phaser.Tilemaps.Parsers.Impact.ParseWeltmeister","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact"},"kind":"namespace","name":"Impact","memberof":"Phaser.Tilemaps.Parsers","longname":"Phaser.Tilemaps.Parsers.Impact","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers"},"kind":"namespace","name":"Parsers","memberof":"Phaser.Tilemaps","longname":"Phaser.Tilemaps.Parsers","scope":"static","___s":true},{"meta":{"range":[180,228],"filename":"AssignTileProperties.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"Extend","longname":"Extend","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"AssignTileProperties.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Copy properties from tileset to tiles.","kind":"function","name":"AssignTileProperties","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.MapData"]},"description":"[description]","name":"mapData"}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.AssignTileProperties","scope":"static","___s":true},{"meta":{"filename":"Base64Decode.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Decode base-64 encoded data, for example as exported by Tiled.","kind":"function","name":"Base64Decode","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"Base-64 encoded data to decode.","name":"data"}],"returns":[{"type":{"names":["array"]},"description":"Array containing the decoded bytes."}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.Base64Decode","scope":"static","___s":true},{"meta":{"filename":"BuildTilesetIndex.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Master list of tiles -> x, y, index in tileset.","kind":"function","name":"BuildTilesetIndex","since":"3.0.0","params":[{"type":{"names":["Phaser.Tilemaps.MapData"]},"description":"[description]","name":"mapData"}],"returns":[{"type":{"names":["array"]},"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.BuildTilesetIndex","scope":"static","___s":true},{"meta":{"range":[179,239],"filename":"CreateGroupLayer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CreateGroupLayer.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Parse a Tiled group layer and create a state object for inheriting.","kind":"function","name":"CreateGroupLayer","since":"3.21.0","params":[{"type":{"names":["object"]},"description":"The Tiled JSON object.","name":"json"},{"type":{"names":["object"]},"optional":true,"description":"The current group layer from the Tiled JSON file.","name":"currentl"},{"type":{"names":["object"]},"optional":true,"description":"The state of the parent group (if any).","name":"parentstate"}],"returns":[{"type":{"names":["object"]},"description":"A group state object with proper values for updating children layers."}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.CreateGroupLayer","scope":"static","___s":true},{"meta":{"range":[180,211],"filename":"ParseGID.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"FLIPPED_HORIZONTAL","longname":"FLIPPED_HORIZONTAL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseGID.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"See Tiled documentation on tile flipping:\nhttp://docs.mapeditor.org/en/latest/reference/tmx-map-format/","kind":"function","name":"ParseGID","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"gid"}],"returns":[{"type":{"names":["object"]},"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseGID","scope":"static","___s":true},{"meta":{"range":[180,240],"filename":"ParseImageLayers.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseImageLayers.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Parses a Tiled JSON object into an array of objects with details about the image layers.","kind":"function","name":"ParseImageLayers","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The Tiled JSON object.","name":"json"}],"returns":[{"type":{"names":["array"]},"description":"Array of objects that include critical info about the map's image layers"}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseImageLayers","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"ParseJSONTiled.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"Formats","longname":"Formats","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseJSONTiled.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Parses a Tiled JSON object into a new MapData object.","kind":"function","name":"ParseJSONTiled","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the tilemap, used to set the name on the MapData.","name":"name"},{"type":{"names":["object"]},"description":"The Tiled JSON object.","name":"json"},{"type":{"names":["boolean"]},"description":"Controls how empty tiles, tiles with an index of -1, in the map\ndata are handled. If `true`, empty locations will get a value of `null`. If `false`, empty\nlocation will get a Tile object with an index of -1. If you've a large sparsely populated map and\nthe tile data doesn't need to change then setting this value to `true` will help with memory\nconsumption. However if your map is small or you need to update the tiles dynamically, then leave\nthe default value set.","name":"insertNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.MapData"]},"nullable":true,"description":"The created MapData object, or `null` if the data can't be parsed."}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseJSONTiled","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"ParseObject.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"Pick","longname":"Pick","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseObject.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Convert a Tiled object to an internal parsed object normalising and copying properties over, while applying optional x and y offsets. The parsed object will always have the properties `id`, `name`, `type`, `rotation`, `properties`, `visible`, `x`, `y`, `width` and `height`. Other properties will be added according to the object type (such as text, polyline, gid etc.)","kind":"function","name":"ParseObject","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"Tiled object to convert to an internal parsed object normalising and copying properties over.","name":"tiledObject"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional additional offset to apply to the object's x property. Defaults to 0.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional additional offset to apply to the object's y property. Defaults to 0.","name":"offsetY"}],"returns":[{"type":{"names":["object"]},"description":"The parsed object containing properties read from the Tiled object according to it's type with x and y values updated according to the given offsets."}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseObject","scope":"static","___s":true},{"meta":{"range":[180,240],"filename":"ParseObjectLayers.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseObjectLayers.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Parses a Tiled JSON object into an array of ObjectLayer objects.","kind":"function","name":"ParseObjectLayers","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The Tiled JSON object.","name":"json"}],"returns":[{"type":{"names":["array"]},"description":"An array of all object layers in the tilemap as `ObjectLayer`s."}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseObjectLayers","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"ParseTileLayers.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"Base64Decode","longname":"Base64Decode","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseTileLayers.js","lineno":14,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Parses all tilemap layers in a Tiled JSON object into new LayerData objects.","kind":"function","name":"ParseTileLayers","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The Tiled JSON object.","name":"json"},{"type":{"names":["boolean"]},"description":"Controls how empty tiles, tiles with an index of -1, in the map\ndata are handled (see {@link Phaser.Tilemaps.Parsers.Tiled.ParseJSONTiled}).","name":"insertNull"}],"returns":[{"type":{"names":["Array."]},"description":"- An array of LayerData objects, one for each entry in\njson.layers with the type 'tilelayer'."}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseTileLayers","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"ParseTilesets.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"name":"Tileset","longname":"Tileset","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ParseTilesets.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"description":"Tilesets and Image Collections","kind":"function","name":"ParseTilesets","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"[description]","name":"json"}],"returns":[{"type":{"names":["object"]},"description":"[description]"}],"memberof":"Phaser.Tilemaps.Parsers.Tiled","longname":"Phaser.Tilemaps.Parsers.Tiled.ParseTilesets","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled"},"kind":"namespace","name":"Tiled","memberof":"Phaser.Tilemaps.Parsers","longname":"Phaser.Tilemaps.Parsers.Tiled","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"StaticTilemapLayer.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":16,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"classdesc":"A Static Tilemap Layer is a Game Object that renders LayerData from a Tilemap when used in combination\nwith one, or more, Tilesets.\n\nA Static Tilemap Layer is optimized for rendering speed over flexibility. You cannot apply per-tile\neffects like tint or alpha, or change the tiles or tilesets the layer uses.\n\nUse a Static Tilemap Layer instead of a Dynamic Tilemap Layer when you don't need tile manipulation features.","kind":"class","name":"StaticTilemapLayer","augments":["Phaser.GameObjects.GameObject","Phaser.GameObjects.Components.Alpha","Phaser.GameObjects.Components.BlendMode","Phaser.GameObjects.Components.ComputedSize","Phaser.GameObjects.Components.Depth","Phaser.GameObjects.Components.Flip","Phaser.GameObjects.Components.GetBounds","Phaser.GameObjects.Components.Origin","Phaser.GameObjects.Components.Pipeline","Phaser.GameObjects.Components.Transform","Phaser.GameObjects.Components.Visible","Phaser.GameObjects.Components.ScrollFactor"],"memberof":"Phaser.Tilemaps","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene to which this Game Object belongs.","name":"scene"},{"type":{"names":["Phaser.Tilemaps.Tilemap"]},"description":"The Tilemap this layer is a part of.","name":"tilemap"},{"type":{"names":["integer"]},"description":"The index of the LayerData associated with this layer.","name":"layerIndex"},{"type":{"names":["string","Array.","Phaser.Tilemaps.Tileset","Array."]},"description":"The tileset, or an array of tilesets, used to render this layer. Can be a string or a Tileset object.","name":"tileset"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world x position where the top left of this layer will be placed.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The world y position where the top left of this layer will be placed.","name":"y"}],"scope":"static","longname":"Phaser.Tilemaps.StaticTilemapLayer","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Used internally by physics system to perform fast type checks.","name":"isTilemap","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#isTilemap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"The Tilemap that this layer is a part of.","name":"tilemap","type":{"names":["Phaser.Tilemaps.Tilemap"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tilemap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"The index of the LayerData associated with this layer.","name":"layerIndex","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#layerIndex","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"The LayerData associated with this layer. LayerData can only be associated with one\ntilemap layer.","name":"layer","type":{"names":["Phaser.Tilemaps.LayerData"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#layer","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"The Tileset/s associated with this layer.\n\nAs of Phaser 3.14 this property is now an array of Tileset objects, previously it was a single reference.","name":"tileset","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tileset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Used internally by the Canvas renderer.\nThis holds the tiles that are visible within the camera in the last frame.","name":"culledTiles","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#culledTiles","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nYou can control if the Cameras should cull tiles before rendering them or not.\nBy default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.\n\nHowever, there are some instances when you may wish to disable this, and toggling this flag allows\nyou to do so. Also see `setSkipCull` for a chainable method that does the same thing.","name":"skipCull","type":{"names":["boolean"]},"since":"3.12.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#skipCull","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":153,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nThe total number of tiles drawn by the renderer in the last frame.\n\nThis only works when rending with Canvas.","name":"tilesDrawn","type":{"names":["integer"]},"readonly":true,"since":"3.12.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tilesDrawn","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":167,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nThe total number of tiles in this layer. Updated every frame.","name":"tilesTotal","type":{"names":["integer"]},"readonly":true,"since":"3.12.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tilesTotal","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":179,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nThe amount of extra tiles to add into the cull rectangle when calculating its horizontal size.\n\nSee the method `setCullPadding` for more details.","name":"cullPaddingX","type":{"names":["integer"]},"defaultvalue":"1","since":"3.12.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#cullPaddingX","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":193,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nThe amount of extra tiles to add into the cull rectangle when calculating its vertical size.\n\nSee the method `setCullPadding` for more details.","name":"cullPaddingY","type":{"names":["integer"]},"defaultvalue":"1","since":"3.12.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#cullPaddingY","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":207,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nThe callback that is invoked when the tiles are culled.\n\nBy default it will call `TilemapComponents.CullTiles` but you can override this to call any function you like.\n\nIt will be sent 3 arguments:\n\n1. The Phaser.Tilemaps.LayerData object for this Layer\n2. The Camera that is culling the layer. You can check its `dirty` property to see if it has changed since the last cull.\n3. A reference to the `culledTiles` array, which should be used to store the tiles you want rendered.\n\nSee the `TilemapComponents.CullTiles` source code for details on implementing your own culling system.","name":"cullCallback","type":{"names":["function"]},"since":"3.12.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#cullCallback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":343,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"An array holding the mapping between the tile indexes and the tileset they belong to.","name":"gidMap","type":{"names":["Array."]},"since":"3.14.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#gidMap","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":438,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Upload the tile data to a VBO.","kind":"function","name":"upload","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The camera to render to.","name":"camera"},{"type":{"names":["integer"]},"description":"The tileset index.","name":"tilesetIndex"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#upload","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":722,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets the rendering (draw) order of the tiles in this layer.\n\nThe default is 'right-down', meaning it will order the tiles starting from the top-left,\ndrawing to the right and then moving down to the next row.\n\nThe draw orders are:\n\n0 = right-down\n1 = left-down\n2 = right-up\n3 = left-up\n\nSetting the render order does not change the tiles or how they are stored in the layer,\nit purely impacts the order in which they are rendered.\n\nYou can provide either an integer (0 to 3), or the string version of the order.","kind":"function","name":"setRenderOrder","since":"3.12.0","params":[{"type":{"names":["integer","string"]},"description":"The render (draw) order value. Either an integer between 0 and 3, or a string: 'right-down', 'left-down', 'right-up' or 'left-up'.","name":"renderOrder"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setRenderOrder","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":769,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Calculates interesting faces at the given tile coordinates of the specified layer. Interesting\nfaces are used internally for optimizing collisions against tiles. This method is mostly used\ninternally to optimize recalculating faces when only one tile has been changed.","kind":"function","name":"calculateFacesAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The x coordinate.","name":"tileX"},{"type":{"names":["integer"]},"description":"The y coordinate.","name":"tileY"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#calculateFacesAt","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":789,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Calculates interesting faces within the rectangular area specified (in tile coordinates) of the\nlayer. Interesting faces are used internally for optimizing collisions against tiles. This method\nis mostly used internally.","kind":"function","name":"calculateFacesWithin","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The top most tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#calculateFacesWithin","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":811,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Creates a Sprite for every object matching the given tile indexes in the layer. You can\noptionally specify if each tile will be replaced with a new tile after the Sprite has been\ncreated. This is useful if you want to lay down special tiles in a level that are converted to\nSprites, but want to replace the tile itself with a floor tile or similar once converted.","kind":"function","name":"createFromTiles","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"The tile index, or array of indexes, to create Sprites from.","name":"indexes"},{"type":{"names":["integer","array"]},"description":"The tile index, or array of indexes, to change a converted\ntile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a\none-to-one mapping with the indexes array.","name":"replacements"},{"type":{"names":["Phaser.Types.GameObjects.Sprite.SpriteConfig"]},"description":"The config object to pass into the Sprite creator (i.e.\nscene.make.sprite).","name":"spriteConfig"},{"type":{"names":["Phaser.Scene"]},"optional":true,"defaultvalue":"scene the map is within","description":"The Scene to create the Sprites within.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when determining the world XY","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of the Sprites that were created."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#createFromTiles","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":836,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Returns the tiles in the given layer that are within the cameras viewport.\nThis is used internally.","kind":"function","name":"cull","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"description":"The Camera to run the cull check against.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#cull","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":852,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nYou can control if the Cameras should cull tiles before rendering them or not.\nBy default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.\n\nHowever, there are some instances when you may wish to disable this.","kind":"function","name":"setSkipCull","since":"3.12.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Set to `true` to stop culling tiles. Set to `false` to enable culling again.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setSkipCull","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":876,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Canvas only.\n\nWhen a Camera culls the tiles in this layer it does so using its view into the world, building up a\nrectangle inside which the tiles must exist or they will be culled. Sometimes you may need to expand the size\nof this 'cull rectangle', especially if you plan on rotating the Camera viewing the layer. Do so\nby providing the padding values. The values given are in tiles, not pixels. So if the tile width was 32px\nand you set `paddingX` to be 4, it would add 32px x 4 to the cull rectangle (adjusted for scale)","kind":"function","name":"setCullPadding","since":"3.12.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The amount of extra horizontal tiles to add to the cull check padding.","name":"paddingX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The amount of extra vertical tiles to add to the cull check padding.","name":"paddingY"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setCullPadding","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":904,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Searches the entire map layer for the first tile matching the given index, then returns that Tile\nobject. If no match is found, it returns null. The search starts from the top-left tile and\ncontinues horizontally until it hits the end of the row, then it drops down to the next column.\nIf the reverse boolean is true, it scans starting from the bottom-right corner traveling up to\nthe top-left.","kind":"function","name":"findByIndex","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The tile index value to search for.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The number of times to skip a matching tile before returning.","name":"skip"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true it will scan the layer in reverse, starting at the\nbottom-right. Otherwise it scans from the top-left.","name":"reverse"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"A Tile object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#findByIndex","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":926,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Find the first tile in the given rectangular area (in tile coordinates) of the layer that\nsatisfies the provided testing function. I.e. finds the first tile for which `callback` returns\ntrue. Similar to Array.prototype.find in vanilla JS.","kind":"function","name":"findTile","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"The callback. Each tile in the given area will be passed to this\ncallback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The left most tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The topmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"nullable":true}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#findTile","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":950,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\nfilter callback function. Any tiles that pass the filter test (i.e. where the callback returns\ntrue) will returned as a new array. Similar to Array.prototype.Filter in vanilla JS.","kind":"function","name":"filterTiles","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"The callback. Each tile in the given area will be passed to this\ncallback as the first and only parameter. The callback should return true for tiles that pass the\nfilter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The leftmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The topmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#filterTiles","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":975,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"For each tile in the given rectangular area (in tile coordinates) of the layer, run the given\ncallback. Similar to Array.prototype.forEach in vanilla JS.","kind":"function","name":"forEachTile","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"The callback. Each tile in the given area will be passed to this\ncallback as the first and only parameter.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback should be run.","name":"context"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The leftmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The topmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#forEachTile","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1000,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Gets a tile at the given tile coordinates from the given layer.","kind":"function","name":"getTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"X position to get the tile from (given in tile units, not pixels).","name":"tileX"},{"type":{"names":["integer"]},"description":"Y position to get the tile from (given in tile units, not pixels).","name":"tileY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true getTile won't return null for empty tiles, but a Tile\nobject with an index of -1.","name":"nonNull"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile at the given coordinates or null if no tile was found or the coordinates were invalid."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTileAt","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1018,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Gets a tile at the given world coordinates from the given layer.","kind":"function","name":"getTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"X position to get the tile from (given in pixels)","name":"worldX"},{"type":{"names":["number"]},"description":"Y position to get the tile from (given in pixels)","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, function won't return null for empty tiles, but a Tile\nobject with an index of -1.","name":"nonNull"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"The tile at the given coordinates or null if no tile was found or the coordinates\nwere invalid."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1038,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Gets the tiles in the given rectangular area (in tile coordinates) of the layer.","kind":"function","name":"getTilesWithin","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The leftmost tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The topmost tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max width based on tileX","description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"max height based on tileY","description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTilesWithin","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1057,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Gets the tiles in the given rectangular area (in world coordinates) of the layer.","kind":"function","name":"getTilesWithinWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The leftmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"worldX"},{"type":{"names":["number"]},"description":"The topmost tile index (in tile coordinates) to use as the origin of the area to filter.","name":"worldY"},{"type":{"names":["number"]},"description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["number"]},"description":"How many tiles high from the `tileY` index the area will be.","name":"height"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when factoring in which tiles to return.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTilesWithinWorldXY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1077,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Gets the tiles that overlap with the given shape in the given layer. The shape must be a Circle,\nLine, Rectangle or Triangle. The shape should be in world coordinates.","kind":"function","name":"getTilesWithinShape","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Circle","Phaser.Geom.Line","Phaser.Geom.Rectangle","Phaser.Geom.Triangle"]},"description":"A shape in world (pixel) coordinates","name":"shape"},{"type":{"names":["Phaser.Types.Tilemaps.FilteringOptions"]},"optional":true,"description":"Optional filters to apply when getting the tiles.","name":"filteringOptions"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tile objects."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTilesWithinShape","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1095,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns\nfalse if there is no tile or if the tile at that location has an index of -1.","kind":"function","name":"hasTileAt","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"X position to get the tile from in tile coordinates.","name":"tileX"},{"type":{"names":["integer"]},"description":"Y position to get the tile from in tile coordinates.","name":"tileY"}],"returns":[{"type":{"names":["boolean"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#hasTileAt","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1112,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns\nfalse if there is no tile or if the tile at that location has an index of -1.","kind":"function","name":"hasTileAtWorldXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate of the world position.","name":"worldX"},{"type":{"names":["number"]},"description":"The Y coordinate of the world position.","name":"worldY"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["boolean"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#hasTileAtWorldXY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1130,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Draws a debug representation of the layer to the given Graphics. This is helpful when you want to\nget a quick idea of which of your tiles are colliding and which have interesting faces. The tiles\nare drawn starting at (0, 0) in the Graphics, allowing you to place the debug representation\nwherever you want on the screen.","kind":"function","name":"renderDebug","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The target Graphics object to draw upon.","name":"graphics"},{"type":{"names":["Phaser.Types.Tilemaps.StyleConfig"]},"description":"An object specifying the colors to use for the debug drawing.","name":"styleConfig"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#renderDebug","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1151,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets collision on the given tile or tiles within a layer by index. You can pass in either a\nsingle numeric index or an array of indexes: [2, 3, 15, 20]. The `collides` parameter controls if\ncollision will be enabled (true) or disabled (false).","kind":"function","name":"setCollision","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"Either a single tile index, or an array of tile indexes.","name":"indexes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear\ncollision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the\nupdate.","name":"recalculateFaces"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true, updates the current tiles on the layer. Set to\nfalse if no tiles have been placed for significant performance boost.","name":"updateLayer"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setCollision","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1176,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets collision on a range of tiles in a layer whose index is between the specified `start` and\n`stop` (inclusive). Calling this with a start value of 10 and a stop value of 14 would set\ncollision for tiles 10, 11, 12, 13 and 14. The `collides` parameter controls if collision will be\nenabled (true) or disabled (false).","kind":"function","name":"setCollisionBetween","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The first index of the tile to be set for collision.","name":"start"},{"type":{"names":["integer"]},"description":"The last index of the tile to be set for collision.","name":"stop"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear\ncollision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the\nupdate.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setCollisionBetween","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets collision on the tiles within a layer by checking tile properties. If a tile has a property\nthat matches the given properties object, its collision flag will be set. The `collides`\nparameter controls if collision will be enabled (true) or disabled (false). Passing in\n`{ collides: true }` would update the collision flag on any tiles with a \"collides\" property that\nhas a value of true. Any tile that doesn't have \"collides\" set to true will be ignored. You can\nalso use an array of values, e.g. `{ types: [\"stone\", \"lava\", \"sand\" ] }`. If a tile has a\n\"types\" property that matches any of those values, its collision flag will be updated.","kind":"function","name":"setCollisionByProperty","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"An object with tile properties and corresponding values that should\nbe checked.","name":"properties"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear\ncollision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the\nupdate.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setCollisionByProperty","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets collision on all tiles in the given layer, except for tiles that have an index specified in\nthe given array. The `collides` parameter controls if collision will be enabled (true) or\ndisabled (false).","kind":"function","name":"setCollisionByExclusion","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of the tile indexes to not be counted for collision.","name":"indexes"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear\ncollision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the\nupdate.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setCollisionByExclusion","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets a global collision callback for the given tile index within the layer. This will affect all\ntiles on this layer that have the same index. If a callback is already set for the tile index it\nwill be replaced. Set the callback to null to remove it. If you want to set a callback for a tile\nat a specific location on the map then see setTileLocationCallback.","kind":"function","name":"setTileIndexCallback","since":"3.0.0","params":[{"type":{"names":["integer","array"]},"description":"Either a single tile index, or an array of tile indexes to have a\ncollision callback set for.","name":"indexes"},{"type":{"names":["function"]},"description":"The callback that will be invoked when the tile is collided with.","name":"callback"},{"type":{"names":["object"]},"description":"The context under which the callback is called.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setTileIndexCallback","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1275,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets collision on the tiles within a layer by checking each tiles collision group data\n(typically defined in Tiled within the tileset collision editor). If any objects are found within\na tiles collision group, the tile's colliding information will be set. The `collides` parameter\ncontrols if collision will be enabled (true) or disabled (false).","kind":"function","name":"setCollisionFromCollisionGroup","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"If true it will enable collision. If false it will clear\ncollision.","name":"collides"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to recalculate the tile faces after the\nupdate.","name":"recalculateFaces"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setCollisionFromCollisionGroup","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Sets a collision callback for the given rectangular area (in tile coordinates) within the layer.\nIf a callback is already set for the tile index it will be replaced. Set the callback to null to\nremove it.","kind":"function","name":"setTileLocationCallback","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The leftmost tile index (in tile coordinates) to use as the origin of the area.","name":"tileX"},{"type":{"names":["integer"]},"description":"The topmost tile index (in tile coordinates) to use as the origin of the area.","name":"tileY"},{"type":{"names":["integer"]},"description":"How many tiles wide from the `tileX` index the area will be.","name":"width"},{"type":{"names":["integer"]},"description":"How many tiles tall from the `tileY` index the area will be.","name":"height"},{"type":{"names":["function"]},"description":"The callback that will be invoked when the tile is collided with.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context under which the callback is called.","name":"callbackContext"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Tilemap Layer object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setTileLocationCallback","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1322,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Converts from tile X coordinates (tile units) to world X coordinates (pixels), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"tileToWorldX","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The X coordinate, in tile coordinates.","name":"tileX"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the world values from the tile index.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tileToWorldX","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1339,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Converts from tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"tileToWorldY","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The Y coordinate, in tile coordinates.","name":"tileY"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the world values from the tile index.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tileToWorldY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1356,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Converts from tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the\nlayers position, scale and scroll. This will return a new Vector2 object or update the given\n`point` object.","kind":"function","name":"tileToWorldXY","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The X coordinate, in tile coordinates.","name":"tileX"},{"type":{"names":["integer"]},"description":"The Y coordinate, in tile coordinates.","name":"tileY"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the coordinates in. If not given, a new Vector2 is created.","name":"point"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the world values from the tile index.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tileToWorldXY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1376,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Converts from world X coordinates (pixels) to tile X coordinates (tile units), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"worldToTileX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate, in world pixels.","name":"worldX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the\nnearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.]","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#worldToTileX","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1395,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Converts from world Y coordinates (pixels) to tile Y coordinates (tile units), factoring in the\nlayers position, scale and scroll.","kind":"function","name":"worldToTileY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The Y coordinate, in world pixels.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the\nnearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["number"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#worldToTileY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1414,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Converts from world XY coordinates (pixels) to tile XY coordinates (tile units), factoring in the\nlayers position, scale and scroll. This will return a new Vector2 object or update the given\n`point` object.","kind":"function","name":"worldToTileXY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The X coordinate, in world pixels.","name":"worldX"},{"type":{"names":["number"]},"description":"The Y coordinate, in world pixels.","name":"worldY"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether or not to round the tile coordinate down to the\nnearest integer.","name":"snapToFloor"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the coordinates in. If not given, a new Vector2 is created.","name":"point"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"optional":true,"defaultvalue":"main camera","description":"The Camera to use when calculating the tile index from the world values.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#worldToTileXY","scope":"instance","___s":true},{"meta":{"filename":"StaticTilemapLayer.js","lineno":1436,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"description":"Destroys this StaticTilemapLayer and removes its link to the associated LayerData.","kind":"function","name":"destroy","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Remove this layer from the parent Tilemap?","name":"removeFromTilemap"}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#destroy","scope":"instance","overrides":"Phaser.GameObjects.GameObject#destroy","___s":true},{"meta":{"range":[180,221],"filename":"StaticTilemapLayerRender.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer"},"name":"renderWebGL","longname":"renderWebGL","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FilteringOptions.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"FilteringOptions","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, only return tiles that don't have -1 for an index.","name":"isNotEmpty"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, only return tiles that collide on at least one side.","name":"isColliding"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, only return tiles that have at least one interesting face.","name":"hasInterestingFace"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.FilteringOptions","scope":"static","___s":true},{"meta":{"filename":"GetTilesWithinFilteringOptions.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"GetTilesWithinFilteringOptions","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, only return tiles that don't have -1 for an index.","name":"isNotEmpty"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, only return tiles that collide on at least one side.","name":"isColliding"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If true, only return tiles that have at least one interesting face.","name":"hasInterestingFace"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.GetTilesWithinFilteringOptions","scope":"static","___s":true},{"meta":{"filename":"MapDataConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"MapDataConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"The key in the Phaser cache that corresponds to the loaded tilemap data.","name":"name"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The width of the entire tilemap.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The height of the entire tilemap.","name":"height"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The width of the tiles.","name":"tileWidth"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The height of the tiles.","name":"tileHeight"},{"type":{"names":["number"]},"optional":true,"description":"The width in pixels of the entire tilemap.","name":"widthInPixels"},{"type":{"names":["number"]},"optional":true,"description":"The height in pixels of the entire tilemap.","name":"heightInPixels"},{"type":{"names":["integer"]},"optional":true,"description":"The format of the Tilemap, as defined in Tiled.","name":"format"},{"type":{"names":["string"]},"optional":true,"description":"The orientation of the map data (i.e. orthogonal, isometric, hexagonal), default 'orthogonal'.","name":"orientation"},{"type":{"names":["string"]},"optional":true,"description":"Determines the draw order of tilemap. Default is right-down.","name":"renderOrder"},{"type":{"names":["number"]},"optional":true,"description":"The version of Tiled the map uses.","name":"version"},{"type":{"names":["number"]},"optional":true,"description":"Map specific properties (can be specified in Tiled).","name":"properties"},{"type":{"names":["Array."]},"optional":true,"description":"The layers of the tilemap.","name":"layers"},{"type":{"names":["array"]},"optional":true,"description":"An array with all the layers configured to the MapData.","name":"images"},{"type":{"names":["object"]},"optional":true,"description":"An array of Tiled Image Layers.","name":"objects"},{"type":{"names":["object"]},"optional":true,"description":"An object of Tiled Object Layers.","name":"collision"},{"type":{"names":["Array."]},"optional":true,"description":"The tilesets the map uses.","name":"tilesets"},{"type":{"names":["array"]},"optional":true,"description":"The collection of images the map uses(specified in Tiled).","name":"imageCollections"},{"type":{"names":["array"]},"optional":true,"description":"[description]","name":"tiles"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.MapDataConfig","scope":"static","___s":true},{"meta":{"filename":"ObjectLayerConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"ObjectLayerConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"'object layer'","description":"The name of the Object Layer.","name":"name"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The opacity of the layer, between 0 and 1.","name":"opacity"},{"type":{"names":["any"]},"optional":true,"description":"The custom properties defined on the Object Layer, keyed by their name.","name":"properties"},{"type":{"names":["any"]},"optional":true,"description":"The type of each custom property defined on the Object Layer, keyed by its name.","name":"propertytypes"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'objectgroup'","description":"The type of the layer, which should be `objectgroup`.","name":"type"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether the layer is shown (`true`) or hidden (`false`).","name":"visible"},{"type":{"names":["Array."]},"optional":true,"description":"An array of all objects on this Object Layer.","name":"objects"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.ObjectLayerConfig","scope":"static","___s":true},{"meta":{"filename":"StyleConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"StyleConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["Phaser.Display.Color","number","null"]},"optional":true,"nullable":true,"defaultvalue":"blue","description":"Color to use for drawing a filled rectangle at non-colliding tile locations. If set to null, non-colliding tiles will not be drawn.","name":"tileColor"},{"type":{"names":["Phaser.Display.Color","number","null"]},"optional":true,"nullable":true,"defaultvalue":"orange","description":"Color to use for drawing a filled rectangle at colliding tile locations. If set to null, colliding tiles will not be drawn.","name":"collidingTileColor"},{"type":{"names":["Phaser.Display.Color","number","null"]},"optional":true,"nullable":true,"defaultvalue":"grey","description":"Color to use for drawing a line at interesting tile faces. If set to null, interesting tile faces will not be drawn.","name":"faceColor"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.StyleConfig","scope":"static","___s":true},{"meta":{"filename":"TiledObject.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"TiledObject","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["integer"]},"description":"The unique object ID.","name":"id"},{"type":{"names":["string"]},"description":"The name this object was assigned in Tiled.","name":"name"},{"type":{"names":["string"]},"description":"The type, as assigned in Tiled.","name":"type"},{"type":{"names":["boolean"]},"optional":true,"description":"The visible state of this object.","name":"visible"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of this object, in pixels, relative to the tilemap.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of this object, in pixels, relative to the tilemap.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of this object, in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of this object, in pixels.","name":"height"},{"type":{"names":["number"]},"optional":true,"description":"The rotation of the object in clockwise degrees.","name":"rotation"},{"type":{"names":["any"]},"optional":true,"description":"Custom properties object.","name":"properties"},{"type":{"names":["integer"]},"optional":true,"description":"Only set if of type 'tile'.","name":"gid"},{"type":{"names":["boolean"]},"optional":true,"description":"Only set if a tile object. The horizontal flip value.","name":"flippedHorizontal"},{"type":{"names":["boolean"]},"optional":true,"description":"Only set if a tile object. The vertical flip value.","name":"flippedVertical"},{"type":{"names":["boolean"]},"optional":true,"description":"Only set if a tile object. The diagonal flip value.","name":"flippedAntiDiagonal"},{"type":{"names":["Array."]},"optional":true,"description":"Only set if a polyline object. An array of objects corresponding to points, where each point has an `x` property and a `y` property.","name":"polyline"},{"type":{"names":["Array."]},"optional":true,"description":"Only set if a polygon object. An array of objects corresponding to points, where each point has an `x` property and a `y` property.","name":"polygon"},{"type":{"names":["any"]},"optional":true,"description":"Only set if a text object. Contains the text objects properties.","name":"text"},{"type":{"names":["boolean"]},"optional":true,"description":"Only set, and set to `true`, if a rectangle object.","name":"rectangle"},{"type":{"names":["boolean"]},"optional":true,"description":"Only set, and set to `true`, if a ellipse object.","name":"ellipse"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.TiledObject","scope":"static","___s":true},{"meta":{"filename":"TilemapConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"typedef","name":"TilemapConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["string"]},"optional":true,"description":"The key in the Phaser cache that corresponds to the loaded tilemap data.","name":"key"},{"type":{"names":["Array.>"]},"optional":true,"description":"Instead of loading from the cache, you can also load directly from a 2D array of tile indexes.","name":"data"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The width of a tile in pixels.","name":"tileWidth"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The height of a tile in pixels.","name":"tileHeight"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The width of the map in tiles.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The height of the map in tiles.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Controls how empty tiles, tiles with an index of -1,\nin the map data are handled. If `true`, empty locations will get a value of `null`. If `false`,\nempty location will get a Tile object with an index of -1. If you've a large sparsely populated\nmap and the tile data doesn't need to change then setting this value to `true` will help with\nmemory consumption. However if your map is small or you need to update the tiles dynamically,\nthen leave the default value set.","name":"insertNull"}],"memberof":"Phaser.Types.Tilemaps","longname":"Phaser.Types.Tilemaps.TilemapConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs"},"kind":"namespace","name":"Tilemaps","memberof":"Phaser.Types","longname":"Phaser.Types.Tilemaps","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Clock.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Clock.js","lineno":12,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"classdesc":"The Clock is a Scene plugin which creates and updates Timer Events for its Scene.","kind":"class","name":"Clock","memberof":"Phaser.Time","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene which owns this Clock.","name":"scene"}],"scope":"static","longname":"Phaser.Time.Clock","___s":true},{"meta":{"filename":"Clock.js","lineno":29,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The Scene which owns this Clock.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Clock.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The Scene Systems object of the Scene which owns this Clock.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Clock.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The current time of the Clock, in milliseconds.\n\nIf accessed externally, this is equivalent to the `time` parameter normally passed to a Scene's `update` method.","name":"now","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#now","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Clock.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The scale of the Clock's time delta.\n\nThe time delta is the time elapsed between two consecutive frames and influences the speed of time for this Clock and anything which uses it, such as its Timer Events. Values higher than 1 increase the speed of time, while values smaller than 1 decrease it. A value of 0 freezes time and is effectively equivalent to pausing the Clock.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Clock.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Whether the Clock is paused (`true`) or active (`false`).\n\nWhen paused, the Clock will not update any of its Timer Events, thus freezing time.","name":"paused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#paused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Clock.js","lineno":156,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Creates a Timer Event and adds it to the Clock at the start of the frame.","kind":"function","name":"addEvent","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Time.TimerEventConfig"]},"description":"The configuration for the Timer Event.","name":"config"}],"returns":[{"type":{"names":["Phaser.Time.TimerEvent"]},"description":"The Timer Event which was created."}],"memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#addEvent","scope":"instance","___s":true},{"meta":{"filename":"Clock.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Creates a Timer Event and adds it to the Clock at the start of the frame.\n\nThis is a shortcut for {@link #addEvent} which can be shorter and is compatible with the syntax of the GreenSock Animation Platform (GSAP).","kind":"function","name":"delayedCall","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The delay of the function call, in milliseconds.","name":"delay"},{"type":{"names":["function"]},"description":"The function to call after the delay expires.","name":"callback"},{"type":{"names":["Array.<*>"]},"optional":true,"description":"The arguments to call the function with.","name":"args"},{"type":{"names":["*"]},"optional":true,"description":"The scope (`this` object) to call the function with.","name":"callbackScope"}],"returns":[{"type":{"names":["Phaser.Time.TimerEvent"]},"description":"The Timer Event which was created."}],"memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#delayedCall","scope":"instance","___s":true},{"meta":{"filename":"Clock.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Clears and recreates the array of pending Timer Events.","kind":"function","name":"clearPendingEvents","since":"3.0.0","returns":[{"type":{"names":["Phaser.Time.Clock"]},"description":"This Clock object."}],"memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#clearPendingEvents","scope":"instance","___s":true},{"meta":{"filename":"Clock.js","lineno":210,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Schedules all active Timer Events for removal at the start of the frame.","kind":"function","name":"removeAllEvents","since":"3.0.0","returns":[{"type":{"names":["Phaser.Time.Clock"]},"description":"This Clock object."}],"memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#removeAllEvents","scope":"instance","___s":true},{"meta":{"filename":"Clock.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Updates the arrays of active and pending Timer Events. Called at the start of the frame.","kind":"function","name":"preUpdate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#preUpdate","scope":"instance","___s":true},{"meta":{"filename":"Clock.js","lineno":276,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Updates the Clock's internal time and all of its Timer Events.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"time"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Time.Clock","longname":"Phaser.Time.Clock#update","scope":"instance","___s":true},{"meta":{"range":[180,213],"filename":"TimerEvent.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TimerEvent.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"classdesc":"A Timer Event represents a delayed function call. It's managed by a Scene's {@link Clock} and will call its function after a set amount of time has passed. The Timer Event can optionally repeat - i.e. call its function multiple times before finishing, or loop indefinitely.\n\nBecause it's managed by a Clock, a Timer Event is based on game time, will be affected by its Clock's time scale, and will pause if its Clock pauses.","kind":"class","name":"TimerEvent","memberof":"Phaser.Time","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Time.TimerEventConfig"]},"description":"The configuration for the Timer Event, including its delay and callback.","name":"config"}],"scope":"static","longname":"Phaser.Time.TimerEvent","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":29,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The delay in ms at which this TimerEvent fires.","name":"delay","type":{"names":["number"]},"defaultvalue":"0","readonly":true,"since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#delay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The total number of times this TimerEvent will repeat before finishing.","name":"repeat","type":{"names":["number"]},"defaultvalue":"0","readonly":true,"since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#repeat","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"If repeating this contains the current repeat count.","name":"repeatCount","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#repeatCount","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":61,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"True if this TimerEvent loops, otherwise false.","name":"loop","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#loop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The callback that will be called when the TimerEvent occurs.","name":"callback","type":{"names":["function"]},"since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#callback","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":81,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The scope in which the callback will be called.","name":"callbackScope","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#callbackScope","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":90,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Additional arguments to be passed to the callback.","name":"args","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#args","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":99,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Scale the time causing this TimerEvent to update.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":109,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Start this many MS into the elapsed (useful if you want a long duration with repeat, but for the first loop to fire quickly)","name":"startAt","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#startAt","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"The time in milliseconds which has elapsed since the Timer Event's creation.\n\nThis value is local for the Timer Event and is relative to its Clock. As such, it's influenced by the Clock's time scale and paused state, the Timer Event's initial {@link #startAt} property, and the Timer Event's {@link #timeScale} and {@link #paused} state.","name":"elapsed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#elapsed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":131,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Whether or not this timer is paused.","name":"paused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#paused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Whether the Timer Event's function has been called.\n\nWhen the Timer Event fires, this property will be set to `true` before the callback function is invoked and will be reset immediately afterward if the Timer Event should repeat. The value of this property does not directly influence whether the Timer Event will be removed from its Clock, but can prevent it from firing.","name":"hasDispatched","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#hasDispatched","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":156,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Completely reinitializes the Timer Event, regardless of its current state, according to a configuration object.","kind":"function","name":"reset","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Time.TimerEventConfig"]},"description":"The new state for the Timer Event.","name":"config"}],"returns":[{"type":{"names":["Phaser.Time.TimerEvent"]},"description":"This TimerEvent object."}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#reset","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":194,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Gets the progress of the current iteration, not factoring in repeats.","kind":"function","name":"getProgress","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"A number between 0 and 1 representing the current progress."}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#getProgress","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":207,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Gets the progress of the timer overall, factoring in repeats.","kind":"function","name":"getOverallProgress","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The overall progress of the Timer Event, between 0 and 1."}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#getOverallProgress","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":230,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Returns the number of times this Timer Event will repeat before finishing.\n\nThis should not be confused with the number of times the Timer Event will fire before finishing. A return value of 0 doesn't indicate that the Timer Event has finished running - it indicates that it will not repeat after the next time it fires.","kind":"function","name":"getRepeatCount","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"How many times the Timer Event will repeat."}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#getRepeatCount","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Returns the local elapsed time for the current iteration of the Timer Event.","kind":"function","name":"getElapsed","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The local elapsed time in milliseconds."}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#getElapsed","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Returns the local elapsed time for the current iteration of the Timer Event in seconds.","kind":"function","name":"getElapsedSeconds","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The local elapsed time in seconds."}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#getElapsedSeconds","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":271,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Forces the Timer Event to immediately expire, thus scheduling its removal in the next frame.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true`, the function of the Timer Event will be called before its removal.","name":"dispatchCallback"}],"memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#remove","scope":"instance","___s":true},{"meta":{"filename":"TimerEvent.js","lineno":290,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"description":"Destroys all object references in the Timer Event, i.e. its callback, scope, and arguments.\n\nNormally, this method is only called by the Clock when it shuts down. As such, it doesn't stop the Timer Event. If called manually, the Timer Event will still be updated by the Clock, but it won't do anything when it fires.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Time.TimerEvent","longname":"Phaser.Time.TimerEvent#destroy","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/time"},"kind":"namespace","name":"Time","memberof":"Phaser","longname":"Phaser.Time","scope":"static","___s":true},{"meta":{"filename":"TimerEventConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/time/typedefs"},"kind":"typedef","name":"TimerEventConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The delay after which the Timer Event should fire, in milliseconds.","name":"delay"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The total number of times the Timer Event will repeat before finishing.","name":"repeat"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"`true` if the Timer Event should repeat indefinitely.","name":"loop"},{"type":{"names":["function"]},"optional":true,"description":"The callback which will be called when the Timer Event fires.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"The scope (`this` object) with which to invoke the `callback`.","name":"callbackScope"},{"type":{"names":["Array.<*>"]},"optional":true,"description":"Additional arguments to be passed to the `callback`.","name":"args"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The scale of the elapsed time.","name":"timeScale"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The initial elapsed time in milliseconds. Useful if you want a long duration with repeat, but for the first loop to fire quickly.","name":"startAt"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"`true` if the Timer Event should be paused.","name":"paused"}],"memberof":"Phaser.Types.Time","longname":"Phaser.Types.Time.TimerEventConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/time/typedefs"},"kind":"namespace","name":"Time","memberof":"Phaser.Types","longname":"Phaser.Types.Time","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"Timeline.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Timeline.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"classdesc":"A Timeline combines multiple Tweens into one. Its overall behavior is otherwise similar to a single Tween.\n\nThe Timeline updates all of its Tweens simultaneously. Its methods allow you to easily build a sequence\nof Tweens (each one starting after the previous one) or run multiple Tweens at once during given parts of the Timeline.","kind":"class","name":"Timeline","memberof":"Phaser.Tweens","augments":["Phaser.Events.EventEmitter"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"The Tween Manager which owns this Timeline.","name":"manager"}],"scope":"static","longname":"Phaser.Tweens.Timeline","___s":true},{"meta":{"filename":"Timeline.js","lineno":38,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The Tween Manager which owns this Timeline.","name":"manager","type":{"names":["Phaser.Tweens.TweenManager"]},"since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#manager","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":47,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"A constant value which allows this Timeline to be easily identified as one.","name":"isTimeline","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#isTimeline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":57,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"An array of Tween objects, each containing a unique property and target being tweened.","name":"data","type":{"names":["array"]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":67,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The cached size of the data array.","name":"totalData","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#totalData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"If true then duration, delay, etc values are all frame totals, rather than ms.","name":"useFrames","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#useFrames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Scales the time applied to this Timeline. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.\nValue isn't used when calculating total duration of the Timeline, it's a run-time delta adjustment only.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Loop this Timeline? Can be -1 for an infinite loop, or an integer.\nWhen enabled it will play through ALL Tweens again (use Tween.repeat to loop a single tween)","name":"loop","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#loop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":109,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Time in ms/frames before this Timeline loops.","name":"loopDelay","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#loopDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"How many loops are left to run?","name":"loopCounter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#loopCounter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Time in ms/frames before the 'onComplete' event fires. This never fires if loop = true (as it never completes)","name":"completeDelay","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#completeDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":139,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Countdown timer value, as used by `loopDelay` and `completeDelay`.","name":"countdown","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#countdown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":149,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The current state of the Timeline.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#state","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Does the Timeline start off paused? (if so it needs to be started with Timeline.play)","name":"paused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#paused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Elapsed time in ms/frames of this run through of the Timeline.","name":"elapsed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#elapsed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":188,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Total elapsed time in ms/frames of the entire Timeline, including looping.","name":"totalElapsed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#totalElapsed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":198,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Time in ms/frames for the whole Timeline to play through once, excluding loop amounts and loop delays.","name":"duration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":208,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Value between 0 and 1. The amount of progress through the Timeline, _excluding loops_.","name":"progress","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":218,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Time in ms/frames for all Tweens in this Timeline to complete (including looping)","name":"totalDuration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#totalDuration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":228,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Value between 0 and 1. The amount through the entire Timeline, including looping.","name":"totalProgress","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#totalProgress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":238,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"An object containing the different Tween callback functions.\n\nYou can either set these in the Tween config, or by calling the `Tween.setCallback` method.\n\n`onComplete` When the Timeline finishes playback fully or `Timeline.stop` is called. Never invoked if timeline is set to repeat infinitely.\n`onLoop` When a Timeline loops.\n`onStart` When the Timeline starts playing.\n`onUpdate` When a Timeline updates a child Tween.\n`onYoyo` When a Timeline starts a yoyo.","name":"callbacks","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#callbacks","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":261,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The context in which all callbacks are invoked.","name":"callbackScope","type":{"names":["any"]},"since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#callbackScope","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Timeline.js","lineno":271,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Internal method that will emit a Timeline based Event and invoke the given callback.","kind":"function","name":"dispatchTimelineEvent","since":"3.19.0","params":[{"type":{"names":["Phaser.Types.Tweens.Event"]},"description":"The Event to be dispatched.","name":"event"},{"type":{"names":["function"]},"description":"The callback to be invoked. Can be `null` or `undefined` to skip invocation.","name":"callback"}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#dispatchTimelineEvent","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":290,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Sets the value of the time scale applied to this Timeline. A value of 1 runs in real-time.\nA value of 0.5 runs 50% slower, and so on.\n\nThe value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.","kind":"function","name":"setTimeScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The time scale value to set.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"This Timeline object."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#setTimeScale","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Gets the value of the time scale applied to this Timeline. A value of 1 runs in real-time.\nA value of 0.5 runs 50% slower, and so on.","kind":"function","name":"getTimeScale","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The value of the time scale applied to this Timeline."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#getTimeScale","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":324,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Check whether or not the Timeline is playing.","kind":"function","name":"isPlaying","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if this Timeline is active, otherwise `false`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#isPlaying","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Creates a new Tween, based on the given Tween Config, and adds it to this Timeline.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig","object"]},"description":"The configuration object for the Tween.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"This Timeline object."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#add","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":352,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Adds an existing Tween to this Timeline.","kind":"function","name":"queue","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to be added to this Timeline.","name":"tween"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"This Timeline object."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#queue","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":377,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Checks whether a Tween has an offset value.","kind":"function","name":"hasOffset","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to check.","name":"tween"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the tween has a non-null offset."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#hasOffset","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Checks whether the offset value is a number or a directive that is relative to previous tweens.","kind":"function","name":"isOffsetAbsolute","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The offset value to be evaluated.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the result is a number, `false` if it is a directive like \" -= 1000\"."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#isOffsetAbsolute","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":407,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Checks if the offset is a relative value rather than an absolute one.\nIf the value is just a number, this returns false.","kind":"function","name":"isOffsetRelative","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The offset value to be evaluated.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the value is relative, i.e \" -= 1000\". If `false`, the offset is absolute."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#isOffsetRelative","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":435,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Parses the relative offset value, returning a positive or negative number.","kind":"function","name":"getRelativeOffset","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The relative offset, in the format of '-=500', for example. The first character determines whether it will be a positive or negative number. Spacing matters here.","name":"value"},{"type":{"names":["number"]},"description":"The value to use as the offset.","name":"base"}],"returns":[{"type":{"names":["number"]},"description":"The parsed offset value."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#getRelativeOffset","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":467,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Calculates the total duration of the timeline.\n\nComputes all tween durations and returns the full duration of the timeline.\n\nThe resulting number is stored in the timeline, not as a return value.","kind":"function","name":"calcDuration","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#calcDuration","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":534,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Initializes the timeline, which means all Tweens get their init() called, and the total duration will be computed.\nReturns a boolean indicating whether the timeline is auto-started or not.","kind":"function","name":"init","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Timeline is started. `false` if it is paused."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#init","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":562,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Resets all of the timeline's tweens back to their initial states.\nThe boolean parameter indicates whether tweens that are looping should reset as well, or not.","kind":"function","name":"resetTweens","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"If `true`, resets all looping tweens to their initial values.","name":"resetFromLoop"}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#resetTweens","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":581,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Sets a callback for the Timeline.","kind":"function","name":"setCallback","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The internal type of callback to set.","name":"type"},{"type":{"names":["function"]},"description":"Timeline allows multiple tweens to be linked together to create a streaming sequence.","name":"callback"},{"type":{"names":["array"]},"optional":true,"description":"The parameters to pass to the callback.","name":"params"},{"type":{"names":["object"]},"optional":true,"description":"The context scope of the callback.","name":"scope"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"This Timeline object."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#setCallback","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":604,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Passed a Tween to the Tween Manager and requests it be made active.","kind":"function","name":"makeActive","since":"3.3.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween object to make active.","name":"tween"}],"returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"The Timeline's Tween Manager reference."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#makeActive","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":619,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Starts playing the Timeline.","kind":"function","name":"play","fires":["Phaser.Tweens.Events#event:TIMELINE_START"],"since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#play","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":651,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Updates the Timeline's `state` and fires callbacks and events.","kind":"function","name":"nextState","fires":["Phaser.Tweens.Events#event:TIMELINE_COMPLETE","Phaser.Tweens.Events#event:TIMELINE_LOOP"],"since":"3.0.0","see":["Phaser.Tweens.Timeline#update"],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#nextState","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":700,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Returns 'true' if this Timeline has finished and should be removed from the Tween Manager.\nOtherwise, returns false.","kind":"function","name":"update","fires":["Phaser.Tweens.Events#event:TIMELINE_COMPLETE","Phaser.Tweens.Events#event:TIMELINE_UPDATE"],"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"timestamp"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if this Timeline has finished and should be removed from the Tween Manager."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#update","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":790,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Stops the Timeline immediately, whatever stage of progress it is at and flags it for removal by the TweenManager.","kind":"function","name":"stop","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#stop","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":801,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Pauses the Timeline, retaining its internal state.\n\nCalling this on a Timeline that is already paused has no effect and fires no event.","kind":"function","name":"pause","fires":["Phaser.Tweens.Events#event:TIMELINE_PAUSE"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"This Timeline object."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#pause","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":830,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Resumes a paused Timeline from where it was when it was paused.\n\nCalling this on a Timeline that isn't paused has no effect and fires no event.","kind":"function","name":"resume","fires":["Phaser.Tweens.Events#event:TIMELINE_RESUME"],"since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"This Timeline object."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#resume","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":855,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Checks if any of the Tweens in this Timeline as operating on the target object.\n\nReturns `false` if no Tweens operate on the target object.","kind":"function","name":"hasTarget","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The target to check all Tweens against.","name":"target"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if there is at least a single Tween that operates on the target object, otherwise `false`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#hasTarget","scope":"instance","___s":true},{"meta":{"filename":"Timeline.js","lineno":880,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Stops all the Tweens in the Timeline immediately, whatever stage of progress they are at and flags\nthem for removal by the TweenManager.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"range":[180,226],"filename":"TweenManager.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"name":"ArrayRemove","longname":"ArrayRemove","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TweenManager.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"classdesc":"The Tween Manager is a default Scene Plugin which controls and updates Tweens and Timelines.","kind":"class","name":"TweenManager","memberof":"Phaser.Tweens","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene which owns this Tween Manager.","name":"scene"}],"scope":"static","longname":"Phaser.Tweens.TweenManager","___s":true},{"meta":{"filename":"TweenManager.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The Scene which owns this Tween Manager.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#scene","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TweenManager.js","lineno":43,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The Systems object of the Scene which owns this Tween Manager.","name":"systems","type":{"names":["Phaser.Scenes.Systems"]},"since":"3.0.0","memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#systems","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TweenManager.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The time scale of the Tween Manager.\n\nThis value scales the time delta between two frames, thus influencing the speed of time for all Tweens owned by this Tween Manager.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"TweenManager.js","lineno":152,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Create a Tween Timeline and return it, but do NOT add it to the active or pending Tween lists.","kind":"function","name":"createTimeline","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TimelineBuilderConfig"]},"optional":true,"description":"The configuration object for the Timeline and its Tweens.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The created Timeline object."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#createTimeline","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Create a Tween Timeline and add it to the active Tween list/","kind":"function","name":"timeline","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TimelineBuilderConfig"]},"optional":true,"description":"The configuration object for the Timeline and its Tweens.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The created Timeline object."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#timeline","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":191,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Create a Tween and return it, but do NOT add it to the active or pending Tween lists.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig","object"]},"description":"The configuration object for the Tween.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The created Tween object."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#create","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Create a Tween and add it to the active Tween list.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig","object"]},"description":"The configuration object for the Tween.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The created Tween."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#add","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Add an existing tween into the active Tween list.","kind":"function","name":"existing","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to add.","name":"tween"}],"returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager object."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#existing","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":246,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Create a Number Tween and add it to the active Tween list.","kind":"function","name":"addCounter","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.NumberTweenBuilderConfig"]},"description":"The configuration object for the Number Tween.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The created Number Tween."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#addCounter","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":267,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Creates a Stagger function to be used by a Tween property.\n\nThe stagger function will allow you to stagger changes to the value of the property across all targets of the tween.\n\nThis is only worth using if the tween has multiple targets.\n\nThe following will stagger the delay by 100ms across all targets of the tween, causing them to scale down to 0.2\nover the duration specified:\n\n```javascript\nthis.tweens.add({\n targets: [ ... ],\n scale: 0.2,\n ease: 'linear',\n duration: 1000,\n delay: this.tweens.stagger(100)\n});\n```\n\nThe following will stagger the delay by 500ms across all targets of the tween using a 10 x 6 grid, staggering\nfrom the center out, using a cubic ease.\n\n```javascript\nthis.tweens.add({\n targets: [ ... ],\n scale: 0.2,\n ease: 'linear',\n duration: 1000,\n delay: this.tweens.stagger(500, { grid: [ 10, 6 ], from: 'center', ease: 'cubic.out' })\n});\n```","kind":"function","name":"stagger","since":"3.19.0","params":[{"type":{"names":["number","Array."]},"description":"The amount to stagger by, or an array containing two elements representing the min and max values to stagger between.","name":"value"},{"type":{"names":["Phaser.Types.Tweens.StaggerConfig"]},"description":"The configuration object for the Stagger function.","name":"config"}],"returns":[{"type":{"names":["function"]},"description":"The stagger function."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#stagger","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":313,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Updates the Tween Manager's internal lists at the start of the frame.\n\nThis method will return immediately if no changes have been indicated.","kind":"function","name":"preUpdate","since":"3.0.0","memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#preUpdate","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":393,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Updates all Tweens and Timelines of the Tween Manager.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time in milliseconds.","name":"timestamp"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#update","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Removes the given tween from the Tween Manager, regardless of its state (pending or active).","kind":"function","name":"remove","since":"3.17.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to be removed.","name":"tween"}],"returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager object."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#remove","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":447,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Checks if a Tween or Timeline is active and adds it to the Tween Manager at the start of the frame if it isn't.","kind":"function","name":"makeActive","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to check.","name":"tween"}],"returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager object."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#makeActive","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":480,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Passes all Tweens to the given callback.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["function"]},"description":"The function to call.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The scope (`this` object) to call the function with.","name":"scope"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"The arguments to pass into the function. Its first argument will always be the Tween currently being iterated.","name":"args"}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#each","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":507,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Returns an array of all active Tweens and Timelines in the Tween Manager.","kind":"function","name":"getAllTweens","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"A new array containing references to all active Tweens and Timelines."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#getAllTweens","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":528,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Returns the scale of the time delta for all Tweens and Timelines owned by this Tween Manager.","kind":"function","name":"getGlobalTimeScale","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The scale of the time delta, usually 1."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#getGlobalTimeScale","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Returns an array of all Tweens or Timelines in the Tween Manager which affect the given target or array of targets.","kind":"function","name":"getTweensOf","since":"3.0.0","params":[{"type":{"names":["object","array"]},"description":"The target to look for. Provide an array to look for multiple targets.","name":"target"}],"returns":[{"type":{"names":["Array."]},"description":"A new array containing all Tweens and Timelines which affect the given target(s)."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#getTweensOf","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":589,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Checks if the given object is being affected by a playing Tween.","kind":"function","name":"isTweening","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"target Phaser.Tweens.Tween object","name":"target"}],"returns":[{"type":{"names":["boolean"]},"description":"returns if target tween object is active or not"}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#isTweening","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":617,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Stops all Tweens in this Tween Manager. They will be removed at the start of the frame.","kind":"function","name":"killAll","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#killAll","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":637,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Stops all Tweens which affect the given target or array of targets. The Tweens will be removed from the Tween Manager at the start of the frame.","see":["{@link #getTweensOf}"],"kind":"function","name":"killTweensOf","since":"3.0.0","params":[{"type":{"names":["object","array"]},"description":"The target to look for. Provide an array to look for multiple targets.","name":"target"}],"returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#killTweensOf","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":661,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Pauses all Tweens in this Tween Manager.","kind":"function","name":"pauseAll","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#pauseAll","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":681,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Resumes all Tweens in this Tween Manager.","kind":"function","name":"resumeAll","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#resumeAll","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":701,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"Sets a new scale of the time delta for this Tween Manager.\n\nThe time delta is the time elapsed between two consecutive frames and influences the speed of time for this Tween Manager and all Tweens it owns. Values higher than 1 increase the speed of time, while values smaller than 1 decrease it. A value of 0 freezes time and is effectively equivalent to pausing all Tweens.","kind":"function","name":"setGlobalTimeScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new scale of the time delta, where 1 is the normal speed.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"This Tween Manager."}],"memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#setGlobalTimeScale","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":720,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The Scene that owns this plugin is shutting down.\nWe need to kill and reset all internal properties as well as stop listening to Scene events.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#shutdown","scope":"instance","___s":true},{"meta":{"filename":"TweenManager.js","lineno":745,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"description":"The Scene that owns this plugin is being destroyed.\nWe need to shutdown and then kill off all external references.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Tweens.TweenManager","longname":"Phaser.Tweens.TweenManager#destroy","scope":"instance","___s":true},{"meta":{"filename":"GetBoolean.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Retrieves the value of the given key from an object.","kind":"function","name":"GetBoolean","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to retrieve the value from.","name":"source"},{"type":{"names":["string"]},"description":"The key to look for in the `source` object.","name":"key"},{"type":{"names":["*"]},"description":"The default value to return if the `key` doesn't exist or if no `source` object is provided.","name":"defaultValue"}],"returns":[{"type":{"names":["*"]},"description":"The retrieved value."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetBoolean","scope":"static","___s":true},{"meta":{"range":[180,226],"filename":"GetEaseFunction.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"EaseMap","longname":"EaseMap","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetEaseFunction.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"This internal function is used to return the correct ease function for a Tween.\n\nIt can take a variety of input, including an EaseMap based string, or a custom function.","kind":"function","name":"GetEaseFunction","since":"3.0.0","params":[{"type":{"names":["string","function"]},"description":"The ease to find. This can be either a string from the EaseMap, or a custom function.","name":"ease"},{"type":{"names":["Array."]},"optional":true,"description":"An optional array of ease parameters to go with the ease.","name":"easeParams"}],"returns":[{"type":{"names":["function"]},"description":"The ease function."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetEaseFunction","scope":"static","___s":true},{"meta":{"filename":"GetNewValue.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Internal function used by the Tween Builder to create a function that will return\nthe given value from the source.","kind":"function","name":"GetNewValue","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"The source object to get the value from.","name":"source"},{"type":{"names":["string"]},"description":"The property to get from the source.","name":"key"},{"type":{"names":["any"]},"description":"A default value to return should the source not have the property set.","name":"defaultValue"}],"returns":[{"type":{"names":["function"]},"description":"A function which when called will return the property value from the source."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetNewValue","scope":"static","___s":true},{"meta":{"range":[180,224],"filename":"GetProps.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"RESERVED","longname":"RESERVED","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetProps.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Internal function used by the Tween Builder to return an array of properties\nthat the Tween will be operating on. It takes a tween configuration object\nand then checks that none of the `props` entries start with an underscore, or that\nnone of the direct properties are on the Reserved list.","kind":"function","name":"GetProps","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig"]},"description":"The configuration object of the Tween to get the properties from.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"An array of all the properties the tween will operate on."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetProps","scope":"static","___s":true},{"meta":{"range":[180,229],"filename":"GetTargets.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"GetValue","longname":"GetValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetTargets.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Extracts an array of targets from a Tween configuration object.\n\nThe targets will be looked for in a `targets` property. If it's a function, its return value will be used as the result.","kind":"function","name":"GetTargets","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The configuration object to use.","name":"config"}],"returns":[{"type":{"names":["array"]},"description":"An array of targets (may contain only one element), or `null` if no targets were specified."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetTargets","scope":"static","___s":true},{"meta":{"range":[180,229],"filename":"GetTweens.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"GetValue","longname":"GetValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetTweens.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Internal function used by the Timeline Builder.\n\nIt returns an array of all tweens in the given timeline config.","kind":"function","name":"GetTweens","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TimelineBuilderConfig"]},"description":"The configuration object for the Timeline.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Tween instances that the Timeline will manage."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetTweens","scope":"static","___s":true},{"meta":{"range":[195,295],"filename":"GetValueOp.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"ignore":true,"name":"hasGetActive","longname":"hasGetActive","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[316,413],"filename":"GetValueOp.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"ignore":true,"name":"hasGetStart","longname":"hasGetStart","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[434,525],"filename":"GetValueOp.js","lineno":26,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"ignore":true,"name":"hasGetEnd","longname":"hasGetEnd","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[546,643],"filename":"GetValueOp.js","lineno":34,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"ignore":true,"name":"hasGetters","longname":"hasGetters","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetValueOp.js","lineno":39,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Returns `getActive`, `getStart` and `getEnd` functions for a TweenData based on a target property and end value.\n\n`getActive` if not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.\n`getEnd` is invoked once any start delays have expired and returns what the value should tween to.\n`getStart` is invoked when the tween reaches the end and needs to either repeat or yoyo, it returns the value to go back to.\n\nIf the end value is a number, it will be treated as an absolute value and the property will be tweened to it.\nA string can be provided to specify a relative end value which consists of an operation\n(`+=` to add to the current value, `-=` to subtract from the current value, `*=` to multiply the current\nvalue, or `/=` to divide the current value) followed by its operand.\n\nA function can be provided to allow greater control over the end value; it will receive the target\nobject being tweened, the name of the property being tweened, and the current value of the property\nas its arguments.\n\nIf both the starting and the ending values need to be controlled, an object with `getStart` and `getEnd`\ncallbacks, which will receive the same arguments, can be provided instead. If an object with a `value`\nproperty is provided, the property will be used as the effective value under the same rules described here.","kind":"function","name":"GetValueOp","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the property to modify.","name":"key"},{"type":{"names":["*"]},"description":"The ending value of the property, as described above.","name":"propertyValue"}],"returns":[{"type":{"names":["function"]},"description":"An array of functions, `getActive`, `getStart` and `getEnd`, which return the starting and the ending value of the property based on the provided value."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.GetValueOp","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"NumberTweenBuilder.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"Defaults","longname":"Defaults","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NumberTweenBuilder.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Creates a new Number Tween.","kind":"function","name":"NumberTweenBuilder","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.TweenManager","Phaser.Tweens.Timeline"]},"description":"The owner of the new Tween.","name":"parent"},{"type":{"names":["Phaser.Types.Tweens.NumberTweenBuilderConfig"]},"description":"Configuration for the new Tween.","name":"config"},{"type":{"names":["Phaser.Types.Tweens.TweenConfigDefaults"]},"description":"Tween configuration defaults.","name":"defaults"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The new tween."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.NumberTweenBuilder","scope":"static","___s":true},{"meta":{"range":[180,226],"filename":"StaggerBuilder.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"GetEaseFunction","longname":"GetEaseFunction","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"StaggerBuilder.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Creates a Stagger function to be used by a Tween property.\n\nThe stagger function will allow you to stagger changes to the value of the property across all targets of the tween.\n\nThis is only worth using if the tween has multiple targets.\n\nThe following will stagger the delay by 100ms across all targets of the tween, causing them to scale down to 0.2\nover the duration specified:\n\n```javascript\nthis.tweens.add({\n targets: [ ... ],\n scale: 0.2,\n ease: 'linear',\n duration: 1000,\n delay: this.tweens.stagger(100)\n});\n```\n\nThe following will stagger the delay by 500ms across all targets of the tween using a 10 x 6 grid, staggering\nfrom the center out, using a cubic ease.\n\n```javascript\nthis.tweens.add({\n targets: [ ... ],\n scale: 0.2,\n ease: 'linear',\n duration: 1000,\n delay: this.tweens.stagger(500, { grid: [ 10, 6 ], from: 'center', ease: 'cubic.out' })\n});\n```","kind":"function","name":"StaggerBuilder","since":"3.19.0","params":[{"type":{"names":["number","Array."]},"description":"The amount to stagger by, or an array containing two elements representing the min and max values to stagger between.","name":"value"},{"type":{"names":["Phaser.Types.Tweens.StaggerConfig"]},"optional":true,"description":"A Stagger Configuration object.","name":"config"}],"returns":[{"type":{"names":["function"]},"description":"The stagger function."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.StaggerBuilder","scope":"static","___s":true},{"meta":{"range":[180,223],"filename":"TimelineBuilder.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"Clone","longname":"Clone","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TimelineBuilder.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Builds a Timeline of Tweens based on a configuration object.","kind":"function","name":"TimelineBuilder","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.TweenManager"]},"description":"The Tween Manager to which the Timeline will belong.","name":"manager"},{"type":{"names":["Phaser.Types.Tweens.TimelineBuilderConfig"]},"description":"The configuration object for the Timeline.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The created Timeline."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.TimelineBuilder","scope":"static","___s":true},{"meta":{"range":[180,219],"filename":"TweenBuilder.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"name":"Defaults","longname":"Defaults","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"TweenBuilder.js","lineno":19,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"description":"Creates a new Tween.","kind":"function","name":"TweenBuilder","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.TweenManager","Phaser.Tweens.Timeline"]},"description":"The owner of the new Tween.","name":"parent"},{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig","object"]},"description":"Configuration for the new Tween.","name":"config"},{"type":{"names":["Phaser.Types.Tweens.TweenConfigDefaults"]},"description":"Tween configuration defaults.","name":"defaults"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The new tween."}],"memberof":"Phaser.Tweens.Builders","longname":"Phaser.Tweens.Builders.TweenBuilder","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/builders"},"kind":"namespace","name":"Builders","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.Builders","scope":"static","___s":true},{"meta":{"filename":"TIMELINE_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Timeline Complete Event.\n\nThis event is dispatched by a Tween Timeline when it completes playback.\n\nListen to it from a Timeline instance using `Timeline.on('complete', listener)`, i.e.:\n\n```javascript\nvar timeline = this.tweens.timeline({\n targets: image,\n ease: 'Power1',\n duration: 3000,\n tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]\n});\ntimeline.on('complete', listener);\ntimeline.play();\n```","kind":"event","name":"TIMELINE_COMPLETE","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"A reference to the Timeline instance that emitted the event.","name":"timeline"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TIMELINE_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"TIMELINE_LOOP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Timeline Loop Event.\n\nThis event is dispatched by a Tween Timeline every time it loops.\n\nListen to it from a Timeline instance using `Timeline.on('loop', listener)`, i.e.:\n\n```javascript\nvar timeline = this.tweens.timeline({\n targets: image,\n ease: 'Power1',\n duration: 3000,\n loop: 4,\n tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]\n});\ntimeline.on('loop', listener);\ntimeline.play();\n```","kind":"event","name":"TIMELINE_LOOP","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"A reference to the Timeline instance that emitted the event.","name":"timeline"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TIMELINE_LOOP","scope":"instance","___s":true},{"meta":{"filename":"TIMELINE_PAUSE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Timeline Pause Event.\n\nThis event is dispatched by a Tween Timeline when it is paused.\n\nListen to it from a Timeline instance using `Timeline.on('pause', listener)`, i.e.:\n\n```javascript\nvar timeline = this.tweens.timeline({\n targets: image,\n ease: 'Power1',\n duration: 3000,\n tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]\n});\ntimeline.on('pause', listener);\n// At some point later ...\ntimeline.pause();\n```","kind":"event","name":"TIMELINE_PAUSE","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"A reference to the Timeline instance that emitted the event.","name":"timeline"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TIMELINE_PAUSE","scope":"instance","___s":true},{"meta":{"filename":"TIMELINE_RESUME_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Timeline Resume Event.\n\nThis event is dispatched by a Tween Timeline when it is resumed from a paused state.\n\nListen to it from a Timeline instance using `Timeline.on('resume', listener)`, i.e.:\n\n```javascript\nvar timeline = this.tweens.timeline({\n targets: image,\n ease: 'Power1',\n duration: 3000,\n tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]\n});\ntimeline.on('resume', listener);\n// At some point later ...\ntimeline.resume();\n```","kind":"event","name":"TIMELINE_RESUME","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"A reference to the Timeline instance that emitted the event.","name":"timeline"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TIMELINE_RESUME","scope":"instance","___s":true},{"meta":{"filename":"TIMELINE_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Timeline Start Event.\n\nThis event is dispatched by a Tween Timeline when it starts.\n\nListen to it from a Timeline instance using `Timeline.on('start', listener)`, i.e.:\n\n```javascript\nvar timeline = this.tweens.timeline({\n targets: image,\n ease: 'Power1',\n duration: 3000,\n tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]\n});\ntimeline.on('start', listener);\ntimeline.play();\n```","kind":"event","name":"TIMELINE_START","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"A reference to the Timeline instance that emitted the event.","name":"timeline"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TIMELINE_START","scope":"instance","___s":true},{"meta":{"filename":"TIMELINE_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Timeline Update Event.\n\nThis event is dispatched by a Tween Timeline every time it updates, which can happen a lot of times per second,\nso be careful about listening to this event unless you absolutely require it.\n\nListen to it from a Timeline instance using `Timeline.on('update', listener)`, i.e.:\n\n```javascript\nvar timeline = this.tweens.timeline({\n targets: image,\n ease: 'Power1',\n duration: 3000,\n tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]\n});\ntimeline.on('update', listener);\ntimeline.play();\n```","kind":"event","name":"TIMELINE_UPDATE","since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"A reference to the Timeline instance that emitted the event.","name":"timeline"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TIMELINE_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_ACTIVE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Active Event.\n\nThis event is dispatched by a Tween when it becomes active within the Tween Manager.\n\nAn 'active' Tween is one that is now progressing, although it may not yet be updating\nany target properties, due to settings such as `delay`. If you need an event for when\nthe Tween starts actually updating its first property, see `TWEEN_START`.\n\nListen to it from a Tween instance using `Tween.on('active', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000\n});\ntween.on('active', listener);\n```","kind":"event","name":"TWEEN_ACTIVE","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["Array."]},"description":"An array of references to the target/s the Tween is operating on.","name":"targets"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_ACTIVE","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_COMPLETE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Complete Event.\n\nThis event is dispatched by a Tween when it completes playback entirely, factoring in repeats and loops.\n\nIf the Tween has been set to loop or repeat infinitely, this event will not be dispatched\nunless the `Tween.stop` method is called.\n\nIf a Tween has a `completeDelay` set, this event will fire after that delay expires.\n\nListen to it from a Tween instance using `Tween.on('complete', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000\n});\ntween.on('complete', listener);\n```","kind":"event","name":"TWEEN_COMPLETE","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["Array."]},"description":"An array of references to the target/s the Tween is operating on.","name":"targets"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_COMPLETE","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_LOOP_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Loop Event.\n\nThis event is dispatched by a Tween when it loops.\n\nThis event will only be dispatched if the Tween has a loop count set.\n\nIf a Tween has a `loopDelay` set, this event will fire after that delay expires.\n\nThe difference between `loop` and `repeat` is that `repeat` is a property setting,\nwhere-as `loop` applies to the entire Tween.\n\nListen to it from a Tween instance using `Tween.on('loop', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000,\n loop: 6\n});\ntween.on('loop', listener);\n```","kind":"event","name":"TWEEN_LOOP","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["Array."]},"description":"An array of references to the target/s the Tween is operating on.","name":"targets"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_LOOP","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_REPEAT_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Repeat Event.\n\nThis event is dispatched by a Tween when one of the properties it is tweening repeats.\n\nThis event will only be dispatched if the Tween has a property with a repeat count set.\n\nIf a Tween has a `repeatDelay` set, this event will fire after that delay expires.\n\nThe difference between `loop` and `repeat` is that `repeat` is a property setting,\nwhere-as `loop` applies to the entire Tween.\n\nListen to it from a Tween instance using `Tween.on('repeat', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000,\n repeat: 4\n});\ntween.on('repeat', listener);\n```","kind":"event","name":"TWEEN_REPEAT","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["string"]},"description":"The key of the property that just repeated.","name":"key"},{"type":{"names":["any"]},"description":"The target that the property just repeated on.","name":"target"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_REPEAT","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_START_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Start Event.\n\nThis event is dispatched by a Tween when it starts tweening its first property.\n\nA Tween will only emit this event once, as it can only start once.\n\nIf a Tween has a `delay` set, this event will fire after that delay expires.\n\nListen to it from a Tween instance using `Tween.on('start', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000\n});\ntween.on('start', listener);\n```","kind":"event","name":"TWEEN_START","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["Array."]},"description":"An array of references to the target/s the Tween is operating on.","name":"targets"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_START","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_UPDATE_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Update Event.\n\nThis event is dispatched by a Tween every time it updates _any_ of the properties it is tweening.\n\nA Tween that is changing 3 properties of a target will emit this event 3 times per change, once per property.\n\n**Note:** This is a very high frequency event and may be dispatched multiple times, every single frame.\n\nListen to it from a Tween instance using `Tween.on('update', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000,\n});\ntween.on('update', listener);\n```","kind":"event","name":"TWEEN_UPDATE","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["string"]},"description":"The property that was updated, i.e. `x` or `scale`.","name":"key"},{"type":{"names":["any"]},"description":"The target object that was updated. Usually a Game Object, but can be of any type.","name":"target"},{"type":{"names":["number"]},"description":"The current value of the property that was tweened.","name":"current"},{"type":{"names":["number"]},"description":"The previous value of the property that was tweened, prior to this update.","name":"previous"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_UPDATE","scope":"instance","___s":true},{"meta":{"filename":"TWEEN_YOYO_EVENT.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"description":"The Tween Yoyo Event.\n\nThis event is dispatched by a Tween whenever a property it is tweening yoyos.\n\nThis event will only be dispatched if the Tween has a property with `yoyo` set.\n\nIf the Tween has a `hold` value, this event is dispatched when the hold expires.\n\nThis event is dispatched for every property, and for every target, that yoyos.\nFor example, if a Tween was updating 2 properties and had 10 targets, this event\nwould be dispatched 20 times (twice per target). So be careful how you use it!\n\nListen to it from a Tween instance using `Tween.on('yoyo', listener)`, i.e.:\n\n```javascript\nvar tween = this.tweens.add({\n targets: image,\n x: 500,\n ease: 'Power1',\n duration: 3000,\n yoyo: true\n});\ntween.on('yoyo', listener);\n```","kind":"event","name":"TWEEN_YOYO","since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"A reference to the Tween instance that emitted the event.","name":"tween"},{"type":{"names":["string"]},"description":"The property that yoyo'd, i.e. `x` or `scale`.","name":"key"},{"type":{"names":["any"]},"description":"The target object that was yoyo'd. Usually a Game Object, but can be of any type.","name":"target"}],"memberof":"Phaser.Tweens.Events","longname":"Phaser.Tweens.Events#event:TWEEN_YOYO","scope":"instance","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/events"},"kind":"namespace","name":"Events","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.Events","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"index.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"name":"CONST","longname":"CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"index.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens"},"kind":"namespace","name":"Tweens","memberof":"Phaser","longname":"Phaser.Tweens","scope":"static","___s":true},{"meta":{"filename":"Defaults.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"kind":"typedef","name":"TweenConfigDefaults","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["object","Array."]},"description":"The object, or an array of objects, to run the tween on.","name":"targets"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to delay before the tween will start.","name":"delay"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1000,"description":"The duration of the tween in milliseconds.","name":"duration"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"'Power0'","description":"The easing equation to use for the tween.","name":"ease"},{"type":{"names":["array"]},"optional":true,"description":"Optional easing parameters.","name":"easeParams"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to hold the tween for before yoyo'ing.","name":"hold"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of times to repeat the tween.","name":"repeat"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to pause before a tween will repeat.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.","name":"yoyo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipX` property.","name":"flipX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipY` property.","name":"flipY"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenConfigDefaults","scope":"static","___s":true},{"meta":{"range":[180,216],"filename":"Tween.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Tween.js","lineno":15,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"classdesc":"A Tween is able to manipulate the properties of one or more objects to any given value, based\non a duration and type of ease. They are rarely instantiated directly and instead should be\ncreated via the TweenManager.","kind":"class","name":"Tween","memberof":"Phaser.Tweens","augments":["Phaser.Events.EventEmitter"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.TweenManager","Phaser.Tweens.Timeline"]},"description":"A reference to the parent of this Tween. Either the Tween Manager or a Tween Timeline instance.","name":"parent"},{"type":{"names":["Array."]},"description":"An array of TweenData objects, each containing a unique property to be tweened.","name":"data"},{"type":{"names":["array"]},"description":"An array of targets to be tweened.","name":"targets"}],"scope":"static","longname":"Phaser.Tweens.Tween","___s":true},{"meta":{"filename":"Tween.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"A reference to the parent of this Tween.\nEither the Tween Manager or a Tween Timeline instance.","name":"parent","type":{"names":["Phaser.Tweens.TweenManager","Phaser.Tweens.Timeline"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#parent","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":51,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Is the parent of this Tween a Timeline?","name":"parentIsTimeline","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#parentIsTimeline","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"An array of TweenData objects, each containing a unique property and target being tweened.","name":"data","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"The cached length of the data array.","name":"totalData","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#totalData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"An array of references to the target/s this Tween is operating on.","name":"targets","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#targets","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Cached target total (not necessarily the same as the data total)","name":"totalTargets","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#totalTargets","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"If `true` then duration, delay, etc values are all frame totals.","name":"useFrames","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#useFrames","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Scales the time applied to this Tween. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.\nValue isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.","name":"timeScale","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#timeScale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Loop this tween? Can be -1 for an infinite loop, or an integer.\nWhen enabled it will play through ALL TweenDatas again. Use TweenData.repeat to loop a single element.","name":"loop","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#loop","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":128,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Time in ms/frames before the tween loops.","name":"loopDelay","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#loopDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"How many loops are left to run?","name":"loopCounter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#loopCounter","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Time in ms/frames before the 'onStart' event fires.\nThis is the shortest `delay` value across all of the TweenDatas of this Tween.","name":"startDelay","type":{"names":["number"]},"defaultvalue":"0","since":"3.19.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#startDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Has this Tween started playback yet?\nThis boolean is toggled when the Tween leaves the 'delayed' state and starts running.","name":"hasStarted","type":{"names":["boolean"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#hasStarted","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":170,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Is this Tween currently seeking?\nThis boolean is toggled in the `Tween.seek` method.\nWhen a tween is seeking it will not dispatch any events or callbacks.","name":"isSeeking","type":{"names":["boolean"]},"readonly":true,"since":"3.19.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#isSeeking","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":182,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Time in ms/frames before the 'onComplete' event fires. This never fires if loop = -1 (as it never completes)","name":"completeDelay","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#completeDelay","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Countdown timer (used by timeline offset, loopDelay and completeDelay)","name":"countdown","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#countdown","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":202,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Set only if this Tween is part of a Timeline.","name":"offset","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#offset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":212,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Set only if this Tween is part of a Timeline. The calculated offset amount.","name":"calculatedOffset","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#calculatedOffset","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":222,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"The current state of the tween","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#state","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":241,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Does the Tween start off paused? (if so it needs to be started with Tween.play)","name":"paused","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#paused","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":251,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Elapsed time in ms/frames of this run through the Tween.","name":"elapsed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#elapsed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":261,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Total elapsed time in ms/frames of the entire Tween, including looping.","name":"totalElapsed","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#totalElapsed","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":271,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Time in ms/frames for the whole Tween to play through once, excluding loop amounts and loop delays.","name":"duration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#duration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":281,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Value between 0 and 1. The amount through the Tween, excluding loops.","name":"progress","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#progress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":291,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Time in ms/frames for the Tween to complete (including looping)","name":"totalDuration","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#totalDuration","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":301,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Value between 0 and 1. The amount through the entire Tween, including looping.","name":"totalProgress","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#totalProgress","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":311,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"An object containing the different Tween callback functions.\n\nYou can either set these in the Tween config, or by calling the `Tween.setCallback` method.\n\n`onActive` When the Tween is moved from the pending to the active list in the Tween Manager, even if playback paused.\n`onStart` When the Tween starts playing after a delayed state. Will happen at the same time as `onActive` if it has no delay.\n`onYoyo` When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\n`onRepeat` When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\n`onComplete` When the Tween finishes playback fully or `Tween.stop` is called. Never invoked if tween is set to repeat infinitely.\n`onUpdate` When a TweenData updates a property on a source target during playback.\n`onLoop` When a Tween loops. This happens _after_ the `loopDelay` expires, if set.","name":"callbacks","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#callbacks","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":338,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"The context in which all callbacks are invoked.","name":"callbackScope","type":{"names":["any"]},"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#callbackScope","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Tween.js","lineno":348,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Returns the current value of the specified Tween Data.","kind":"function","name":"getValue","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The Tween Data to return the value from.","name":"index"}],"returns":[{"type":{"names":["number"]},"description":"The value of the requested Tween Data."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#getValue","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":365,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Set the scale the time applied to this Tween. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.","kind":"function","name":"setTimeScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The scale factor for timescale.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"- This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#setTimeScale","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":382,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Returns the scale of the time applied to this Tween.","kind":"function","name":"getTimeScale","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The timescale of this tween (between 0 and 1)"}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#getTimeScale","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":395,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Checks if the Tween is currently active.","kind":"function","name":"isPlaying","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Tween is active, otherwise `false`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#isPlaying","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":408,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Checks if the Tween is currently paused.","kind":"function","name":"isPaused","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the Tween is paused, otherwise `false`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#isPaused","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":421,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"See if this Tween is currently acting upon the given target.","kind":"function","name":"hasTarget","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The target to check against this Tween.","name":"target"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the given target is a target of this Tween, otherwise `false`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#hasTarget","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":436,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Updates the 'end' value of the given property across all matching targets.\n\nCalling this does not adjust the duration of the tween, or the current progress.\n\nYou can optionally tell it to set the 'start' value to be the current value (before the change).","kind":"function","name":"updateTo","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The property to set the new value for.","name":"key"},{"type":{"names":["*"]},"description":"The new value of the property.","name":"value"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this change set the start value to be the current value?","name":"startToCurrent"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"- This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#updateTo","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":474,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Restarts the tween from the beginning.","kind":"function","name":"restart","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#restart","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":511,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that calculates the overall duration of the Tween.","kind":"function","name":"calcDuration","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#calcDuration","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":584,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Called by TweenManager.preUpdate as part of its loop to check pending and active tweens.\nShould not be called directly.","kind":"function","name":"init","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if this Tween should be moved from the pending list to the active list by the Tween Manager."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#init","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":637,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that makes this Tween active within the TweenManager\nand emits the onActive event and callback.","kind":"function","name":"makeActive","fires":["Phaser.Tweens.Events#event:TWEEN_ACTIVE"],"since":"3.19.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#makeActive","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":652,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that advances to the next state of the Tween during playback.","kind":"function","name":"nextState","fires":["Phaser.Tweens.Events#event:TWEEN_COMPLETE","Phaser.Tweens.Events#event:TWEEN_LOOP"],"since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#nextState","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":696,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Pauses the Tween immediately. Use `resume` to continue playback.","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"- This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#pause","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":720,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Starts a Tween playing.\n\nYou only need to call this method if you have configured the tween to be paused on creation.\n\nIf the Tween is already playing, calling this method again will have no effect. If you wish to\nrestart the Tween, use `Tween.restart` instead.\n\nCalling this method after the Tween has completed will start the Tween playing again from the start.\nThis is the same as calling `Tween.seek(0)` and then `Tween.play()`.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Tween being played as part of a Timeline?","name":"resetFromTimeline"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#play","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":797,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that resets all of the Tween Data, including the progress and elapsed values.","kind":"function","name":"resetTweenData","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Has this method been called as part of a loop?","name":"resetFromLoop"}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#resetTweenData","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":853,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Resumes the playback of a previously paused Tween.","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"- This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#resume","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":877,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Seeks to a specific point in the Tween.\n\n**Note:** You cannot seek a Tween that repeats or loops forever, or that has an unusually long total duration.\n\nThe given position is a value between 0 and 1 which represents how far through the Tween to seek to.\nA value of 0.5 would seek to half-way through the Tween, where-as a value of zero would seek to the start.\n\nNote that the seek takes the entire duration of the Tween into account, including delays, loops and repeats.\nFor example, a Tween that lasts for 2 seconds, but that loops 3 times, would have a total duration of 6 seconds,\nso seeking to 0.5 would seek to 3 seconds into the Tween, as that's half-way through its _entire_ duration.\n\nSeeking works by resetting the Tween to its initial values and then iterating through the Tween at `delta`\njumps per step. The longer the Tween, the longer this can take.","kind":"function","name":"seek","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 and 1 which represents the progress point to seek to.","name":"toPosition"},{"type":{"names":["number"]},"optional":true,"defaultvalue":16.6,"description":"The size of each step when seeking through the Tween. A higher value completes faster but at a cost of less precision.","name":"delta"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#seek","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":987,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Sets an event based callback to be invoked during playback.\n\nCalling this method will replace a previously set callback for the given type, if any exists.\n\nThe types available are:\n\n`onActive` When the Tween is moved from the pending to the active list in the Tween Manager, even if playback paused.\n`onStart` When the Tween starts playing after a delayed state. Will happen at the same time as `onActive` if it has no delay.\n`onYoyo` When a TweenData starts a yoyo. This happens _after_ the `hold` delay expires, if set.\n`onRepeat` When a TweenData repeats playback. This happens _after_ the `repeatDelay` expires, if set.\n`onComplete` When the Tween finishes playback fully or `Tween.stop` is called. Never invoked if tween is set to repeat infinitely.\n`onUpdate` When a TweenData updates a property on a source target during playback.\n`onLoop` When a Tween loops. This happens _after_ the `loopDelay` expires, if set.","kind":"function","name":"setCallback","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Type of the callback to set.","name":"type"},{"type":{"names":["function"]},"description":"The function to invoke when this callback happens.","name":"callback"},{"type":{"names":["array"]},"optional":true,"description":"An array of parameters for specified callbacks types.","name":"params"},{"type":{"names":["any"]},"optional":true,"description":"The context the callback will be invoked in.","name":"scope"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#setCallback","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1019,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Flags the Tween as being complete, whatever stage of progress it is at.\n\nIf an onComplete callback has been defined it will automatically invoke it, unless a `delay`\nargument is provided, in which case the Tween will delay for that period of time before calling the callback.\n\nIf you don't need a delay, or have an onComplete callback, then call `Tween.stop` instead.","kind":"function","name":"complete","fires":["Phaser.Tweens.Events#event:TWEEN_COMPLETE"],"since":"3.2.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The time to wait before invoking the complete callback. If zero it will fire immediately.","name":"delay"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#complete","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1055,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Immediately removes this Tween from the TweenManager and all of its internal arrays,\nno matter what stage it as it. Then sets the tween state to `REMOVED`.\n\nYou should dispose of your reference to this tween after calling this method, to\nfree it from memory.","kind":"function","name":"remove","since":"3.17.0","returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#remove","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1074,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Stops the Tween immediately, whatever stage of progress it is at and flags it for removal by the TweenManager.","kind":"function","name":"stop","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"If you want to seek the tween, provide a value between 0 and 1.","name":"resetTo"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"This Tween instance."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#stop","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1118,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that advances the Tween based on the time values.","kind":"function","name":"update","fires":["Phaser.Tweens.Events#event:TWEEN_COMPLETE","Phaser.Tweens.Events#event:TWEEN_LOOP","Phaser.Tweens.Events#event:TWEEN_START"],"since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.","name":"timestamp"},{"type":{"names":["number"]},"description":"The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.","name":"delta"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if this Tween has finished and should be removed from the Tween Manager, otherwise returns `false`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#update","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that will emit a TweenData based Event and invoke the given callback.","kind":"function","name":"dispatchTweenDataEvent","since":"3.19.0","params":[{"type":{"names":["Phaser.Types.Tweens.Event"]},"description":"The Event to be dispatched.","name":"event"},{"type":{"names":["function"]},"description":"The callback to be invoked. Can be `null` or `undefined` to skip invocation.","name":"callback"},{"type":{"names":["Phaser.Types.Tweens.TweenDataConfig"]},"description":"The TweenData object that caused this event.","name":"tweenData"}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#dispatchTweenDataEvent","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that will emit a Tween based Event and invoke the given callback.","kind":"function","name":"dispatchTweenEvent","since":"3.19.0","params":[{"type":{"names":["Phaser.Types.Tweens.Event"]},"description":"The Event to be dispatched.","name":"event"},{"type":{"names":["function"]},"description":"The callback to be invoked. Can be `null` or `undefined` to skip invocation.","name":"callback"}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#dispatchTweenEvent","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method used as part of the playback process that sets a tween to play in reverse.","kind":"function","name":"setStateFromEnd","fires":["Phaser.Tweens.Events#event:TWEEN_REPEAT","Phaser.Tweens.Events#event:TWEEN_YOYO"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to update.","name":"tween"},{"type":{"names":["Phaser.Types.Tweens.TweenDataConfig"]},"description":"The TweenData property to update.","name":"tweenData"},{"type":{"names":["number"]},"description":"Any extra time that needs to be accounted for in the elapsed and progress values.","name":"diff"}],"returns":[{"type":{"names":["integer"]},"description":"The state of this Tween."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#setStateFromEnd","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1365,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method used as part of the playback process that sets a tween to play from the start.","kind":"function","name":"setStateFromStart","fires":["Phaser.Tweens.Events#event:TWEEN_REPEAT"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to update.","name":"tween"},{"type":{"names":["Phaser.Types.Tweens.TweenDataConfig"]},"description":"The TweenData property to update.","name":"tweenData"},{"type":{"names":["number"]},"description":"Any extra time that needs to be accounted for in the elapsed and progress values.","name":"diff"}],"returns":[{"type":{"names":["integer"]},"description":"The state of this Tween."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#setStateFromStart","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1422,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Internal method that advances the TweenData based on the time value given.","kind":"function","name":"updateTweenData","fires":["Phaser.Tweens.Events#event:TWEEN_UPDATE","Phaser.Tweens.Events#event:TWEEN_REPEAT"],"since":"3.0.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween to update.","name":"tween"},{"type":{"names":["Phaser.Types.Tweens.TweenDataConfig"]},"description":"The TweenData property to update.","name":"tweenData"},{"type":{"names":["number"]},"description":"Either a value in ms, or 1 if Tween.useFrames is true.","name":"delta"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the tween is not complete (e.g., playing), or false if the tween is complete."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#updateTweenData","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1594,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Creates a new Tween object.\n\nNote: This method will only be available if Tweens have been built into Phaser.","kind":"function","name":"tween","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig","object"]},"description":"The Tween configuration.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween that was created."}],"memberof":"Phaser.GameObjects.GameObjectFactory","longname":"Phaser.GameObjects.GameObjectFactory#tween","scope":"instance","___s":true},{"meta":{"filename":"Tween.js","lineno":1619,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Creates a new Tween object and returns it.\n\nNote: This method will only be available if Tweens have been built into Phaser.","kind":"function","name":"tween","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Tweens.TweenBuilderConfig","object"]},"description":"The Tween configuration.","name":"config"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween that was created."}],"memberof":"Phaser.GameObjects.GameObjectCreator","longname":"Phaser.GameObjects.GameObjectCreator#tween","scope":"instance","___s":true},{"meta":{"filename":"TweenData.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Returns a TweenDataConfig object that describes the tween data for a unique property of a unique target.\nA single Tween consists of multiple TweenDatas, depending on how many properties are being changed by the Tween.\n\nThis is an internal function used by the TweenBuilder and should not be accessed directly, instead,\nTweens should be created using the GameObjectFactory or GameObjectCreator.","kind":"function","name":"TweenData","since":"3.0.0","params":[{"type":{"names":["any"]},"description":"The target to tween.","name":"target"},{"type":{"names":["integer"]},"description":"The target index within the Tween targets array.","name":"index"},{"type":{"names":["string"]},"description":"The property of the target to tween.","name":"key"},{"type":{"names":["function"]},"description":"What the property will be at the END of the Tween.","name":"getEnd"},{"type":{"names":["function"]},"description":"What the property will be at the START of the Tween.","name":"getStart"},{"type":{"names":["function"]},"nullable":true,"description":"If not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.","name":"getActive"},{"type":{"names":["function"]},"description":"The ease function this tween uses.","name":"ease"},{"type":{"names":["number"]},"description":"Time in ms/frames before tween will start.","name":"delay"},{"type":{"names":["number"]},"description":"Duration of the tween in ms/frames.","name":"duration"},{"type":{"names":["boolean"]},"description":"Determines whether the tween should return back to its start value after hold has expired.","name":"yoyo"},{"type":{"names":["number"]},"description":"Time in ms/frames the tween will pause before repeating or returning to its starting value if yoyo is set to true.","name":"hold"},{"type":{"names":["number"]},"description":"Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.","name":"repeat"},{"type":{"names":["number"]},"description":"Time in ms/frames before the repeat will start.","name":"repeatDelay"},{"type":{"names":["boolean"]},"description":"Should toggleFlipX be called when yoyo or repeat happens?","name":"flipX"},{"type":{"names":["boolean"]},"description":"Should toggleFlipY be called when yoyo or repeat happens?","name":"flipY"}],"returns":[{"type":{"names":["Phaser.Types.Tweens.TweenDataConfig"]},"description":"The config object describing this TweenData."}],"memberof":"Phaser.Tweens","longname":"Phaser.Tweens.TweenData","scope":"static","___s":true},{"meta":{"range":[180,2806],"filename":"const.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"name":"TWEEN_CONST","longname":"TWEEN_CONST","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"const.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"CREATED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.CREATED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"INIT","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.INIT","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"DELAY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.DELAY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"OFFSET_DELAY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.OFFSET_DELAY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"PENDING_RENDER","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.PENDING_RENDER","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"PLAYING_FORWARD","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.PLAYING_FORWARD","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"PLAYING_BACKWARD","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.PLAYING_BACKWARD","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"HOLD_DELAY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.HOLD_DELAY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":81,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"REPEAT_DELAY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.REPEAT_DELAY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"TweenData state.","name":"COMPLETE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.COMPLETE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"PENDING_ADD","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.PENDING_ADD","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"PAUSED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.PAUSED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":119,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"LOOP_DELAY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.LOOP_DELAY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":128,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"ACTIVE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.ACTIVE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":137,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"COMPLETE_DELAY","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.COMPLETE_DELAY","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":146,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"PENDING_REMOVE","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.PENDING_REMOVE","scope":"static","kind":"member","___s":true},{"meta":{"filename":"const.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/tween"},"description":"Tween state.","name":"REMOVED","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Tweens","longname":"Phaser.Tweens.REMOVED","scope":"static","kind":"member","___s":true},{"meta":{"filename":"Event.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"Event","type":{"names":["string"]},"description":"A Tween Event.","since":"3.19.0","memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.Event","scope":"static","___s":true},{"meta":{"filename":"GetActiveCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"GetActiveCallback","type":{"names":["function"]},"since":"3.19.0","params":[{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["string"]},"description":"The target property.","name":"key"},{"type":{"names":["number"]},"description":"The current value of the target property.","name":"value"},{"type":{"names":["integer"]},"description":"The index of the target within the Tween.","name":"targetIndex"},{"type":{"names":["integer"]},"description":"The total number of targets in this Tween.","name":"totalTargets"},{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween that invoked this callback.","name":"tween"}],"returns":[{"type":{"names":["number"]},"description":"- The new value."}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.GetActiveCallback","scope":"static","___s":true},{"meta":{"filename":"GetEndCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"GetEndCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["string"]},"description":"The target property.","name":"key"},{"type":{"names":["number"]},"description":"The current value of the target property.","name":"value"},{"type":{"names":["integer"]},"description":"The index of the target within the Tween.","name":"targetIndex"},{"type":{"names":["integer"]},"description":"The total number of targets in this Tween.","name":"totalTargets"},{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween that invoked this callback.","name":"tween"}],"returns":[{"type":{"names":["number"]},"description":"- The new value."}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.GetEndCallback","scope":"static","___s":true},{"meta":{"filename":"GetStartCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"GetStartCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["string"]},"description":"The target property.","name":"key"},{"type":{"names":["number"]},"description":"The current value of the target property.","name":"value"},{"type":{"names":["integer"]},"description":"The index of the target within the Tween.","name":"targetIndex"},{"type":{"names":["integer"]},"description":"The total number of targets in this Tween.","name":"totalTargets"},{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The Tween that invoked this callback.","name":"tween"}],"returns":[{"type":{"names":["number"]},"description":"- The new value."}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.GetStartCallback","scope":"static","___s":true},{"meta":{"filename":"NumberTweenBuilderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"NumberTweenBuilderConfig","type":{"names":["object"]},"since":"3.18.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The start number.","name":"from"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The end number.","name":"to"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to delay before the tween will start.","name":"delay"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1000,"description":"The duration of the tween in milliseconds.","name":"duration"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Power0'","description":"The easing equation to use for the tween.","name":"ease"},{"type":{"names":["array"]},"optional":true,"description":"Optional easing parameters.","name":"easeParams"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to hold the tween for before yoyo'ing.","name":"hold"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of times to repeat the tween.","name":"repeat"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to pause before a tween will repeat.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.","name":"yoyo"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":null,"description":"Used when the Tween is part of a Timeline.","name":"offset"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.","name":"completeDelay"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property tween has completed once.","name":"loop"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The time the tween will pause before starting either a yoyo or returning to the start for a repeat.","name":"loopDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Does the tween start in a paused state (true) or playing (false)?","name":"paused"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use frames or milliseconds?","name":"useFrames"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for the callbacks. The default scope is the tween.","name":"callbackScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnCompleteCallback"]},"optional":true,"description":"A function to call when the tween completes.","name":"onComplete"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onComplete`.","name":"onCompleteParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onComplete`.","name":"onCompleteScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnLoopCallback"]},"optional":true,"description":"A function to call each time the tween loops.","name":"onLoop"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onLoop`.","name":"onLoopParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onLoop`.","name":"onLoopScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnRepeatCallback"]},"optional":true,"description":"A function to call each time the tween repeats. Called once per property per target.","name":"onRepeat"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onRepeat`.","name":"onRepeatParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onRepeat`.","name":"onRepeatScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnStartCallback"]},"optional":true,"description":"A function to call when the tween starts.","name":"onStart"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onStart`.","name":"onStartParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onStart`.","name":"onStartScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnUpdateCallback"]},"optional":true,"description":"A function to call each time the tween steps. Called once per property per target.","name":"onUpdate"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onUpdate`.","name":"onUpdateParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onUpdate`.","name":"onUpdateScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnYoyoCallback"]},"optional":true,"description":"A function to call each time the tween yoyos. Called once per property per target.","name":"onYoyo"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onYoyo`.","name":"onYoyoParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onYoyo`.","name":"onYoyoScope"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.NumberTweenBuilderConfig","scope":"static","___s":true},{"meta":{"filename":"StaggerConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"StaggerConfig","type":{"names":["object"]},"since":"3.19.0","properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The value to start the stagger from. Can be used as a way to offset the stagger while still using a range for the value.","name":"start"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Linear'","description":"An ease to apply across the staggered values. Can either be a string, such as 'sine.inout', or a function.","name":"ease"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":0,"description":"The index to start the stagger from. Can be the strings `first`, `last` or `center`, or an integer representing the stagger position.","name":"from"},{"type":{"names":["Array."]},"optional":true,"description":"Set the stagger to run across a grid by providing an array where element 0 is the width of the grid and element 1 is the height. Combine with the 'from' property to control direction.","name":"grid"}],"examples":["{\n grid: [ 20, 8 ],\n from: 'center',\n ease: 'Power0',\n start: 100\n};"],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.StaggerConfig","scope":"static","___s":true},{"meta":{"filename":"TimelineBuilderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TimelineBuilderConfig","type":{"names":["object"]},"since":"3.18.0","properties":[{"type":{"names":["Array.","Array.","function"]},"optional":true,"description":"An array of tween configuration objects to create and add into the new Timeline. If this doesn't exist or is empty, the Timeline will start off paused and none of the other configuration settings will be read. If it's a function, it will be called and its return value will be used as the array.","name":"tweens"},{"type":{"names":["any"]},"optional":true,"description":"An array (or function which returns one) of default targets to which to apply the Timeline. Each individual Tween configuration can override this value.","name":"targets"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"If specified, each Tween in the Timeline will get an equal portion of this duration, usually in milliseconds, by default. Each individual Tween configuration can override the Tween's duration.","name":"totalDuration"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1000,"description":"If `totalDuration` is not specified, the default duration, usually in milliseconds, of each Tween which will be created. Each individual Tween configuration can override the Tween's duration.","name":"duration"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to delay before the tween will start. Each individual Tween configuration can override this value.","name":"delay"},{"type":{"names":["array"]},"optional":true,"description":"Optional easing parameters. Each individual Tween configuration can override this value.","name":"easeParams"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Power0'","description":"The easing equation to use for each tween. Each individual Tween configuration can override this value.","name":"ease"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to hold each tween before yoyo'ing. Each individual Tween configuration can override this value.","name":"hold"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The number of times to repeat each tween. Each individual Tween configuration can override this value.","name":"repeat"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to pause before each tween will repeat. Each individual Tween configuration can override this value.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should each tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete. Each individual Tween configuration can override this value.","name":"yoyo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipX` property. Each individual Tween configuration can override this value.","name":"flipX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipY` property. Each individual Tween configuration can override this value.","name":"flipY"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"If specified, the time to wait, usually in milliseconds, before the Timeline completes.","name":"completeDelay"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"How many times the Timeline should loop, or -1 to loop indefinitely.","name":"loop"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The time, usually in milliseconds, between each loop.","name":"loopDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true`, the Timeline will start paused.","name":"paused"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true`, all duration in the Timeline will be in frames instead of milliseconds.","name":"useFrames"},{"type":{"names":["any"]},"optional":true,"description":"The default scope (`this` value) to use for each callback registered by the Timeline Builder. If not specified, the Timeline itself will be used.","name":"callbackScope"},{"type":{"names":["Phaser.Types.Tweens.TimelineOnStartCallback"]},"optional":true,"description":"If specified, the `onStart` callback for the Timeline, called every time it starts playing.","name":"onStart"},{"type":{"names":["any"]},"optional":true,"description":"The scope (`this` value) to use for the `onStart` callback. If not specified, the `callbackScope` will be used.","name":"onStartScope"},{"type":{"names":["array"]},"optional":true,"description":"Additional arguments to pass to the `onStart` callback. The Timeline will always be the first argument.","name":"onStartParams"},{"type":{"names":["Phaser.Types.Tweens.TimelineOnUpdateCallback"]},"optional":true,"description":"If specified, the `onUpdate` callback for the Timeline, called every frame it's active, regardless of its Tweens.","name":"onUpdate"},{"type":{"names":["any"]},"optional":true,"description":"The scope (`this` value) to use for the `onUpdate` callback. If not specified, the `callbackScope` will be used.","name":"onUpdateScope"},{"type":{"names":["array"]},"optional":true,"description":"Additional arguments to pass to the `onUpdate` callback. The Timeline will always be the first argument.","name":"onUpdateParams"},{"type":{"names":["Phaser.Types.Tweens.TimelineOnLoopCallback"]},"optional":true,"description":"If specified, the `onLoop` callback for the Timeline, called every time it loops.","name":"onLoop"},{"type":{"names":["any"]},"optional":true,"description":"The scope (`this` value) to use for the `onLoop` callback. If not specified, the `callbackScope` will be used.","name":"onLoopScope"},{"type":{"names":["array"]},"optional":true,"description":"Additional arguments to pass to the `onLoop` callback. The Timeline will always be the first argument.","name":"onLoopParams"},{"type":{"names":["Phaser.Types.Tweens.TimelineOnYoyoCallback"]},"optional":true,"description":"If specified, the `onYoyo` callback for the Timeline, called every time it yoyos.","name":"onYoyo"},{"type":{"names":["any"]},"optional":true,"description":"The scope (`this` value) to use for the `onYoyo` callback. If not specified, the `callbackScope` will be used.","name":"onYoyoScope"},{"type":{"names":["array"]},"optional":true,"description":"Additional arguments to pass to the `onYoyo` callback. The first argument will always be `null`, while the Timeline will always be the second argument.","name":"onYoyoParams"},{"type":{"names":["Phaser.Types.Tweens.TimelineOnCompleteCallback"]},"optional":true,"description":"If specified, the `onComplete` callback for the Timeline, called after it completes.","name":"onComplete"},{"type":{"names":["any"]},"optional":true,"description":"The scope (`this` value) to use for the `onComplete` callback. If not specified, the `callbackScope` will be used.","name":"onCompleteScope"},{"type":{"names":["array"]},"optional":true,"description":"Additional arguments to pass to the `onComplete` callback. The Timeline will always be the first argument.","name":"onCompleteParams"}],"see":["Phaser.Tweens.Builders.TimelineBuilder"],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TimelineBuilderConfig","scope":"static","___s":true},{"meta":{"filename":"TimelineOnCompleteCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TimelineOnCompleteCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The timeline.","name":"timeline"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onCompleteParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TimelineOnCompleteCallback","scope":"static","___s":true},{"meta":{"filename":"TimelineOnLoopCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TimelineOnLoopCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The timeline.","name":"timeline"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onLoopParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TimelineOnLoopCallback","scope":"static","___s":true},{"meta":{"filename":"TimelineOnStartCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TimelineOnStartCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The timeline.","name":"timeline"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onStartParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TimelineOnStartCallback","scope":"static","___s":true},{"meta":{"filename":"TimelineOnUpdateCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TimelineOnUpdateCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The timeline.","name":"timeline"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onUpdateParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TimelineOnUpdateCallback","scope":"static","___s":true},{"meta":{"filename":"TimelineOnYoyoCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TimelineOnYoyoCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"The timeline.","name":"timeline"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onYoyoParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TimelineOnYoyoCallback","scope":"static","___s":true},{"meta":{"filename":"TweenBuilderConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenBuilderConfig","type":{"names":["object"]},"since":"3.18.0","properties":[{"type":{"names":["any"]},"description":"The object, or an array of objects, to run the tween on.","name":"targets"},{"type":{"names":["number","function"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to delay before the tween will start.","name":"delay"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1000,"description":"The duration of the tween in milliseconds.","name":"duration"},{"type":{"names":["string","function"]},"optional":true,"defaultvalue":"'Power0'","description":"The easing equation to use for the tween.","name":"ease"},{"type":{"names":["array"]},"optional":true,"description":"Optional easing parameters.","name":"easeParams"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to hold the tween for before yoyo'ing.","name":"hold"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of times each property tween repeats.","name":"repeat"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to pause before a repeat.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.","name":"yoyo"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipX` property.","name":"flipX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipY` property.","name":"flipY"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":null,"description":"Used when the Tween is part of a Timeline.","name":"offset"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.","name":"completeDelay"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property tween has completed once.","name":"loop"},{"type":{"names":["number","function","object","array"]},"optional":true,"defaultvalue":0,"description":"The time the tween will pause before starting either a yoyo or returning to the start for a repeat.","name":"loopDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Does the tween start in a paused state (true) or playing (false)?","name":"paused"},{"type":{"names":["Object."]},"optional":true,"description":"The properties to tween.","name":"props"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Use frames or milliseconds?","name":"useFrames"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for the callbacks. The default scope is the tween.","name":"callbackScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnCompleteCallback"]},"optional":true,"description":"A function to call when the tween completes.","name":"onComplete"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onComplete`.","name":"onCompleteParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onComplete`.","name":"onCompleteScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnLoopCallback"]},"optional":true,"description":"A function to call each time the tween loops.","name":"onLoop"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onLoop`.","name":"onLoopParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onLoop`.","name":"onLoopScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnRepeatCallback"]},"optional":true,"description":"A function to call each time the tween repeats. Called once per property per target.","name":"onRepeat"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onRepeat`.","name":"onRepeatParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onRepeat`.","name":"onRepeatScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnStartCallback"]},"optional":true,"description":"A function to call when the tween starts playback, after any delays have expired.","name":"onStart"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onStart`.","name":"onStartParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onStart`.","name":"onStartScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnUpdateCallback"]},"optional":true,"description":"A function to call each time the tween steps. Called once per property per target.","name":"onUpdate"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onUpdate`.","name":"onUpdateParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onUpdate`.","name":"onUpdateScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnYoyoCallback"]},"optional":true,"description":"A function to call each time the tween yoyos. Called once per property per target.","name":"onYoyo"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onYoyo`.","name":"onYoyoParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onYoyo`.","name":"onYoyoScope"},{"type":{"names":["Phaser.Types.Tweens.TweenOnActiveCallback"]},"optional":true,"description":"A function to call when the tween becomes active within the Tween Manager.","name":"onActive"},{"type":{"names":["array"]},"optional":true,"description":"Additional parameters to pass to `onActive`.","name":"onActiveParams"},{"type":{"names":["any"]},"optional":true,"description":"Scope (this) for `onActive`.","name":"onActiveScope"}],"examples":["{\n targets: null,\n delay: 0,\n duration: 1000,\n ease: 'Power0',\n easeParams: null,\n hold: 0,\n repeat: 0,\n repeatDelay: 0,\n yoyo: false,\n flipX: false,\n flipY: false\n};"],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenBuilderConfig","scope":"static","___s":true},{"meta":{"filename":"TweenDataConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenDataConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["any"]},"description":"The target to tween.","name":"target"},{"type":{"names":["integer"]},"description":"The target index within the Tween targets array.","name":"index"},{"type":{"names":["string"]},"description":"The property of the target being tweened.","name":"key"},{"type":{"names":["Phaser.Types.Tweens.GetActiveCallback"]},"nullable":true,"description":"If not null, is invoked _immediately_ as soon as the TweenData is running, and is set on the target property.","name":"getActiveValue"},{"type":{"names":["Phaser.Types.Tweens.GetEndCallback"]},"description":"The returned value sets what the property will be at the END of the Tween.","name":"getEndValue"},{"type":{"names":["Phaser.Types.Tweens.GetStartCallback"]},"description":"The returned value sets what the property will be at the START of the Tween.","name":"getStartValue"},{"type":{"names":["function"]},"description":"The ease function this tween uses.","name":"ease"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Duration of the tween in ms/frames, excludes time for yoyo or repeats.","name":"duration"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The total calculated duration of this TweenData (based on duration, repeat, delay and yoyo)","name":"totalDuration"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time in ms/frames before tween will start.","name":"delay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Cause the tween to return back to its start value after hold has expired.","name":"yoyo"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time in ms/frames the tween will pause before running the yoyo or starting a repeat.","name":"hold"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.","name":"repeat"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time in ms/frames before the repeat will start.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Automatically call toggleFlipX when the TweenData yoyos or repeats","name":"flipX"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Automatically call toggleFlipY when the TweenData yoyos or repeats","name":"flipY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Between 0 and 1 showing completion of this TweenData.","name":"progress"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Delta counter","name":"elapsed"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"How many repeats are left to run?","name":"repeatCounter"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The property value at the start of the ease.","name":"start"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The current propety value.","name":"current"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The previous property value.","name":"previous"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The property value at the end of the ease.","name":"end"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time duration 1.","name":"t1"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Time duration 2.","name":"t2"},{"type":{"names":["Phaser.Types.Tweens.TweenDataGenConfig"]},"optional":true,"description":"LoadValue generation functions.","name":"gen"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"TWEEN_CONST.CREATED","name":"state"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenDataConfig","scope":"static","___s":true},{"meta":{"filename":"TweenDataGenConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenDataGenConfig","type":{"names":["object"]},"since":"3.0.0","properties":[{"type":{"names":["function"]},"description":"Time in ms/frames before tween will start.","name":"delay"},{"type":{"names":["function"]},"description":"Duration of the tween in ms/frames, excludes time for yoyo or repeats.","name":"duration"},{"type":{"names":["function"]},"description":"Time in ms/frames the tween will pause before running the yoyo or starting a repeat.","name":"hold"},{"type":{"names":["function"]},"description":"Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.","name":"repeat"},{"type":{"names":["function"]},"description":"Time in ms/frames before the repeat will start.","name":"repeatDelay"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenDataGenConfig","scope":"static","___s":true},{"meta":{"filename":"TweenOnActiveCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnActiveCallback","type":{"names":["function"]},"since":"3.19.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onActiveParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnActiveCallback","scope":"static","___s":true},{"meta":{"filename":"TweenOnCompleteCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnCompleteCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["array"]},"description":"The tween targets.","name":"targets"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onCompleteParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnCompleteCallback","scope":"static","___s":true},{"meta":{"filename":"TweenOnLoopCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnLoopCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["array"]},"description":"The tween targets.","name":"targets"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onLoopParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnLoopCallback","scope":"static","___s":true},{"meta":{"filename":"TweenOnRepeatCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnRepeatCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onRepeatParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnRepeatCallback","scope":"static","___s":true},{"meta":{"filename":"TweenOnStartCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnStartCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["array"]},"description":"The tween targets.","name":"targets"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onStartParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnStartCallback","scope":"static","___s":true},{"meta":{"filename":"TweenOnUpdateCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnUpdateCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onUpdateParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnUpdateCallback","scope":"static","___s":true},{"meta":{"filename":"TweenOnYoyoCallback.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenOnYoyoCallback","type":{"names":["function"]},"since":"3.18.0","params":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"The tween.","name":"tween"},{"type":{"names":["any"]},"description":"The tween target.","name":"target"},{"type":{"names":["any"]},"variable":true,"description":"Any value passed in `onYoyoParams`.","name":"param"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenOnYoyoCallback","scope":"static","___s":true},{"meta":{"filename":"TweenPropConfig.js","lineno":1,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"typedef","name":"TweenPropConfig","type":{"names":["object"]},"since":"3.18.0","properties":[{"type":{"names":["number","string","Phaser.Types.Tweens.GetEndCallback","Phaser.Types.Tweens.TweenPropConfig"]},"optional":true,"description":"What the property will be at the END of the Tween.","name":"value"},{"type":{"names":["Phaser.Types.Tweens.GetActiveCallback"]},"optional":true,"description":"What the property will be set to immediately when this tween becomes active.","name":"getActive"},{"type":{"names":["Phaser.Types.Tweens.GetEndCallback"]},"optional":true,"description":"What the property will be at the END of the Tween.","name":"getEnd"},{"type":{"names":["Phaser.Types.Tweens.GetStartCallback"]},"optional":true,"description":"What the property will be at the START of the Tween.","name":"getStart"},{"type":{"names":["string","function"]},"optional":true,"description":"The ease function this tween uses.","name":"ease"},{"type":{"names":["number"]},"optional":true,"description":"Time in ms/frames before tween will start.","name":"delay"},{"type":{"names":["number"]},"optional":true,"description":"Duration of the tween in ms/frames.","name":"duration"},{"type":{"names":["boolean"]},"optional":true,"description":"Determines whether the tween should return back to its start value after hold has expired.","name":"yoyo"},{"type":{"names":["number"]},"optional":true,"description":"Time in ms/frames the tween will pause before repeating or returning to its starting value if yoyo is set to true.","name":"hold"},{"type":{"names":["number"]},"optional":true,"description":"Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.","name":"repeat"},{"type":{"names":["number"]},"optional":true,"description":"Time in ms/frames before the repeat will start.","name":"repeatDelay"},{"type":{"names":["boolean"]},"optional":true,"description":"Should toggleFlipX be called when yoyo or repeat happens?","name":"flipX"},{"type":{"names":["boolean"]},"optional":true,"description":"Should toggleFlipY be called when yoyo or repeat happens?","name":"flipY"}],"memberof":"Phaser.Types.Tweens","longname":"Phaser.Types.Tweens.TweenPropConfig","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/tweens/typedefs"},"kind":"namespace","name":"Tweens","memberof":"Phaser.Types","longname":"Phaser.Types.Tweens","scope":"static","___s":true},{"meta":{"filename":"Class.js","lineno":69,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils"},"description":"Extends the given `myClass` object's prototype with the properties of `definition`.","kind":"function","name":"extend","params":[{"type":{"names":["Object"]},"description":"The constructor object to mix into.","name":"ctor"},{"type":{"names":["Object"]},"description":"A dictionary of functions for the class.","name":"definition"},{"type":{"names":["boolean"]},"description":"Is the definition a class descriptor?","name":"isClassDescriptor"},{"type":{"names":["Object"]},"optional":true,"description":"The parent constructor object.","name":"extend"}],"longname":"extend","scope":"global","___s":true},{"meta":{"filename":"Class.js","lineno":120,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils"},"description":"Applies the given `mixins` to the prototype of `myClass`.","kind":"function","name":"mixin","params":[{"type":{"names":["Object"]},"description":"The constructor object to mix into.","name":"myClass"},{"type":{"names":["Object","Array."]},"description":"The mixins to apply to the constructor.","name":"mixins"}],"longname":"mixin","scope":"global","___s":true},{"meta":{"range":[4556,6299],"filename":"Class.js","lineno":171,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils"},"description":"Creates a new class with the given descriptor.\nThe constructor, defined by the name `initialize`,\nis an optional function. If unspecified, an anonymous\nfunction will be used which calls the parent class (if\none exists).\n\nYou can also use `Extends` and `Mixins` to provide subclassing\nand inheritance.","kind":"class","classdesc":"Phaser.Class","params":[{"type":{"names":["Object"]},"description":"a dictionary of functions for the class","name":"definition"}],"examples":["var MyClass = new Phaser.Class({\n\n initialize: function() {\n this.foo = 2.0;\n },\n\n bar: function() {\n return this.foo + 5;\n }\n });"],"name":"Class","longname":"Class","scope":"global","___s":true},{"meta":{"filename":"NOOP.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils"},"description":"A NOOP (No Operation) callback function.\n\nUsed internally by Phaser when it's more expensive to determine if a callback exists\nthan it is to just invoke an empty function.","kind":"function","name":"NOOP","since":"3.0.0","memberof":"Phaser.Utils","longname":"Phaser.Utils.NOOP","scope":"static","___s":true},{"meta":{"filename":"Add.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Adds the given item, or array of items, to the array.\n\nEach item must be unique within the array.\n\nThe array is modified in-place and returned.\n\nYou can optionally specify a limit to the maximum size of the array. If the quantity of items being\nadded will take the array length over this limit, it will stop adding once the limit is reached.\n\nYou can optionally specify a callback to be invoked for each item successfully added to the array.","kind":"function","name":"Add","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to be added to.","name":"array"},{"type":{"names":["any","Array."]},"description":"The item, or array of items, to add to the array. Each item must be unique within the array.","name":"item"},{"type":{"names":["integer"]},"optional":true,"description":"Optional limit which caps the size of the array.","name":"limit"},{"type":{"names":["function"]},"optional":true,"description":"A callback to be invoked for each item successfully added to the array.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context in which the callback is invoked.","name":"context"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Add","scope":"static","___s":true},{"meta":{"filename":"AddAt.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Adds the given item, or array of items, to the array starting at the index specified.\n\nEach item must be unique within the array.\n\nExisting elements in the array are shifted up.\n\nThe array is modified in-place and returned.\n\nYou can optionally specify a limit to the maximum size of the array. If the quantity of items being\nadded will take the array length over this limit, it will stop adding once the limit is reached.\n\nYou can optionally specify a callback to be invoked for each item successfully added to the array.","kind":"function","name":"AddAt","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to be added to.","name":"array"},{"type":{"names":["any","Array."]},"description":"The item, or array of items, to add to the array.","name":"item"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The index in the array where the item will be inserted.","name":"index"},{"type":{"names":["integer"]},"optional":true,"description":"Optional limit which caps the size of the array.","name":"limit"},{"type":{"names":["function"]},"optional":true,"description":"A callback to be invoked for each item successfully added to the array.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context in which the callback is invoked.","name":"context"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.AddAt","scope":"static","___s":true},{"meta":{"filename":"BringToTop.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves the given element to the top of the array.\nThe array is modified in-place.","kind":"function","name":"BringToTop","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array.","name":"array"},{"type":{"names":["*"]},"description":"The element to move.","name":"item"}],"returns":[{"type":{"names":["*"]},"description":"The element that was moved."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.BringToTop","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"CountAllMatching.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SafeRange","longname":"SafeRange","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"CountAllMatching.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Returns the total number of elements in the array which have a property matching the given value.","kind":"function","name":"CountAllMatching","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search.","name":"array"},{"type":{"names":["string"]},"description":"The property to test on each array element.","name":"property"},{"type":{"names":["*"]},"description":"The value to test the property against. Must pass a strict (`===`) comparison check.","name":"value"},{"type":{"names":["integer"]},"optional":true,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"An optional end index to search to.","name":"endIndex"}],"returns":[{"type":{"names":["integer"]},"description":"The total number of elements with properties matching the given value."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.CountAllMatching","scope":"static","___s":true},{"meta":{"filename":"Each.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Passes each element in the array to the given callback.","kind":"function","name":"Each","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search.","name":"array"},{"type":{"names":["function"]},"description":"A callback to be invoked for each item in the array.","name":"callback"},{"type":{"names":["object"]},"description":"The context in which the callback is invoked.","name":"context"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the current array item.","name":"args"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Each","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"EachInRange.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SafeRange","longname":"SafeRange","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"EachInRange.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Passes each element in the array, between the start and end indexes, to the given callback.","kind":"function","name":"EachInRange","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search.","name":"array"},{"type":{"names":["function"]},"description":"A callback to be invoked for each item in the array.","name":"callback"},{"type":{"names":["object"]},"description":"The context in which the callback is invoked.","name":"context"},{"type":{"names":["integer"]},"description":"The start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"description":"The end index to search to.","name":"endIndex"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the child.","name":"args"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.EachInRange","scope":"static","___s":true},{"meta":{"filename":"FindClosestInSorted.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Searches a pre-sorted array for the closet value to the given number.\n\nIf the `key` argument is given it will assume the array contains objects that all have the required `key` property name,\nand will check for the closest value of those to the given number.","kind":"function","name":"FindClosestInSorted","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The value to search for in the array.","name":"value"},{"type":{"names":["array"]},"description":"The array to search, which must be sorted.","name":"array"},{"type":{"names":["string"]},"optional":true,"description":"An optional property key. If specified the array elements property will be checked against value.","name":"key"}],"returns":[{"type":{"names":["number","any"]},"description":"The nearest value found in the array, or if a `key` was given, the nearest object with the matching property value."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.FindClosestInSorted","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"GetAll.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SafeRange","longname":"SafeRange","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetAll.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Returns all elements in the array.\n\nYou can optionally specify a matching criteria using the `property` and `value` arguments.\n\nFor example: `getAll('visible', true)` would return only elements that have their visible property set.\n\nOptionally you can specify a start and end index. For example if the array had 100 elements,\nand you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\nthe first 50 elements.","kind":"function","name":"GetAll","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search.","name":"array"},{"type":{"names":["string"]},"optional":true,"description":"The property to test on each array element.","name":"property"},{"type":{"names":["*"]},"optional":true,"description":"The value to test the property against. Must pass a strict (`===`) comparison check.","name":"value"},{"type":{"names":["integer"]},"optional":true,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"An optional end index to search to.","name":"endIndex"}],"returns":[{"type":{"names":["array"]},"description":"All matching elements from the array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.GetAll","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"GetFirst.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SafeRange","longname":"SafeRange","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetFirst.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Returns the first element in the array.\n\nYou can optionally specify a matching criteria using the `property` and `value` arguments.\n\nFor example: `getAll('visible', true)` would return the first element that had its `visible` property set.\n\nOptionally you can specify a start and end index. For example if the array had 100 elements,\nand you set `startIndex` to 0 and `endIndex` to 50, it would search only the first 50 elements.","kind":"function","name":"GetFirst","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search.","name":"array"},{"type":{"names":["string"]},"optional":true,"description":"The property to test on each array element.","name":"property"},{"type":{"names":["*"]},"optional":true,"description":"The value to test the property against. Must pass a strict (`===`) comparison check.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"array.length","description":"An optional end index to search up to (but not included)","name":"endIndex"}],"returns":[{"type":{"names":["object"]},"description":"The first matching element from the array, or `null` if no element could be found in the range given."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.GetFirst","scope":"static","___s":true},{"meta":{"filename":"GetRandom.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Returns a Random element from the array.","kind":"function","name":"GetRandom","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to select the random entry from.","name":"array"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional start index.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"array.length","description":"An optional length, the total number of elements (from the startIndex) to choose from.","name":"length"}],"returns":[{"type":{"names":["*"]},"description":"A random element from the array, or `null` if no element could be found in the range given."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.GetRandom","scope":"static","___s":true},{"meta":{"filename":"MoveDown.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves the given array element down one place in the array.\nThe array is modified in-place.","kind":"function","name":"MoveDown","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The input array.","name":"array"},{"type":{"names":["*"]},"description":"The element to move down the array.","name":"item"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.MoveDown","scope":"static","___s":true},{"meta":{"filename":"MoveTo.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves an element in an array to a new position within the same array.\nThe array is modified in-place.","kind":"function","name":"MoveTo","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array.","name":"array"},{"type":{"names":["*"]},"description":"The element to move.","name":"item"},{"type":{"names":["integer"]},"description":"The new index that the element will be moved to.","name":"index"}],"returns":[{"type":{"names":["*"]},"description":"The element that was moved."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.MoveTo","scope":"static","___s":true},{"meta":{"filename":"MoveUp.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves the given array element up one place in the array.\nThe array is modified in-place.","kind":"function","name":"MoveUp","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The input array.","name":"array"},{"type":{"names":["*"]},"description":"The element to move up the array.","name":"item"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.MoveUp","scope":"static","___s":true},{"meta":{"filename":"NumberArray.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Create an array representing the range of numbers (usually integers), between, and inclusive of,\nthe given `start` and `end` arguments. For example:\n\n`var array = numberArray(2, 4); // array = [2, 3, 4]`\n`var array = numberArray(0, 9); // array = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]`\n\nThis is equivalent to `numberArrayStep(start, end, 1)`.\n\nYou can optionally provide a prefix and / or suffix string. If given the array will contain\nstrings, not integers. For example:\n\n`var array = numberArray(1, 4, 'Level '); // array = [\"Level 1\", \"Level 2\", \"Level 3\", \"Level 4\"]`\n`var array = numberArray(5, 7, 'HD-', '.png'); // array = [\"HD-5.png\", \"HD-6.png\", \"HD-7.png\"]`","kind":"function","name":"NumberArray","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum value the array starts with.","name":"start"},{"type":{"names":["number"]},"description":"The maximum value the array contains.","name":"end"},{"type":{"names":["string"]},"optional":true,"description":"Optional prefix to place before the number. If provided the array will contain strings, not integers.","name":"prefix"},{"type":{"names":["string"]},"optional":true,"description":"Optional suffix to place after the number. If provided the array will contain strings, not integers.","name":"suffix"}],"returns":[{"type":{"names":["Array.","Array."]},"description":"The array of number values, or strings if a prefix or suffix was provided."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.NumberArray","scope":"static","___s":true},{"meta":{"range":[180,239],"filename":"NumberArrayStep.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"RoundAwayFromZero","longname":"RoundAwayFromZero","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"NumberArrayStep.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Create an array of numbers (positive and/or negative) progressing from `start`\nup to but not including `end` by advancing by `step`.\n\nIf `start` is less than `end` a zero-length range is created unless a negative `step` is specified.\n\nCertain values for `start` and `end` (eg. NaN/undefined/null) are currently coerced to 0;\nfor forward compatibility make sure to pass in actual numbers.","examples":["NumberArrayStep(4);\n// => [0, 1, 2, 3]\n\nNumberArrayStep(1, 5);\n// => [1, 2, 3, 4]\n\nNumberArrayStep(0, 20, 5);\n// => [0, 5, 10, 15]\n\nNumberArrayStep(0, -4, -1);\n// => [0, -1, -2, -3]\n\nNumberArrayStep(1, 4, 0);\n// => [1, 1, 1]\n\nNumberArrayStep(0);\n// => []"],"kind":"function","name":"NumberArrayStep","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The start of the range.","name":"start"},{"type":{"names":["number"]},"optional":true,"defaultvalue":null,"description":"The end of the range.","name":"end"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The value to increment or decrement by.","name":"step"}],"returns":[{"type":{"names":["Array."]},"description":"The array of number values."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.NumberArrayStep","scope":"static","___s":true},{"meta":{"range":[195,285],"filename":"QuickSelect.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"ignore":true,"name":"swap","longname":"swap","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"range":[306,379],"filename":"QuickSelect.js","lineno":20,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"ignore":true,"name":"defaultCompare","longname":"defaultCompare","kind":"function","scope":"global","params":[],"___s":true},{"meta":{"filename":"QuickSelect.js","lineno":25,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"A [Floyd-Rivest](https://en.wikipedia.org/wiki/Floyd%E2%80%93Rivest_algorithm) quick selection algorithm.\n\nRearranges the array items so that all items in the [left, k] range are smaller than all items in [k, right];\nThe k-th element will have the (k - left + 1)th smallest value in [left, right].\n\nThe array is modified in-place.\n\nBased on code by [Vladimir Agafonkin](https://www.npmjs.com/~mourner)","kind":"function","name":"QuickSelect","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to sort.","name":"arr"},{"type":{"names":["integer"]},"description":"The k-th element index.","name":"k"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The index of the left part of the range.","name":"left"},{"type":{"names":["integer"]},"optional":true,"description":"The index of the right part of the range.","name":"right"},{"type":{"names":["function"]},"optional":true,"description":"An optional comparison function. Is passed two elements and should return 0, 1 or -1.","name":"compare"}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.QuickSelect","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"Range.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"GetValue","longname":"GetValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Range.js","lineno":28,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Creates an array populated with a range of values, based on the given arguments and configuration object.\n\nRange ([a,b,c], [1,2,3]) =\na1, a2, a3, b1, b2, b3, c1, c2, c3\n\nRange ([a,b], [1,2,3], qty = 3) =\na1, a1, a1, a2, a2, a2, a3, a3, a3, b1, b1, b1, b2, b2, b2, b3, b3, b3\n\nRange ([a,b,c], [1,2,3], repeat x1) =\na1, a2, a3, b1, b2, b3, c1, c2, c3, a1, a2, a3, b1, b2, b3, c1, c2, c3\n\nRange ([a,b], [1,2], repeat -1 = endless, max = 14) =\nMaybe if max is set then repeat goes to -1 automatically?\na1, a2, b1, b2, a1, a2, b1, b2, a1, a2, b1, b2, a1, a2 (capped at 14 elements)\n\nRange ([a], [1,2,3,4,5], random = true) =\na4, a1, a5, a2, a3\n\nRange ([a, b], [1,2,3], random = true) =\nb3, a2, a1, b1, a3, b2\n\nRange ([a, b, c], [1,2,3], randomB = true) =\na3, a1, a2, b2, b3, b1, c1, c3, c2\n\nRange ([a], [1,2,3,4,5], yoyo = true) =\na1, a2, a3, a4, a5, a5, a4, a3, a2, a1\n\nRange ([a, b], [1,2,3], yoyo = true) =\na1, a2, a3, b1, b2, b3, b3, b2, b1, a3, a2, a1","kind":"function","name":"Range","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The first array of range elements.","name":"a"},{"type":{"names":["array"]},"description":"The second array of range elements.","name":"b"},{"type":{"names":["object"]},"optional":true,"description":"A range configuration object. Can contain: repeat, random, randomB, yoyo, max, qty.","name":"options"}],"returns":[{"type":{"names":["array"]},"description":"An array of arranged elements."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Range","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"Remove.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SpliceOne","longname":"SpliceOne","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Remove.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Removes the given item, or array of items, from the array.\n\nThe array is modified in-place.\n\nYou can optionally specify a callback to be invoked for each item successfully removed from the array.","kind":"function","name":"Remove","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to be modified.","name":"array"},{"type":{"names":["*","Array.<*>"]},"description":"The item, or array of items, to be removed from the array.","name":"item"},{"type":{"names":["function"]},"optional":true,"description":"A callback to be invoked for each item successfully removed from the array.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context in which the callback is invoked.","name":"context"}],"returns":[{"type":{"names":["*","Array.<*>"]},"description":"The item, or array of items, that were successfully removed from the array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Remove","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"RemoveAt.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SpliceOne","longname":"SpliceOne","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RemoveAt.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Removes the item from the given position in the array.\n\nThe array is modified in-place.\n\nYou can optionally specify a callback to be invoked for the item if it is successfully removed from the array.","kind":"function","name":"RemoveAt","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to be modified.","name":"array"},{"type":{"names":["integer"]},"description":"The array index to remove the item from. The index must be in bounds or it will throw an error.","name":"index"},{"type":{"names":["function"]},"optional":true,"description":"A callback to be invoked for the item removed from the array.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context in which the callback is invoked.","name":"context"}],"returns":[{"type":{"names":["*"]},"description":"The item that was removed."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.RemoveAt","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"RemoveBetween.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SafeRange","longname":"SafeRange","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RemoveBetween.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Removes the item within the given range in the array.\n\nThe array is modified in-place.\n\nYou can optionally specify a callback to be invoked for the item/s successfully removed from the array.","kind":"function","name":"RemoveBetween","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to be modified.","name":"array"},{"type":{"names":["integer"]},"description":"The start index to remove from.","name":"startIndex"},{"type":{"names":["integer"]},"description":"The end index to remove to.","name":"endIndex"},{"type":{"names":["function"]},"optional":true,"description":"A callback to be invoked for the item removed from the array.","name":"callback"},{"type":{"names":["object"]},"optional":true,"description":"The context in which the callback is invoked.","name":"context"}],"returns":[{"type":{"names":["Array.<*>"]},"description":"An array of items that were removed."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.RemoveBetween","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"RemoveRandomElement.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SpliceOne","longname":"SpliceOne","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RemoveRandomElement.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Removes a random object from the given array and returns it.\nWill return null if there are no array items that fall within the specified range or if there is no item for the randomly chosen index.","kind":"function","name":"RemoveRandomElement","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to removed a random element from.","name":"array"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The array index to start the search from.","name":"start"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"array.length","description":"Optional restriction on the number of elements to randomly select from.","name":"length"}],"returns":[{"type":{"names":["object"]},"description":"The random element that was removed, or `null` if there were no array elements that fell within the given range."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.RemoveRandomElement","scope":"static","___s":true},{"meta":{"filename":"Replace.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Replaces an element of the array with the new element.\nThe new element cannot already be a member of the array.\nThe array is modified in-place.","kind":"function","name":"Replace","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search within.","name":"array"},{"type":{"names":["*"]},"description":"The element in the array that will be replaced.","name":"oldChild"},{"type":{"names":["*"]},"description":"The element to be inserted into the array at the position of `oldChild`.","name":"newChild"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns true if the oldChild was successfully replaced, otherwise returns false."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Replace","scope":"static","___s":true},{"meta":{"filename":"RotateLeft.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves the element at the start of the array to the end, shifting all items in the process.\nThe \"rotation\" happens to the left.","kind":"function","name":"RotateLeft","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to shift to the left. This array is modified in place.","name":"array"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The number of times to shift the array.","name":"total"}],"returns":[{"type":{"names":["*"]},"description":"The most recently shifted element."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.RotateLeft","scope":"static","___s":true},{"meta":{"filename":"RotateRight.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves the element at the end of the array to the start, shifting all items in the process.\nThe \"rotation\" happens to the right.","kind":"function","name":"RotateRight","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to shift to the right. This array is modified in place.","name":"array"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The number of times to shift the array.","name":"total"}],"returns":[{"type":{"names":["*"]},"description":"The most recently shifted element."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.RotateRight","scope":"static","___s":true},{"meta":{"filename":"SafeRange.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Tests if the start and end indexes are a safe range for the given array.","kind":"function","name":"SafeRange","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to check.","name":"array"},{"type":{"names":["integer"]},"description":"The start index.","name":"startIndex"},{"type":{"names":["integer"]},"description":"The end index.","name":"endIndex"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Throw an error if the range is out of bounds.","name":"throwError"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the range is safe, otherwise false."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.SafeRange","scope":"static","___s":true},{"meta":{"filename":"SendToBack.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Moves the given element to the bottom of the array.\nThe array is modified in-place.","kind":"function","name":"SendToBack","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array.","name":"array"},{"type":{"names":["*"]},"description":"The element to move.","name":"item"}],"returns":[{"type":{"names":["*"]},"description":"The element that was moved."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.SendToBack","scope":"static","___s":true},{"meta":{"range":[180,214],"filename":"SetAll.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"name":"SafeRange","longname":"SafeRange","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"SetAll.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Scans the array for elements with the given property. If found, the property is set to the `value`.\n\nFor example: `SetAll('visible', true)` would set all elements that have a `visible` property to `false`.\n\nOptionally you can specify a start and end index. For example if the array had 100 elements,\nand you set `startIndex` to 0 and `endIndex` to 50, it would update only the first 50 elements.","kind":"function","name":"SetAll","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The array to search.","name":"array"},{"type":{"names":["string"]},"description":"The property to test for on each array element.","name":"property"},{"type":{"names":["*"]},"description":"The value to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"description":"An optional start index to search from.","name":"startIndex"},{"type":{"names":["integer"]},"optional":true,"description":"An optional end index to search to.","name":"endIndex"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.SetAll","scope":"static","___s":true},{"meta":{"filename":"Shuffle.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Shuffles the contents of the given array using the Fisher-Yates implementation.\n\nThe original array is modified directly and returned.","kind":"function","name":"Shuffle","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The array to shuffle. This array is modified in place.","name":"array"}],"returns":[{"type":{"names":["Array."]},"description":"The shuffled array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Shuffle","scope":"static","___s":true},{"meta":{"filename":"SpliceOne.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Removes a single item from an array and returns it without creating gc, like the native splice does.\nBased on code by Mike Reinstein.","kind":"function","name":"SpliceOne","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The array to splice from.","name":"array"},{"type":{"names":["integer"]},"description":"The index of the item which should be spliced.","name":"index"}],"returns":[{"type":{"names":["*"]},"description":"The item which was spliced (removed)."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.SpliceOne","scope":"static","___s":true},{"meta":{"filename":"StableSort.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"kind":"namespace","name":"StableSortFunctions","memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.StableSortFunctions","scope":"static","___s":true},{"meta":{"filename":"StableSort.js","lineno":16,"columnno":1,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"A stable array sort, because `Array#sort()` is not guaranteed stable.\nThis is an implementation of merge sort, without recursion.","kind":"function","name":"StableSort","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The input array to be sorted.","name":"arr"},{"type":{"names":["function"]},"description":"The comparison handler.","name":"comp"}],"returns":[{"type":{"names":["array"]},"description":"The sorted result."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.StableSort","scope":"static","___s":true},{"meta":{"filename":"StableSort.js","lineno":32,"columnno":1,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Sort the input array and simply copy it back if the result isn't in the original array, which happens on an odd number of passes.","kind":"function","name":"inplace","memberof":"Phaser.Utils.Array.StableSortFunctions","since":"3.0.0","params":[{"type":{"names":["array"]},"description":"The input array.","name":"arr"},{"type":{"names":["function"]},"description":"The comparison handler.","name":"comp"}],"returns":[{"type":{"names":["array"]},"description":"The sorted array."}],"longname":"Phaser.Utils.Array.StableSortFunctions.inplace","scope":"static","___s":true},{"meta":{"filename":"Swap.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"description":"Swaps the position of two elements in the given array.\nThe elements must exist in the same array.\nThe array is modified in-place.","kind":"function","name":"Swap","since":"3.4.0","params":[{"type":{"names":["array"]},"description":"The input array.","name":"array"},{"type":{"names":["*"]},"description":"The first element to swap.","name":"item1"},{"type":{"names":["*"]},"description":"The second element to swap.","name":"item2"}],"returns":[{"type":{"names":["array"]},"description":"The input array."}],"memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Swap","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array"},"kind":"namespace","name":"Array","memberof":"Phaser.Utils","longname":"Phaser.Utils.Array","scope":"static","___s":true},{"meta":{"filename":"CheckMatrix.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Checks if an array can be used as a matrix.\n\nA matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows) have the same length. There must be at least two rows:\n\n```\n [\n [ 1, 1, 1, 1, 1, 1 ],\n [ 2, 0, 0, 0, 0, 4 ],\n [ 2, 0, 1, 2, 0, 4 ],\n [ 2, 0, 3, 4, 0, 4 ],\n [ 2, 0, 0, 0, 0, 4 ],\n [ 3, 3, 3, 3, 3, 3 ]\n ]\n```","kind":"function","name":"CheckMatrix","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array to check.","name":"matrix"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the given `matrix` array is a valid matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.CheckMatrix","scope":"static","___s":true},{"meta":{"range":[180,213],"filename":"MatrixToString.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"name":"Pad","longname":"Pad","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MatrixToString.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Generates a string (which you can pass to console.log) from the given Array Matrix.","kind":"function","name":"MatrixToString","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"A 2-dimensional array.","name":"matrix"}],"returns":[{"type":{"names":["string"]},"description":"A string representing the matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.MatrixToString","scope":"static","___s":true},{"meta":{"filename":"ReverseColumns.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Reverses the columns in the given Array Matrix.","kind":"function","name":"ReverseColumns","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array matrix to reverse the columns for.","name":"matrix"}],"returns":[{"type":{"names":["Array.>"]},"description":"The column reversed matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.ReverseColumns","scope":"static","___s":true},{"meta":{"filename":"ReverseRows.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Reverses the rows in the given Array Matrix.","kind":"function","name":"ReverseRows","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array matrix to reverse the rows for.","name":"matrix"}],"returns":[{"type":{"names":["Array.>"]},"description":"The column reversed matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.ReverseRows","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"Rotate180.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"name":"RotateMatrix","longname":"RotateMatrix","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Rotate180.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Rotates the array matrix 180 degrees.","kind":"function","name":"Rotate180","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array to rotate.","name":"matrix"}],"returns":[{"type":{"names":["Array.>"]},"description":"The rotated matrix array. The source matrix should be discard for the returned matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.Rotate180","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"RotateLeft.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"name":"RotateMatrix","longname":"RotateMatrix","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateLeft.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Rotates the array matrix to the left (or 90 degrees)","kind":"function","name":"RotateLeft","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array to rotate.","name":"matrix"}],"returns":[{"type":{"names":["Array.>"]},"description":"The rotated matrix array. The source matrix should be discard for the returned matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.RotateLeft","scope":"static","___s":true},{"meta":{"range":[180,218],"filename":"RotateMatrix.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"name":"CheckMatrix","longname":"CheckMatrix","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateMatrix.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Rotates the array matrix based on the given rotation value.\n\nThe value can be given in degrees: 90, -90, 270, -270 or 180,\nor a string command: `rotateLeft`, `rotateRight` or `rotate180`.\n\nBased on the routine from {@link http://jsfiddle.net/MrPolywhirl/NH42z/}.","kind":"function","name":"RotateMatrix","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array to rotate.","name":"matrix"},{"type":{"names":["number","string"]},"optional":true,"defaultvalue":90,"description":"The amount to rotate the matrix by.","name":"direction"}],"returns":[{"type":{"names":["Array.>"]},"description":"The rotated matrix array. The source matrix should be discard for the returned matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.RotateMatrix","scope":"static","___s":true},{"meta":{"range":[180,220],"filename":"RotateRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"name":"RotateMatrix","longname":"RotateMatrix","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"RotateRight.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Rotates the array matrix to the left (or -90 degrees)","kind":"function","name":"RotateRight","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array to rotate.","name":"matrix"}],"returns":[{"type":{"names":["Array.>"]},"description":"The rotated matrix array. The source matrix should be discard for the returned matrix."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.RotateRight","scope":"static","___s":true},{"meta":{"filename":"TransposeMatrix.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"description":"Transposes the elements of the given matrix (array of arrays).\n\nThe transpose of a matrix is a new matrix whose rows are the columns of the original.","kind":"function","name":"TransposeMatrix","since":"3.0.0","params":[{"type":{"names":["Array.>"]},"optional":true,"description":"The array matrix to transpose.","name":"array"}],"returns":[{"type":{"names":["Array.>"]},"description":"A new array matrix which is a transposed version of the given array."}],"memberof":"Phaser.Utils.Array.Matrix","longname":"Phaser.Utils.Array.Matrix.TransposeMatrix","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/array/matrix"},"kind":"namespace","name":"Matrix","memberof":"Phaser.Utils.Array","longname":"Phaser.Utils.Array.Matrix","scope":"static","___s":true},{"meta":{"range":[265,339],"filename":"ArrayBufferToBase64.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/base64"},"name":"chars","longname":"chars","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"ArrayBufferToBase64.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/base64"},"description":"Converts an ArrayBuffer into a base64 string.\n\nThe resulting string can optionally be a data uri if the `mediaType` argument is provided.\n\nSee https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs for more details.","kind":"function","name":"ArrayBufferToBase64","since":"3.18.0","params":[{"type":{"names":["ArrayBuffer"]},"description":"The Array Buffer to encode.","name":"arrayBuffer"},{"type":{"names":["string"]},"optional":true,"description":"An optional media type, i.e. `audio/ogg` or `image/jpeg`. If included the resulting string will be a data URI.","name":"mediaType"}],"returns":[{"type":{"names":["string"]},"description":"The base64 encoded Array Buffer."}],"memberof":"Phaser.Utils.Base64","longname":"Phaser.Utils.Base64.ArrayBufferToBase64","scope":"static","___s":true},{"meta":{"range":[265,339],"filename":"Base64ToArrayBuffer.js","lineno":8,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/base64"},"name":"chars","longname":"chars","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Base64ToArrayBuffer.js","lineno":18,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/base64"},"description":"Converts a base64 string, either with or without a data uri, into an Array Buffer.","kind":"function","name":"Base64ToArrayBuffer","since":"3.18.0","params":[{"type":{"names":["string"]},"description":"The base64 string to be decoded. Can optionally contain a data URI header, which will be stripped out prior to decoding.","name":"base64"}],"returns":[{"type":{"names":["ArrayBuffer"]},"description":"An ArrayBuffer decoded from the base64 data."}],"memberof":"Phaser.Utils.Base64","longname":"Phaser.Utils.Base64.Base64ToArrayBuffer","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/base64"},"kind":"namespace","name":"Base64","memberof":"Phaser.Utils","longname":"Phaser.Utils.Base64","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils"},"kind":"namespace","name":"Utils","memberof":"Phaser","longname":"Phaser.Utils","scope":"static","___s":true},{"meta":{"filename":"Clone.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Shallow Object Clone. Will not clone nested objects.","kind":"function","name":"Clone","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"the object from which to clone","name":"obj"}],"returns":[{"type":{"names":["object"]},"description":"a new object with the same properties as the input obj"}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.Clone","scope":"static","___s":true},{"meta":{"range":[180,222],"filename":"Extend.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"name":"IsPlainObject","longname":"IsPlainObject","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Extend.js","lineno":13,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"This is a slightly modified version of http://api.jquery.com/jQuery.extend/","kind":"function","name":"Extend","since":"3.0.0","returns":[{"type":{"names":["object"]},"description":"The extended object."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.Extend","scope":"static","___s":true},{"meta":{"range":[180,208],"filename":"GetAdvancedValue.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"name":"MATH","longname":"MATH","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetAdvancedValue.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Retrieves a value from an object. Allows for more advanced selection options, including:\n\nAllowed types:\n\nImplicit\n{\n x: 4\n}\n\nFrom function\n{\n x: function ()\n}\n\nRandomly pick one element from the array\n{\n x: [a, b, c, d, e, f]\n}\n\nRandom integer between min and max:\n{\n x: { randInt: [min, max] }\n}\n\nRandom float between min and max:\n{\n x: { randFloat: [min, max] }\n}","kind":"function","name":"GetAdvancedValue","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to retrieve the value from.","name":"source"},{"type":{"names":["string"]},"description":"The name of the property to retrieve from the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`) - `banner.hideBanner` would return the value of the `hideBanner` property from the object stored in the `banner` property of the `source` object.","name":"key"},{"type":{"names":["*"]},"description":"The value to return if the `key` isn't found in the `source` object.","name":"defaultValue"}],"returns":[{"type":{"names":["*"]},"description":"The value of the requested key."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.GetAdvancedValue","scope":"static","___s":true},{"meta":{"filename":"GetFastValue.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Finds the key within the top level of the {@link source} object, or returns {@link defaultValue}","kind":"function","name":"GetFastValue","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to search","name":"source"},{"type":{"names":["string"]},"description":"The key for the property on source. Must exist at the top level of the source object (no periods)","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The default value to use if the key does not exist.","name":"defaultValue"}],"returns":[{"type":{"names":["*"]},"description":"The value if found; otherwise, defaultValue (null if none provided)"}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.GetFastValue","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"GetMinMaxValue.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"name":"GetValue","longname":"GetValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"GetMinMaxValue.js","lineno":10,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Retrieves and clamps a numerical value from an object.","kind":"function","name":"GetMinMaxValue","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to retrieve the value from.","name":"source"},{"type":{"names":["string"]},"description":"The name of the property to retrieve from the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`).","name":"key"},{"type":{"names":["number"]},"description":"The minimum value which can be returned.","name":"min"},{"type":{"names":["number"]},"description":"The maximum value which can be returned.","name":"max"},{"type":{"names":["number"]},"description":"The value to return if the property doesn't exist. It's also constrained to the given bounds.","name":"defaultValue"}],"returns":[{"type":{"names":["number"]},"description":"The clamped value from the `source` object."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.GetMinMaxValue","scope":"static","___s":true},{"meta":{"filename":"GetValue.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Retrieves a value from an object.","kind":"function","name":"GetValue","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to retrieve the value from.","name":"source"},{"type":{"names":["string"]},"description":"The name of the property to retrieve from the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`) - `banner.hideBanner` would return the value of the `hideBanner` property from the object stored in the `banner` property of the `source` object.","name":"key"},{"type":{"names":["*"]},"description":"The value to return if the `key` isn't found in the `source` object.","name":"defaultValue"}],"returns":[{"type":{"names":["*"]},"description":"The value of the requested key."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.GetValue","scope":"static","___s":true},{"meta":{"filename":"HasAll.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Verifies that an object contains all requested keys","kind":"function","name":"HasAll","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"an object on which to check for key existence","name":"source"},{"type":{"names":["Array."]},"description":"an array of keys to ensure the source object contains","name":"keys"}],"returns":[{"type":{"names":["boolean"]},"description":"true if the source object contains all keys, false otherwise."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.HasAll","scope":"static","___s":true},{"meta":{"filename":"HasAny.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Verifies that an object contains at least one of the requested keys","kind":"function","name":"HasAny","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"an object on which to check for key existence","name":"source"},{"type":{"names":["Array."]},"description":"an array of keys to search the object for","name":"keys"}],"returns":[{"type":{"names":["boolean"]},"description":"true if the source object contains at least one of the keys, false otherwise"}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.HasAny","scope":"static","___s":true},{"meta":{"filename":"HasValue.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Determine whether the source object has a property with the specified key.","kind":"function","name":"HasValue","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The source object to be checked.","name":"source"},{"type":{"names":["string"]},"description":"The property to check for within the object","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the provided `key` exists on the `source` object, otherwise `false`."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.HasValue","scope":"static","___s":true},{"meta":{"filename":"IsPlainObject.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"This is a slightly modified version of jQuery.isPlainObject.\nA plain object is an object whose internal class property is [object Object].","kind":"function","name":"IsPlainObject","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The object to inspect.","name":"obj"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the object is plain, otherwise `false`."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.IsPlainObject","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"Merge.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"name":"Clone","longname":"Clone","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Merge.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Creates a new Object using all values from obj1 and obj2.\nIf a value exists in both obj1 and obj2, the value in obj1 is used.\n\nThis is only a shallow copy. Deeply nested objects are not cloned, so be sure to only use this\nfunction on shallow objects.","kind":"function","name":"Merge","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The first object.","name":"obj1"},{"type":{"names":["object"]},"description":"The second object.","name":"obj2"}],"returns":[{"type":{"names":["object"]},"description":"A new object containing the union of obj1's and obj2's properties."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.Merge","scope":"static","___s":true},{"meta":{"range":[180,206],"filename":"MergeRight.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"name":"Clone","longname":"Clone","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"MergeRight.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Creates a new Object using all values from obj1.\n\nThen scans obj2. If a property is found in obj2 that *also* exists in obj1, the value from obj2 is used, otherwise the property is skipped.","kind":"function","name":"MergeRight","since":"3.0.0","params":[{"type":{"names":["object"]},"description":"The first object to merge.","name":"obj1"},{"type":{"names":["object"]},"description":"The second object to merge. Keys from this object which also exist in `obj1` will be copied to `obj1`.","name":"obj2"}],"returns":[{"type":{"names":["object"]},"description":"The merged object. `obj1` and `obj2` are not modified."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.MergeRight","scope":"static","___s":true},{"meta":{"range":[180,212],"filename":"Pick.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"name":"HasValue","longname":"HasValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Pick.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Returns a new object that only contains the `keys` that were found on the object provided.\nIf no `keys` are found, an empty object is returned.","kind":"function","name":"Pick","since":"3.18.0","params":[{"type":{"names":["object"]},"description":"The object to pick the provided keys from.","name":"object"},{"type":{"names":["array"]},"description":"An array of properties to retrieve from the provided object.","name":"keys"}],"returns":[{"type":{"names":["object"]},"description":"A new object that only contains the `keys` that were found on the provided object. If no `keys` were found, an empty object will be returned."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.Pick","scope":"static","___s":true},{"meta":{"filename":"SetValue.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"description":"Sets a value in an object, allowing for dot notation to control the depth of the property.\n\nFor example:\n\n```javascript\nvar data = {\n world: {\n position: {\n x: 200,\n y: 100\n }\n }\n};\n\nSetValue(data, 'world.position.y', 300);\n\nconsole.log(data.world.position.y); // 300\n```","kind":"function","name":"SetValue","since":"3.17.0","params":[{"type":{"names":["object"]},"description":"The object to set the value in.","name":"source"},{"type":{"names":["string"]},"description":"The name of the property in the object. If a property is nested, the names of its preceding properties should be separated by a dot (`.`)","name":"key"},{"type":{"names":["any"]},"description":"The value to set into the property, if found in the source object.","name":"value"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the property key was valid and the value was set, otherwise `false`."}],"memberof":"Phaser.Utils.Objects","longname":"Phaser.Utils.Objects.SetValue","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/object"},"kind":"namespace","name":"Objects","memberof":"Phaser.Utils","longname":"Phaser.Utils.Objects","scope":"static","___s":true},{"meta":{"filename":"Format.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/string"},"description":"Takes a string and replaces instances of markers with values in the given array.\nThe markers take the form of `%1`, `%2`, etc. I.e.:\n\n`Format(\"The %1 is worth %2 gold\", [ 'Sword', 500 ])`","kind":"function","name":"Format","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string containing the replacement markers.","name":"string"},{"type":{"names":["array"]},"description":"An array containing values that will replace the markers. If no value exists an empty string is inserted instead.","name":"values"}],"returns":[{"type":{"names":["string"]},"description":"The string containing replaced values."}],"memberof":"Phaser.Utils.String","longname":"Phaser.Utils.String.Format","scope":"static","___s":true},{"meta":{"filename":"Pad.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/string"},"description":"Takes the given string and pads it out, to the length required, using the character\nspecified. For example if you need a string to be 6 characters long, you can call:\n\n`pad('bob', 6, '-', 2)`\n\nThis would return: `bob---` as it has padded it out to 6 characters, using the `-` on the right.\n\nYou can also use it to pad numbers (they are always returned as strings):\n\n`pad(512, 6, '0', 1)`\n\nWould return: `000512` with the string padded to the left.\n\nIf you don't specify a direction it'll pad to both sides:\n\n`pad('c64', 7, '*')`\n\nWould return: `**c64**`","kind":"function","name":"Pad","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The target string. `toString()` will be called on the string, which means you can also pass in common data types like numbers.","name":"str"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The number of characters to be added.","name":"len"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"\" \"","description":"The string to pad it out with (defaults to a space).","name":"pad"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":3,"description":"The direction dir = 1 (left), 2 (right), 3 (both).","name":"dir"}],"returns":[{"type":{"names":["string"]},"description":"The padded string."}],"memberof":"Phaser.Utils.String","longname":"Phaser.Utils.String.Pad","scope":"static","___s":true},{"meta":{"filename":"Reverse.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/string"},"description":"Takes the given string and reverses it, returning the reversed string.\nFor example if given the string `Atari 520ST` it would return `TS025 iratA`.","kind":"function","name":"Reverse","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string to be reversed.","name":"string"}],"returns":[{"type":{"names":["string"]},"description":"The reversed string."}],"memberof":"Phaser.Utils.String","longname":"Phaser.Utils.String.Reverse","scope":"static","___s":true},{"meta":{"filename":"UUID.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/string"},"description":"Creates and returns an RFC4122 version 4 compliant UUID.\n\nThe string is in the form: `xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx` where each `x` is replaced with a random\nhexadecimal digit from 0 to f, and `y` is replaced with a random hexadecimal digit from 8 to b.","kind":"function","name":"UUID","since":"3.12.0","returns":[{"type":{"names":["string"]},"description":"The UUID string."}],"memberof":"Phaser.Utils.String","longname":"Phaser.Utils.String.UUID","scope":"static","___s":true},{"meta":{"filename":"UppercaseFirst.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/string"},"description":"Capitalizes the first letter of a string if there is one.","examples":["UppercaseFirst('abc');\n// returns 'Abc'","UppercaseFirst('the happy family');\n// returns 'The happy family'","UppercaseFirst('');\n// returns ''"],"kind":"function","name":"UppercaseFirst","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string to capitalize.","name":"str"}],"returns":[{"type":{"names":["string"]},"description":"A new string, same as the first, but with the first letter capitalized."}],"memberof":"Phaser.Utils.String","longname":"Phaser.Utils.String.UppercaseFirst","scope":"static","___s":true},{"meta":{"filename":"index.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/utils/string"},"kind":"namespace","name":"String","memberof":"Phaser.Utils","longname":"Phaser.Utils.String","scope":"static","___s":true},{"meta":{"filename":"AdInstance.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"kind":"typedef","name":"AdInstance","type":{"names":["object"]},"properties":[{"type":{"names":["any"]},"description":"Represents an instance of an ad.","name":"instance"},{"type":{"names":["string"]},"description":"The Audience Network placement ID of this ad instance.","name":"placementID"},{"type":{"names":["boolean"]},"description":"Has this ad already been shown in-game?","name":"shown"},{"type":{"names":["boolean"]},"description":"Is this a video ad?","name":"video"}],"longname":"AdInstance","scope":"global","___s":true},{"meta":{"range":[234,270],"filename":"FacebookInstantGamesPlugin.js","lineno":9,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"name":"AdInstance","longname":"AdInstance","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":17,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"classdesc":"The Facebook Instant Games Plugin for Phaser 3 provides a seamless bridge between Phaser\nand the Facebook Instant Games API version 6.2.\n\nYou can access this plugin via the `facebook` property in a Scene, i.e:\n\n```javascript\nthis.facebook.getPlatform();\n```\n\nIf this is unavailable please check to make sure you're using a build of Phaser that has\nthis plugin within it. You can quickly check this by looking at the dev tools console\nheader - the Phaser version number will have `-FB` after it if this plugin is loaded.\n\nIf you are building your own version of Phaser then use this Webpack DefinePlugin flag:\n\n`\"typeof PLUGIN_FBINSTANT\": JSON.stringify(true)`\n\nYou will find that every Instant Games API method has a mapping in this plugin.\nFor a full list please consult either the plugin documentation, or the 6.2 SDK documentation\nat https://developers.facebook.com/docs/games/instant-games/sdk/fbinstant6.2\n\nInternally this plugin uses its own Data Manager to handle seamless user data updates and provides\nhandy functions for advertisement displaying, opening share dialogs, logging, leaderboards, purchase API requests,\nloader integration and more.\n\nTo get started with Facebook Instant Games you will need to register on Facebook and create a new Instant\nGame app that has its own unique app ID. Facebook have also provided a dashboard interface for setting up\nvarious features for your game, including leaderboards, ad requests and the payments API. There are lots\nof guides on the Facebook Developers portal to assist with setting these\nvarious systems up: https://developers.facebook.com/docs/games/instant-games/guides\n\nFor more details follow the Quick Start guide here: https://developers.facebook.com/docs/games/instant-games","kind":"class","name":"FacebookInstantGamesPlugin","memberof":"Phaser","augments":["Phaser.Events.EventEmitter"],"since":"3.13.0","params":[{"type":{"names":["Phaser.Game"]},"description":"A reference to the Phaser.Game instance.","name":"game"}],"scope":"static","longname":"Phaser.FacebookInstantGamesPlugin","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A reference to the Phaser.Game instance.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#game","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A Data Manager instance.\nIt allows you to store, query and retrieve any key/value data you may need to store.\nIt's also used internally by the plugin to store FBIG API data.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#data","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":94,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Has the Facebook Instant Games API loaded yet?\nThis is set automatically during the boot process.","name":"hasLoaded","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#hasLoaded","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Is the Data Manager currently locked?","name":"dataLocked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#dataLocked","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":113,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A list of the Facebook Instant Games APIs that are available,\nbased on the given platform, context and user privacy settings.\nThis value is populated automatically during boot.","name":"supportedAPIs","type":{"names":["Array."]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#supportedAPIs","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Holds the entry point that the game was launched from.\nThis value is populated automatically during boot.","name":"entryPoint","type":{"names":["string"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#entryPoint","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":134,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"An object that contains any data associated with the entry point that the game was launched from.\nThe contents of the object are developer-defined, and can occur from entry points on different platforms.\nThis will return null for older mobile clients, as well as when there is no data associated with the particular entry point.\nThis value is populated automatically during boot.","name":"entryPointData","type":{"names":["any"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#entryPointData","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":146,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A unique identifier for the current game context. This represents a specific context\nthat the game is being played in (for example, a particular messenger conversation or facebook post).\nThe identifier will be null if game is being played in a solo context.\nThis value is populated automatically during boot.","name":"contextID","type":{"names":["string"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#contextID","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The current context in which your game is running. This can be either `null` or\none of:\n\n`POST` - The game is running inside of a Facebook post.\n`THREAD` - The game is running inside a Facebook Messenger thread.\n`GROUP` - The game is running inside a Facebook Group.\n`SOLO` - This is the default context, the player is the only participant.\n\nThis value is populated automatically during boot.","name":"contextType","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#contextType","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":175,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The current locale.\nSee https://origincache.facebook.com/developers/resources/?id=FacebookLocales.xml for a complete list of supported locale values.\nUse this to determine what languages the current game should be localized with.\nThis value is populated automatically during boot.","name":"locale","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#locale","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The platform on which the game is currently running, i.e. `IOS`.\nThis value is populated automatically during boot.","name":"platform","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#platform","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":197,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The string representation of the Facebook Instant Games SDK version being used.\nThis value is populated automatically during boot.","name":"version","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#version","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":207,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Holds the id of the player. This is a string based ID, the same as `FBInstant.player.getID()`.\nThis value is populated automatically during boot if the API is supported.","name":"playerID","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#playerID","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":217,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The player's localized display name.\nThis value is populated automatically during boot if the API is supported.","name":"playerName","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#playerName","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":227,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A url to the player's public profile photo. The photo will always be a square, and with dimensions\nof at least 200x200. When rendering it in the game, the exact dimensions should never be assumed to be constant.\nIt's recommended to always scale the image to a desired size before rendering.\nThis value is populated automatically during boot if the API is supported.","name":"playerPhotoURL","type":{"names":["string"]},"nullable":true,"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#playerPhotoURL","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":239,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Whether a player can subscribe to the game bot or not.","name":"playerCanSubscribeBot","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#playerCanSubscribeBot","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":248,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Does the current platform and context allow for use of the payments API?\nCurrently this is only available on Facebook.com and Android 6+.","name":"paymentsReady","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#paymentsReady","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":258,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The set of products that are registered to the game.","name":"catalog","type":{"names":["Array."]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#catalog","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":267,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Contains all of the player's unconsumed purchases.\nThe game must fetch the current player's purchases as soon as the client indicates that it is ready to perform payments-related operations,\ni.e. at game start. The game can then process and consume any purchases that are waiting to be consumed.","name":"purchases","type":{"names":["Array."]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#purchases","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":278,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Contains all of the leaderboard data, as populated by the `getLeaderboard()` method.","name":"leaderboards","type":{"names":["Array."]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#leaderboards","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":287,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Contains AdInstance objects, as created by the `preloadAds()` method.","name":"ads","type":{"names":["Array."]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#ads","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":357,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Call this method from your `Scene.preload` in order to sync the load progress\nof the Phaser Loader with the Facebook Instant Games loader display, i.e.:\n\n```javascript\nthis.facebook.showLoadProgress(this);\nthis.facebook.once('startgame', this.startGame, this);\n```","kind":"function","name":"showLoadProgress","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene for which you want to show loader progress for.","name":"scene"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#showLoadProgress","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":398,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"This method is called automatically when the game has finished loading,\nif you used the `showLoadProgress` method. If your game doesn't need to\nload any assets, or you're managing the load yourself, then call this\nmethod directly to start the API running.\n\nWhen the API has finished starting this plugin will emit a `startgame` event\nwhich you should listen for.","kind":"function","name":"gameStarted","since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#gameStarted","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Checks to see if a given Facebook Instant Games API is available or not.","kind":"function","name":"checkAPI","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The API to check for, i.e. `player.getID`.","name":"api"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the API is supported, otherwise `false`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#checkAPI","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the unique identifier for the current game context. This represents a specific context\nthat the game is being played in (for example, a particular messenger conversation or facebook post).\nThe identifier will be null if game is being played in a solo context.\n\nIt is only populated if `contextGetID` is in the list of supported APIs.","kind":"function","name":"getID","since":"3.13.0","returns":[{"type":{"names":["string"]},"description":"The context ID."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getID","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":538,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the current context in which your game is running. This can be either `null` or one of:\n\n`POST` - The game is running inside of a Facebook post.\n`THREAD` - The game is running inside a Facebook Messenger thread.\n`GROUP` - The game is running inside a Facebook Group.\n`SOLO` - This is the default context, the player is the only participant.\n\nIt is only populated if `contextGetType` is in the list of supported APIs.","kind":"function","name":"getType","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The context type."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getType","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":563,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the current locale.\nSee https://origincache.facebook.com/developers/resources/?id=FacebookLocales.xml for a complete list of supported locale values.\nUse this to determine what languages the current game should be localized with.\nIt is only populated if `getLocale` is in the list of supported APIs.","kind":"function","name":"getLocale","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The current locale."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getLocale","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":584,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the platform on which the game is currently running, i.e. `IOS`.\nIt is only populated if `getPlatform` is in the list of supported APIs.","kind":"function","name":"getPlatform","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The current platform."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getPlatform","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":603,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the string representation of the Facebook Instant Games SDK version being used.\nIt is only populated if `getSDKVersion` is in the list of supported APIs.","kind":"function","name":"getSDKVersion","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The sdk version."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getSDKVersion","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":622,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the id of the player. This is a string based ID, the same as `FBInstant.player.getID()`.\nIt is only populated if `playerGetID` is in the list of supported APIs.","kind":"function","name":"getPlayerID","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The player ID."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getPlayerID","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":641,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the player's localized display name.\nIt is only populated if `playerGetName` is in the list of supported APIs.","kind":"function","name":"getPlayerName","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The player's localized display name."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getPlayerName","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":660,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Returns the url to the player's public profile photo. The photo will always be a square, and with dimensions\nof at least 200x200. When rendering it in the game, the exact dimensions should never be assumed to be constant.\nIt's recommended to always scale the image to a desired size before rendering.\nIt is only populated if `playerGetPhoto` is in the list of supported APIs.","kind":"function","name":"getPlayerPhotoURL","since":"3.13.0","returns":[{"type":{"names":["string"]},"nullable":true,"description":"The player's photo url."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getPlayerPhotoURL","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":681,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Load the player's photo and store it in the Texture Manager, ready for use in-game.\n\nThis method works by using a Scene Loader instance and then asking the Loader to\nretrieve the image.\n\nWhen complete the plugin will emit a `photocomplete` event, along with the key of the photo.\n\n```javascript\nthis.facebook.loadPlayerPhoto(this, 'player').once('photocomplete', function (key) {\n this.add.image(x, y, 'player');\n}, this);\n```","kind":"function","name":"loadPlayerPhoto","since":"3.13.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene that will be responsible for loading this photo.","name":"scene"},{"type":{"names":["string"]},"description":"The key to use when storing the photo in the Texture Manager.","name":"key"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#loadPlayerPhoto","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Checks if the current player can subscribe to the game bot.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they can subscribe, the `playerCanSubscribeBot` property is set to `true`\nand this plugin will emit the `cansubscribebot` event.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `cansubscribebotfail` event instead.","kind":"function","name":"canSubscribeBot","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#canSubscribeBot","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":764,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Subscribes the current player to the game bot.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they are successfully subscribed this plugin will emit the `subscribebot` event.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `subscribebotfail` event instead.","kind":"function","name":"subscribeBot","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#subscribeBot","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":802,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Gets the associated data from the player based on the given key, or array of keys.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes the data is set into this plugins Data Manager and the\n`getdata` event will be emitted.","kind":"function","name":"getData","since":"3.13.0","params":[{"type":{"names":["string","Array."]},"description":"The key/s of the data to retrieve.","name":"keys"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getData","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":848,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Set data to be saved to the designated cloud storage of the current player. The game can store up to 1MB of data for each unique player.\n\nThe data save is requested in an async call, so the result isn't available immediately.\n\nData managed via this plugins Data Manager instance is automatically synced with Facebook. However, you can call this\nmethod directly if you need to replace the data object directly.\n\nWhen the APIs `setDataAsync` call resolves it will emit the `savedata` event from this plugin. If the call fails for some\nreason it will emit `savedatafail` instead.\n\nThe call resolving does not necessarily mean that the input has already been persisted. Rather, it means that the data was valid and\nhas been scheduled to be saved. It also guarantees that all values that were set are now available in `getData`.","kind":"function","name":"saveData","since":"3.13.0","params":[{"type":{"names":["object"]},"description":"An object containing a set of key-value pairs that should be persisted to cloud storage.\nThe object must contain only serializable values - any non-serializable values will cause the entire modification to be rejected.","name":"data"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#saveData","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":891,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Immediately flushes any changes to the player data to the designated cloud storage.\nThis function is expensive, and should primarily be used for critical changes where persistence needs to be immediate\nand known by the game. Non-critical changes should rely on the platform to persist them in the background.\nNOTE: Calls to player.setDataAsync will be rejected while this function's result is pending.\n\nData managed via this plugins Data Manager instance is automatically synced with Facebook. However, you can call this\nmethod directly if you need to flush the data directly.\n\nWhen the APIs `flushDataAsync` call resolves it will emit the `flushdata` event from this plugin. If the call fails for some\nreason it will emit `flushdatafail` instead.","kind":"function","name":"flushData","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#flushData","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":929,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Retrieve stats from the designated cloud storage of the current player.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes the `getstats` event will be emitted along with the data object returned.\n\nIf the call fails, i.e. it's not in the list of supported APIs, or the request was rejected,\nit will emit a `getstatsfail` event instead.","kind":"function","name":"getStats","since":"3.13.0","params":[{"type":{"names":["Array."]},"optional":true,"description":"An optional array of unique keys to retrieve stats for. If the function is called without it, it will fetch all stats.","name":"keys"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getStats","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":967,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Save the stats of the current player to the designated cloud storage.\n\nStats in the Facebook Instant Games API are purely numerical values paired with a string-based key. Only numbers can be saved as stats,\nall other data types will be ignored.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes the `savestats` event will be emitted along with the data object returned.\n\nIf the call fails, i.e. it's not in the list of supported APIs, or the request was rejected,\nit will emit a `savestatsfail` event instead.","kind":"function","name":"saveStats","since":"3.13.0","params":[{"type":{"names":["object"]},"description":"An object containing a set of key-value pairs that should be persisted to cloud storage as stats. Note that only numerical values are stored.","name":"data"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#saveStats","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1018,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Increment the stats of the current player and save them to the designated cloud storage.\n\nStats in the Facebook Instant Games API are purely numerical values paired with a string-based key. Only numbers can be saved as stats,\nall other data types will be ignored.\n\nThe data object provided for this call should contain offsets for how much to modify the stats by:\n\n```javascript\nthis.facebook.incStats({\n level: 1,\n zombiesSlain: 17,\n rank: -1\n});\n```\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes the `incstats` event will be emitted along with the data object returned.\n\nIf the call fails, i.e. it's not in the list of supported APIs, or the request was rejected,\nit will emit a `incstatsfail` event instead.","kind":"function","name":"incStats","since":"3.13.0","params":[{"type":{"names":["object"]},"description":"An object containing a set of key-value pairs indicating how much to increment each stat in cloud storage. Note that only numerical values are processed.","name":"data"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#incStats","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1079,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Sets the data associated with the individual gameplay session for the current context.\n\nThis function should be called whenever the game would like to update the current session data.\n\nThis session data may be used to populate a variety of payloads, such as game play webhooks.","kind":"function","name":"saveSession","since":"3.13.0","params":[{"type":{"names":["object"]},"description":"An arbitrary data object, which must be less than or equal to 1000 characters when stringified.","name":"data"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#saveSession","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.\n\nA blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\n\nThis data must be less than or equal to 1000 characters when stringified.\n\nWhen this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\n\nThe user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.","kind":"function","name":"openShare","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"A text message to be shared.","name":"text"},{"type":{"names":["string"]},"description":"The key of the texture to use as the share image.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.","name":"frame"},{"type":{"names":["object"]},"optional":true,"description":"A blob of data to attach to the share.","name":"sessionData"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#openShare","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"This invokes a dialog to let the user invite a friend to play this game, either as a message in Messenger or as a post on the user's timeline.\n\nA blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\n\nThis data must be less than or equal to 1000 characters when stringified.\n\nWhen this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\n\nThe user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.","kind":"function","name":"openInvite","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"A text message to be shared.","name":"text"},{"type":{"names":["string"]},"description":"The key of the texture to use as the share image.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.","name":"frame"},{"type":{"names":["object"]},"optional":true,"description":"A blob of data to attach to the share.","name":"sessionData"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#openInvite","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.\n\nA blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\n\nThis data must be less than or equal to 1000 characters when stringified.\n\nWhen this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\n\nThe user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.","kind":"function","name":"openRequest","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"A text message to be shared.","name":"text"},{"type":{"names":["string"]},"description":"The key of the texture to use as the share image.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.","name":"frame"},{"type":{"names":["object"]},"optional":true,"description":"A blob of data to attach to the share.","name":"sessionData"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#openRequest","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1192,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.\n\nA blob of data can be attached to the share which every game session launched from the share will be able to access via the `this.entryPointData` property.\n\nThis data must be less than or equal to 1000 characters when stringified.\n\nWhen this method is called you should consider your game paused. Listen out for the `resume` event from this plugin to know when the dialog has been closed.\n\nThe user may choose to cancel the share action and close the dialog. The resulting `resume` event will be dispatched regardless if the user actually shared the content or not.","kind":"function","name":"openChallenge","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"A text message to be shared.","name":"text"},{"type":{"names":["string"]},"description":"The key of the texture to use as the share image.","name":"key"},{"type":{"names":["string"]},"optional":true,"description":"The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.","name":"frame"},{"type":{"names":["object"]},"optional":true,"description":"A blob of data to attach to the share.","name":"sessionData"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#openChallenge","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"This function determines whether the number of participants in the current game context is between a given minimum and maximum, inclusive.\nIf one of the bounds is null only the other bound will be checked against.\nIt will always return the original result for the first call made in a context in a given game play session.\nSubsequent calls, regardless of arguments, will return the answer to the original query until a context change occurs and the query result is reset.","kind":"function","name":"isSizeBetween","since":"3.13.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The minimum bound of the context size query.","name":"min"},{"type":{"names":["integer"]},"optional":true,"description":"The maximum bound of the context size query.","name":"max"}],"returns":[{"type":{"names":["object"]},"description":"The Context Size Response object in the format: `{answer: boolean, minSize: number?, maxSize: number?}`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#isSizeBetween","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1293,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Request a switch into a specific context. If the player does not have permission to enter that context,\nor if the player does not provide permission for the game to enter that context, this will emit a `switchfail` event.\n\nOtherwise, the plugin will emit the `switch` event when the game has switched into the specified context.","kind":"function","name":"switchContext","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The ID of the desired context.","name":"contextID"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#switchContext","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A filter that may be applied to a Context Choose operation.\n\n'NEW_CONTEXT_ONLY' - Prefer to only surface contexts the game has not been played in before.\n'INCLUDE_EXISTING_CHALLENGES' - Include the \"Existing Challenges\" section, which surfaces actively played-in contexts that the player is a part of.\n'NEW_PLAYERS_ONLY' - In sections containing individuals, prefer people who have not played the game.","kind":"typedef","name":"ContextFilter","type":{"names":["string"]},"longname":"ContextFilter","scope":"global","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1342,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A configuration object that may be applied to a Context Choose operation.","kind":"typedef","name":"ChooseContextConfig","type":{"names":["object"]},"properties":[{"type":{"names":["Array."]},"optional":true,"description":"The set of filters to apply to the context suggestions: 'NEW_CONTEXT_ONLY', 'INCLUDE_EXISTING_CHALLENGES' or 'NEW_PLAYERS_ONLY'.","name":"filters"},{"type":{"names":["number"]},"optional":true,"description":"The maximum number of participants that a suggested context should ideally have.","name":"maxSize"},{"type":{"names":["number"]},"optional":true,"description":"The minimum number of participants that a suggested context should ideally have.","name":"minSize"}],"longname":"ChooseContextConfig","scope":"global","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Opens a context selection dialog for the player. If the player selects an available context,\nthe client will attempt to switch into that context, and emit the `choose` event if successful.\nOtherwise, if the player exits the menu or the client fails to switch into the new context, the `choosefail` event will be emitted.","kind":"function","name":"chooseContext","since":"3.13.0","params":[{"type":{"names":["ChooseContextConfig"]},"optional":true,"description":"An object specifying conditions on the contexts that should be offered.","name":"options"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#chooseContext","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Attempts to create or switch into a context between a specified player and the current player.\nThis plugin will emit the `create` event once the context switch is completed.\nIf the API call fails, such as if the player listed is not a Connected Player of the current player or if the\nplayer does not provide permission to enter the new context, then the plugin will emit a 'createfail' event.","kind":"function","name":"createContext","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"ID of the player.","name":"playerID"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#createContext","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1420,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Fetches an array of ConnectedPlayer objects containing information about active players\n(people who played the game in the last 90 days) that are connected to the current player.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they are successfully subscribed this plugin will emit the `players` event along\nwith the player data.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `playersfail` event instead.","kind":"function","name":"getPlayers","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getPlayers","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1458,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Fetches the game's product catalog.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they are successfully subscribed this plugin will emit the `getcatalog` event along\nwith the catalog data.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `getcatalogfail` event instead.","kind":"function","name":"getCatalog","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getCatalog","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1503,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Fetches a single Product from the game's product catalog.\n\nThe product catalog must have been populated using `getCatalog` prior to calling this method.\n\nUse this to look-up product details based on a purchase list.","kind":"function","name":"getProduct","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The Product ID of the item to get from the catalog.","name":"productID"}],"returns":[{"type":{"names":["Product"]},"nullable":true,"description":"The Product from the catalog, or `null` if it couldn't be found or the catalog isn't populated."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getProduct","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1530,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Begins the purchase flow for a specific product.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they are successfully subscribed this plugin will emit the `purchase` event along\nwith the purchase data.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `purchasefail` event instead.","kind":"function","name":"purchase","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The identifier of the product to purchase.","name":"productID"},{"type":{"names":["string"]},"optional":true,"description":"An optional developer-specified payload, to be included in the returned purchase's signed request.","name":"developerPayload"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#purchase","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1579,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Fetches all of the player's unconsumed purchases. The game must fetch the current player's purchases\nas soon as the client indicates that it is ready to perform payments-related operations,\ni.e. at game start. The game can then process and consume any purchases that are waiting to be consumed.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they are successfully subscribed this plugin will emit the `getpurchases` event along\nwith the purchase data.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `getpurchasesfail` event instead.","kind":"function","name":"getPurchases","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getPurchases","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Consumes a specific purchase belonging to the current player. Before provisioning a product's effects to the player,\nthe game should request the consumption of the purchased product. Once the purchase is successfully consumed,\nthe game should immediately provide the player with the effects of their purchase.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf they are successfully subscribed this plugin will emit the `consumepurchase` event along\nwith the purchase data.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `consumepurchasefail` event instead.","kind":"function","name":"consumePurchase","since":"3.17.0","params":[{"type":{"names":["string"]},"description":"The purchase token of the purchase that should be consumed.","name":"purchaseToken"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#consumePurchase","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1667,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Informs Facebook of a custom update that occurred in the game.\nThis will temporarily yield control to Facebook and Facebook will decide what to do based on what the update is.\nOnce Facebook returns control to the game the plugin will emit an `update` or `updatefail` event.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nThe `text` parameter is an update payload with the following structure:\n\n```\ntext: {\n default: 'X just invaded Y\\'s village!',\n localizations: {\n ar_AR: 'X \\u0641\\u0642\\u0637 \\u063A\\u0632\\u062A ' +\n '\\u0642\\u0631\\u064A\\u0629 Y!',\n en_US: 'X just invaded Y\\'s village!',\n es_LA: '\\u00A1X acaba de invadir el pueblo de Y!',\n }\n}\n```","kind":"function","name":"update","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The call to action text.","name":"cta"},{"type":{"names":["object"]},"description":"The text object.","name":"text"},{"type":{"names":["string"]},"description":"The key of the texture to use as the share image.","name":"key"},{"type":{"names":["string","integer"]},"nullable":true,"description":"The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.","name":"frame"},{"type":{"names":["string"]},"description":"The update template key.","name":"template"},{"type":{"names":["object"]},"description":"The update data object payload.","name":"updateData"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#update","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1705,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Informs Facebook of a leaderboard update that occurred in the game.\nThis will temporarily yield control to Facebook and Facebook will decide what to do based on what the update is.\nOnce Facebook returns control to the game the plugin will emit an `update` or `updatefail` event.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nThe `text` parameter is an update payload with the following structure:\n\n```\ntext: {\n default: 'X just invaded Y\\'s village!',\n localizations: {\n ar_AR: 'X \\u0641\\u0642\\u0637 \\u063A\\u0632\\u062A ' +\n '\\u0642\\u0631\\u064A\\u0629 Y!',\n en_US: 'X just invaded Y\\'s village!',\n es_LA: '\\u00A1X acaba de invadir el pueblo de Y!',\n }\n}\n```","kind":"function","name":"updateLeaderboard","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The call to action text.","name":"cta"},{"type":{"names":["object"]},"description":"The text object.","name":"text"},{"type":{"names":["string"]},"description":"The key of the texture to use as the share image.","name":"key"},{"type":{"names":["string","integer"]},"nullable":true,"description":"The frame of the texture to use as the share image. Set to `null` if you don't require a frame, but do need to set session data.","name":"frame"},{"type":{"names":["string"]},"description":"The update template key.","name":"template"},{"type":{"names":["object"]},"description":"The update data object payload.","name":"updateData"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#updateLeaderboard","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1806,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Request that the client switch to a different Instant Game.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf the game switches successfully this plugin will emit the `switchgame` event and the client will load the new game.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `switchgamefail` event instead.","kind":"function","name":"switchGame","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The Application ID of the Instant Game to switch to. The application must be an Instant Game, and must belong to the same business as the current game.","name":"appID"},{"type":{"names":["object"]},"optional":true,"description":"An optional data payload. This will be set as the entrypoint data for the game being switched to. Must be less than or equal to 1000 characters when stringified.","name":"data"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#switchGame","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1856,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Prompts the user to create a shortcut to the game if they are eligible to.\nCan only be called once per session.\n\nIt makes an async call to the API, so the result isn't available immediately.\n\nIf the user choose to create a shortcut this plugin will emit the `shortcutcreated` event.\n\nIf they cannot, i.e. it's not in the list of supported APIs, or the request\nwas rejected, it will emit a `shortcutcreatedfail` event instead.","kind":"function","name":"createShortcut","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#createShortcut","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1894,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Quits the game.","kind":"function","name":"quit","since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#quit","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1905,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Log an app event with FB Analytics.\n\nSee https://developers.facebook.com/docs/javascript/reference/v2.8#app_events for more details about FB Analytics.","kind":"function","name":"log","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"Name of the event. Must be 2 to 40 characters, and can only contain '_', '-', ' ', and alphanumeric characters.","name":"name"},{"type":{"names":["number"]},"optional":true,"description":"An optional numeric value that FB Analytics can calculate a sum with.","name":"value"},{"type":{"names":["object"]},"optional":true,"description":"An optional object that can contain up to 25 key-value pairs to be logged with the event. Keys must be 2 to 40 characters, and can only contain '_', '-', ' ', and alphanumeric characters. Values must be less than 100 characters in length.","name":"params"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#log","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":1936,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Attempt to create an instance of an interstitial ad.\n\nIf the instance is created successfully then the ad is preloaded ready for display in-game via the method `showAd()`.\n\nIf the ad loads it will emit the `adloaded` event, passing the AdInstance as the only parameter.\n\nIf the ad cannot be displayed because there was no inventory to fill it, it will emit the `adsnofill` event.","kind":"function","name":"preloadAds","since":"3.13.0","params":[{"type":{"names":["string","Array."]},"description":"The ad placement ID, or an array of IDs, as created in your Audience Network settings within Facebook.","name":"placementID"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#preloadAds","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":2022,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Attempt to create an instance of an rewarded video ad.\n\nIf the instance is created successfully then the ad is preloaded ready for display in-game via the method `showVideo()`.\n\nIf the ad loads it will emit the `adloaded` event, passing the AdInstance as the only parameter.\n\nIf the ad cannot be displayed because there was no inventory to fill it, it will emit the `adsnofill` event.","kind":"function","name":"preloadVideoAds","since":"3.13.0","params":[{"type":{"names":["string","Array."]},"description":"The ad placement ID, or an array of IDs, as created in your Audience Network settings within Facebook.","name":"placementID"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#preloadVideoAds","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":2108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Displays a previously loaded interstitial ad.\n\nIf the ad is successfully displayed this plugin will emit the `adfinished` event, with the AdInstance object as its parameter.\n\nIf the ad cannot be displayed, it will emit the `adsnotloaded` event.","kind":"function","name":"showAd","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The ad placement ID to display.","name":"placementID"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#showAd","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":2159,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Displays a previously loaded interstitial video ad.\n\nIf the ad is successfully displayed this plugin will emit the `adfinished` event, with the AdInstance object as its parameter.\n\nIf the ad cannot be displayed, it will emit the `adsnotloaded` event.","kind":"function","name":"showVideo","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The ad placement ID to display.","name":"placementID"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#showVideo","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":2210,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Attempts to match the current player with other users looking for people to play with.\nIf successful, a new Messenger group thread will be created containing the matched players and the player will\nbe context switched to that thread. This plugin will also dispatch the `matchplayer` event, containing the new context ID and Type.\n\nThe default minimum and maximum number of players in one matched thread are 2 and 20 respectively,\ndepending on how many players are trying to get matched around the same time.\n\nThe values can be changed in `fbapp-config.json`. See the Bundle Config documentation for documentation about `fbapp-config.json`.","kind":"function","name":"matchPlayer","since":"3.13.0","params":[{"type":{"names":["string"]},"optional":true,"description":"Optional extra information about the player used to group them with similar players. Players will only be grouped with other players with exactly the same tag. The tag must only include letters, numbers, and underscores and be 100 characters or less in length.","name":"matchTag"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optional extra parameter that specifies whether the player should be immediately switched to the new context when a match is found. By default this will be false which will mean the player needs explicitly press play after being matched to switch to the new context.","name":"switchImmediately"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#matchPlayer","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":2251,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Fetch a specific leaderboard belonging to this Instant Game.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes the `getleaderboard` event will be emitted along with a Leaderboard object instance.","kind":"function","name":"getLeaderboard","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the leaderboard. Each leaderboard for an Instant Game must have its own distinct name.","name":"name"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"This Facebook Instant Games Plugin instance."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#getLeaderboard","scope":"instance","___s":true},{"meta":{"filename":"FacebookInstantGamesPlugin.js","lineno":2290,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Quits the Facebook API and then destroys this plugin.","kind":"function","name":"destroy","since":"3.13.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#destroy","scope":"instance","overrides":"Phaser.Events.EventEmitter#destroy","___s":true},{"meta":{"range":[206,249],"filename":"Leaderboard.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"name":"Class","longname":"Class","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Leaderboard.js","lineno":11,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"classdesc":"This class represents one single Leaderboard that belongs to a Facebook Instant Game.\n\nYou do not need to instantiate this class directly, it will be created when you use the\n`getLeaderboard()` method of the main plugin.","kind":"class","name":"FacebookInstantGamesLeaderboard","memberof":"Phaser","augments":["Phaser.Events.EventEmitter"],"since":"3.13.0","params":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"A reference to the Facebook Instant Games Plugin.","name":"plugin"},{"type":{"names":["any"]},"description":"An Instant Game leaderboard instance.","name":"data"}],"scope":"static","longname":"Phaser.FacebookInstantGamesLeaderboard","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":37,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"A reference to the Facebook Instant Games Plugin.","name":"plugin","type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#plugin","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"An Instant Game leaderboard instance.","name":"ref","type":{"names":["any"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#ref","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":55,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The name of the leaderboard.","name":"name","type":{"names":["string"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#name","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":64,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The ID of the context that the leaderboard is associated with, or null if the leaderboard is not tied to a particular context.","name":"contextID","type":{"names":["string"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#contextID","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The total number of player entries in the leaderboard.\nThis value defaults to zero. Populate it via the `getEntryCount()` method.","name":"entryCount","type":{"names":["integer"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#entryCount","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The players score object.\nThis value defaults to `null`. Populate it via the `getPlayerScore()` method.","name":"playerScore","type":{"names":["LeaderboardScore"]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#playerScore","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"The scores in the Leaderboard from the currently requested range.\nThis value defaults to an empty array. Populate it via the `getScores()` method.\nThe contents of this array are reset each time `getScores()` is called.","name":"scores","type":{"names":["Array."]},"since":"3.13.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#scores","scope":"instance","kind":"member","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Fetches the total number of player entries in the leaderboard.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes this Leaderboard will emit the `getentrycount` event along with the count and name of the Leaderboard.","kind":"function","name":"getEntryCount","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"This Leaderboard instance."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#getEntryCount","scope":"instance","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":137,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Updates the player's score. If the player has an existing score, the old score will only be replaced if the new score is better than it.\nNOTE: If the leaderboard is associated with a specific context, the game must be in that context to set a score for the player.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes this Leaderboard will emit the `setscore` event along with the LeaderboardScore object and the name of the Leaderboard.\n\nIf the save fails the event will send `null` as the score value.","kind":"function","name":"setScore","since":"3.13.0","params":[{"type":{"names":["integer"]},"description":"The new score for the player. Must be a 64-bit integer number.","name":"score"},{"type":{"names":["string","any"]},"optional":true,"description":"Metadata to associate with the stored score. Must be less than 2KB in size. If an object is given it will be passed to `JSON.stringify`.","name":"data"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"This Leaderboard instance."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#setScore","scope":"instance","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Gets the players leaderboard entry and stores it in the `playerScore` property.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes this Leaderboard will emit the `getplayerscore` event along with the score and the name of the Leaderboard.\n\nIf the player has not yet saved a score, the event will send `null` as the score value, and `playerScore` will be set to `null` as well.","kind":"function","name":"getPlayerScore","since":"3.13.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"This Leaderboard instance."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#getPlayerScore","scope":"instance","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":230,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Retrieves a set of leaderboard entries, ordered by score ranking in the leaderboard.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes this Leaderboard will emit the `getscores` event along with an array of LeaderboardScore entries and the name of the Leaderboard.","kind":"function","name":"getScores","since":"3.13.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":10,"description":"The number of entries to attempt to fetch from the leaderboard. Currently, up to a maximum of 100 entries may be fetched per query.","name":"count"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The offset from the top of the leaderboard that entries will be fetched from.","name":"offset"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"This Leaderboard instance."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#getScores","scope":"instance","___s":true},{"meta":{"filename":"Leaderboard.js","lineno":271,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"description":"Retrieves a set of leaderboard entries, based on the current player's connected players (including the current player), ordered by local rank within the set of connected players.\n\nThe data is requested in an async call, so the result isn't available immediately.\n\nWhen the call completes this Leaderboard will emit the `getconnectedscores` event along with an array of LeaderboardScore entries and the name of the Leaderboard.","kind":"function","name":"getConnectedScores","since":"3.16.0","returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"This Leaderboard instance."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#getConnectedScores","scope":"instance","___s":true},{"meta":{"filename":"LeaderboardScore.js","lineno":7,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"kind":"typedef","name":"LeaderboardScore","type":{"names":["object"]},"properties":[{"type":{"names":["integer"]},"description":"An integer score value.","name":"score"},{"type":{"names":["string"]},"description":"The score value, formatted with the score format associated with the leaderboard.","name":"scoreFormatted"},{"type":{"names":["integer"]},"description":"The Unix timestamp of when the leaderboard entry was last updated.","name":"timestamp"},{"type":{"names":["integer"]},"description":"The entry's leaderboard ranking.","name":"rank"},{"type":{"names":["string"]},"description":"The developer-specified payload associated with the score, or null if one was not set.","name":"data"},{"type":{"names":["string"]},"description":"The player's localized display name.","name":"playerName"},{"type":{"names":["string"]},"description":"A url to the player's public profile photo.","name":"playerPhotoURL"},{"type":{"names":["string"]},"description":"The game's unique identifier for the player.","name":"playerID"}],"longname":"LeaderboardScore","scope":"global","___s":true},{"meta":{"range":[206,270],"filename":"Product.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Product.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"kind":"typedef","name":"Product","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"optional":true,"description":"The title of the product.","name":"title"},{"type":{"names":["string"]},"optional":true,"description":"The product's game-specified identifier.","name":"productID"},{"type":{"names":["string"]},"optional":true,"description":"The product description.","name":"description"},{"type":{"names":["string"]},"optional":true,"description":"A link to the product's associated image.","name":"imageURI"},{"type":{"names":["string"]},"optional":true,"description":"The price of the product.","name":"price"},{"type":{"names":["string"]},"optional":true,"description":"The currency code for the product.","name":"priceCurrencyCode"}],"longname":"Product","scope":"global","___s":true},{"meta":{"range":[206,270],"filename":"Purchase.js","lineno":7,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"name":"GetFastValue","longname":"GetFastValue","kind":"member","scope":"global","params":[],"___s":true},{"meta":{"filename":"Purchase.js","lineno":9,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src"},"kind":"typedef","name":"Purchase","type":{"names":["object"]},"properties":[{"type":{"names":["string"]},"optional":true,"description":"A developer-specified string, provided during the purchase of the product.","name":"developerPayload"},{"type":{"names":["string"]},"optional":true,"description":"The identifier for the purchase transaction.","name":"paymentID"},{"type":{"names":["string"]},"optional":true,"description":"The product's game-specified identifier.","name":"productID"},{"type":{"names":["string"]},"optional":true,"description":"Unix timestamp of when the purchase occurred.","name":"purchaseTime"},{"type":{"names":["string"]},"optional":true,"description":"A token representing the purchase that may be used to consume the purchase.","name":"purchaseToken"},{"type":{"names":["string"]},"optional":true,"description":"Server-signed encoding of the purchase request.","name":"signedRequest"}],"longname":"Purchase","scope":"global","___s":true},{"kind":"package","longname":"package:undefined","files":["/home/arian/Documents/Phaser/phaser/src/actions/AlignTo.js","/home/arian/Documents/Phaser/phaser/src/actions/Angle.js","/home/arian/Documents/Phaser/phaser/src/actions/Call.js","/home/arian/Documents/Phaser/phaser/src/actions/GetFirst.js","/home/arian/Documents/Phaser/phaser/src/actions/GetLast.js","/home/arian/Documents/Phaser/phaser/src/actions/GridAlign.js","/home/arian/Documents/Phaser/phaser/src/actions/IncAlpha.js","/home/arian/Documents/Phaser/phaser/src/actions/IncX.js","/home/arian/Documents/Phaser/phaser/src/actions/IncXY.js","/home/arian/Documents/Phaser/phaser/src/actions/IncY.js","/home/arian/Documents/Phaser/phaser/src/actions/PlaceOnCircle.js","/home/arian/Documents/Phaser/phaser/src/actions/PlaceOnEllipse.js","/home/arian/Documents/Phaser/phaser/src/actions/PlaceOnLine.js","/home/arian/Documents/Phaser/phaser/src/actions/PlaceOnRectangle.js","/home/arian/Documents/Phaser/phaser/src/actions/PlaceOnTriangle.js","/home/arian/Documents/Phaser/phaser/src/actions/PlayAnimation.js","/home/arian/Documents/Phaser/phaser/src/actions/PropertyValueInc.js","/home/arian/Documents/Phaser/phaser/src/actions/PropertyValueSet.js","/home/arian/Documents/Phaser/phaser/src/actions/RandomCircle.js","/home/arian/Documents/Phaser/phaser/src/actions/RandomEllipse.js","/home/arian/Documents/Phaser/phaser/src/actions/RandomLine.js","/home/arian/Documents/Phaser/phaser/src/actions/RandomRectangle.js","/home/arian/Documents/Phaser/phaser/src/actions/RandomTriangle.js","/home/arian/Documents/Phaser/phaser/src/actions/Rotate.js","/home/arian/Documents/Phaser/phaser/src/actions/RotateAround.js","/home/arian/Documents/Phaser/phaser/src/actions/RotateAroundDistance.js","/home/arian/Documents/Phaser/phaser/src/actions/ScaleX.js","/home/arian/Documents/Phaser/phaser/src/actions/ScaleXY.js","/home/arian/Documents/Phaser/phaser/src/actions/ScaleY.js","/home/arian/Documents/Phaser/phaser/src/actions/SetAlpha.js","/home/arian/Documents/Phaser/phaser/src/actions/SetBlendMode.js","/home/arian/Documents/Phaser/phaser/src/actions/SetDepth.js","/home/arian/Documents/Phaser/phaser/src/actions/SetHitArea.js","/home/arian/Documents/Phaser/phaser/src/actions/SetOrigin.js","/home/arian/Documents/Phaser/phaser/src/actions/SetRotation.js","/home/arian/Documents/Phaser/phaser/src/actions/SetScale.js","/home/arian/Documents/Phaser/phaser/src/actions/SetScaleX.js","/home/arian/Documents/Phaser/phaser/src/actions/SetScaleY.js","/home/arian/Documents/Phaser/phaser/src/actions/SetScrollFactor.js","/home/arian/Documents/Phaser/phaser/src/actions/SetScrollFactorX.js","/home/arian/Documents/Phaser/phaser/src/actions/SetScrollFactorY.js","/home/arian/Documents/Phaser/phaser/src/actions/SetTint.js","/home/arian/Documents/Phaser/phaser/src/actions/SetVisible.js","/home/arian/Documents/Phaser/phaser/src/actions/SetX.js","/home/arian/Documents/Phaser/phaser/src/actions/SetXY.js","/home/arian/Documents/Phaser/phaser/src/actions/SetY.js","/home/arian/Documents/Phaser/phaser/src/actions/ShiftPosition.js","/home/arian/Documents/Phaser/phaser/src/actions/Shuffle.js","/home/arian/Documents/Phaser/phaser/src/actions/SmoothStep.js","/home/arian/Documents/Phaser/phaser/src/actions/SmootherStep.js","/home/arian/Documents/Phaser/phaser/src/actions/Spread.js","/home/arian/Documents/Phaser/phaser/src/actions/ToggleVisible.js","/home/arian/Documents/Phaser/phaser/src/actions/WrapInRectangle.js","/home/arian/Documents/Phaser/phaser/src/actions/index.js","/home/arian/Documents/Phaser/phaser/src/actions/typedefs/CallCallback.js","/home/arian/Documents/Phaser/phaser/src/actions/typedefs/GridAlignConfig.js","/home/arian/Documents/Phaser/phaser/src/actions/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/animations/Animation.js","/home/arian/Documents/Phaser/phaser/src/animations/AnimationFrame.js","/home/arian/Documents/Phaser/phaser/src/animations/AnimationManager.js","/home/arian/Documents/Phaser/phaser/src/animations/events/ADD_ANIMATION_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/ANIMATION_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/ANIMATION_REPEAT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/ANIMATION_RESTART_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/ANIMATION_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/PAUSE_ALL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/REMOVE_ANIMATION_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/RESUME_ALL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_KEY_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_KEY_REPEAT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_KEY_RESTART_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_KEY_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_KEY_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_REPEAT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_RESTART_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/SPRITE_ANIMATION_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/animations/events/index.js","/home/arian/Documents/Phaser/phaser/src/animations/index.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/Animation.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/AnimationFrame.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/GenerateFrameNames.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/GenerateFrameNumbers.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/JSONAnimation.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/JSONAnimationFrame.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/JSONAnimations.js","/home/arian/Documents/Phaser/phaser/src/animations/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/cache/BaseCache.js","/home/arian/Documents/Phaser/phaser/src/cache/CacheManager.js","/home/arian/Documents/Phaser/phaser/src/cache/events/ADD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cache/events/REMOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cache/events/index.js","/home/arian/Documents/Phaser/phaser/src/cache/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/BaseCamera.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/Camera.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/CameraManager.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects/Fade.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects/Flash.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects/Pan.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects/Shake.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects/Zoom.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/effects/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/DESTROY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/FADE_IN_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/FADE_IN_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/FADE_OUT_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/FADE_OUT_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/FLASH_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/FLASH_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/PAN_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/PAN_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/POST_RENDER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/PRE_RENDER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/SHAKE_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/SHAKE_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/ZOOM_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/ZOOM_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/events/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/CameraConfig.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/CameraFadeCallback.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/CameraFlashCallback.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/CameraPanCallback.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/CameraShakeCallback.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/CameraZoomCallback.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/JSONCamera.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/JSONCameraBounds.js","/home/arian/Documents/Phaser/phaser/src/cameras/2d/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/controls/FixedKeyControl.js","/home/arian/Documents/Phaser/phaser/src/cameras/controls/SmoothedKeyControl.js","/home/arian/Documents/Phaser/phaser/src/cameras/controls/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/controls/typedefs/FixedKeyControlConfig.js","/home/arian/Documents/Phaser/phaser/src/cameras/controls/typedefs/SmoothedKeyControlConfig.js","/home/arian/Documents/Phaser/phaser/src/cameras/controls/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/cameras/index.js","/home/arian/Documents/Phaser/phaser/src/const.js","/home/arian/Documents/Phaser/phaser/src/core/Config.js","/home/arian/Documents/Phaser/phaser/src/core/CreateRenderer.js","/home/arian/Documents/Phaser/phaser/src/core/DebugHeader.js","/home/arian/Documents/Phaser/phaser/src/core/Game.js","/home/arian/Documents/Phaser/phaser/src/core/TimeStep.js","/home/arian/Documents/Phaser/phaser/src/core/VisibilityHandler.js","/home/arian/Documents/Phaser/phaser/src/core/events/BLUR_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/BOOT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/CONTEXT_LOST_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/CONTEXT_RESTORED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/DESTROY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/FOCUS_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/HIDDEN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/POST_RENDER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/POST_STEP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/PRE_RENDER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/PRE_STEP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/READY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/STEP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/VISIBLE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/core/events/index.js","/home/arian/Documents/Phaser/phaser/src/core/index.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/AudioConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/BannerConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/BootCallback.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/CallbacksConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/DOMContainerConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/FPSConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/GameConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/GamepadInputConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/ImagesConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/InputConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/KeyboardInputConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/LoaderConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/MouseInputConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/NOOP.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/PhysicsConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/PluginObject.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/PluginObjectItem.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/RenderConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/ScaleConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/TimeStepCallback.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/TouchInputConfig.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/WidthHeight.js","/home/arian/Documents/Phaser/phaser/src/core/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/create/GenerateTexture.js","/home/arian/Documents/Phaser/phaser/src/create/index.js","/home/arian/Documents/Phaser/phaser/src/create/palettes/Arne16.js","/home/arian/Documents/Phaser/phaser/src/create/palettes/C64.js","/home/arian/Documents/Phaser/phaser/src/create/palettes/CGA.js","/home/arian/Documents/Phaser/phaser/src/create/palettes/JMP.js","/home/arian/Documents/Phaser/phaser/src/create/palettes/MSX.js","/home/arian/Documents/Phaser/phaser/src/create/palettes/index.js","/home/arian/Documents/Phaser/phaser/src/create/typedefs/GenerateTextureConfig.js","/home/arian/Documents/Phaser/phaser/src/create/typedefs/Palette.js","/home/arian/Documents/Phaser/phaser/src/create/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/curves/CubicBezierCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/Curve.js","/home/arian/Documents/Phaser/phaser/src/curves/EllipseCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/LineCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/QuadraticBezierCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/SplineCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/index.js","/home/arian/Documents/Phaser/phaser/src/curves/path/MoveTo.js","/home/arian/Documents/Phaser/phaser/src/curves/path/Path.js","/home/arian/Documents/Phaser/phaser/src/curves/typedefs/EllipseCurveConfig.js","/home/arian/Documents/Phaser/phaser/src/curves/typedefs/JSONCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/typedefs/JSONEllipseCurve.js","/home/arian/Documents/Phaser/phaser/src/curves/typedefs/JSONPath.js","/home/arian/Documents/Phaser/phaser/src/curves/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/data/DataManager.js","/home/arian/Documents/Phaser/phaser/src/data/DataManagerPlugin.js","/home/arian/Documents/Phaser/phaser/src/data/events/CHANGE_DATA_EVENT.js","/home/arian/Documents/Phaser/phaser/src/data/events/CHANGE_DATA_KEY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/data/events/REMOVE_DATA_EVENT.js","/home/arian/Documents/Phaser/phaser/src/data/events/SET_DATA_EVENT.js","/home/arian/Documents/Phaser/phaser/src/data/events/index.js","/home/arian/Documents/Phaser/phaser/src/data/index.js","/home/arian/Documents/Phaser/phaser/src/device/Audio.js","/home/arian/Documents/Phaser/phaser/src/device/Browser.js","/home/arian/Documents/Phaser/phaser/src/device/CanvasFeatures.js","/home/arian/Documents/Phaser/phaser/src/device/Features.js","/home/arian/Documents/Phaser/phaser/src/device/Fullscreen.js","/home/arian/Documents/Phaser/phaser/src/device/Input.js","/home/arian/Documents/Phaser/phaser/src/device/OS.js","/home/arian/Documents/Phaser/phaser/src/device/Video.js","/home/arian/Documents/Phaser/phaser/src/device/index.js","/home/arian/Documents/Phaser/phaser/src/display/align/const.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/BottomCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/BottomLeft.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/BottomRight.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/Center.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/LeftCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/QuickSet.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/RightCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/TopCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/TopLeft.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/TopRight.js","/home/arian/Documents/Phaser/phaser/src/display/align/in/index.js","/home/arian/Documents/Phaser/phaser/src/display/align/index.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/BottomCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/BottomLeft.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/BottomRight.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/LeftBottom.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/LeftCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/LeftTop.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/QuickSet.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/RightBottom.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/RightCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/RightTop.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/TopCenter.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/TopLeft.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/TopRight.js","/home/arian/Documents/Phaser/phaser/src/display/align/to/index.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/CenterOn.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetBottom.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetCenterX.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetCenterY.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetLeft.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetOffsetX.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetOffsetY.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetRight.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/GetTop.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/SetBottom.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/SetCenterX.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/SetCenterY.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/SetLeft.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/SetRight.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/SetTop.js","/home/arian/Documents/Phaser/phaser/src/display/bounds/index.js","/home/arian/Documents/Phaser/phaser/src/display/canvas/CanvasInterpolation.js","/home/arian/Documents/Phaser/phaser/src/display/canvas/CanvasPool.js","/home/arian/Documents/Phaser/phaser/src/display/canvas/Smoothing.js","/home/arian/Documents/Phaser/phaser/src/display/canvas/TouchAction.js","/home/arian/Documents/Phaser/phaser/src/display/canvas/UserSelect.js","/home/arian/Documents/Phaser/phaser/src/display/canvas/index.js","/home/arian/Documents/Phaser/phaser/src/display/color/Color.js","/home/arian/Documents/Phaser/phaser/src/display/color/ColorToRGBA.js","/home/arian/Documents/Phaser/phaser/src/display/color/ComponentToHex.js","/home/arian/Documents/Phaser/phaser/src/display/color/GetColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/GetColor32.js","/home/arian/Documents/Phaser/phaser/src/display/color/HSLToColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/HSVColorWheel.js","/home/arian/Documents/Phaser/phaser/src/display/color/HSVToRGB.js","/home/arian/Documents/Phaser/phaser/src/display/color/HexStringToColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/HueToComponent.js","/home/arian/Documents/Phaser/phaser/src/display/color/IntegerToColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/IntegerToRGB.js","/home/arian/Documents/Phaser/phaser/src/display/color/Interpolate.js","/home/arian/Documents/Phaser/phaser/src/display/color/ObjectToColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/RGBStringToColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/RGBToHSV.js","/home/arian/Documents/Phaser/phaser/src/display/color/RGBToString.js","/home/arian/Documents/Phaser/phaser/src/display/color/RandomRGB.js","/home/arian/Documents/Phaser/phaser/src/display/color/ValueToColor.js","/home/arian/Documents/Phaser/phaser/src/display/color/index.js","/home/arian/Documents/Phaser/phaser/src/display/index.js","/home/arian/Documents/Phaser/phaser/src/display/mask/BitmapMask.js","/home/arian/Documents/Phaser/phaser/src/display/mask/GeometryMask.js","/home/arian/Documents/Phaser/phaser/src/display/mask/index.js","/home/arian/Documents/Phaser/phaser/src/display/shader/BaseShader.js","/home/arian/Documents/Phaser/phaser/src/display/typedefs/ColorObject.js","/home/arian/Documents/Phaser/phaser/src/display/typedefs/HSVColorObject.js","/home/arian/Documents/Phaser/phaser/src/display/typedefs/InputColorObject.js","/home/arian/Documents/Phaser/phaser/src/display/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/dom/AddToDOM.js","/home/arian/Documents/Phaser/phaser/src/dom/CreateDOMContainer.js","/home/arian/Documents/Phaser/phaser/src/dom/DOMContentLoaded.js","/home/arian/Documents/Phaser/phaser/src/dom/GetInnerHeight.js","/home/arian/Documents/Phaser/phaser/src/dom/GetScreenOrientation.js","/home/arian/Documents/Phaser/phaser/src/dom/GetTarget.js","/home/arian/Documents/Phaser/phaser/src/dom/ParseXML.js","/home/arian/Documents/Phaser/phaser/src/dom/RemoveFromDOM.js","/home/arian/Documents/Phaser/phaser/src/dom/RequestAnimationFrame.js","/home/arian/Documents/Phaser/phaser/src/dom/index.js","/home/arian/Documents/Phaser/phaser/src/events/EventEmitter.js","/home/arian/Documents/Phaser/phaser/src/events/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/BuildGameObject.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/BuildGameObjectAnimation.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/DisplayList.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/GameObject.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/GameObjectCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/GameObjectFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/UpdateList.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/GetBitmapTextSize.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/ParseFromAtlas.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/ParseRetroFont.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/ParseXMLBitmapFont.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/RetroFont.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/const.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic/DynamicBitmapText.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static/BitmapText.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static/BitmapTextCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static/BitmapTextCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static/BitmapTextFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static/BitmapTextRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static/BitmapTextWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/BitmapFontCharacterData.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/BitmapFontData.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/BitmapTextConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/BitmapTextSize.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/DisplayCallbackConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/GlobalBitmapTextSize.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/JSONBitmapText.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/LocalBitmapTextSize.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/RetroFontConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/TintConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/Blitter.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/BlitterCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/BlitterCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/BlitterFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/BlitterRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/BlitterWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/blitter/Bob.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Alpha.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/AlphaSingle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Animation.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/BlendMode.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/ComputedSize.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Crop.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Depth.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Flip.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/GetBounds.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Mask.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Origin.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/PathFollower.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Pipeline.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/ScrollFactor.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Size.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Texture.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/TextureCrop.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Tint.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/ToJSON.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Transform.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/TransformMatrix.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/Visible.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/components/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/container/Container.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/container/ContainerCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/container/ContainerCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/container/ContainerFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/container/ContainerRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/container/ContainerWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement/CSSBlendModes.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement/DOMElement.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement/DOMElementCSSRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement/DOMElementFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/domelement/DOMElementRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/DESTROY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_CREATED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_ERROR_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_LOOP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_PLAY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_SEEKED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_SEEKING_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_STOP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_TIMEOUT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/VIDEO_UNLOCKED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/events/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/extern/Extern.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/extern/ExternCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/extern/ExternFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/extern/ExternRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/extern/ExternWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/Commands.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/Graphics.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/GraphicsCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/GraphicsCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/GraphicsFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/GraphicsRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/GraphicsWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs/FillStyle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs/LineStyle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs/Options.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs/RoundedRectRadius.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs/Styles.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/graphics/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/Group.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/GroupCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/GroupFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs/GroupCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs/GroupConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs/GroupCreateConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs/GroupMultipleCreateCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/group/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/image/Image.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/image/ImageCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/image/ImageCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/image/ImageFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/image/ImageRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/image/ImageWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/lights/Light.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/lights/LightsManager.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/lights/LightsPlugin.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh/Mesh.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh/MeshCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh/MeshCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh/MeshFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh/MeshRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh/MeshWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/EmitterOp.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/GravityWell.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/Particle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleEmitter.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleEmitterManager.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleManagerCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleManagerCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleManagerFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleManagerRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/ParticleManagerWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/DeathZoneSource.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/DeathZoneSourceCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EdgeZoneSource.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EdgeZoneSourceCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpCustomEmitConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpCustomUpdateConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpEaseConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpOnEmitCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpOnEmitType.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpOnUpdateCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpOnUpdateType.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpRandomConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpRandomMinMaxConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpRandomStartEndConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/EmitterOpSteppedConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/GravityWellConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleDeathCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterBounds.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterBoundsAlt.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterDeathZoneConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterEdgeZoneConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterFrameConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/ParticleEmitterRandomZoneConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/RandomZoneSource.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/RandomZoneSourceCallback.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones/DeathZone.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones/EdgeZone.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones/RandomZone.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/particles/zones/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower/PathFollower.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower/PathFollowerFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower/typedefs/PathConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/pathfollower/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/quad/Quad.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/quad/QuadCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/quad/QuadFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/RenderTexture.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/RenderTextureCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/RenderTextureCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/RenderTextureFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/RenderTextureRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/RenderTextureWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/typedefs/RenderTextureConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/rendertexture/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shader/Shader.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shader/ShaderCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shader/ShaderCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shader/ShaderFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shader/ShaderRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shader/ShaderWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/FillPathWebGL.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/FillStyleCanvas.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/LineStyleCanvas.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/Shape.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/StrokePathWebGL.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc/Arc.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc/ArcCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc/ArcFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc/ArcRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/arc/ArcWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve/Curve.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve/CurveCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve/CurveFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve/CurveRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/curve/CurveWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse/Ellipse.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse/EllipseCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse/EllipseFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse/EllipseRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/ellipse/EllipseWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid/Grid.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid/GridCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid/GridFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid/GridRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/grid/GridWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox/IsoBox.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox/IsoBoxCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox/IsoBoxFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox/IsoBoxRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isobox/IsoBoxWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle/IsoTriangle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle/IsoTriangleCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle/IsoTriangleFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle/IsoTriangleRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/isotriangle/IsoTriangleWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line/Line.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line/LineCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line/LineFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line/LineRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/line/LineWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon/Polygon.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon/PolygonCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon/PolygonFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon/PolygonRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/polygon/PolygonWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle/Rectangle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle/RectangleCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle/RectangleFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle/RectangleRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/rectangle/RectangleWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star/Star.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star/StarCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star/StarFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star/StarRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/star/StarWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle/Triangle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle/TriangleCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle/TriangleFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle/TriangleRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/shape/triangle/TriangleWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/Sprite.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/SpriteCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/SpriteCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/SpriteFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/SpriteRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/SpriteWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/typedefs/SpriteConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/GetTextSize.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/MeasureText.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/TextStyle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static/Text.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static/TextCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static/TextCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static/TextFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static/TextRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/static/TextWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs/TextMetrics.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs/TextPadding.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs/TextShadow.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs/TextStyle.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs/TextWordWrap.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/text/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/TileSprite.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/TileSpriteCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/TileSpriteCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/TileSpriteFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/TileSpriteRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/TileSpriteWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/typedefs/TileSpriteConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/tilesprite/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/typedefs/GameObjectConfig.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/typedefs/JSONGameObject.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/video/Video.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/video/VideoCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/video/VideoCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/video/VideoFactory.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/video/VideoRender.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/video/VideoWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/zone/Zone.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/zone/ZoneCreator.js","/home/arian/Documents/Phaser/phaser/src/gameobjects/zone/ZoneFactory.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Area.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Circle.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Circumference.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/CircumferencePoint.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Contains.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/ContainsPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/ContainsRect.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/CopyFrom.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Equals.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/GetBounds.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/GetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/GetPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Offset.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/OffsetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/Random.js","/home/arian/Documents/Phaser/phaser/src/geom/circle/index.js","/home/arian/Documents/Phaser/phaser/src/geom/const.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Area.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Circumference.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/CircumferencePoint.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Contains.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/ContainsPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/ContainsRect.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/CopyFrom.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Ellipse.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Equals.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/GetBounds.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/GetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/GetPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Offset.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/OffsetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/Random.js","/home/arian/Documents/Phaser/phaser/src/geom/ellipse/index.js","/home/arian/Documents/Phaser/phaser/src/geom/index.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/CircleToCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/CircleToRectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetCircleToCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetCircleToRectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetLineToCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetLineToRectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetRectangleIntersection.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetRectangleToRectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetRectangleToTriangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetTriangleToCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetTriangleToLine.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/GetTriangleToTriangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/LineToCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/LineToLine.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/LineToRectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/PointToLine.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/PointToLineSegment.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/RectangleToRectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/RectangleToTriangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/RectangleToValues.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/TriangleToCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/TriangleToLine.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/TriangleToTriangle.js","/home/arian/Documents/Phaser/phaser/src/geom/intersects/index.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Angle.js","/home/arian/Documents/Phaser/phaser/src/geom/line/BresenhamPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/line/CenterOn.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/line/CopyFrom.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Equals.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Extend.js","/home/arian/Documents/Phaser/phaser/src/geom/line/GetMidPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/line/GetNearestPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/line/GetNormal.js","/home/arian/Documents/Phaser/phaser/src/geom/line/GetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/line/GetPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/line/GetShortestDistance.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Height.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Length.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Line.js","/home/arian/Documents/Phaser/phaser/src/geom/line/NormalAngle.js","/home/arian/Documents/Phaser/phaser/src/geom/line/NormalX.js","/home/arian/Documents/Phaser/phaser/src/geom/line/NormalY.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Offset.js","/home/arian/Documents/Phaser/phaser/src/geom/line/PerpSlope.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Random.js","/home/arian/Documents/Phaser/phaser/src/geom/line/ReflectAngle.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Rotate.js","/home/arian/Documents/Phaser/phaser/src/geom/line/RotateAroundPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/line/RotateAroundXY.js","/home/arian/Documents/Phaser/phaser/src/geom/line/SetToAngle.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Slope.js","/home/arian/Documents/Phaser/phaser/src/geom/line/Width.js","/home/arian/Documents/Phaser/phaser/src/geom/line/index.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Ceil.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/point/CopyFrom.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Equals.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Floor.js","/home/arian/Documents/Phaser/phaser/src/geom/point/GetCentroid.js","/home/arian/Documents/Phaser/phaser/src/geom/point/GetMagnitude.js","/home/arian/Documents/Phaser/phaser/src/geom/point/GetMagnitudeSq.js","/home/arian/Documents/Phaser/phaser/src/geom/point/GetRectangleFromPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Interpolate.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Invert.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Negative.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Point.js","/home/arian/Documents/Phaser/phaser/src/geom/point/Project.js","/home/arian/Documents/Phaser/phaser/src/geom/point/ProjectUnit.js","/home/arian/Documents/Phaser/phaser/src/geom/point/SetMagnitude.js","/home/arian/Documents/Phaser/phaser/src/geom/point/index.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Contains.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/ContainsPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Earcut.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/GetAABB.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/GetNumberArray.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/GetPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Perimeter.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Polygon.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Reverse.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/Smooth.js","/home/arian/Documents/Phaser/phaser/src/geom/polygon/index.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Area.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Ceil.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/CeilAll.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/CenterOn.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Contains.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/ContainsPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/ContainsRect.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/CopyFrom.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Decompose.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Equals.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/FitInside.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/FitOutside.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Floor.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/FloorAll.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/FromPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/GetAspectRatio.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/GetCenter.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/GetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/GetPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/GetSize.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Inflate.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Intersection.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/MarchingAnts.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/MergePoints.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/MergeRect.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/MergeXY.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Offset.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/OffsetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Overlaps.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Perimeter.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/PerimeterPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Random.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/RandomOutside.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Rectangle.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/SameDimensions.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Scale.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/Union.js","/home/arian/Documents/Phaser/phaser/src/geom/rectangle/index.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Area.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/BuildEquilateral.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/BuildFromPolygon.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/BuildRight.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/CenterOn.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Centroid.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/CircumCenter.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/CircumCircle.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Clone.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Contains.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/ContainsArray.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/ContainsPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/CopyFrom.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Decompose.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Equals.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/GetPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/GetPoints.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/InCenter.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Offset.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Perimeter.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Random.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Rotate.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/RotateAroundPoint.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/RotateAroundXY.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/Triangle.js","/home/arian/Documents/Phaser/phaser/src/geom/triangle/index.js","/home/arian/Documents/Phaser/phaser/src/input/CreateInteractiveObject.js","/home/arian/Documents/Phaser/phaser/src/input/CreatePixelPerfectHandler.js","/home/arian/Documents/Phaser/phaser/src/input/InputManager.js","/home/arian/Documents/Phaser/phaser/src/input/InputPlugin.js","/home/arian/Documents/Phaser/phaser/src/input/InputPluginCache.js","/home/arian/Documents/Phaser/phaser/src/input/Pointer.js","/home/arian/Documents/Phaser/phaser/src/input/const.js","/home/arian/Documents/Phaser/phaser/src/input/events/BOOT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DESTROY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DRAG_END_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DRAG_ENTER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DRAG_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DRAG_LEAVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DRAG_OVER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DRAG_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/DROP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DRAG_END_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DRAG_ENTER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DRAG_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DRAG_LEAVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DRAG_OVER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DRAG_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_DROP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_MOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_OUT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_OVER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_POINTER_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_POINTER_MOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_POINTER_OUT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_POINTER_OVER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_POINTER_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_POINTER_WHEEL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAMEOBJECT_WHEEL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAME_OUT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/GAME_OVER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/MANAGER_BOOT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/MANAGER_PROCESS_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/MANAGER_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTERLOCK_CHANGE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_DOWN_OUTSIDE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_MOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_OUT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_OVER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_UP_OUTSIDE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/POINTER_WHEEL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/PRE_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/SHUTDOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/events/index.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/Axis.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/Button.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/Gamepad.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/GamepadPlugin.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs/SNES_USB_Controller.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs/Sony_PlayStation_DualShock_4.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs/XBox360_Controller.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/configs/index.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/BUTTON_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/BUTTON_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/CONNECTED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/DISCONNECTED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/GAMEPAD_BUTTON_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/GAMEPAD_BUTTON_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/events/index.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/index.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/typedefs/Pad.js","/home/arian/Documents/Phaser/phaser/src/input/gamepad/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/input/index.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/KeyboardManager.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/KeyboardPlugin.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo/AdvanceKeyCombo.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo/KeyCombo.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo/ProcessKeyCombo.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/combo/ResetKeyCombo.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/ANY_KEY_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/ANY_KEY_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/COMBO_MATCH_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/KEY_DOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/KEY_UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/UP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/events/index.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/index.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/DownDuration.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/JustDown.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/JustUp.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/Key.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/KeyCodes.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/KeyMap.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/keys/UpDuration.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs/CursorKeys.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs/KeyComboConfig.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs/KeyboardKeydownCallback.js","/home/arian/Documents/Phaser/phaser/src/input/keyboard/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/input/mouse/MouseManager.js","/home/arian/Documents/Phaser/phaser/src/input/mouse/index.js","/home/arian/Documents/Phaser/phaser/src/input/touch/TouchManager.js","/home/arian/Documents/Phaser/phaser/src/input/touch/index.js","/home/arian/Documents/Phaser/phaser/src/input/typedefs/EventData.js","/home/arian/Documents/Phaser/phaser/src/input/typedefs/HitAreaCallback.js","/home/arian/Documents/Phaser/phaser/src/input/typedefs/InputConfiguration.js","/home/arian/Documents/Phaser/phaser/src/input/typedefs/InputPluginContainer.js","/home/arian/Documents/Phaser/phaser/src/input/typedefs/InteractiveObject.js","/home/arian/Documents/Phaser/phaser/src/input/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/loader/File.js","/home/arian/Documents/Phaser/phaser/src/loader/FileTypesManager.js","/home/arian/Documents/Phaser/phaser/src/loader/GetURL.js","/home/arian/Documents/Phaser/phaser/src/loader/LoaderPlugin.js","/home/arian/Documents/Phaser/phaser/src/loader/MergeXHRSettings.js","/home/arian/Documents/Phaser/phaser/src/loader/MultiFile.js","/home/arian/Documents/Phaser/phaser/src/loader/XHRLoader.js","/home/arian/Documents/Phaser/phaser/src/loader/XHRSettings.js","/home/arian/Documents/Phaser/phaser/src/loader/const.js","/home/arian/Documents/Phaser/phaser/src/loader/events/ADD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/FILE_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/FILE_KEY_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/FILE_LOAD_ERROR_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/FILE_LOAD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/FILE_PROGRESS_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/POST_PROCESS_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/PROGRESS_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/loader/events/index.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/AnimationJSONFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/AtlasJSONFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/AtlasXMLFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/AudioFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/AudioSpriteFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/BinaryFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/BitmapFontFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/CSSFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/GLSLFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/HTML5AudioFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/HTMLFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/HTMLTextureFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/ImageFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/JSONFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/MultiAtlasFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/MultiScriptFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/PackFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/PluginFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/SVGFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/SceneFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/ScenePluginFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/ScriptFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/SpriteSheetFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/TextFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/TilemapCSVFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/TilemapImpactFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/TilemapJSONFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/UnityAtlasFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/VideoFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/XMLFile.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/index.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/AtlasJSONFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/AtlasXMLFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/AudioFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/AudioSpriteFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/BinaryFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/BitmapFontFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/CSSFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/GLSLFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/HTMLFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/HTMLTextureFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/ImageFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/ImageFrameConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/JSONFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/MultiAtlasFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/MultiScriptFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/PackFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/PluginFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/SVGFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/SVGSizeConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/SceneFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/ScenePluginFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/ScriptFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/SpriteSheetFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/TextFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/TilemapCSVFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/TilemapImpactFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/TilemapJSONFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/UnityAtlasFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/VideoFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/XMLFileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/filetypes/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/loader/index.js","/home/arian/Documents/Phaser/phaser/src/loader/typedefs/FileConfig.js","/home/arian/Documents/Phaser/phaser/src/loader/typedefs/XHRSettingsObject.js","/home/arian/Documents/Phaser/phaser/src/loader/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/math/Average.js","/home/arian/Documents/Phaser/phaser/src/math/Bernstein.js","/home/arian/Documents/Phaser/phaser/src/math/Between.js","/home/arian/Documents/Phaser/phaser/src/math/CatmullRom.js","/home/arian/Documents/Phaser/phaser/src/math/CeilTo.js","/home/arian/Documents/Phaser/phaser/src/math/Clamp.js","/home/arian/Documents/Phaser/phaser/src/math/DegToRad.js","/home/arian/Documents/Phaser/phaser/src/math/Difference.js","/home/arian/Documents/Phaser/phaser/src/math/Factorial.js","/home/arian/Documents/Phaser/phaser/src/math/FloatBetween.js","/home/arian/Documents/Phaser/phaser/src/math/FloorTo.js","/home/arian/Documents/Phaser/phaser/src/math/FromPercent.js","/home/arian/Documents/Phaser/phaser/src/math/GetSpeed.js","/home/arian/Documents/Phaser/phaser/src/math/IsEven.js","/home/arian/Documents/Phaser/phaser/src/math/IsEvenStrict.js","/home/arian/Documents/Phaser/phaser/src/math/Linear.js","/home/arian/Documents/Phaser/phaser/src/math/Matrix3.js","/home/arian/Documents/Phaser/phaser/src/math/Matrix4.js","/home/arian/Documents/Phaser/phaser/src/math/MaxAdd.js","/home/arian/Documents/Phaser/phaser/src/math/MinSub.js","/home/arian/Documents/Phaser/phaser/src/math/Percent.js","/home/arian/Documents/Phaser/phaser/src/math/Quaternion.js","/home/arian/Documents/Phaser/phaser/src/math/RadToDeg.js","/home/arian/Documents/Phaser/phaser/src/math/RandomXY.js","/home/arian/Documents/Phaser/phaser/src/math/RandomXYZ.js","/home/arian/Documents/Phaser/phaser/src/math/RandomXYZW.js","/home/arian/Documents/Phaser/phaser/src/math/Rotate.js","/home/arian/Documents/Phaser/phaser/src/math/RotateAround.js","/home/arian/Documents/Phaser/phaser/src/math/RotateAroundDistance.js","/home/arian/Documents/Phaser/phaser/src/math/RotateVec3.js","/home/arian/Documents/Phaser/phaser/src/math/RoundAwayFromZero.js","/home/arian/Documents/Phaser/phaser/src/math/RoundTo.js","/home/arian/Documents/Phaser/phaser/src/math/SinCosTableGenerator.js","/home/arian/Documents/Phaser/phaser/src/math/SmoothStep.js","/home/arian/Documents/Phaser/phaser/src/math/SmootherStep.js","/home/arian/Documents/Phaser/phaser/src/math/ToXY.js","/home/arian/Documents/Phaser/phaser/src/math/TransformXY.js","/home/arian/Documents/Phaser/phaser/src/math/Vector2.js","/home/arian/Documents/Phaser/phaser/src/math/Vector3.js","/home/arian/Documents/Phaser/phaser/src/math/Vector4.js","/home/arian/Documents/Phaser/phaser/src/math/Within.js","/home/arian/Documents/Phaser/phaser/src/math/Wrap.js","/home/arian/Documents/Phaser/phaser/src/math/angle/Between.js","/home/arian/Documents/Phaser/phaser/src/math/angle/BetweenPoints.js","/home/arian/Documents/Phaser/phaser/src/math/angle/BetweenPointsY.js","/home/arian/Documents/Phaser/phaser/src/math/angle/BetweenY.js","/home/arian/Documents/Phaser/phaser/src/math/angle/CounterClockwise.js","/home/arian/Documents/Phaser/phaser/src/math/angle/Normalize.js","/home/arian/Documents/Phaser/phaser/src/math/angle/Reverse.js","/home/arian/Documents/Phaser/phaser/src/math/angle/RotateTo.js","/home/arian/Documents/Phaser/phaser/src/math/angle/ShortestBetween.js","/home/arian/Documents/Phaser/phaser/src/math/angle/Wrap.js","/home/arian/Documents/Phaser/phaser/src/math/angle/WrapDegrees.js","/home/arian/Documents/Phaser/phaser/src/math/angle/index.js","/home/arian/Documents/Phaser/phaser/src/math/const.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistanceBetween.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistanceBetweenPoints.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistanceBetweenPointsSquared.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistanceChebyshev.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistancePower.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistanceSnake.js","/home/arian/Documents/Phaser/phaser/src/math/distance/DistanceSquared.js","/home/arian/Documents/Phaser/phaser/src/math/distance/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/EaseMap.js","/home/arian/Documents/Phaser/phaser/src/math/easing/back/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/back/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/back/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/back/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/bounce/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/bounce/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/bounce/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/bounce/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/circular/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/circular/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/circular/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/circular/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/cubic/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/cubic/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/cubic/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/cubic/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/elastic/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/elastic/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/elastic/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/elastic/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/expo/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/expo/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/expo/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/expo/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/linear/Linear.js","/home/arian/Documents/Phaser/phaser/src/math/easing/linear/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quadratic/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quartic/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quartic/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quartic/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quartic/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quintic/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quintic/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quintic/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/quintic/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/sine/In.js","/home/arian/Documents/Phaser/phaser/src/math/easing/sine/InOut.js","/home/arian/Documents/Phaser/phaser/src/math/easing/sine/Out.js","/home/arian/Documents/Phaser/phaser/src/math/easing/sine/index.js","/home/arian/Documents/Phaser/phaser/src/math/easing/stepped/Stepped.js","/home/arian/Documents/Phaser/phaser/src/math/easing/stepped/index.js","/home/arian/Documents/Phaser/phaser/src/math/fuzzy/Ceil.js","/home/arian/Documents/Phaser/phaser/src/math/fuzzy/Equal.js","/home/arian/Documents/Phaser/phaser/src/math/fuzzy/Floor.js","/home/arian/Documents/Phaser/phaser/src/math/fuzzy/GreaterThan.js","/home/arian/Documents/Phaser/phaser/src/math/fuzzy/LessThan.js","/home/arian/Documents/Phaser/phaser/src/math/fuzzy/index.js","/home/arian/Documents/Phaser/phaser/src/math/index.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/BezierInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/CatmullRomInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/CubicBezierInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/LinearInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/QuadraticBezierInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/SmoothStepInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/SmootherStepInterpolation.js","/home/arian/Documents/Phaser/phaser/src/math/interpolation/index.js","/home/arian/Documents/Phaser/phaser/src/math/pow2/GetPowerOfTwo.js","/home/arian/Documents/Phaser/phaser/src/math/pow2/IsSizePowerOfTwo.js","/home/arian/Documents/Phaser/phaser/src/math/pow2/IsValuePowerOfTwo.js","/home/arian/Documents/Phaser/phaser/src/math/pow2/index.js","/home/arian/Documents/Phaser/phaser/src/math/random-data-generator/RandomDataGenerator.js","/home/arian/Documents/Phaser/phaser/src/math/snap/SnapCeil.js","/home/arian/Documents/Phaser/phaser/src/math/snap/SnapFloor.js","/home/arian/Documents/Phaser/phaser/src/math/snap/SnapTo.js","/home/arian/Documents/Phaser/phaser/src/math/snap/index.js","/home/arian/Documents/Phaser/phaser/src/math/typedefs/SinCosTable.js","/home/arian/Documents/Phaser/phaser/src/math/typedefs/Vector2Like.js","/home/arian/Documents/Phaser/phaser/src/math/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/phaser.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/ArcadeImage.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/ArcadePhysics.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/ArcadeSprite.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/Body.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/Collider.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/Factory.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/GetOverlapX.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/GetOverlapY.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/PhysicsGroup.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/SeparateX.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/SeparateY.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/StaticBody.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/StaticPhysicsGroup.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/World.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Acceleration.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Angular.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Bounce.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Debug.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Drag.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Enable.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Friction.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Gravity.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Immovable.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Mass.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/OverlapCirc.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/OverlapRect.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Size.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/Velocity.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/components/index.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/const.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/COLLIDE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/OVERLAP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/TILE_COLLIDE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/TILE_OVERLAP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/WORLD_BOUNDS_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/WORLD_STEP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/events/index.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/index.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/ProcessTileCallbacks.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/ProcessTileSeparationX.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/ProcessTileSeparationY.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/SeparateTile.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/TileCheckX.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/TileCheckY.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/TileIntersectsBody.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/tilemap/index.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/ArcadeBodyBounds.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/ArcadeBodyCollision.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/ArcadeColliderType.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/ArcadeWorldConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/ArcadeWorldDefaults.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/ArcadeWorldTreeMinMax.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/CheckCollisionObject.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/PhysicsGroupConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/PhysicsGroupDefaults.js","/home/arian/Documents/Phaser/phaser/src/physics/arcade/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/Body.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/COLLIDES.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/CollisionMap.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/DefaultDefs.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/Factory.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/GetVelocity.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/ImpactBody.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/ImpactImage.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/ImpactPhysics.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/ImpactSprite.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/SeparateX.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/SeparateY.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/Solver.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/TYPE.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/UpdateMotion.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/World.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Acceleration.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/BodyScale.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/BodyType.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Bounce.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/CheckAgainst.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Collides.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Debug.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Friction.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Gravity.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Offset.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/SetGameObject.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/Velocity.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/components/index.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/events/COLLIDE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/events/PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/events/RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/events/index.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/index.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs/CollisionOptions.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs/JSONImpactBody.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs/WorldConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs/WorldDefaults.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs/WorldWalls.js","/home/arian/Documents/Phaser/phaser/src/physics/impact/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/physics/index.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/BodyBounds.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/CustomMain.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/Factory.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/MatterGameObject.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/MatterImage.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/MatterPhysics.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/MatterSprite.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/MatterTileBody.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/PhysicsEditorParser.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/PhysicsJSONParser.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/PointerConstraint.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/World.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Bounce.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Collision.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Force.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Friction.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Gravity.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Mass.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Sensor.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/SetBody.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Sleep.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Static.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Transform.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/Velocity.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components/index.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/AFTER_ADD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/AFTER_REMOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/AFTER_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/BEFORE_ADD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/BEFORE_REMOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/BEFORE_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/COLLISION_ACTIVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/COLLISION_END_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/COLLISION_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/DRAG_END_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/DRAG_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/DRAG_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/SLEEP_END_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/SLEEP_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/events/index.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/index.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterBody.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterBodyConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterBodyRenderConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterBodyTileOptions.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterChamferConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterCollisionData.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterCollisionFilter.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterCollisionPair.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterConstraintConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterConstraintRenderConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterDebugConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterRunnerConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterSetBodyConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterTileOptions.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/MatterWorldConfig.js","/home/arian/Documents/Phaser/phaser/src/physics/matter-js/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/plugins/BasePlugin.js","/home/arian/Documents/Phaser/phaser/src/plugins/DefaultPlugins.js","/home/arian/Documents/Phaser/phaser/src/plugins/PluginCache.js","/home/arian/Documents/Phaser/phaser/src/plugins/PluginManager.js","/home/arian/Documents/Phaser/phaser/src/plugins/ScenePlugin.js","/home/arian/Documents/Phaser/phaser/src/plugins/index.js","/home/arian/Documents/Phaser/phaser/src/plugins/typedefs/CorePluginContainer.js","/home/arian/Documents/Phaser/phaser/src/plugins/typedefs/CustomPluginContainer.js","/home/arian/Documents/Phaser/phaser/src/plugins/typedefs/GlobalPlugin.js","/home/arian/Documents/Phaser/phaser/src/plugins/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/BlendModes.js","/home/arian/Documents/Phaser/phaser/src/renderer/ScaleModes.js","/home/arian/Documents/Phaser/phaser/src/renderer/canvas/CanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/renderer/canvas/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/canvas/utils/GetBlendModes.js","/home/arian/Documents/Phaser/phaser/src/renderer/canvas/utils/SetTransform.js","/home/arian/Documents/Phaser/phaser/src/renderer/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/CanvasSnapshot.js","/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/WebGLSnapshot.js","/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/typedefs/SnapshotCallback.js","/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/typedefs/SnapshotState.js","/home/arian/Documents/Phaser/phaser/src/renderer/snapshot/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/Utils.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/WebGLPipeline.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/WebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/BitmapMaskPipeline.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/ForwardDiffuseLightPipeline.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/TextureTintPipeline.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/components/ModelViewProjection.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines/index.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/BitmapMask-frag.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/BitmapMask-vert.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/DeferredDiffuse-frag.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/DeferredDiffuse-vert.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/ForwardDiffuse-frag.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/TextureTint-frag.js","/home/arian/Documents/Phaser/phaser/src/renderer/webgl/shaders/TextureTint-vert.js","/home/arian/Documents/Phaser/phaser/src/scale/ScaleManager.js","/home/arian/Documents/Phaser/phaser/src/scale/const/CENTER_CONST.js","/home/arian/Documents/Phaser/phaser/src/scale/const/ORIENTATION_CONST.js","/home/arian/Documents/Phaser/phaser/src/scale/const/SCALE_MODE_CONST.js","/home/arian/Documents/Phaser/phaser/src/scale/const/ZOOM_CONST.js","/home/arian/Documents/Phaser/phaser/src/scale/const/index.js","/home/arian/Documents/Phaser/phaser/src/scale/events/ENTER_FULLSCREEN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scale/events/FULLSCREEN_FAILED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scale/events/FULLSCREEN_UNSUPPORTED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scale/events/LEAVE_FULLSCREEN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scale/events/ORIENTATION_CHANGE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scale/events/RESIZE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scale/events/index.js","/home/arian/Documents/Phaser/phaser/src/scale/index.js","/home/arian/Documents/Phaser/phaser/src/scene/GetPhysicsPlugins.js","/home/arian/Documents/Phaser/phaser/src/scene/GetScenePlugins.js","/home/arian/Documents/Phaser/phaser/src/scene/InjectionMap.js","/home/arian/Documents/Phaser/phaser/src/scene/Scene.js","/home/arian/Documents/Phaser/phaser/src/scene/SceneManager.js","/home/arian/Documents/Phaser/phaser/src/scene/ScenePlugin.js","/home/arian/Documents/Phaser/phaser/src/scene/Settings.js","/home/arian/Documents/Phaser/phaser/src/scene/Systems.js","/home/arian/Documents/Phaser/phaser/src/scene/const.js","/home/arian/Documents/Phaser/phaser/src/scene/events/BOOT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/CREATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/DESTROY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/POST_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/PRE_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/READY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/RENDER_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/SHUTDOWN_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/SLEEP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/TRANSITION_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/TRANSITION_INIT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/TRANSITION_OUT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/TRANSITION_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/TRANSITION_WAKE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/WAKE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/scene/events/index.js","/home/arian/Documents/Phaser/phaser/src/scene/index.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/CreateSceneFromObjectConfig.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/SceneCreateCallback.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/SceneInitCallback.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/ScenePreloadCallback.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/SceneTransitionConfig.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/SettingsConfig.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/SettingsObject.js","/home/arian/Documents/Phaser/phaser/src/scene/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/sound/BaseSound.js","/home/arian/Documents/Phaser/phaser/src/sound/BaseSoundManager.js","/home/arian/Documents/Phaser/phaser/src/sound/SoundManagerCreator.js","/home/arian/Documents/Phaser/phaser/src/sound/events/COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/DECODED_ALL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/DECODED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/DESTROY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/DETUNE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/GLOBAL_DETUNE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/GLOBAL_MUTE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/GLOBAL_RATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/GLOBAL_VOLUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/LOOPED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/LOOP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/MUTE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/PAUSE_ALL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/PLAY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/RATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/RESUME_ALL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/SEEK_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/STOP_ALL_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/STOP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/UNLOCKED_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/VOLUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/sound/events/index.js","/home/arian/Documents/Phaser/phaser/src/sound/html5/HTML5AudioSound.js","/home/arian/Documents/Phaser/phaser/src/sound/html5/HTML5AudioSoundManager.js","/home/arian/Documents/Phaser/phaser/src/sound/index.js","/home/arian/Documents/Phaser/phaser/src/sound/noaudio/NoAudioSound.js","/home/arian/Documents/Phaser/phaser/src/sound/noaudio/NoAudioSoundManager.js","/home/arian/Documents/Phaser/phaser/src/sound/typedefs/AudioSpriteSound.js","/home/arian/Documents/Phaser/phaser/src/sound/typedefs/DecodeAudioConfig.js","/home/arian/Documents/Phaser/phaser/src/sound/typedefs/EachActiveSoundCallback.js","/home/arian/Documents/Phaser/phaser/src/sound/typedefs/SoundConfig.js","/home/arian/Documents/Phaser/phaser/src/sound/typedefs/SoundMarker.js","/home/arian/Documents/Phaser/phaser/src/sound/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/sound/webaudio/WebAudioSound.js","/home/arian/Documents/Phaser/phaser/src/sound/webaudio/WebAudioSoundManager.js","/home/arian/Documents/Phaser/phaser/src/structs/List.js","/home/arian/Documents/Phaser/phaser/src/structs/Map.js","/home/arian/Documents/Phaser/phaser/src/structs/ProcessQueue.js","/home/arian/Documents/Phaser/phaser/src/structs/RTree.js","/home/arian/Documents/Phaser/phaser/src/structs/Set.js","/home/arian/Documents/Phaser/phaser/src/structs/Size.js","/home/arian/Documents/Phaser/phaser/src/structs/events/PROCESS_QUEUE_ADD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/structs/events/PROCESS_QUEUE_REMOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/structs/events/index.js","/home/arian/Documents/Phaser/phaser/src/structs/index.js","/home/arian/Documents/Phaser/phaser/src/textures/CanvasTexture.js","/home/arian/Documents/Phaser/phaser/src/textures/Frame.js","/home/arian/Documents/Phaser/phaser/src/textures/Texture.js","/home/arian/Documents/Phaser/phaser/src/textures/TextureManager.js","/home/arian/Documents/Phaser/phaser/src/textures/TextureSource.js","/home/arian/Documents/Phaser/phaser/src/textures/const.js","/home/arian/Documents/Phaser/phaser/src/textures/events/ADD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/textures/events/ERROR_EVENT.js","/home/arian/Documents/Phaser/phaser/src/textures/events/LOAD_EVENT.js","/home/arian/Documents/Phaser/phaser/src/textures/events/READY_EVENT.js","/home/arian/Documents/Phaser/phaser/src/textures/events/REMOVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/textures/events/index.js","/home/arian/Documents/Phaser/phaser/src/textures/index.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/AtlasXML.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/Canvas.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/Image.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/JSONArray.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/JSONHash.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/SpriteSheet.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/SpriteSheetFromAtlas.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/UnityYAML.js","/home/arian/Documents/Phaser/phaser/src/textures/parsers/index.js","/home/arian/Documents/Phaser/phaser/src/textures/typedefs/PixelConfig.js","/home/arian/Documents/Phaser/phaser/src/textures/typedefs/SpriteSheetConfig.js","/home/arian/Documents/Phaser/phaser/src/textures/typedefs/SpriteSheetFromAtlasConfig.js","/home/arian/Documents/Phaser/phaser/src/textures/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/Formats.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/ImageCollection.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/ParseToTilemap.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/Tile.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/Tilemap.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/TilemapCreator.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/TilemapFactory.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/Tileset.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/CalculateFacesAt.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/CalculateFacesWithin.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/Copy.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/CreateFromTiles.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/CullTiles.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/Fill.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/FilterTiles.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/FindByIndex.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/FindTile.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/ForEachTile.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/GetTileAt.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/GetTileAtWorldXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/GetTilesWithin.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/GetTilesWithinShape.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/GetTilesWithinWorldXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/HasTileAt.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/HasTileAtWorldXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/IsInLayerBounds.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/PutTileAt.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/PutTileAtWorldXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/PutTilesAt.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/Randomize.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/RemoveTileAt.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/RemoveTileAtWorldXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/RenderDebug.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/ReplaceByIndex.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetCollision.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetCollisionBetween.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetCollisionByExclusion.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetCollisionByProperty.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetCollisionFromCollisionGroup.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetLayerCollisionIndex.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetTileCollision.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetTileIndexCallback.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SetTileLocationCallback.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/Shuffle.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/SwapByIndex.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/TileToWorldX.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/TileToWorldXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/TileToWorldY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/WeightedRandomize.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/WorldToTileX.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/WorldToTileXY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/WorldToTileY.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/components/index.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer/DynamicTilemapLayer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer/DynamicTilemapLayerCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer/DynamicTilemapLayerRender.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/dynamiclayer/DynamicTilemapLayerWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/index.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata/LayerData.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata/MapData.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/mapdata/ObjectLayer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/Parse.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/Parse2DArray.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/ParseCSV.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact/ParseTileLayers.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact/ParseTilesets.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact/ParseWeltmeister.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/impact/index.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/index.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/AssignTileProperties.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/Base64Decode.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/BuildTilesetIndex.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/CreateGroupLayer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseGID.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseImageLayers.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseJSONTiled.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseObject.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseObjectLayers.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseTileLayers.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/ParseTilesets.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/parsers/tiled/index.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer/StaticTilemapLayer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer/StaticTilemapLayerCanvasRenderer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer/StaticTilemapLayerRender.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/staticlayer/StaticTilemapLayerWebGLRenderer.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/FilteringOptions.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/GetTilesWithinFilteringOptions.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/MapDataConfig.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/ObjectLayerConfig.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/StyleConfig.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/TiledObject.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/TilemapConfig.js","/home/arian/Documents/Phaser/phaser/src/tilemaps/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/time/Clock.js","/home/arian/Documents/Phaser/phaser/src/time/TimerEvent.js","/home/arian/Documents/Phaser/phaser/src/time/index.js","/home/arian/Documents/Phaser/phaser/src/time/typedefs/TimerEventConfig.js","/home/arian/Documents/Phaser/phaser/src/time/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/tweens/Timeline.js","/home/arian/Documents/Phaser/phaser/src/tweens/TweenManager.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetBoolean.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetEaseFunction.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetNewValue.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetProps.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetTargets.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetTweens.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/GetValueOp.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/NumberTweenBuilder.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/StaggerBuilder.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/TimelineBuilder.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/TweenBuilder.js","/home/arian/Documents/Phaser/phaser/src/tweens/builders/index.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TIMELINE_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TIMELINE_LOOP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TIMELINE_PAUSE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TIMELINE_RESUME_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TIMELINE_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TIMELINE_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_ACTIVE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_COMPLETE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_LOOP_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_REPEAT_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_START_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_UPDATE_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/TWEEN_YOYO_EVENT.js","/home/arian/Documents/Phaser/phaser/src/tweens/events/index.js","/home/arian/Documents/Phaser/phaser/src/tweens/index.js","/home/arian/Documents/Phaser/phaser/src/tweens/tween/Defaults.js","/home/arian/Documents/Phaser/phaser/src/tweens/tween/ReservedProps.js","/home/arian/Documents/Phaser/phaser/src/tweens/tween/Tween.js","/home/arian/Documents/Phaser/phaser/src/tweens/tween/TweenData.js","/home/arian/Documents/Phaser/phaser/src/tweens/tween/const.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/Event.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/GetActiveCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/GetEndCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/GetStartCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/NumberTweenBuilderConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/StaggerConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TimelineBuilderConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TimelineOnCompleteCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TimelineOnLoopCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TimelineOnStartCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TimelineOnUpdateCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TimelineOnYoyoCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenBuilderConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenDataConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenDataGenConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnActiveCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnCompleteCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnLoopCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnRepeatCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnStartCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnUpdateCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenOnYoyoCallback.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/TweenPropConfig.js","/home/arian/Documents/Phaser/phaser/src/tweens/typedefs/index.js","/home/arian/Documents/Phaser/phaser/src/utils/Class.js","/home/arian/Documents/Phaser/phaser/src/utils/NOOP.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Add.js","/home/arian/Documents/Phaser/phaser/src/utils/array/AddAt.js","/home/arian/Documents/Phaser/phaser/src/utils/array/BringToTop.js","/home/arian/Documents/Phaser/phaser/src/utils/array/CountAllMatching.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Each.js","/home/arian/Documents/Phaser/phaser/src/utils/array/EachInRange.js","/home/arian/Documents/Phaser/phaser/src/utils/array/FindClosestInSorted.js","/home/arian/Documents/Phaser/phaser/src/utils/array/GetAll.js","/home/arian/Documents/Phaser/phaser/src/utils/array/GetFirst.js","/home/arian/Documents/Phaser/phaser/src/utils/array/GetRandom.js","/home/arian/Documents/Phaser/phaser/src/utils/array/MoveDown.js","/home/arian/Documents/Phaser/phaser/src/utils/array/MoveTo.js","/home/arian/Documents/Phaser/phaser/src/utils/array/MoveUp.js","/home/arian/Documents/Phaser/phaser/src/utils/array/NumberArray.js","/home/arian/Documents/Phaser/phaser/src/utils/array/NumberArrayStep.js","/home/arian/Documents/Phaser/phaser/src/utils/array/QuickSelect.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Range.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Remove.js","/home/arian/Documents/Phaser/phaser/src/utils/array/RemoveAt.js","/home/arian/Documents/Phaser/phaser/src/utils/array/RemoveBetween.js","/home/arian/Documents/Phaser/phaser/src/utils/array/RemoveRandomElement.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Replace.js","/home/arian/Documents/Phaser/phaser/src/utils/array/RotateLeft.js","/home/arian/Documents/Phaser/phaser/src/utils/array/RotateRight.js","/home/arian/Documents/Phaser/phaser/src/utils/array/SafeRange.js","/home/arian/Documents/Phaser/phaser/src/utils/array/SendToBack.js","/home/arian/Documents/Phaser/phaser/src/utils/array/SetAll.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Shuffle.js","/home/arian/Documents/Phaser/phaser/src/utils/array/SpliceOne.js","/home/arian/Documents/Phaser/phaser/src/utils/array/StableSort.js","/home/arian/Documents/Phaser/phaser/src/utils/array/Swap.js","/home/arian/Documents/Phaser/phaser/src/utils/array/index.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/CheckMatrix.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/MatrixToString.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/ReverseColumns.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/ReverseRows.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/Rotate180.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/RotateLeft.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/RotateMatrix.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/RotateRight.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/TransposeMatrix.js","/home/arian/Documents/Phaser/phaser/src/utils/array/matrix/index.js","/home/arian/Documents/Phaser/phaser/src/utils/base64/ArrayBufferToBase64.js","/home/arian/Documents/Phaser/phaser/src/utils/base64/Base64ToArrayBuffer.js","/home/arian/Documents/Phaser/phaser/src/utils/base64/index.js","/home/arian/Documents/Phaser/phaser/src/utils/index.js","/home/arian/Documents/Phaser/phaser/src/utils/object/Clone.js","/home/arian/Documents/Phaser/phaser/src/utils/object/Extend.js","/home/arian/Documents/Phaser/phaser/src/utils/object/GetAdvancedValue.js","/home/arian/Documents/Phaser/phaser/src/utils/object/GetFastValue.js","/home/arian/Documents/Phaser/phaser/src/utils/object/GetMinMaxValue.js","/home/arian/Documents/Phaser/phaser/src/utils/object/GetValue.js","/home/arian/Documents/Phaser/phaser/src/utils/object/HasAll.js","/home/arian/Documents/Phaser/phaser/src/utils/object/HasAny.js","/home/arian/Documents/Phaser/phaser/src/utils/object/HasValue.js","/home/arian/Documents/Phaser/phaser/src/utils/object/IsPlainObject.js","/home/arian/Documents/Phaser/phaser/src/utils/object/Merge.js","/home/arian/Documents/Phaser/phaser/src/utils/object/MergeRight.js","/home/arian/Documents/Phaser/phaser/src/utils/object/Pick.js","/home/arian/Documents/Phaser/phaser/src/utils/object/SetValue.js","/home/arian/Documents/Phaser/phaser/src/utils/object/index.js","/home/arian/Documents/Phaser/phaser/src/utils/string/Format.js","/home/arian/Documents/Phaser/phaser/src/utils/string/Pad.js","/home/arian/Documents/Phaser/phaser/src/utils/string/Reverse.js","/home/arian/Documents/Phaser/phaser/src/utils/string/UUID.js","/home/arian/Documents/Phaser/phaser/src/utils/string/UppercaseFirst.js","/home/arian/Documents/Phaser/phaser/src/utils/string/index.js","/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src/AdInstance.js","/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src/FacebookInstantGamesPlugin.js","/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src/Leaderboard.js","/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src/LeaderboardScore.js","/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src/Product.js","/home/arian/Documents/Phaser/phaser/plugins/fbinstant/src/Purchase.js"],"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"`this`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"`this`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"`this`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"`this`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"`this`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Animations.Animation"]},"description":"`this`."}],"memberof":"Phaser.Animations.Animation","longname":"Phaser.Animations.Animation#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"`this`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"`this`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"`this`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"`this`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"`this`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Animations.AnimationManager"]},"description":"`this`."}],"memberof":"Phaser.Animations.AnimationManager","longname":"Phaser.Animations.AnimationManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.BaseCamera","longname":"Phaser.Cameras.Scene2D.BaseCamera#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":79,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Scene this camera belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#scene","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#scene","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Game Scene Manager.","name":"sceneManager","type":{"names":["Phaser.Scenes.SceneManager"]},"since":"3.12.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#sceneManager","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#sceneManager","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Game Scale Manager.","name":"scaleManager","type":{"names":["Phaser.Scale.ScaleManager"]},"since":"3.16.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#scaleManager","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#scaleManager","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"A reference to the Scene's Camera Manager to which this Camera belongs.","name":"cameraManager","type":{"names":["Phaser.Cameras.Scene2D.CameraManager"]},"since":"3.17.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#cameraManager","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#cameraManager","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera ID. Assigned by the Camera Manager and used to handle camera exclusion.\nThis value is a bitmask.","name":"id","type":{"names":["integer"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#id","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#id","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The name of the Camera. This is left empty for your own use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#name","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#name","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":136,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"This property is un-used in v3.16.\n\nThe resolution of the Game, used in most Camera calculations.","name":"resolution","type":{"names":["number"]},"readonly":true,"deprecated":true,"since":"3.12.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#resolution","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#resolution","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":149,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Should this camera round its pixel values to integers?","name":"roundPixels","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#roundPixels","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#roundPixels","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera visible or not?\n\nA visible camera will render and perform input tests.\nAn invisible camera will not render anything and will skip input tests.","name":"visible","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.10.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#visible","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#visible","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":171,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera using a bounds to restrict scrolling movement?\n\nSet this property along with the bounds via `Camera.setBounds`.","name":"useBounds","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#useBounds","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#useBounds","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The World View is a Rectangle that defines the area of the 'world' the Camera is currently looking at.\nThis factors in the Camera viewport size, zoom and scroll position and is updated in the Camera preRender step.\nIf you have enabled Camera bounds the worldview will be clamped to those bounds accordingly.\nYou can use it for culling or intersection checks.","name":"worldView","type":{"names":["Phaser.Geom.Rectangle"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#worldView","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#worldView","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Is this Camera dirty?\n\nA dirty Camera has had either its viewport size, bounds, scroll, rotation or zoom levels changed since the last frame.\n\nThis flag is cleared during the `postRenderCamera` method of the renderer.","name":"dirty","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#dirty","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#dirty","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":392,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Does this Camera have a transparent background?","name":"transparent","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#transparent","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#transparent","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":402,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The background color of this Camera. Only used if `transparent` is `false`.","name":"backgroundColor","type":{"names":["Phaser.Display.Color"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#backgroundColor","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#backgroundColor","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":411,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera alpha value. Setting this property impacts every single object that this Camera\nrenders. You can either set the property directly, i.e. via a Tween, to fade a Camera in or out,\nor via the chainable `setAlpha` method instead.","name":"alpha","type":{"names":["number"]},"defaultvalue":"1","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#alpha","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#alpha","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":422,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Should the camera cull Game Objects before checking them for input hit tests?\nIn some special cases it may be beneficial to disable this.","name":"disableCull","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#disableCull","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#disableCull","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":444,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The mid-point of the Camera in 'world' coordinates.\n\nUse it to obtain exactly where in the world the center of the camera is currently looking.\n\nThis value is updated in the preRender method, after the scroll values and follower\nhave been processed.","name":"midPoint","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#midPoint","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#midPoint","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":459,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The horizontal origin of rotation for this Camera.\n\nBy default the camera rotates around the center of the viewport.\n\nChanging the origin allows you to adjust the point in the viewport from which rotation happens.\nA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.\n\nSee `setOrigin` to set both origins in a single, chainable call.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#originX","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#originX","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":476,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The vertical origin of rotation for this Camera.\n\nBy default the camera rotates around the center of the viewport.\n\nChanging the origin allows you to adjust the point in the viewport from which rotation happens.\nA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.\n\nSee `setOrigin` to set both origins in a single, chainable call.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#originY","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#originY","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":504,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Mask this Camera is using during render.\nSet the mask using the `setMask` method. Remove the mask using the `clearMask` method.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"nullable":true,"since":"3.17.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#mask","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#mask","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the Alpha level of this Camera. The alpha controls the opacity of the Camera as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.11.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The Camera alpha value.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setAlpha","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":541,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the rotation origin of this Camera.\n\nThe values are given in the range 0 to 1 and are only used when calculating Camera rotation.\n\nBy default the camera rotates around the center of the viewport.\n\nChanging the origin allows you to adjust the point in the viewport from which rotation happens.\nA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.","kind":"function","name":"setOrigin","since":"3.11.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setOrigin","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":570,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Calculates what the Camera.scrollX and scrollY values would need to be in order to move\nthe Camera so it is centered on the given x and y coordinates, without actually moving\nthe Camera there. The results are clamped based on the Camera bounds, if set.","kind":"function","name":"getScroll","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A Vector2 to store the values in. If not given a new Vector2 is created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The scroll coordinates stored in the `x` and `y` properties."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#getScroll","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#getScroll","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":603,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera horizontally so that it is centered on the given x coordinate, bounds allowing.\nCalling this does not change the scrollY value.","kind":"function","name":"centerOnX","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerOnX","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerOnX","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":630,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera vertically so that it is centered on the given y coordinate, bounds allowing.\nCalling this does not change the scrollX value.","kind":"function","name":"centerOnY","since":"3.16.0","params":[{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerOnY","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerOnY","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":657,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera so that it is centered on the given coordinates, bounds allowing.","kind":"function","name":"centerOn","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The horizontal coordinate to center on.","name":"x"},{"type":{"names":["number"]},"description":"The vertical coordinate to center on.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerOn","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerOn","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":676,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera so that it is looking at the center of the Camera Bounds, if enabled.","kind":"function","name":"centerToBounds","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerToBounds","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerToBounds","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":701,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Moves the Camera so that it is re-centered based on its viewport size.","kind":"function","name":"centerToSize","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerToSize","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerToSize","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":717,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Takes an array of Game Objects and returns a new array featuring only those objects\nvisible by this camera.","kind":"function","name":"cull","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"An array of Game Objects to cull.","name":"renderableObjects"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Game Objects visible to this Camera."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#cull","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#cull","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":798,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Converts the given `x` and `y` coordinates into World space, based on this Cameras transform.\nYou can optionally provide a Vector2, or similar object, to store the results in.","kind":"function","name":"getWorldPoint","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x position to convert to world space.","name":"x"},{"type":{"names":["number"]},"description":"The y position to convert to world space.","name":"y"},{"type":{"names":["object","Phaser.Math.Vector2"]},"optional":true,"description":"An optional object to store the results in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"An object holding the converted values in its `x` and `y` properties."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#getWorldPoint","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#getWorldPoint","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":866,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Given a Game Object, or an array of Game Objects, it will update all of their camera filter settings\nso that they are ignored by this Camera. This means they will not be rendered by this Camera.","kind":"function","name":"ignore","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject","Array.","Phaser.GameObjects.Group"]},"description":"The Game Object, or array of Game Objects, to be ignored by this Camera.","name":"entries"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#ignore","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#ignore","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":970,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Takes an x value and checks it's within the range of the Camera bounds, adjusting if required.\nDo not call this method if you are not using camera bounds.","kind":"function","name":"clampX","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The value to horizontally scroll clamp.","name":"x"}],"returns":[{"type":{"names":["number"]},"description":"The adjusted value to use as scrollX."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#clampX","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#clampX","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1002,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Takes a y value and checks it's within the range of the Camera bounds, adjusting if required.\nDo not call this method if you are not using camera bounds.","kind":"function","name":"clampY","since":"3.11.0","params":[{"type":{"names":["number"]},"description":"The value to vertically scroll clamp.","name":"y"}],"returns":[{"type":{"names":["number"]},"description":"The adjusted value to use as scrollY."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#clampY","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#clampY","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1039,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"If this Camera has previously had movement bounds set on it, this will remove them.","kind":"function","name":"removeBounds","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#removeBounds","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#removeBounds","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1058,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the rotation of this Camera. This causes everything it renders to appear rotated.\n\nRotating a camera does not rotate the viewport itself, it is applied during rendering.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The cameras angle of rotation, given in degrees.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setAngle","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setAngle","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1079,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the background color for this Camera.\n\nBy default a Camera has a transparent background but it can be given a solid color, with any level\nof transparency, via this method.\n\nThe color value can be specified using CSS color notation, hex or numbers.","kind":"function","name":"setBackgroundColor","since":"3.0.0","params":[{"type":{"names":["string","number","Phaser.Types.Display.InputColorObject"]},"optional":true,"defaultvalue":"'rgba(0,0,0,0)'","description":"The color value. In CSS, hex or numeric color notation.","name":"color"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setBackgroundColor","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setBackgroundColor","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1105,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the bounds of the Camera. The bounds are an axis-aligned rectangle.\n\nThe Camera bounds controls where the Camera can scroll to, stopping it from scrolling off the\nedges and into blank space. It does not limit the placement of Game Objects, or where\nthe Camera viewport can be positioned.\n\nTemporarily disable the bounds by changing the boolean `Camera.useBounds`.\n\nClear the bounds entirely by calling `Camera.removeBounds`.\n\nIf you set bounds that are smaller than the viewport it will stop the Camera from being\nable to scroll. The bounds can be positioned where-ever you wish. By default they are from\n0x0 to the canvas width x height. This means that the coordinate 0x0 is the top left of\nthe Camera bounds. However, you can position them anywhere. So if you wanted a game world\nthat was 2048x2048 in size, with 0x0 being the center of it, you can set the bounds x/y\nto be -1024, -1024, with a width and height of 2048. Depending on your game you may find\nit easier for 0x0 to be the top-left of the bounds, or you may wish 0x0 to be the middle.","kind":"function","name":"setBounds","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The top-left x coordinate of the bounds.","name":"x"},{"type":{"names":["integer"]},"description":"The top-left y coordinate of the bounds.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the bounds, in pixels.","name":"width"},{"type":{"names":["integer"]},"description":"The height of the bounds, in pixels.","name":"height"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If `true` the Camera will automatically be centered on the new bounds.","name":"centerOn"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setBounds","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setBounds","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1157,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Returns a rectangle containing the bounds of the Camera.\n\nIf the Camera does not have any bounds the rectangle will be empty.\n\nThe rectangle is a copy of the bounds, so is safe to modify.","kind":"function","name":"getBounds","since":"3.16.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"An optional Rectangle to store the bounds in. If not given, a new Rectangle will be created.","name":"out"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A rectangle containing the bounds of this Camera."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#getBounds","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#getBounds","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1182,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the name of this Camera.\nThis value is for your own use and isn't used internally.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"''","description":"The name of the Camera.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setName","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setName","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1202,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the position of the Camera viewport within the game.\n\nThis does not change where the camera is 'looking'. See `setScroll` to control that.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the Camera viewport.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The top-left y coordinate of the Camera viewport.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setPosition","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setPosition","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the rotation of this Camera. This causes everything it renders to appear rotated.\n\nRotating a camera does not rotate the viewport itself, it is applied during rendering.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of the Camera, in radians.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setRotation","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setRotation","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1246,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Should the Camera round pixel values to whole integers when rendering Game Objects?\n\nIn some types of game, especially with pixel art, this is required to prevent sub-pixel aliasing.","kind":"function","name":"setRoundPixels","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to round Camera pixels, `false` to not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setRoundPixels","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setRoundPixels","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1265,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the Scene the Camera is bound to.\n\nAlso populates the `resolution` property and updates the internal size values.","kind":"function","name":"setScene","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene the camera is bound to.","name":"scene"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setScene","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setScene","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1306,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the position of where the Camera is looking within the game.\nYou can also modify the properties `Camera.scrollX` and `Camera.scrollY` directly.\nUse this method, or the scroll properties, to move your camera around the game world.\n\nThis does not change where the camera viewport is placed. See `setPosition` to control that.","kind":"function","name":"setScroll","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The x coordinate of the Camera in the game world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y coordinate of the Camera in the game world.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setScroll","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setScroll","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the size of the Camera viewport.\n\nBy default a Camera is the same size as the game, but can be made smaller via this method,\nallowing you to create mini-cam style effects by creating and positioning a smaller Camera\nviewport within your game.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The width of the Camera viewport.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"width","description":"The height of the Camera viewport.","name":"height"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setSize","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setSize","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1356,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"This method sets the position and size of the Camera viewport in a single call.\n\nIf you're trying to change where the Camera is looking at in your game, then see\nthe method `Camera.setScroll` instead. This method is for changing the viewport\nitself, not what the camera can see.\n\nBy default a Camera is the same size as the game, but can be made smaller via this method,\nallowing you to create mini-cam style effects by creating and positioning a smaller Camera\nviewport within your game.","kind":"function","name":"setViewport","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The top-left x coordinate of the Camera viewport.","name":"x"},{"type":{"names":["number"]},"description":"The top-left y coordinate of the Camera viewport.","name":"y"},{"type":{"names":["integer"]},"description":"The width of the Camera viewport.","name":"width"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":"width","description":"The height of the Camera viewport.","name":"height"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setViewport","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setViewport","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1387,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Set the zoom value of the Camera.\n\nChanging to a smaller value, such as 0.5, will cause the camera to 'zoom out'.\nChanging to a larger value, such as 2, will cause the camera to 'zoom in'.\n\nA value of 1 means 'no zoom' and is the default.\n\nChanging the zoom does not impact the Camera viewport in any way, it is only applied during rendering.","kind":"function","name":"setZoom","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The zoom value of the Camera. The minimum it can be is 0.001.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.BaseCamera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setZoom","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setZoom","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1418,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the mask to be applied to this Camera during rendering.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\n\nBitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Camera it will be immediately replaced.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.\n\nNote: You cannot mask a Camera that has `renderToTexture` set.","kind":"function","name":"setMask","since":"3.17.0","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Camera will use when rendering.","name":"mask"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the mask translate along with the Camera, or be fixed in place and not impacted by the Cameras transform?","name":"fixedPosition"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setMask","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setMask","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Clears the mask that this Camera was using.","kind":"function","name":"clearMask","since":"3.17.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#clearMask","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#clearMask","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1475,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Sets the visibility of this Camera.\n\nAn invisible Camera will skip rendering and input tests of everything it can see.","kind":"function","name":"setVisible","since":"3.10.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Camera.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Camera instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setVisible","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#setVisible","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1488,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"Returns an Object suitable for JSON storage containing all of the Camera viewport and rendering properties.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.Cameras.Scene2D.JSONCamera"]},"description":"A well-formed object suitable for conversion to JSON."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#toJSON","scope":"instance","inherits":"Phaser.Cameras.Scene2D.BaseCamera#toJSON","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1660,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The width of the Camera viewport, in pixels.\n\nThe viewport is the area into which the Camera renders. Setting the viewport does\nnot restrict where the Camera can scroll to.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#width","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#width","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1686,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The height of the Camera viewport, in pixels.\n\nThe viewport is the area into which the Camera renders. Setting the viewport does\nnot restrict where the Camera can scroll to.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#height","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#height","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1712,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The horizontal scroll position of this Camera.\n\nChange this value to cause the Camera to scroll around your Scene.\n\nAlternatively, setting the Camera to follow a Game Object, via the `startFollow` method,\nwill automatically adjust the Camera scroll values accordingly.\n\nYou can set the bounds within which the Camera can scroll via the `setBounds` method.","name":"scrollX","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#scrollX","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#scrollX","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The vertical scroll position of this Camera.\n\nChange this value to cause the Camera to scroll around your Scene.\n\nAlternatively, setting the Camera to follow a Game Object, via the `startFollow` method,\nwill automatically adjust the Camera scroll values accordingly.\n\nYou can set the bounds within which the Camera can scroll via the `setBounds` method.","name":"scrollY","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#scrollY","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#scrollY","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1772,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The Camera zoom value. Change this value to zoom in, or out of, a Scene.\n\nA value of 0.5 would zoom the Camera out, so you can now see twice as much\nof the Scene as before. A value of 2 would zoom the Camera in, so every pixel\nnow takes up 2 pixels when rendered.\n\nSet to 1 to return to the default zoom level.\n\nBe careful to never set this value to zero.","name":"zoom","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#zoom","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#zoom","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1833,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The horizontal position of the center of the Camera's viewport, relative to the left of the game canvas.","name":"centerX","type":{"names":["number"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerX","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerX","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1850,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The vertical position of the center of the Camera's viewport, relative to the top of the game canvas.","name":"centerY","type":{"names":["number"]},"readonly":true,"since":"3.10.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#centerY","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#centerY","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1867,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The displayed width of the camera viewport, factoring in the camera zoom level.\n\nIf a camera has a viewport width of 800 and a zoom of 0.5 then its display width\nwould be 1600, as it's displaying twice as many pixels as zoom level 1.\n\nEqually, a camera with a width of 800 and zoom of 2 would have a display width\nof 400 pixels.","name":"displayWidth","type":{"names":["number"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"BaseCamera.js","lineno":1890,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/cameras/2d"},"description":"The displayed height of the camera viewport, factoring in the camera zoom level.\n\nIf a camera has a viewport height of 600 and a zoom of 0.5 then its display height\nwould be 1200, as it's displaying twice as many pixels as zoom level 1.\n\nEqually, a camera with a height of 600 and zoom of 2 would have a display height\nof 300 pixels.","name":"displayHeight","type":{"names":["number"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.Cameras.Scene2D.BaseCamera#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"`this`."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"This Game Object instance."}],"memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Cameras.Scene2D.Camera","longname":"Phaser.Cameras.Scene2D.Camera#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"String based identifier for the type of curve.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#type","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#type","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The default number of divisions within the curve.","name":"defaultDivisions","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#defaultDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#defaultDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The quantity of arc length divisions within the curve.","name":"arcLengthDivisions","type":{"names":["integer"]},"defaultvalue":"100","since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#arcLengthDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#arcLengthDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"An array of cached arc length values.","name":"cacheArcLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#cacheArcLengths","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#cacheArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Does the data of this curve need updating?","name":"needsUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#needsUpdate","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#needsUpdate","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"For a curve on a Path, `false` means the Path will ignore this curve.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#active","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#active","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a Rectangle where the position and dimensions match the bounds of this Curve.\n\nYou can control the accuracy of the bounds. The value given is used to work out how many points\nto plot across the curve. Higher values are more accurate at the cost of calculation speed.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the bounds in. If falsey a new object will be created.","name":"out"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":16,"description":"The accuracy of the bounds calculations.","name":"accuracy"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A Rectangle object holding the bounds of this curve. If `out` was given it will be this object."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getBounds","scope":"instance","inherits":"Phaser.Curves.Curve#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns an array of points, spaced out X distance pixels apart.\nThe smaller the distance, the larger the array will be.","kind":"function","name":"getDistancePoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The distance, in pixels, between each point along the curve.","name":"distance"}],"returns":[{"type":{"names":["Array."]},"description":"An Array of Point objects."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getDistancePoints","scope":"instance","inherits":"Phaser.Curves.Curve#getDistancePoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the end of the curve.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"Optional Vector object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector2 containing the coordinates of the curves end point."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getEndPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getEndPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get total curve arc length","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the curve."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getLength","scope":"instance","inherits":"Phaser.Curves.Curve#getLength","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a list of cumulative segment lengths.\n\nThese lengths are\n\n- [0] 0\n- [1] The first segment\n- [2] The first and second segment\n- ...\n- [divisions] All segments","kind":"function","name":"getLengths","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions or segments.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cumulative lengths."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getLengths","scope":"instance","inherits":"Phaser.Curves.Curve#getLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at a relative position on the curve, by arc length.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getPointAt","scope":"instance","inherits":"Phaser.Curves.Curve#getPointAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of evenly spaced points from the curve.\n\nYou can pass `divisions`, `stepRate`, or neither.\n\nThe number of divisions will be\n\n1. `divisions`, if `divisions` > 0; or\n2. `this.getLength / stepRate`, if `stepRate` > 0; or\n3. `this.defaultDivisions`\n\n`1 + divisions` points will be returned.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"The curve distance between points, implying `divisions`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the curve."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a random point from the curve.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getRandomPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getRandomPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of equally spaced points (by arc distance) from the curve.\n\n`1 + divisions` points will be returned.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.defaultDivisions","description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array of points."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getSpacedPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getSpacedPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve.\nIn case any sub curve does not implement its tangent derivation,\n2 points a small delta apart will be used to find its gradient\nwhich seems to give a reasonable approximation","kind":"function","name":"getTangent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector approximating the tangent line at the point t (delta +/- 0.0001)"}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getTangent","scope":"instance","inherits":"Phaser.Curves.Curve#getTangent","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve, by arc length.","kind":"function","name":"getTangentAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getTangentAt","scope":"instance","inherits":"Phaser.Curves.Curve#getTangentAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getTFromDistance","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getTFromDistance","scope":"instance","inherits":"Phaser.Curves.Curve#getTFromDistance","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getUtoTmapping","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"u"},{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#getUtoTmapping","scope":"instance","inherits":"Phaser.Curves.Curve#getUtoTmapping","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Calculate and cache the arc lengths.","kind":"function","name":"updateArcLengths","since":"3.0.0","see":["Phaser.Curves.Curve#getLengths()"],"memberof":"Phaser.Curves.CubicBezier","longname":"Phaser.Curves.CubicBezier#updateArcLengths","scope":"instance","inherits":"Phaser.Curves.Curve#updateArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"String based identifier for the type of curve.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#type","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#type","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The default number of divisions within the curve.","name":"defaultDivisions","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#defaultDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#defaultDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The quantity of arc length divisions within the curve.","name":"arcLengthDivisions","type":{"names":["integer"]},"defaultvalue":"100","since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#arcLengthDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#arcLengthDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"An array of cached arc length values.","name":"cacheArcLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#cacheArcLengths","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#cacheArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Does the data of this curve need updating?","name":"needsUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#needsUpdate","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#needsUpdate","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"For a curve on a Path, `false` means the Path will ignore this curve.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#active","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#active","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":111,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Draws this curve on the given Graphics object.\n\nThe curve is drawn using `Graphics.strokePoints` so will be drawn at whatever the present Graphics stroke color is.\nThe Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.","kind":"function","name":"draw","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics instance onto which this curve will be drawn.","name":"graphics"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The resolution of the curve. The higher the value the smoother it will render, at the cost of rendering performance.","name":"pointsTotal"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to which the curve was drawn."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#draw","scope":"instance","inherits":"Phaser.Curves.Curve#draw","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a Rectangle where the position and dimensions match the bounds of this Curve.\n\nYou can control the accuracy of the bounds. The value given is used to work out how many points\nto plot across the curve. Higher values are more accurate at the cost of calculation speed.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the bounds in. If falsey a new object will be created.","name":"out"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":16,"description":"The accuracy of the bounds calculations.","name":"accuracy"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A Rectangle object holding the bounds of this curve. If `out` was given it will be this object."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getBounds","scope":"instance","inherits":"Phaser.Curves.Curve#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns an array of points, spaced out X distance pixels apart.\nThe smaller the distance, the larger the array will be.","kind":"function","name":"getDistancePoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The distance, in pixels, between each point along the curve.","name":"distance"}],"returns":[{"type":{"names":["Array."]},"description":"An Array of Point objects."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getDistancePoints","scope":"instance","inherits":"Phaser.Curves.Curve#getDistancePoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the end of the curve.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"Optional Vector object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector2 containing the coordinates of the curves end point."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getEndPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getEndPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get total curve arc length","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the curve."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getLength","scope":"instance","inherits":"Phaser.Curves.Curve#getLength","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a list of cumulative segment lengths.\n\nThese lengths are\n\n- [0] 0\n- [1] The first segment\n- [2] The first and second segment\n- ...\n- [divisions] All segments","kind":"function","name":"getLengths","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions or segments.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cumulative lengths."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getLengths","scope":"instance","inherits":"Phaser.Curves.Curve#getLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at a relative position on the curve, by arc length.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getPointAt","scope":"instance","inherits":"Phaser.Curves.Curve#getPointAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of evenly spaced points from the curve.\n\nYou can pass `divisions`, `stepRate`, or neither.\n\nThe number of divisions will be\n\n1. `divisions`, if `divisions` > 0; or\n2. `this.getLength / stepRate`, if `stepRate` > 0; or\n3. `this.defaultDivisions`\n\n`1 + divisions` points will be returned.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"The curve distance between points, implying `divisions`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the curve."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a random point from the curve.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getRandomPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getRandomPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of equally spaced points (by arc distance) from the curve.\n\n`1 + divisions` points will be returned.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.defaultDivisions","description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array of points."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getSpacedPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getSpacedPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve.\nIn case any sub curve does not implement its tangent derivation,\n2 points a small delta apart will be used to find its gradient\nwhich seems to give a reasonable approximation","kind":"function","name":"getTangent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector approximating the tangent line at the point t (delta +/- 0.0001)"}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getTangent","scope":"instance","inherits":"Phaser.Curves.Curve#getTangent","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve, by arc length.","kind":"function","name":"getTangentAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getTangentAt","scope":"instance","inherits":"Phaser.Curves.Curve#getTangentAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getTFromDistance","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getTFromDistance","scope":"instance","inherits":"Phaser.Curves.Curve#getTFromDistance","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getUtoTmapping","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"u"},{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#getUtoTmapping","scope":"instance","inherits":"Phaser.Curves.Curve#getUtoTmapping","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Calculate and cache the arc lengths.","kind":"function","name":"updateArcLengths","since":"3.0.0","see":["Phaser.Curves.Curve#getLengths()"],"memberof":"Phaser.Curves.Ellipse","longname":"Phaser.Curves.Ellipse#updateArcLengths","scope":"instance","inherits":"Phaser.Curves.Curve#updateArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"String based identifier for the type of curve.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#type","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#type","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The default number of divisions within the curve.","name":"defaultDivisions","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#defaultDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#defaultDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"An array of cached arc length values.","name":"cacheArcLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#cacheArcLengths","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#cacheArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Does the data of this curve need updating?","name":"needsUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#needsUpdate","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#needsUpdate","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"For a curve on a Path, `false` means the Path will ignore this curve.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#active","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#active","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns an array of points, spaced out X distance pixels apart.\nThe smaller the distance, the larger the array will be.","kind":"function","name":"getDistancePoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The distance, in pixels, between each point along the curve.","name":"distance"}],"returns":[{"type":{"names":["Array."]},"description":"An Array of Point objects."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getDistancePoints","scope":"instance","inherits":"Phaser.Curves.Curve#getDistancePoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the end of the curve.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"Optional Vector object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector2 containing the coordinates of the curves end point."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getEndPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getEndPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get total curve arc length","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the curve."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getLength","scope":"instance","inherits":"Phaser.Curves.Curve#getLength","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a list of cumulative segment lengths.\n\nThese lengths are\n\n- [0] 0\n- [1] The first segment\n- [2] The first and second segment\n- ...\n- [divisions] All segments","kind":"function","name":"getLengths","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions or segments.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cumulative lengths."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getLengths","scope":"instance","inherits":"Phaser.Curves.Curve#getLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of evenly spaced points from the curve.\n\nYou can pass `divisions`, `stepRate`, or neither.\n\nThe number of divisions will be\n\n1. `divisions`, if `divisions` > 0; or\n2. `this.getLength / stepRate`, if `stepRate` > 0; or\n3. `this.defaultDivisions`\n\n`1 + divisions` points will be returned.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"The curve distance between points, implying `divisions`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the curve."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a random point from the curve.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getRandomPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getRandomPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of equally spaced points (by arc distance) from the curve.\n\n`1 + divisions` points will be returned.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.defaultDivisions","description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array of points."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getSpacedPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getSpacedPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve, by arc length.","kind":"function","name":"getTangentAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getTangentAt","scope":"instance","inherits":"Phaser.Curves.Curve#getTangentAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getTFromDistance","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#getTFromDistance","scope":"instance","inherits":"Phaser.Curves.Curve#getTFromDistance","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Calculate and cache the arc lengths.","kind":"function","name":"updateArcLengths","since":"3.0.0","see":["Phaser.Curves.Curve#getLengths()"],"memberof":"Phaser.Curves.Line","longname":"Phaser.Curves.Line#updateArcLengths","scope":"instance","inherits":"Phaser.Curves.Curve#updateArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"String based identifier for the type of curve.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#type","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#type","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The default number of divisions within the curve.","name":"defaultDivisions","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#defaultDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#defaultDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The quantity of arc length divisions within the curve.","name":"arcLengthDivisions","type":{"names":["integer"]},"defaultvalue":"100","since":"3.0.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#arcLengthDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#arcLengthDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"An array of cached arc length values.","name":"cacheArcLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#cacheArcLengths","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#cacheArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Does the data of this curve need updating?","name":"needsUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#needsUpdate","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#needsUpdate","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"For a curve on a Path, `false` means the Path will ignore this curve.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#active","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#active","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a Rectangle where the position and dimensions match the bounds of this Curve.\n\nYou can control the accuracy of the bounds. The value given is used to work out how many points\nto plot across the curve. Higher values are more accurate at the cost of calculation speed.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the bounds in. If falsey a new object will be created.","name":"out"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":16,"description":"The accuracy of the bounds calculations.","name":"accuracy"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A Rectangle object holding the bounds of this curve. If `out` was given it will be this object."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getBounds","scope":"instance","inherits":"Phaser.Curves.Curve#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns an array of points, spaced out X distance pixels apart.\nThe smaller the distance, the larger the array will be.","kind":"function","name":"getDistancePoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The distance, in pixels, between each point along the curve.","name":"distance"}],"returns":[{"type":{"names":["Array."]},"description":"An Array of Point objects."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getDistancePoints","scope":"instance","inherits":"Phaser.Curves.Curve#getDistancePoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the end of the curve.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"Optional Vector object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector2 containing the coordinates of the curves end point."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getEndPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getEndPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get total curve arc length","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the curve."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getLength","scope":"instance","inherits":"Phaser.Curves.Curve#getLength","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a list of cumulative segment lengths.\n\nThese lengths are\n\n- [0] 0\n- [1] The first segment\n- [2] The first and second segment\n- ...\n- [divisions] All segments","kind":"function","name":"getLengths","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions or segments.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cumulative lengths."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getLengths","scope":"instance","inherits":"Phaser.Curves.Curve#getLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at a relative position on the curve, by arc length.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getPointAt","scope":"instance","inherits":"Phaser.Curves.Curve#getPointAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of evenly spaced points from the curve.\n\nYou can pass `divisions`, `stepRate`, or neither.\n\nThe number of divisions will be\n\n1. `divisions`, if `divisions` > 0; or\n2. `this.getLength / stepRate`, if `stepRate` > 0; or\n3. `this.defaultDivisions`\n\n`1 + divisions` points will be returned.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"The curve distance between points, implying `divisions`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the curve."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a random point from the curve.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getRandomPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getRandomPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of equally spaced points (by arc distance) from the curve.\n\n`1 + divisions` points will be returned.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.defaultDivisions","description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array of points."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getSpacedPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getSpacedPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve.\nIn case any sub curve does not implement its tangent derivation,\n2 points a small delta apart will be used to find its gradient\nwhich seems to give a reasonable approximation","kind":"function","name":"getTangent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector approximating the tangent line at the point t (delta +/- 0.0001)"}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getTangent","scope":"instance","inherits":"Phaser.Curves.Curve#getTangent","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve, by arc length.","kind":"function","name":"getTangentAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getTangentAt","scope":"instance","inherits":"Phaser.Curves.Curve#getTangentAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getTFromDistance","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getTFromDistance","scope":"instance","inherits":"Phaser.Curves.Curve#getTFromDistance","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getUtoTmapping","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"u"},{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#getUtoTmapping","scope":"instance","inherits":"Phaser.Curves.Curve#getUtoTmapping","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Calculate and cache the arc lengths.","kind":"function","name":"updateArcLengths","since":"3.0.0","see":["Phaser.Curves.Curve#getLengths()"],"memberof":"Phaser.Curves.QuadraticBezier","longname":"Phaser.Curves.QuadraticBezier#updateArcLengths","scope":"instance","inherits":"Phaser.Curves.Curve#updateArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":31,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"String based identifier for the type of curve.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#type","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#type","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":40,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The default number of divisions within the curve.","name":"defaultDivisions","type":{"names":["integer"]},"defaultvalue":"5","since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#defaultDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#defaultDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"The quantity of arc length divisions within the curve.","name":"arcLengthDivisions","type":{"names":["integer"]},"defaultvalue":"100","since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#arcLengthDivisions","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#arcLengthDivisions","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":60,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"An array of cached arc length values.","name":"cacheArcLengths","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#cacheArcLengths","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#cacheArcLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":70,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Does the data of this curve need updating?","name":"needsUpdate","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#needsUpdate","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#needsUpdate","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"For a curve on a Path, `false` means the Path will ignore this curve.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#active","scope":"instance","kind":"member","inherits":"Phaser.Curves.Curve#active","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":111,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Draws this curve on the given Graphics object.\n\nThe curve is drawn using `Graphics.strokePoints` so will be drawn at whatever the present Graphics stroke color is.\nThe Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.","kind":"function","name":"draw","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics instance onto which this curve will be drawn.","name":"graphics"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":32,"description":"The resolution of the curve. The higher the value the smoother it will render, at the cost of rendering performance.","name":"pointsTotal"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"The Graphics object to which the curve was drawn."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#draw","scope":"instance","inherits":"Phaser.Curves.Curve#draw","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":135,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns a Rectangle where the position and dimensions match the bounds of this Curve.\n\nYou can control the accuracy of the bounds. The value given is used to work out how many points\nto plot across the curve. Higher values are more accurate at the cost of calculation speed.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle"]},"optional":true,"description":"The Rectangle to store the bounds in. If falsey a new object will be created.","name":"out"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":16,"description":"The accuracy of the bounds calculations.","name":"accuracy"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle"]},"description":"A Rectangle object holding the bounds of this curve. If `out` was given it will be this object."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getBounds","scope":"instance","inherits":"Phaser.Curves.Curve#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":169,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Returns an array of points, spaced out X distance pixels apart.\nThe smaller the distance, the larger the array will be.","kind":"function","name":"getDistancePoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The distance, in pixels, between each point along the curve.","name":"distance"}],"returns":[{"type":{"names":["Array."]},"description":"An Array of Point objects."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getDistancePoints","scope":"instance","inherits":"Phaser.Curves.Curve#getDistancePoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":189,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at the end of the curve.","kind":"function","name":"getEndPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"Optional Vector object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector2 containing the coordinates of the curves end point."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getEndPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getEndPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":206,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get total curve arc length","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"The total length of the curve."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getLength","scope":"instance","inherits":"Phaser.Curves.Curve#getLength","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a list of cumulative segment lengths.\n\nThese lengths are\n\n- [0] 0\n- [1] The first segment\n- [2] The first and second segment\n- ...\n- [divisions] All segments","kind":"function","name":"getLengths","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions or segments.","name":"divisions"}],"returns":[{"type":{"names":["Array."]},"description":"An array of cumulative lengths."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getLengths","scope":"instance","inherits":"Phaser.Curves.Curve#getLengths","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":278,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a point at a relative position on the curve, by arc length.","kind":"function","name":"getPointAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getPointAt","scope":"instance","inherits":"Phaser.Curves.Curve#getPointAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of evenly spaced points from the curve.\n\nYou can pass `divisions`, `stepRate`, or neither.\n\nThe number of divisions will be\n\n1. `divisions`, if `divisions` > 0; or\n2. `this.getLength / stepRate`, if `stepRate` > 0; or\n3. `this.defaultDivisions`\n\n`1 + divisions` points will be returned.","kind":"function","name":"getPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"The curve distance between points, implying `divisions`.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["array","Array."]},"description":"An array of Points from the curve."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a random point from the curve.","kind":"function","name":"getRandomPoint","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A point object to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The point."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getRandomPoint","scope":"instance","inherits":"Phaser.Curves.Curve#getRandomPoint","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":370,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a sequence of equally spaced points (by arc distance) from the curve.\n\n`1 + divisions` points will be returned.","kind":"function","name":"getSpacedPoints","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"this.defaultDivisions","description":"The number of divisions to make.","name":"divisions"},{"type":{"names":["number"]},"optional":true,"description":"Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.","name":"stepRate"},{"type":{"names":["array","Array."]},"optional":true,"description":"An optional array to store the points in.","name":"out"}],"returns":[{"type":{"names":["Array."]},"description":"An array of points."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getSpacedPoints","scope":"instance","inherits":"Phaser.Curves.Curve#getSpacedPoints","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":430,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve.\nIn case any sub curve does not implement its tangent derivation,\n2 points a small delta apart will be used to find its gradient\nwhich seems to give a reasonable approximation","kind":"function","name":"getTangent","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"t"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"Vector approximating the tangent line at the point t (delta +/- 0.0001)"}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getTangent","scope":"instance","inherits":"Phaser.Curves.Curve#getTangent","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Get a unit vector tangent at a relative position on the curve, by arc length.","kind":"function","name":"getTangentAt","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The relative position on the curve, [0..1].","name":"u"},{"type":{"names":["Phaser.Math.Vector2"]},"optional":true,"description":"A vector to store the result in.","name":"out"}],"returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The tangent vector."}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getTangentAt","scope":"instance","inherits":"Phaser.Curves.Curve#getTangentAt","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":493,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getTFromDistance","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getTFromDistance","scope":"instance","inherits":"Phaser.Curves.Curve#getTFromDistance","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"[description]","kind":"function","name":"getUtoTmapping","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"u"},{"type":{"names":["integer"]},"description":"[description]","name":"distance"},{"type":{"names":["integer"]},"optional":true,"description":"[description]","name":"divisions"}],"returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#getUtoTmapping","scope":"instance","inherits":"Phaser.Curves.Curve#getUtoTmapping","inherited":true,"___s":true},{"meta":{"filename":"Curve.js","lineno":597,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/curves"},"description":"Calculate and cache the arc lengths.","kind":"function","name":"updateArcLengths","since":"3.0.0","see":["Phaser.Curves.Curve#getLengths()"],"memberof":"Phaser.Curves.Spline","longname":"Phaser.Curves.Spline#updateArcLengths","scope":"instance","inherits":"Phaser.Curves.Curve#updateArcLengths","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":39,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The object that this DataManager belongs to.","name":"parent","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#parent","scope":"instance","kind":"member","inherits":"Phaser.Data.DataManager#parent","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The DataManager's event emitter.","name":"events","type":{"names":["Phaser.Events.EventEmitter"]},"since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#events","scope":"instance","kind":"member","inherits":"Phaser.Data.DataManager#events","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The data list.","name":"list","type":{"names":["Object."]},"defaultvalue":"{}","since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#list","scope":"instance","kind":"member","inherits":"Phaser.Data.DataManager#list","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":72,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"The public values list. You can use this to access anything you have stored\nin this Data Manager. For example, if you set a value called `gold` you can\naccess it via:\n\n```javascript\nthis.data.values.gold;\n```\n\nYou can also modify it directly:\n\n```javascript\nthis.data.values.gold += 1000;\n```\n\nDoing so will emit a `setdata` event from the parent of this Data Manager.\n\nDo not modify this object directly. Adding properties directly to this object will not\nemit any events. Always use `DataManager.set` to create new items the first time around.","name":"values","type":{"names":["Object."]},"defaultvalue":"{}","since":"3.10.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#values","scope":"instance","kind":"member","inherits":"Phaser.Data.DataManager#values","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":116,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Retrieves the value for the given key, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nthis.data.get('gold');\n```\n\nOr access the value directly:\n\n```javascript\nthis.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nthis.data.get([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#get","scope":"instance","inherits":"Phaser.Data.DataManager#get","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Retrieves all data values in a new object.","kind":"function","name":"getAll","since":"3.0.0","returns":[{"type":{"names":["Object."]},"description":"All data values."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#getAll","scope":"instance","inherits":"Phaser.Data.DataManager#getAll","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Queries the DataManager for the values of keys matching the given regular expression.","kind":"function","name":"query","since":"3.0.0","params":[{"type":{"names":["RegExp"]},"description":"A regular expression object. If a non-RegExp object obj is passed, it is implicitly converted to a RegExp by using new RegExp(obj).","name":"search"}],"returns":[{"type":{"names":["Object."]},"description":"The values of the keys matching the search string."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#query","scope":"instance","inherits":"Phaser.Data.DataManager#query","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":215,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Sets a value for the given key. If the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\ndata.set('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\ndata.set({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `get`:\n\n```javascript\ndata.get('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\ndata.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"set","fires":["Phaser.Data.Events#event:SET_DATA","Phaser.Data.Events#event:CHANGE_DATA","Phaser.Data.Events#event:CHANGE_DATA_KEY"],"since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object or key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#set","scope":"instance","inherits":"Phaser.Data.DataManager#set","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":349,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Passes all data entries to the given callback.","kind":"function","name":"each","since":"3.0.0","params":[{"type":{"names":["DataEachCallback"]},"description":"The function to call.","name":"callback"},{"type":{"names":["*"]},"optional":true,"description":"Value to use as `this` when executing callback.","name":"context"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the callback, after the game object, key, and data.","name":"args"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#each","scope":"instance","inherits":"Phaser.Data.DataManager#each","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":381,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Merge the given object of key value pairs into this DataManager.\n\nAny newly created values will emit a `setdata` event. Any updated values (see the `overwrite` argument)\nwill emit a `changedata` event.","kind":"function","name":"merge","fires":["Phaser.Data.Events#event:SET_DATA","Phaser.Data.Events#event:CHANGE_DATA","Phaser.Data.Events#event:CHANGE_DATA_KEY"],"since":"3.0.0","params":[{"type":{"names":["Object."]},"description":"The data to merge.","name":"data"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to overwrite existing data. Defaults to true.","name":"overwrite"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#merge","scope":"instance","inherits":"Phaser.Data.DataManager#merge","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":414,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Remove the value for the given key.\n\nIf the key is found in this Data Manager it is removed from the internal lists and a\n`removedata` event is emitted.\n\nYou can also pass in an array of keys, in which case all keys in the array will be removed:\n\n```javascript\nthis.data.remove([ 'gold', 'armor', 'health' ]);\n```","kind":"function","name":"remove","fires":["Phaser.Data.Events#event:REMOVE_DATA"],"since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key to remove, or an array of keys to remove.","name":"key"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#remove","scope":"instance","inherits":"Phaser.Data.DataManager#remove","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Retrieves the data associated with the given 'key', deletes it from this Data Manager, then returns it.","kind":"function","name":"pop","fires":["Phaser.Data.Events#event:REMOVE_DATA"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the value to retrieve and delete.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value of the given key."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#pop","scope":"instance","inherits":"Phaser.Data.DataManager#pop","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":511,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Determines whether the given key is set in this Data Manager.\n\nPlease note that the keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key to check.","name":"key"}],"returns":[{"type":{"names":["boolean"]},"description":"Returns `true` if the key exists, otherwise `false`."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#has","scope":"instance","inherits":"Phaser.Data.DataManager#has","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":529,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Freeze or unfreeze this Data Manager. A frozen Data Manager will block all attempts\nto create new values or update existing ones.","kind":"function","name":"setFreeze","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether to freeze or unfreeze the Data Manager.","name":"value"}],"returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#setFreeze","scope":"instance","inherits":"Phaser.Data.DataManager#setFreeze","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":547,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Delete all data in this Data Manager and unfreeze it.","kind":"function","name":"reset","since":"3.0.0","returns":[{"type":{"names":["Phaser.Data.DataManager"]},"description":"This DataManager object."}],"memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#reset","scope":"instance","inherits":"Phaser.Data.DataManager#reset","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":585,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Gets or sets the frozen state of this Data Manager.\nA frozen Data Manager will block all attempts to create new values or update existing ones.","name":"freeze","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#freeze","scope":"instance","kind":"member","inherits":"Phaser.Data.DataManager#freeze","inherited":true,"___s":true},{"meta":{"filename":"DataManager.js","lineno":607,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/data"},"description":"Return the total number of entries in this Data Manager.","name":"count","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Data.DataManagerPlugin","longname":"Phaser.Data.DataManagerPlugin#count","scope":"instance","kind":"member","inherits":"Phaser.Data.DataManager#count","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.GameObject","longname":"Phaser.GameObjects.GameObject#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#texture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#frame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setTexture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.BitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.BitmapText","longname":"Phaser.GameObjects.BitmapText#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":91,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The key of the Bitmap Font used by this Bitmap Text.\nTo change the font after creation please use `setFont`.","name":"font","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#font","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#font","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The data of the Bitmap Font used by this Bitmap Text.","name":"fontData","type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapFontData"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#fontData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#fontData","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The character code used to detect for word wrapping.\nDefaults to 32 (a space character).","name":"wordWrapCharCode","type":{"names":["number"]},"since":"3.21.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#wordWrapCharCode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#wordWrapCharCode","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":214,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the lines of text in this BitmapText to be left-aligned.\nThis only has any effect if this BitmapText contains more than one line of text.","kind":"function","name":"setLeftAlign","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setLeftAlign","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setLeftAlign","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":232,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the lines of text in this BitmapText to be center-aligned.\nThis only has any effect if this BitmapText contains more than one line of text.","kind":"function","name":"setCenterAlign","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setCenterAlign","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setCenterAlign","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":250,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the lines of text in this BitmapText to be right-aligned.\nThis only has any effect if this BitmapText contains more than one line of text.","kind":"function","name":"setRightAlign","since":"3.11.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setRightAlign","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setRightAlign","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the font size of this Bitmap Text.","kind":"function","name":"setFontSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The font size to set.","name":"size"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setFontSize","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setFontSize","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":287,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Sets the letter spacing between each character of this Bitmap Text.\nCan be a positive value to increase the space, or negative to reduce it.\nSpacing is applied after the kerning values have been set.","kind":"function","name":"setLetterSpacing","since":"3.4.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The amount of horizontal space to add between each character.","name":"spacing"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setLetterSpacing","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setLetterSpacing","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Set the textual content of this BitmapText.\n\nAn array of strings will be converted into multi-line text. Use the align methods to change multi-line alignment.","kind":"function","name":"setText","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The string, or array of strings, to be set as the content of this BitmapText.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setText","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setText","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":346,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Calculate the bounds of this Bitmap Text.\n\nAn object is returned that contains the position, width and height of the Bitmap Text in local and global\ncontexts.\n\nLocal size is based on just the font size and a [0, 0] position.\n\nGlobal size takes into account the Game Object's scale, world position and display origin.\n\nAlso in the object is data regarding the length of each line, should this be a multi-line BitmapText.","kind":"function","name":"getTextBounds","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"description":"Whether to round the results to the nearest integer.","name":"round"}],"returns":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.BitmapTextSize"]},"description":"An object that describes the size of this Bitmap Text."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getTextBounds","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#getTextBounds","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":385,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Changes the font this BitmapText is using to render.\n\nThe new texture is loaded and applied to the BitmapText. The existing test, size and alignment are preserved,\nunless overridden via the arguments.","kind":"function","name":"setFont","since":"3.11.0","params":[{"type":{"names":["string"]},"description":"The key of the font to use from the Bitmap Font cache.","name":"font"},{"type":{"names":["number"]},"optional":true,"description":"The font size of this Bitmap Text. If not specified the current size will be used.","name":"size"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The alignment of the text in a multi-line BitmapText object. If not specified the current alignment will be used.","name":"align"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setFont","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setFont","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":425,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Sets the maximum display width of this BitmapText in pixels.\n\nIf `BitmapText.text` is longer than `maxWidth` then the lines will be automatically wrapped\nbased on the previous whitespace character found in the line.\n\nIf no whitespace was found then no wrapping will take place and consequently the `maxWidth` value will not be honored.\n\nDisable maxWidth by setting the value to 0.\n\nYou can set the whitespace character to be searched for by setting the `wordWrapCharCode` parameter or property.","kind":"function","name":"setMaxWidth","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The maximum display width of this BitmapText in pixels. Set to zero to disable.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"The character code to check for when word wrapping. Defaults to 32 (the space character).","name":"wordWrapCharCode"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This BitmapText Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setMaxWidth","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#setMaxWidth","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":459,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Controls the alignment of each line of text in this BitmapText object.\n\nOnly has any effect when this BitmapText contains multiple lines of text, split with carriage-returns.\nHas no effect with single-lines of text.\n\nSee the methods `setLeftAlign`, `setCenterAlign` and `setRightAlign`.\n\n0 = Left aligned (default)\n1 = Middle aligned\n2 = Right aligned\n\nThe alignment position is based on the longest line of text.","name":"align","type":{"names":["integer"]},"since":"3.11.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#align","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#align","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":492,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The text that this Bitmap Text object displays.\n\nYou can also use the method `setText` if you want a chainable way to change the text content.","name":"text","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#text","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#text","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":515,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The font size of this Bitmap Text.\n\nYou can also use the method `setFontSize` if you want a chainable way to change the font size.","name":"fontSize","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#fontSize","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#fontSize","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":539,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Adds / Removes spacing between characters.\n\nCan be a negative or positive number.\n\nYou can also use the method `setLetterSpacing` if you want a chainable way to change the letter spacing.","name":"letterSpacing","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#letterSpacing","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#letterSpacing","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":565,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The maximum display width of this BitmapText in pixels.\n\nIf BitmapText.text is longer than maxWidth then the lines will be automatically wrapped\nbased on the last whitespace character found in the line.\n\nIf no whitespace was found then no wrapping will take place and consequently the maxWidth value will not be honored.\n\nDisable maxWidth by setting the value to 0.","name":"maxWidth","type":{"names":["number"]},"since":"3.21.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#maxWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#maxWidth","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":594,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The width of this Bitmap Text.","name":"width","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#width","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":613,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"The height of this bitmap text.","name":"height","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.BitmapText#height","inherited":true,"___s":true},{"meta":{"filename":"BitmapText.js","lineno":632,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/bitmaptext/static"},"description":"Build a JSON representation of this Bitmap Text.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.BitmapText.JSONBitmapText"]},"description":"A JSON representation of this Bitmap Text."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#toJSON","scope":"instance","inherits":"Phaser.GameObjects.BitmapText#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#texture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#frame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setTexture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DynamicBitmapText"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DynamicBitmapText","longname":"Phaser.GameObjects.DynamicBitmapText#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#texture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#frame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setTexture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Blitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Blitter","longname":"Phaser.GameObjects.Blitter#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Container"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Container","longname":"Phaser.GameObjects.Container#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.DOMElement"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.DOMElement","longname":"Phaser.GameObjects.DOMElement#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#texture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#frame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setTexture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Extern"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Extern","longname":"Phaser.GameObjects.Extern#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Graphics","longname":"Phaser.GameObjects.Graphics#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Image","longname":"Phaser.GameObjects.Image#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":34,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The pool of Lights.\n\nUsed to recycle removed Lights for a more efficient use of memory.","name":"lightPool","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#lightPool","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.LightsManager#lightPool","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":46,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The Lights in the Scene.","name":"lights","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#lights","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.LightsManager#lights","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Lights that have been culled from a Camera's viewport.\n\nLights in this list will not be rendered.","name":"culledLights","type":{"names":["Array."]},"defaultvalue":"[]","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#culledLights","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.LightsManager#culledLights","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The ambient color.","name":"ambientColor","type":{"names":["Object"]},"since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#ambientColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.LightsManager#ambientColor","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":77,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Whether the Lights Manager is enabled.","name":"active","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.LightsManager#active","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"The maximum number of lights that a single Camera and the lights shader can process.\nChange this via the `maxLights` property in your game config, as it cannot be changed at runtime.","name":"maxLights","type":{"names":["integer"]},"readonly":true,"since":"3.15.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#maxLights","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.LightsManager#maxLights","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":99,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Enable the Lights Manager.","kind":"function","name":"enable","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#enable","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#enable","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":119,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Disable the Lights Manager.","kind":"function","name":"disable","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#disable","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#disable","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":134,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Cull any Lights that aren't visible to the given Camera.\n\nCulling Lights improves performance by ensuring that only Lights within a Camera's viewport are rendered.","kind":"function","name":"cull","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to cull Lights for.","name":"camera"}],"returns":[{"type":{"names":["Array."]},"description":"The culled Lights."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#cull","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#cull","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Iterate over each Light with a callback.","kind":"function","name":"forEachLight","since":"3.0.0","params":[{"type":{"names":["LightForEach"]},"description":"The callback that is called with each Light.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#forEachLight","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#forEachLight","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Set the ambient light color.","kind":"function","name":"setAmbientColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The integer RGB color of the ambient light.","name":"rgb"}],"returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#setAmbientColor","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#setAmbientColor","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Returns the maximum number of Lights allowed to appear at once.","kind":"function","name":"getMaxVisibleLights","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The maximum number of Lights allowed to appear at once."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#getMaxVisibleLights","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#getMaxVisibleLights","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Get the number of Lights managed by this Lights Manager.","kind":"function","name":"getLightCount","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of Lights managed by this Lights Manager."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#getLightCount","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#getLightCount","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Add a Light.","kind":"function","name":"addLight","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the Light.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the Light.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":100,"description":"The radius of the Light.","name":"radius"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"0xffffff","description":"The integer RGB color of the light.","name":"rgb"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The intensity of the Light.","name":"intensity"}],"returns":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"The Light that was added."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#addLight","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#addLight","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":298,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Remove a Light.","kind":"function","name":"removeLight","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.Light"]},"description":"The Light to remove.","name":"light"}],"returns":[{"type":{"names":["Phaser.GameObjects.LightsManager"]},"description":"This Lights Manager object."}],"memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#removeLight","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#removeLight","inherited":true,"___s":true},{"meta":{"filename":"LightsManager.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/lights"},"description":"Shut down the Lights Manager.\n\nRecycles all active Lights into the Light pool, resets ambient light color and clears the lists of Lights and\nculled Lights.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.LightsPlugin","longname":"Phaser.GameObjects.LightsPlugin#shutdown","scope":"instance","inherits":"Phaser.GameObjects.LightsManager#shutdown","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#texture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#frame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setTexture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Mesh"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Mesh","longname":"Phaser.GameObjects.Mesh#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitter"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitter","longname":"Phaser.GameObjects.Particles.ParticleEmitter#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Particles.ParticleEmitterManager"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Particles.ParticleEmitterManager","longname":"Phaser.GameObjects.Particles.ParticleEmitterManager#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Sprite","longname":"Phaser.GameObjects.Sprite#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"The Animation Controller of this Sprite.","name":"anims","type":{"names":["Phaser.GameObjects.Components.Animation"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#anims","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Sprite#anims","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Start playing the given animation.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If an animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#play","scope":"instance","inherits":"Phaser.GameObjects.Sprite#play","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Build a JSON representation of this Sprite.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#toJSON","scope":"instance","inherits":"Phaser.GameObjects.Sprite#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":23,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Path this PathFollower is following. It can only follow one Path at a time.","name":"path","type":{"names":["Phaser.Curves.Path"]},"since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#path","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.PathFollower#path","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Should the PathFollower automatically rotate to point in the direction of the Path?","name":"rotateToPath","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#rotateToPath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.PathFollower#rotateToPath","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":102,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Path that this PathFollower should follow.\n\nOptionally accepts {@link Phaser.Types.GameObjects.PathFollower.PathConfig} settings.","kind":"function","name":"setPath","since":"3.0.0","params":[{"type":{"names":["Phaser.Curves.Path"]},"description":"The Path this PathFollower is following. It can only follow one Path at a time.","name":"path"},{"type":{"names":["number","Phaser.Types.GameObjects.PathFollower.PathConfig","Phaser.Types.Tweens.NumberTweenBuilderConfig"]},"optional":true,"description":"Settings for the PathFollower.","name":"config"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setPath","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#setPath","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set whether the PathFollower should automatically rotate to point in the direction of the Path.","kind":"function","name":"setRotateToPath","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Whether the PathFollower should automatically rotate to point in the direction of the Path.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Rotation offset in degrees.","name":"offset"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#setRotateToPath","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#setRotateToPath","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Is this PathFollower actively following a Path or not?\n\nTo be considered as `isFollowing` it must be currently moving on a Path, and not paused.","kind":"function","name":"isFollowing","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` is this PathFollower is actively following a Path, otherwise `false`."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#isFollowing","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#isFollowing","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Starts this PathFollower following its given Path.","kind":"function","name":"startFollow","since":"3.3.0","params":[{"type":{"names":["number","Phaser.Types.GameObjects.PathFollower.PathConfig","Phaser.Types.Tweens.NumberTweenBuilderConfig"]},"optional":true,"defaultvalue":"{}","description":"The duration of the follow, or a PathFollower config object.","name":"config"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"Optional start position of the follow, between 0 and 1.","name":"startAt"}],"returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#startFollow","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#startFollow","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":267,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Pauses this PathFollower. It will still continue to render, but it will remain motionless at the\npoint on the Path at which you paused it.","kind":"function","name":"pauseFollow","since":"3.3.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pauseFollow","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#pauseFollow","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":288,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resumes a previously paused PathFollower.\n\nIf the PathFollower was not paused this has no effect.","kind":"function","name":"resumeFollow","since":"3.3.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#resumeFollow","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#resumeFollow","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":310,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Stops this PathFollower from following the path any longer.\n\nThis will invoke any 'stop' conditions that may exist on the Path, or for the follower.","kind":"function","name":"stopFollow","since":"3.3.0","returns":[{"type":{"names":["Phaser.GameObjects.PathFollower"]},"description":"This Game Object."}],"memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#stopFollow","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#stopFollow","inherited":true,"___s":true},{"meta":{"filename":"PathFollower.js","lineno":332,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Internal update handler that advances this PathFollower along the path.\n\nCalled automatically by the Scene step, should not typically be called directly.","kind":"function","name":"pathUpdate","since":"3.17.0","memberof":"Phaser.GameObjects.PathFollower","longname":"Phaser.GameObjects.PathFollower#pathUpdate","scope":"instance","inherits":"Phaser.GameObjects.Components.PathFollower#pathUpdate","inherited":true,"___s":true},{"meta":{"filename":"Mesh.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the vertices data for this Mesh.","name":"vertices","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#vertices","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Mesh#vertices","inherited":true,"___s":true},{"meta":{"filename":"Mesh.js","lineno":111,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the uv data for this Mesh.","name":"uv","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#uv","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Mesh#uv","inherited":true,"___s":true},{"meta":{"filename":"Mesh.js","lineno":120,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the color data for this Mesh.","name":"colors","type":{"names":["Uint32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#colors","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Mesh#colors","inherited":true,"___s":true},{"meta":{"filename":"Mesh.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"An array containing the alpha data for this Mesh.","name":"alphas","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#alphas","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Mesh#alphas","inherited":true,"___s":true},{"meta":{"filename":"Mesh.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"Fill or additive mode used when blending the color values?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Mesh#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Mesh.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/mesh"},"description":"This method is left intentionally empty and does not do anything.\nIt is retained to allow a Mesh or Quad to be added to a Container.","kind":"function","name":"setAlpha","since":"3.17.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Mesh#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#texture","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Texture#frame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Textures.Texture"]},"description":"The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.Texture#setTexture","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Quad"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Quad","longname":"Phaser.GameObjects.Quad#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Crop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.Crop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.RenderTexture"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.RenderTexture","longname":"Phaser.GameObjects.RenderTexture#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shader"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shader","longname":"Phaser.GameObjects.Shader#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Shape"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Shape","longname":"Phaser.GameObjects.Shape#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Arc"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Arc","longname":"Phaser.GameObjects.Arc#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Curve"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Curve","longname":"Phaser.GameObjects.Curve#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Ellipse"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Ellipse","longname":"Phaser.GameObjects.Ellipse#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Grid"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Grid","longname":"Phaser.GameObjects.Grid#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoBox"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoBox","longname":"Phaser.GameObjects.IsoBox#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.IsoTriangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.IsoTriangle","longname":"Phaser.GameObjects.IsoTriangle#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Line"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Line","longname":"Phaser.GameObjects.Line#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Polygon"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Polygon","longname":"Phaser.GameObjects.Polygon#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Rectangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Rectangle","longname":"Phaser.GameObjects.Rectangle#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Star"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Star","longname":"Phaser.GameObjects.Star#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The source Shape data. Typically a geometry object.\nYou should not manipulate this directly.","name":"data","type":{"names":["any"]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#data","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":76,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the polygon path data for filled rendering.","name":"pathData","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#pathData","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathData","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":86,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Holds the earcut polygon path index data for filled rendering.","name":"pathIndexes","type":{"names":["Array."]},"readonly":true,"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#pathIndexes","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#pathIndexes","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill color used by this Shape.","name":"fillColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#fillColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":105,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The fill alpha value used by this Shape.","name":"fillAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#fillAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#fillAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":114,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke color used by this Shape.","name":"strokeColor","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#strokeColor","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeColor","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":123,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke alpha value used by this Shape.","name":"strokeAlpha","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#strokeAlpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#strokeAlpha","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":132,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"The stroke line width used by this Shape.","name":"lineWidth","type":{"names":["number"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#lineWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#lineWidth","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":141,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is filled or not.\nNote that some Shapes do not support being filled (such as Line shapes)","name":"isFilled","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#isFilled","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isFilled","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":151,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape is stroked or not.\nNote that some Shapes do not support being stroked (such as Iso Box shapes)","name":"isStroked","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#isStroked","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#isStroked","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":161,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Controls if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)","name":"closePath","type":{"names":["boolean"]},"since":"3.13.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#closePath","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Shape#closePath","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":185,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the fill color and alpha for this Shape.\n\nIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\n\nNote that some Shapes do not support fill colors, such as the Line shape.\n\nThis call can be chained.","kind":"function","name":"setFillStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The color used to fill this shape. If not provided the Shape will not be filled.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when filling this shape, if a fill color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setFillStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setFillStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":220,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets the stroke color and alpha for this Shape.\n\nIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\n\nNote that some Shapes do not support being stroked, such as the Iso Box shape.\n\nThis call can be chained.","kind":"function","name":"setStrokeStyle","since":"3.13.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The width of line to stroke with. If not provided or undefined the Shape will not be stroked.","name":"lineWidth"},{"type":{"names":["number"]},"optional":true,"description":"The color used to stroke this shape. If not provided the Shape will not be stroked.","name":"color"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used when stroking this shape, if a stroke color is given.","name":"alpha"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setStrokeStyle","scope":"instance","inherits":"Phaser.GameObjects.Shape#setStrokeStyle","inherited":true,"___s":true},{"meta":{"filename":"Shape.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/shape"},"description":"Sets if this Shape path is closed during rendering when stroked.\nNote that some Shapes are always closed when stroked (such as Ellipse shapes)\n\nThis call can be chained.","kind":"function","name":"setClosePath","since":"3.13.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` if the Shape should be closed when stroked, otherwise `false`.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setClosePath","scope":"instance","inherits":"Phaser.GameObjects.Shape#setClosePath","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value applied across the whole Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.AlphaSingle#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"AlphaSingle.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.AlphaSingle#alpha","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Triangle"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Triangle","longname":"Phaser.GameObjects.Triangle#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Crop#texture","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":25,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Crop#frame","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Crop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.Crop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Text"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Text","longname":"Phaser.GameObjects.Text#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Crop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"Crop.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.Crop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.TileSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.TileSprite","longname":"Phaser.GameObjects.TileSprite#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Video"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Video","longname":"Phaser.GameObjects.Video#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This GameObject."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"`this`."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Zone"]},"description":"This Game Object instance."}],"memberof":"Phaser.GameObjects.Zone","longname":"Phaser.GameObjects.Zone#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Input.InputPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.InputPlugin","longname":"Phaser.Input.InputPlugin#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.Gamepad"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.Gamepad","longname":"Phaser.Input.Gamepad.Gamepad#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Input.Gamepad.GamepadPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Gamepad.GamepadPlugin","longname":"Phaser.Input.Gamepad.GamepadPlugin#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.KeyboardPlugin"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.KeyboardPlugin","longname":"Phaser.Input.Keyboard.KeyboardPlugin#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Input.Keyboard.Key"]},"description":"`this`."}],"memberof":"Phaser.Input.Keyboard.Key","longname":"Phaser.Input.Keyboard.Key#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"`this`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"`this`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"`this`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"`this`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"`this`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Loader.LoaderPlugin"]},"description":"`this`."}],"memberof":"Phaser.Loader.LoaderPlugin","longname":"Phaser.Loader.LoaderPlugin#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AnimationJSONFile","longname":"Phaser.Loader.FileTypes.AnimationJSONFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#onFileComplete","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileComplete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.AtlasJSONFile","longname":"Phaser.Loader.FileTypes.AtlasJSONFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#onFileComplete","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileComplete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.AtlasXMLFile","longname":"Phaser.Loader.FileTypes.AtlasXMLFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioFile","longname":"Phaser.Loader.FileTypes.AudioFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.AudioSpriteFile","longname":"Phaser.Loader.FileTypes.AudioSpriteFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BinaryFile","longname":"Phaser.Loader.FileTypes.BinaryFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#onFileComplete","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileComplete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.BitmapFontFile","longname":"Phaser.Loader.FileTypes.BitmapFontFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.CSSFile","longname":"Phaser.Loader.FileTypes.CSSFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.GLSLFile","longname":"Phaser.Loader.FileTypes.GLSLFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Usually overridden by the FileTypes and is called by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data, for example a JSON file will parse itself during this stage.","kind":"function","name":"onProcess","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#onProcess","scope":"instance","inherits":"Phaser.Loader.File#onProcess","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTML5AudioFile","longname":"Phaser.Loader.FileTypes.HTML5AudioFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLFile","longname":"Phaser.Loader.FileTypes.HTMLFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.HTMLTextureFile","longname":"Phaser.Loader.FileTypes.HTMLTextureFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ImageFile","longname":"Phaser.Loader.FileTypes.ImageFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.JSONFile","longname":"Phaser.Loader.FileTypes.JSONFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.MultiAtlasFile","longname":"Phaser.Loader.FileTypes.MultiAtlasFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#onFileComplete","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileComplete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.MultiScriptFile","longname":"Phaser.Loader.FileTypes.MultiScriptFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PackFile","longname":"Phaser.Loader.FileTypes.PackFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.PluginFile","longname":"Phaser.Loader.FileTypes.PluginFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SVGFile","longname":"Phaser.Loader.FileTypes.SVGFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SceneFile","longname":"Phaser.Loader.FileTypes.SceneFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScenePluginFile","longname":"Phaser.Loader.FileTypes.ScenePluginFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.ScriptFile","longname":"Phaser.Loader.FileTypes.ScriptFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Usually overridden by the FileTypes and is called by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data, for example a JSON file will parse itself during this stage.","kind":"function","name":"onProcess","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#onProcess","scope":"instance","inherits":"Phaser.Loader.File#onProcess","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.SpriteSheetFile","longname":"Phaser.Loader.FileTypes.SpriteSheetFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TextFile","longname":"Phaser.Loader.FileTypes.TextFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapCSVFile","longname":"Phaser.Loader.FileTypes.TilemapCSVFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Usually overridden by the FileTypes and is called by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data, for example a JSON file will parse itself during this stage.","kind":"function","name":"onProcess","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#onProcess","scope":"instance","inherits":"Phaser.Loader.File#onProcess","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapImpactFile","longname":"Phaser.Loader.FileTypes.TilemapImpactFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":359,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Usually overridden by the FileTypes and is called by Loader.nextFile.\nThis method controls what extra work this File does with its loaded data, for example a JSON file will parse itself during this stage.","kind":"function","name":"onProcess","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#onProcess","scope":"instance","inherits":"Phaser.Loader.File#onProcess","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.TilemapJSONFile","longname":"Phaser.Loader.FileTypes.TilemapJSONFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":32,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#loader","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":41,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#type","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#key","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Array of files that make up this MultiFile.","name":"files","type":{"names":["Array."]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#files","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#files","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The completion status of this MultiFile.","name":"complete","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#complete","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#complete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files to load.","name":"pending","type":{"names":["integer"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#pending","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#pending","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":98,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The number of files that failed to load.","name":"failed","type":{"names":["integer"]},"defaultvalue":"0","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#failed","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#failed","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":108,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A storage container for transient data that the loading files need.","name":"config","type":{"names":["any"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#config","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders baseURL at the time this MultiFile was created.\nUsed to populate child-files.","name":"baseURL","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#baseURL","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#baseURL","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders path at the time this MultiFile was created.\nUsed to populate child-files.","name":"path","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#path","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#path","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":137,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loaders prefix at the time this MultiFile was created.\nUsed to populate child-files.","name":"prefix","type":{"names":["string"]},"since":"3.20.0","memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#prefix","scope":"instance","kind":"member","inherits":"Phaser.Loader.MultiFile#prefix","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":154,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if this MultiFile is ready to process its children or not.","kind":"function","name":"isReadyToProcess","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if all children of this MultiFile have loaded, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#isReadyToProcess","scope":"instance","inherits":"Phaser.Loader.MultiFile#isReadyToProcess","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds another child to this MultiFile, increases the pending count and resets the completion status.","kind":"function","name":"addToMultiFile","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File to add to this MultiFile.","name":"files"}],"returns":[{"type":{"names":["Phaser.Loader.MultiFile"]},"description":"This MultiFile instance."}],"memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#addToMultiFile","scope":"instance","inherits":"Phaser.Loader.MultiFile#addToMultiFile","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":190,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File when it finishes loading.","kind":"function","name":"onFileComplete","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has completed processing.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#onFileComplete","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileComplete","inherited":true,"___s":true},{"meta":{"filename":"MultiFile.js","lineno":208,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by each File that fails to load.","kind":"function","name":"onFileFailed","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The File that has failed to load.","name":"file"}],"memberof":"Phaser.Loader.FileTypes.UnityAtlasFile","longname":"Phaser.Loader.FileTypes.UnityAtlasFile#onFileFailed","scope":"instance","inherits":"Phaser.Loader.MultiFile#onFileFailed","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.VideoFile","longname":"Phaser.Loader.FileTypes.VideoFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":35,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Loader that is going to load this file.","name":"loader","type":{"names":["Phaser.Loader.LoaderPlugin"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#loader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#loader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":44,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A reference to the Cache, or Texture Manager, that is going to store this file if it loads.","name":"cache","type":{"names":["Phaser.Cache.BaseCache","Phaser.Textures.TextureManager"]},"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#cache","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#cache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":53,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The file type string (image, json, etc) for sorting within the Loader.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#type","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#type","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":62,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Unique cache key (unique within its file type)","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#key","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#key","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The URL of the file, not including baseURL.\nAutomatically has Loader.path prepended to it.","name":"url","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#url","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#url","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":102,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The final URL this file will load from, including baseURL and path.\nSet automatically when the Loader calls 'load' on this file.","name":"src","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#src","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#src","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":112,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The merged XHRSettings for this file.","name":"xhrSettings","type":{"names":["Phaser.Types.Loader.XHRSettingsObject"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#xhrSettings","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrSettings","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.","name":"xhrLoader","type":{"names":["XMLHttpRequest"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#xhrLoader","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#xhrLoader","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":135,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The current state of the file. One of the FILE_CONST values.","name":"state","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#state","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#state","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":144,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The total size of this file.\nSet by onProgress and only if loading via XHR.","name":"bytesTotal","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#bytesTotal","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesTotal","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":155,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Updated as the file loads.\nOnly set if loading via XHR.","name":"bytesLoaded","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#bytesLoaded","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#bytesLoaded","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":166,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A percentage value between 0 and 1 indicating how much of this file has loaded.\nOnly set if loading via XHR.","name":"percentComplete","type":{"names":["number"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#percentComplete","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#percentComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":177,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"For CORs based loading.\nIf this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)","name":"crossOrigin","type":{"names":["string","undefined"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#crossOrigin","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#crossOrigin","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":187,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"The processed file data, stored here after the file has loaded.","name":"data","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#data","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#data","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":196,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"A config object that can be used by file types to store transitional data.","name":"config","type":{"names":["*"]},"since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#config","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#config","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":205,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"If this is a multipart file, i.e. an atlas and its json together, then this is a reference\nto the parent MultiFile. Set and used internally by the Loader or specific file types.","name":"multiFile","type":{"names":["Phaser.Loader.MultiFile"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#multiFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#multiFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":215,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Does this file have an associated linked file? Such as an image and a normal map.\nAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\nactually bound by data, where-as a linkFile is.","name":"linkFile","type":{"names":["Phaser.Loader.File"]},"nullable":true,"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#linkFile","scope":"instance","kind":"member","inherits":"Phaser.Loader.File#linkFile","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Links this File with another, so they depend upon each other for loading and processing.","kind":"function","name":"setLink","since":"3.7.0","params":[{"type":{"names":["Phaser.Loader.File"]},"description":"The file to link to this one.","name":"fileB"}],"memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#setLink","scope":"instance","inherits":"Phaser.Loader.File#setLink","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":242,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Resets the XHRLoader instance this file is using.","kind":"function","name":"resetXHR","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#resetXHR","scope":"instance","inherits":"Phaser.Loader.File#resetXHR","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called by the Loader, starts the actual file downloading.\nDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\nYou shouldn't normally call this method directly, it's meant to be invoked by the Loader.","kind":"function","name":"load","since":"3.0.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#load","scope":"instance","inherits":"Phaser.Loader.File#load","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":295,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the file finishes loading, is sent a DOM ProgressEvent.","kind":"function","name":"onLoad","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this load.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#onLoad","scope":"instance","inherits":"Phaser.Loader.File#onLoad","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":321,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called if the file errors while loading, is sent a DOM ProgressEvent.","kind":"function","name":"onError","since":"3.0.0","params":[{"type":{"names":["XMLHttpRequest"]},"description":"The XMLHttpRequest that caused this onload event.","name":"xhr"},{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent that resulted from this error.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#onError","scope":"instance","inherits":"Phaser.Loader.File#onError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":337,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called during the file load progress. Is sent a DOM ProgressEvent.","kind":"function","name":"onProgress","fires":["Phaser.Loader.Events#event:FILE_PROGRESS"],"since":"3.0.0","params":[{"type":{"names":["ProgressEvent"]},"description":"The DOM ProgressEvent.","name":"event"}],"memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#onProgress","scope":"instance","inherits":"Phaser.Loader.File#onProgress","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessComplete","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#onProcessComplete","scope":"instance","inherits":"Phaser.Loader.File#onProcessComplete","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called when the File has completed processing but it generated an error.\nChecks on the state of its multifile, if set.","kind":"function","name":"onProcessError","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#onProcessError","scope":"instance","inherits":"Phaser.Loader.File#onProcessError","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":411,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Checks if a key matching the one used by this file exists in the target Cache or not.\nThis is called automatically by the LoaderPlugin to decide if the file can be safely\nloaded or will conflict.","kind":"function","name":"hasCacheConflict","since":"3.7.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if adding this file will cause a conflict, otherwise `false`."}],"memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#hasCacheConflict","scope":"instance","inherits":"Phaser.Loader.File#hasCacheConflict","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Adds this file to its target cache upon successful loading and processing.\nThis method is often overridden by specific file types.","kind":"function","name":"addToCache","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#addToCache","scope":"instance","inherits":"Phaser.Loader.File#addToCache","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":443,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Called once the file has been added to its cache and is now ready for deletion from the Loader.\nIt will emit a `filecomplete` event from the LoaderPlugin.","kind":"function","name":"pendingDestroy","fires":["Phaser.Loader.Events#event:FILE_COMPLETE","Phaser.Loader.Events#event:FILE_KEY_COMPLETE"],"since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#pendingDestroy","scope":"instance","inherits":"Phaser.Loader.File#pendingDestroy","inherited":true,"___s":true},{"meta":{"filename":"File.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/loader"},"description":"Destroy this File and any references it holds.","kind":"function","name":"destroy","since":"3.7.0","memberof":"Phaser.Loader.FileTypes.XMLFile","longname":"Phaser.Loader.FileTypes.XMLFile#destroy","scope":"instance","inherits":"Phaser.Loader.File#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesPlugin"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesPlugin","longname":"Phaser.FacebookInstantGamesPlugin#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#clearAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopRight","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#setBlendMode","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#depth","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#setDepth","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipX","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlip","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#resetFlip","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getRightCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBounds","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originX","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originY","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginX","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginY","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#pipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#initPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#setPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#resetPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#getPipelineName","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#width","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#height","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayWidth","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayHeight","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSizeToFrame","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSize","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setDisplaySize","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#texture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#frame","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#isCropped","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setTexture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setFrame","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#clearTint","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTint","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopRight","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomRight","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tint","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#isTinted","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#x","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#y","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#z","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#w","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scale","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleX","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleY","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#angle","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#rotation","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRandomPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRotation","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setAngle","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setScale","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setX","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setY","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setZ","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setW","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getParentRotation","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"Acceleration.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal and vertical acceleration. If the vertical acceleration value is not provided, the vertical acceleration is set to the same value as the horizontal acceleration.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal acceleration","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical acceleration","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAcceleration","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Acceleration#setAcceleration","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal acceleration.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal acceleration","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAccelerationX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Acceleration#setAccelerationX","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's vertical acceleration.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical acceleration","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAccelerationY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Acceleration#setAccelerationY","inherited":true,"___s":true},{"meta":{"filename":"Angular.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular velocity of the body.\n\nIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\nHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\ncausing them to visually rotate, even though the body remains axis-aligned.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAngularVelocity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Angular#setAngularVelocity","inherited":true,"___s":true},{"meta":{"filename":"Angular.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular acceleration of the body.\n\nIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\nHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\ncausing them to visually rotate, even though the body remains axis-aligned.","kind":"function","name":"setAngularAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of angular acceleration.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAngularAcceleration","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Angular#setAngularAcceleration","inherited":true,"___s":true},{"meta":{"filename":"Angular.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular drag of the body. Drag is applied to the current velocity, providing a form of deceleration.","kind":"function","name":"setAngularDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of drag.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setAngularDrag","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Angular#setAngularDrag","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the bounce values of this body.\n\nBounce is the amount of restitution, or elasticity, the body has when it collides with another object.\nA value of 1 means that it will retain its full velocity after the rebound. A value of 0 means it will not rebound at all.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setBounce","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the horizontal bounce value for this body.","kind":"function","name":"setBounceX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setBounceX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setBounceX","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the vertical bounce value for this body.","kind":"function","name":"setBounceY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setBounceY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setBounceY","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets whether this Body collides with the world boundary.\n\nOptionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.","kind":"function","name":"setCollideWorldBounds","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if this body should collide with the world bounds, otherwise `false`.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.x` value.","name":"bounceX"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.y` value.","name":"bounceY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setCollideWorldBounds","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setCollideWorldBounds","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the debug values of this body.\n\nBodies will only draw their debug if debug has been enabled for Arcade Physics as a whole.\nNote that there is a performance cost in drawing debug displays. It should never be used in production.","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` to have this body render its outline to the debug display.","name":"showBody"},{"type":{"names":["boolean"]},"description":"Set to `true` to have this body render a velocity marker to the debug display.","name":"showVelocity"},{"type":{"names":["number"]},"description":"The color of the body outline when rendered to the debug display.","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDebug","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Debug#setDebug","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the color of the body outline when it renders to the debug display.","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The color of the body outline when rendered to the debug display.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDebugBodyColor","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Debug#setDebugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set to `true` to have this body render its outline to the debug display.","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#debugShowBody","scope":"instance","kind":"member","inherits":"Phaser.Physics.Arcade.Components.Debug#debugShowBody","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set to `true` to have this body render a velocity marker to the debug display.","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#debugShowVelocity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Arcade.Components.Debug#debugShowVelocity","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"The color of the body outline when it renders to the debug display.","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#debugBodyColor","scope":"instance","kind":"member","inherits":"Phaser.Physics.Arcade.Components.Debug#debugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal and vertical drag. If the vertical drag value is not provided, the vertical drag is set to the same value as the horizontal drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal drag to apply.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical drag to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDrag","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDrag","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDragX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal drag to apply.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDragX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDragX","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's vertical drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDragY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of vertical drag to apply.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDragY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDragY","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"If this Body is using `drag` for deceleration this function controls how the drag is applied.\nIf set to `true` drag will use a damping effect rather than a linear approach. If you are\ncreating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\nthe game Asteroids) then you will get a far smoother and more visually correct deceleration\nby using damping, avoiding the axis-drift that is prone with linear deceleration.\n\nIf you enable this property then you should use far smaller `drag` values than with linear, as\nthey are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\ndeceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.","kind":"function","name":"setDamping","since":"3.10.0","params":[{"type":{"names":["boolean"]},"description":"`true` to use damping for deceleration, or `false` to use linear deceleration.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setDamping","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDamping","inherited":true,"___s":true},{"meta":{"filename":"Enable.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Enables this Game Object's Body.","kind":"function","name":"enableBody","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Also reset the Body and place it at (x, y).","name":"reset"},{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"x"},{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"y"},{"type":{"names":["boolean"]},"description":"Also activate this Game Object.","name":"enableGameObject"},{"type":{"names":["boolean"]},"description":"Also show this Game Object.","name":"showGameObject"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.Body#enable","Phaser.Physics.Arcade.StaticBody#enable","Phaser.Physics.Arcade.Body#reset","Phaser.Physics.Arcade.StaticBody#reset","Phaser.GameObjects.GameObject#active","Phaser.GameObjects.GameObject#visible"],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#enableBody","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Enable#enableBody","inherited":true,"___s":true},{"meta":{"filename":"Enable.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Stops and disables this Game Object's Body.","kind":"function","name":"disableBody","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also deactivate this Game Object.","name":"disableGameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also hide this Game Object.","name":"hideGameObject"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.Body#enable","Phaser.Physics.Arcade.StaticBody#enable","Phaser.GameObjects.GameObject#active","Phaser.GameObjects.GameObject#visible"],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#disableBody","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Enable#disableBody","inherited":true,"___s":true},{"meta":{"filename":"Enable.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Syncs the Body's position and size with its parent Game Object.\nYou don't need to call this for Dynamic Bodies, as it happens automatically.\nBut for Static bodies it's a useful way of modifying the position of a Static Body\nin the Physics World, based on its Game Object.","kind":"function","name":"refreshBody","since":"3.1.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.StaticBody#updateFromGameObject"],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#refreshBody","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Enable#refreshBody","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal friction to apply.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical friction to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFriction","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving horizontally in the X axis.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of friction to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFrictionX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Friction#setFrictionX","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving vertically in the Y axis.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of friction to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setFrictionY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Friction#setFrictionY","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the X and Y values of the gravitational pull to act upon this Arcade Physics Game Object. Values can be positive or negative. Larger values result in a stronger effect.\n\nIf only one value is provided, this value will be used for both the X and Y axis.","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the X-axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The gravitational force to be applied to the Y-axis. If this is not specified, the X value will be used.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setGravity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Gravity#setGravity","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the gravitational force to be applied to the X axis. Value can be positive or negative. Larger values result in a stronger effect.","kind":"function","name":"setGravityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the X-axis.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setGravityX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Gravity#setGravityX","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the gravitational force to be applied to the Y axis. Value can be positive or negative. Larger values result in a stronger effect.","kind":"function","name":"setGravityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the Y-axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setGravityY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Gravity#setGravityY","inherited":true,"___s":true},{"meta":{"filename":"Immovable.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets Whether this Body can be moved by collisions with another Body.","kind":"function","name":"setImmovable","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets if this body can be moved by collisions with another Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setImmovable","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Immovable#setImmovable","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the mass of the physics body","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"New value for the mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setMass","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Mass#setMass","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body offset. This allows you to adjust the difference between the center of the body\nand the x and y coordinates of the parent Game Object.","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to offset the body from the parent Game Object along the x-axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setOffset","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Size#setOffset","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":55,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets this physics body to use a circle for collision instead of a rectangle.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the physics body, in pixels.","name":"radius"},{"type":{"names":["number"]},"optional":true,"description":"The amount to offset the body from the parent Game Object along the x-axis.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to offset the body from the parent Game Object along the y-axis.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setCircle","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Size#setCircle","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the velocity of the Body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity of the body. Positive values move the body to the right, while negative values move it to the left.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity of the body. Positive values move the body down, while negative values move it up.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setVelocity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the horizontal component of the body's velocity.\n\nPositive values move the body to the right, while negative values move it to the left.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new horizontal velocity.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the vertical component of the body's velocity.\n\nPositive values move the body down, while negative values move it up.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new vertical velocity of the body.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the maximum velocity of the body.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new maximum horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The new maximum vertical velocity.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Image","longname":"Phaser.Physics.Arcade.Image#setMaxVelocity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setMaxVelocity","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"The Animation Controller of this Sprite.","name":"anims","type":{"names":["Phaser.GameObjects.Components.Animation"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#anims","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Sprite#anims","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Start playing the given animation.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If an animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#play","scope":"instance","inherits":"Phaser.GameObjects.Sprite#play","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Build a JSON representation of this Sprite.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#toJSON","scope":"instance","inherits":"Phaser.GameObjects.Sprite#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#clearAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopRight","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#setBlendMode","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#depth","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#setDepth","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipX","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlip","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#resetFlip","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getRightCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBounds","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originX","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originY","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginX","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginY","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#pipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#initPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#setPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#resetPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#getPipelineName","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#width","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#height","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayWidth","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayHeight","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSizeToFrame","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSize","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setDisplaySize","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#texture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#frame","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#isCropped","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setTexture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setFrame","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#clearTint","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTint","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopRight","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomRight","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tint","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#isTinted","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#x","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#y","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#z","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#w","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scale","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleX","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleY","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#angle","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#rotation","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRandomPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRotation","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setAngle","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setScale","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setX","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setY","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setZ","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setW","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getParentRotation","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"Acceleration.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal and vertical acceleration. If the vertical acceleration value is not provided, the vertical acceleration is set to the same value as the horizontal acceleration.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal acceleration","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical acceleration","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAcceleration","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Acceleration#setAcceleration","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal acceleration.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal acceleration","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAccelerationX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Acceleration#setAccelerationX","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's vertical acceleration.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical acceleration","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAccelerationY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Acceleration#setAccelerationY","inherited":true,"___s":true},{"meta":{"filename":"Angular.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular velocity of the body.\n\nIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\nHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\ncausing them to visually rotate, even though the body remains axis-aligned.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAngularVelocity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Angular#setAngularVelocity","inherited":true,"___s":true},{"meta":{"filename":"Angular.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular acceleration of the body.\n\nIn Arcade Physics, bodies cannot rotate. They are always axis-aligned.\nHowever, they can have angular motion, which is passed on to the Game Object bound to the body,\ncausing them to visually rotate, even though the body remains axis-aligned.","kind":"function","name":"setAngularAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of angular acceleration.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAngularAcceleration","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Angular#setAngularAcceleration","inherited":true,"___s":true},{"meta":{"filename":"Angular.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the angular drag of the body. Drag is applied to the current velocity, providing a form of deceleration.","kind":"function","name":"setAngularDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of drag.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setAngularDrag","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Angular#setAngularDrag","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the bounce values of this body.\n\nBounce is the amount of restitution, or elasticity, the body has when it collides with another object.\nA value of 1 means that it will retain its full velocity after the rebound. A value of 0 means it will not rebound at all.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setBounce","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the horizontal bounce value for this body.","kind":"function","name":"setBounceX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal bounce to apply on collision. A float, typically between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setBounceX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setBounceX","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the vertical bounce value for this body.","kind":"function","name":"setBounceY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of vertical bounce to apply on collision. A float, typically between 0 and 1.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setBounceY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setBounceY","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":70,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets whether this Body collides with the world boundary.\n\nOptionally also sets the World Bounce values. If the `Body.worldBounce` is null, it's set to a new Phaser.Math.Vector2 first.","kind":"function","name":"setCollideWorldBounds","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"`true` if this body should collide with the world bounds, otherwise `false`.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.x` value.","name":"bounceX"},{"type":{"names":["number"]},"optional":true,"description":"If given this will be replace the `worldBounce.y` value.","name":"bounceY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setCollideWorldBounds","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Bounce#setCollideWorldBounds","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the debug values of this body.\n\nBodies will only draw their debug if debug has been enabled for Arcade Physics as a whole.\nNote that there is a performance cost in drawing debug displays. It should never be used in production.","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to `true` to have this body render its outline to the debug display.","name":"showBody"},{"type":{"names":["boolean"]},"description":"Set to `true` to have this body render a velocity marker to the debug display.","name":"showVelocity"},{"type":{"names":["number"]},"description":"The color of the body outline when rendered to the debug display.","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDebug","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Debug#setDebug","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the color of the body outline when it renders to the debug display.","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The color of the body outline when rendered to the debug display.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDebugBodyColor","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Debug#setDebugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set to `true` to have this body render its outline to the debug display.","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#debugShowBody","scope":"instance","kind":"member","inherits":"Phaser.Physics.Arcade.Components.Debug#debugShowBody","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set to `true` to have this body render a velocity marker to the debug display.","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#debugShowVelocity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Arcade.Components.Debug#debugShowVelocity","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":98,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"The color of the body outline when it renders to the debug display.","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#debugBodyColor","scope":"instance","kind":"member","inherits":"Phaser.Physics.Arcade.Components.Debug#debugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal and vertical drag. If the vertical drag value is not provided, the vertical drag is set to the same value as the horizontal drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDrag","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal drag to apply.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical drag to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDrag","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDrag","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's horizontal drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDragX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal drag to apply.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDragX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDragX","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":72,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body's vertical drag.\n\nDrag can be considered as a form of deceleration that will return the velocity of a body back to zero over time.\nIt is the absolute loss of velocity due to movement, in pixels per second squared.\nThe x and y components are applied separately.\n\nWhen `useDamping` is true, this is 1 minus the damping factor.\nA value of 1 means the Body loses no velocity.\nA value of 0.95 means the Body loses 5% of its velocity per step.\nA value of 0.5 means the Body loses 50% of its velocity per step.\n\nDrag is applied only when `acceleration` is zero.","kind":"function","name":"setDragY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of vertical drag to apply.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDragY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDragY","inherited":true,"___s":true},{"meta":{"filename":"Drag.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"If this Body is using `drag` for deceleration this function controls how the drag is applied.\nIf set to `true` drag will use a damping effect rather than a linear approach. If you are\ncreating a game where the Body moves freely at any angle (i.e. like the way the ship moves in\nthe game Asteroids) then you will get a far smoother and more visually correct deceleration\nby using damping, avoiding the axis-drift that is prone with linear deceleration.\n\nIf you enable this property then you should use far smaller `drag` values than with linear, as\nthey are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow\ndeceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.","kind":"function","name":"setDamping","since":"3.10.0","params":[{"type":{"names":["boolean"]},"description":"`true` to use damping for deceleration, or `false` to use linear deceleration.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setDamping","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Drag#setDamping","inherited":true,"___s":true},{"meta":{"filename":"Enable.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Enables this Game Object's Body.","kind":"function","name":"enableBody","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Also reset the Body and place it at (x, y).","name":"reset"},{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"x"},{"type":{"names":["number"]},"description":"The horizontal position to place the Game Object and Body.","name":"y"},{"type":{"names":["boolean"]},"description":"Also activate this Game Object.","name":"enableGameObject"},{"type":{"names":["boolean"]},"description":"Also show this Game Object.","name":"showGameObject"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.Body#enable","Phaser.Physics.Arcade.StaticBody#enable","Phaser.Physics.Arcade.Body#reset","Phaser.Physics.Arcade.StaticBody#reset","Phaser.GameObjects.GameObject#active","Phaser.GameObjects.GameObject#visible"],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#enableBody","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Enable#enableBody","inherited":true,"___s":true},{"meta":{"filename":"Enable.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Stops and disables this Game Object's Body.","kind":"function","name":"disableBody","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also deactivate this Game Object.","name":"disableGameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also hide this Game Object.","name":"hideGameObject"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.Body#enable","Phaser.Physics.Arcade.StaticBody#enable","Phaser.GameObjects.GameObject#active","Phaser.GameObjects.GameObject#visible"],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#disableBody","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Enable#disableBody","inherited":true,"___s":true},{"meta":{"filename":"Enable.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Syncs the Body's position and size with its parent Game Object.\nYou don't need to call this for Dynamic Bodies, as it happens automatically.\nBut for Static bodies it's a useful way of modifying the position of a Static Body\nin the Physics World, based on its Game Object.","kind":"function","name":"refreshBody","since":"3.1.0","returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"see":["Phaser.Physics.Arcade.StaticBody#updateFromGameObject"],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#refreshBody","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Enable#refreshBody","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal friction to apply.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount of vertical friction to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFriction","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving horizontally in the X axis.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of friction to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFrictionX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Friction#setFrictionX","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving vertically in the Y axis.\nThe higher than friction, the faster the body will slow down once force stops being applied to it.","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of friction to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setFrictionY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Friction#setFrictionY","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the X and Y values of the gravitational pull to act upon this Arcade Physics Game Object. Values can be positive or negative. Larger values result in a stronger effect.\n\nIf only one value is provided, this value will be used for both the X and Y axis.","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the X-axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The gravitational force to be applied to the Y-axis. If this is not specified, the X value will be used.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setGravity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Gravity#setGravity","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":36,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the gravitational force to be applied to the X axis. Value can be positive or negative. Larger values result in a stronger effect.","kind":"function","name":"setGravityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the X-axis.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setGravityX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Gravity#setGravityX","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Set the gravitational force to be applied to the Y axis. Value can be positive or negative. Larger values result in a stronger effect.","kind":"function","name":"setGravityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The gravitational force to be applied to the Y-axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setGravityY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Gravity#setGravityY","inherited":true,"___s":true},{"meta":{"filename":"Immovable.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets Whether this Body can be moved by collisions with another Body.","kind":"function","name":"setImmovable","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Sets if this body can be moved by collisions with another Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setImmovable","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Immovable#setImmovable","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the mass of the physics body","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"New value for the mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setMass","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Mass#setMass","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the body offset. This allows you to adjust the difference between the center of the body\nand the x and y coordinates of the parent Game Object.","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to offset the body from the parent Game Object along the x-axis.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setOffset","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Size#setOffset","inherited":true,"___s":true},{"meta":{"filename":"Size.js","lineno":55,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets this physics body to use a circle for collision instead of a rectangle.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the physics body, in pixels.","name":"radius"},{"type":{"names":["number"]},"optional":true,"description":"The amount to offset the body from the parent Game Object along the x-axis.","name":"offsetX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to offset the body from the parent Game Object along the y-axis.","name":"offsetY"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setCircle","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Size#setCircle","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the velocity of the Body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity of the body. Positive values move the body to the right, while negative values move it to the left.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity of the body. Positive values move the body down, while negative values move it up.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setVelocity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the horizontal component of the body's velocity.\n\nPositive values move the body to the right, while negative values move it to the left.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new horizontal velocity.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the vertical component of the body's velocity.\n\nPositive values move the body down, while negative values move it up.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new vertical velocity of the body.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/arcade/components"},"description":"Sets the maximum velocity of the body.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new maximum horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The new maximum vertical velocity.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Arcade.Sprite","longname":"Phaser.Physics.Arcade.Sprite#setMaxVelocity","scope":"instance","inherits":"Phaser.Physics.Arcade.Components.Velocity#setMaxVelocity","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"This scene this group belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#scene","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#scene","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Members of this group.","name":"children","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#children","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#children","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A flag identifying this object as a group.","name":"isParent","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#isParent","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#isParent","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The name of this group.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.18.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#name","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether this group runs its {@link Phaser.GameObjects.Group#preUpdate} method\n(which may update any members).","name":"active","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#active","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The maximum size of this group, if used as a pool. -1 is no limit.","name":"maxSize","type":{"names":["integer"]},"since":"3.0.0","defaultvalue":"-1","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#maxSize","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#maxSize","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A default texture key to use when creating new group members.\n\nThis is used in {@link Phaser.GameObjects.Group#create}\nbut not in {@link Phaser.GameObjects.Group#createMultiple}.","name":"defaultKey","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#defaultKey","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#defaultKey","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":170,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A default texture frame to use when creating new group members.","name":"defaultFrame","type":{"names":["string","integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#defaultFrame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#defaultFrame","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":179,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether to call the update method of any members.","name":"runChildUpdate","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.GameObjects.Group#preUpdate"],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#runChildUpdate","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#runChildUpdate","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":190,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when adding or creating group members.","name":"createCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#createCallback","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#createCallback","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":199,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when removing group members.","name":"removeCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#removeCallback","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#removeCallback","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":208,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when creating several group members at once.","name":"createMultipleCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#createMultipleCallback","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#createMultipleCallback","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates a new Game Object and adds it to this group, unless the group {@link Phaser.GameObjects.Group#isFull is full}.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the new Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the new Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key of the new Game Object.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"The texture frame of the new Game Object.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of the new Game Object.","name":"visible"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.GameObject#active} state of the new Game Object.","name":"active"}],"returns":[{"type":{"names":["any"]},"description":"The new Game Object (usually a Sprite, etc.)."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#create","scope":"instance","inherits":"Phaser.GameObjects.Group#create","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":294,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates several Game Objects and adds them to this group.\n\nIf the group becomes {@link Phaser.GameObjects.Group#isFull}, no further Game Objects are created.\n\nCalls {@link Phaser.GameObjects.Group#createMultipleCallback} and {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"createMultiple","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCreateConfig","Array."]},"description":"Creation settings. This can be a single configuration object or an array of such objects, which will be applied in turn.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"The newly created Game Objects."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#createMultiple","scope":"instance","inherits":"Phaser.GameObjects.Group#createMultiple","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":335,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A helper for {@link Phaser.GameObjects.Group#createMultiple}.","kind":"function","name":"createFromConfig","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"description":"Creation settings.","name":"options"}],"returns":[{"type":{"names":["Array."]},"description":"The newly created Game Objects."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#createFromConfig","scope":"instance","inherits":"Phaser.GameObjects.Group#createFromConfig","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Updates any group members, if {@link Phaser.GameObjects.Group#runChildUpdate} is enabled.","kind":"function","name":"preUpdate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current timestamp.","name":"time"},{"type":{"names":["number"]},"description":"The delta time elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#preUpdate","scope":"instance","inherits":"Phaser.GameObjects.Group#preUpdate","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds a Game Object to this group.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to add.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also add the Game Object to the scene.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#add","scope":"instance","inherits":"Phaser.GameObjects.Group#add","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":562,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds several Game Objects to this group.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"addMultiple","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The Game Objects to add.","name":"children"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also add the Game Objects to the scene.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This group."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#addMultiple","scope":"instance","inherits":"Phaser.GameObjects.Group#addMultiple","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Removes a member of this Group and optionally removes it from the Scene and / or destroys it.\n\nCalls {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to remove.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally remove the Group member from the Scene it belongs to.","name":"removeFromScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call destroy on the removed Group member.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#remove","scope":"instance","inherits":"Phaser.GameObjects.Group#remove","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":645,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Removes all members of this Group and optionally removes them from the Scene and / or destroys them.\n\nDoes not call {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"clear","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally remove each Group member from the Scene.","name":"removeFromScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call destroy on the removed Group members.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This group."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#clear","scope":"instance","inherits":"Phaser.GameObjects.Group#clear","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":691,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Tests if a Game Object is a member of this group.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A Game Object.","name":"child"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object is a member of this group."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#contains","scope":"instance","inherits":"Phaser.GameObjects.Group#contains","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":706,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"All members of the group.","kind":"function","name":"getChildren","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"The group members."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getChildren","scope":"instance","inherits":"Phaser.GameObjects.Group#getChildren","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":719,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The number of members of the group.","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["integer"]}}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getLength","scope":"instance","inherits":"Phaser.GameObjects.Group#getLength","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":732,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group, from top to bottom, for the first member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirst","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getFirst","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirst","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":757,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group, from top to bottom, for the nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstNth","since":"3.6.0","params":[{"type":{"names":["integer"]},"description":"The nth matching Group member to search for.","name":"nth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getFirstNth","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirstNth","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":783,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group for the last member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getLast","since":"3.6.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getLast","scope":"instance","inherits":"Phaser.GameObjects.Group#getLast","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":808,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group for the last nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getLastNth","since":"3.6.0","params":[{"type":{"names":["integer"]},"description":"The nth matching Group member to search for.","name":"nth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getLastNth","scope":"instance","inherits":"Phaser.GameObjects.Group#getLastNth","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":937,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\nassigns `x` and `y`, and returns the member.\n\nIf no inactive member is found and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nThe new Game Object will have its active state set to `true`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first inactive group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#get","scope":"instance","inherits":"Phaser.GameObjects.Group#get","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":961,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `true`,\nassigns `x` and `y`, and returns the member.\n\nIf no active member is found and `createIfNull` is `true` and the group isn't full then it will create a new one using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstAlive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"description":"The first active group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getFirstAlive","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirstAlive","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":985,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\nassigns `x` and `y`, and returns the member.\n\nIf no inactive member is found and `createIfNull` is `true` and the group isn't full then it will create a new one using `x`, `y`, `key`, `frame`, and `visible`.\nThe new Game Object will have an active state set to `true`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstDead","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"description":"The first inactive group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getFirstDead","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirstDead","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1010,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"{@link Phaser.GameObjects.Components.Animation#play Plays} an animation for all members of this group.","kind":"function","name":"playAnimation","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["string"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#playAnimation","scope":"instance","inherits":"Phaser.GameObjects.Group#playAnimation","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1028,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether this group's size at its {@link Phaser.GameObjects.Group#maxSize maximum}.","kind":"function","name":"isFull","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if the number of members equals {@link Phaser.GameObjects.Group#maxSize}."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#isFull","scope":"instance","inherits":"Phaser.GameObjects.Group#isFull","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1048,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Counts the number of active (or inactive) group members.","kind":"function","name":"countActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Count active (true) or inactive (false) group members.","name":"value"}],"returns":[{"type":{"names":["integer"]},"description":"The number of group members with an active state matching the `active` argument."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#countActive","scope":"instance","inherits":"Phaser.GameObjects.Group#countActive","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1075,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Counts the number of in-use (active) group members.","kind":"function","name":"getTotalUsed","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of group members with an active state of true."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getTotalUsed","scope":"instance","inherits":"Phaser.GameObjects.Group#getTotalUsed","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The difference of {@link Phaser.GameObjects.Group#maxSize} and the number of active group members.\n\nThis represents the number of group members that could be created or reactivated before reaching the size limit.","kind":"function","name":"getTotalFree","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"maxSize minus the number of active group numbers; or a large number (if maxSize is -1)."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#getTotalFree","scope":"instance","inherits":"Phaser.GameObjects.Group#getTotalFree","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the property as defined in `key` of each group member to the given value.","kind":"function","name":"propertyValueSet","since":"3.21.0","params":[{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#propertyValueSet","scope":"instance","inherits":"Phaser.GameObjects.Group#propertyValueSet","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the property as defined in `key` of each group member.","kind":"function","name":"propertyValueInc","since":"3.21.0","params":[{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#propertyValueInc","scope":"instance","inherits":"Phaser.GameObjects.Group#propertyValueInc","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1148,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the x of each group member.","kind":"function","name":"setX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setX","scope":"instance","inherits":"Phaser.GameObjects.Group#setX","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the y of each group member.","kind":"function","name":"setY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setY","scope":"instance","inherits":"Phaser.GameObjects.Group#setY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the x, y of each group member.","kind":"function","name":"setXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the `x` property to.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to set the `y` property to. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setXY","scope":"instance","inherits":"Phaser.GameObjects.Group#setXY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the x of each group member.","kind":"function","name":"incX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#incX","scope":"instance","inherits":"Phaser.GameObjects.Group#incX","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the y of each group member.","kind":"function","name":"incY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `y` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#incY","scope":"instance","inherits":"Phaser.GameObjects.Group#incY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1240,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the x, y of each group member.","kind":"function","name":"incXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to be added to the `y` property. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#incXY","scope":"instance","inherits":"Phaser.GameObjects.Group#incXY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Iterate through the group members changing the position of each element to be that of the element that came before\nit in the array (or after it if direction = 1)\n\nThe first group member position is set to x/y.","kind":"function","name":"shiftPosition","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to place the first item in the array at.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to place the first item in the array at.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The iteration direction. 0 = first to last and 1 = last to first.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#shiftPosition","scope":"instance","inherits":"Phaser.GameObjects.Group#shiftPosition","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1282,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the angle of each group member.","kind":"function","name":"angle","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the angle to, in degrees.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#angle","scope":"instance","inherits":"Phaser.GameObjects.Group#angle","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the rotation of each group member.","kind":"function","name":"rotate","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the rotation to, in radians.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#rotate","scope":"instance","inherits":"Phaser.GameObjects.Group#rotate","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Rotates each group member around the given point by the given angle.","kind":"function","name":"rotateAround","since":"3.21.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#rotateAround","scope":"instance","inherits":"Phaser.GameObjects.Group#rotateAround","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1336,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Rotates each group member around the given point by the given angle and distance.","kind":"function","name":"rotateAroundDistance","since":"3.21.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"},{"type":{"names":["number"]},"description":"The distance from the point of rotation in pixels.","name":"distance"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#rotateAroundDistance","scope":"instance","inherits":"Phaser.GameObjects.Group#rotateAroundDistance","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the alpha of each group member.","kind":"function","name":"setAlpha","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the alpha to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Group#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the tint of each group member.","kind":"function","name":"setTint","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The tint being applied to top-left corner of item. If other parameters are given no value, this tint will be applied to whole item.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to top-right corner of item.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-left corner of item.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-right corner of item.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setTint","scope":"instance","inherits":"Phaser.GameObjects.Group#setTint","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1393,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the originX, originY of each group member.","kind":"function","name":"setOrigin","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the `originX` property to.","name":"originX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to set the `originY` property to. If `undefined` or `null` it uses the `originX` value.","name":"originY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originY` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Group#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1413,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleX of each group member.","kind":"function","name":"scaleX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#scaleX","scope":"instance","inherits":"Phaser.GameObjects.Group#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleY of each group member.","kind":"function","name":"scaleY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#scaleY","scope":"instance","inherits":"Phaser.GameObjects.Group#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleX, scaleY of each group member.","kind":"function","name":"scaleXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `scaleX` property.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to be added to the `scaleY` property. If `undefined` or `null` it uses the `scaleX` value.","name":"scaleY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleY` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#scaleXY","scope":"instance","inherits":"Phaser.GameObjects.Group#scaleXY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1469,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the depth of each group member.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Group#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1487,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the blendMode of each group member.","kind":"function","name":"setBlendMode","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Group#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1504,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Passes all group members to the Input Manager to enable them for input with identical areas and callbacks.","kind":"function","name":"setHitArea","since":"3.21.0","params":[{"type":{"names":["*"]},"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"hitAreaCallback"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setHitArea","scope":"instance","inherits":"Phaser.GameObjects.Group#setHitArea","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1522,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Shuffles the group members in place.","kind":"function","name":"shuffle","since":"3.21.0","returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#shuffle","scope":"instance","inherits":"Phaser.GameObjects.Group#shuffle","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Deactivates a member of this group.","kind":"function","name":"kill","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A member of this group.","name":"gameObject"}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#kill","scope":"instance","inherits":"Phaser.GameObjects.Group#kill","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1553,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Deactivates and hides a member of this group.","kind":"function","name":"killAndHide","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A member of this group.","name":"gameObject"}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#killAndHide","scope":"instance","inherits":"Phaser.GameObjects.Group#killAndHide","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1570,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the visible of each group member.","kind":"function","name":"setVisible","since":"3.21.0","params":[{"type":{"names":["boolean"]},"description":"The value to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Group#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1589,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Toggles (flips) the visible state of each member of this group.","kind":"function","name":"toggleVisible","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#toggleVisible","scope":"instance","inherits":"Phaser.GameObjects.Group#toggleVisible","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1604,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Empties this group and removes it from the Scene.\n\nDoes not call {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"destroy","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also {@link Phaser.GameObjects.GameObject#destroy} each group member.","name":"destroyChildren"}],"memberof":"Phaser.Physics.Arcade.Group","longname":"Phaser.Physics.Arcade.Group#destroy","scope":"instance","inherits":"Phaser.GameObjects.Group#destroy","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"This scene this group belongs to.","name":"scene","type":{"names":["Phaser.Scene"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#scene","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#scene","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":87,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Members of this group.","name":"children","type":{"names":["Phaser.Structs.Set."]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#children","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#children","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":96,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A flag identifying this object as a group.","name":"isParent","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#isParent","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#isParent","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":117,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The class to create new group members from.","name":"classType","type":{"names":["function"]},"since":"3.0.0","defaultvalue":"Phaser.GameObjects.Sprite","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#classType","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#classType","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":127,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The name of this group.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.18.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#name","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether this group runs its {@link Phaser.GameObjects.Group#preUpdate} method\n(which may update any members).","name":"active","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#active","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The maximum size of this group, if used as a pool. -1 is no limit.","name":"maxSize","type":{"names":["integer"]},"since":"3.0.0","defaultvalue":"-1","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#maxSize","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#maxSize","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":158,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A default texture key to use when creating new group members.\n\nThis is used in {@link Phaser.GameObjects.Group#create}\nbut not in {@link Phaser.GameObjects.Group#createMultiple}.","name":"defaultKey","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#defaultKey","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#defaultKey","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":170,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A default texture frame to use when creating new group members.","name":"defaultFrame","type":{"names":["string","integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#defaultFrame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#defaultFrame","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":179,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether to call the update method of any members.","name":"runChildUpdate","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","see":["Phaser.GameObjects.Group#preUpdate"],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#runChildUpdate","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#runChildUpdate","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":190,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when adding or creating group members.","name":"createCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#createCallback","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#createCallback","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":199,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when removing group members.","name":"removeCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#removeCallback","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#removeCallback","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":208,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A function to be called when creating several group members at once.","name":"createMultipleCallback","type":{"names":["Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback"]},"nullable":true,"since":"3.0.0","memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#createMultipleCallback","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Group#createMultipleCallback","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates a new Game Object and adds it to this group, unless the group {@link Phaser.GameObjects.Group#isFull is full}.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"create","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal position of the new Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The vertical position of the new Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key of the new Game Object.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"The texture frame of the new Game Object.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of the new Game Object.","name":"visible"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.GameObject#active} state of the new Game Object.","name":"active"}],"returns":[{"type":{"names":["any"]},"description":"The new Game Object (usually a Sprite, etc.)."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#create","scope":"instance","inherits":"Phaser.GameObjects.Group#create","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":294,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Creates several Game Objects and adds them to this group.\n\nIf the group becomes {@link Phaser.GameObjects.Group#isFull}, no further Game Objects are created.\n\nCalls {@link Phaser.GameObjects.Group#createMultipleCallback} and {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"createMultiple","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCreateConfig","Array."]},"description":"Creation settings. This can be a single configuration object or an array of such objects, which will be applied in turn.","name":"config"}],"returns":[{"type":{"names":["Array."]},"description":"The newly created Game Objects."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#createMultiple","scope":"instance","inherits":"Phaser.GameObjects.Group#createMultiple","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":335,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"A helper for {@link Phaser.GameObjects.Group#createMultiple}.","kind":"function","name":"createFromConfig","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.GameObjects.Group.GroupCreateConfig"]},"description":"Creation settings.","name":"options"}],"returns":[{"type":{"names":["Array."]},"description":"The newly created Game Objects."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#createFromConfig","scope":"instance","inherits":"Phaser.GameObjects.Group#createFromConfig","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":483,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Updates any group members, if {@link Phaser.GameObjects.Group#runChildUpdate} is enabled.","kind":"function","name":"preUpdate","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The current timestamp.","name":"time"},{"type":{"names":["number"]},"description":"The delta time elapsed since the last frame.","name":"delta"}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#preUpdate","scope":"instance","inherits":"Phaser.GameObjects.Group#preUpdate","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds a Game Object to this group.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to add.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also add the Game Object to the scene.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#add","scope":"instance","inherits":"Phaser.GameObjects.Group#add","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":562,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds several Game Objects to this group.\n\nCalls {@link Phaser.GameObjects.Group#createCallback}.","kind":"function","name":"addMultiple","since":"3.0.0","params":[{"type":{"names":["Array."]},"description":"The Game Objects to add.","name":"children"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also add the Game Objects to the scene.","name":"addToScene"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This group."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#addMultiple","scope":"instance","inherits":"Phaser.GameObjects.Group#addMultiple","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Removes a member of this Group and optionally removes it from the Scene and / or destroys it.\n\nCalls {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"The Game Object to remove.","name":"child"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally remove the Group member from the Scene it belongs to.","name":"removeFromScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call destroy on the removed Group member.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#remove","scope":"instance","inherits":"Phaser.GameObjects.Group#remove","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":645,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Removes all members of this Group and optionally removes them from the Scene and / or destroys them.\n\nDoes not call {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"clear","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally remove each Group member from the Scene.","name":"removeFromScene"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Optionally call destroy on the removed Group members.","name":"destroyChild"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This group."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#clear","scope":"instance","inherits":"Phaser.GameObjects.Group#clear","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":691,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Tests if a Game Object is a member of this group.","kind":"function","name":"contains","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A Game Object.","name":"child"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object is a member of this group."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#contains","scope":"instance","inherits":"Phaser.GameObjects.Group#contains","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":706,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"All members of the group.","kind":"function","name":"getChildren","since":"3.0.0","returns":[{"type":{"names":["Array."]},"description":"The group members."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getChildren","scope":"instance","inherits":"Phaser.GameObjects.Group#getChildren","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":719,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The number of members of the group.","kind":"function","name":"getLength","since":"3.0.0","returns":[{"type":{"names":["integer"]}}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getLength","scope":"instance","inherits":"Phaser.GameObjects.Group#getLength","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":732,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group, from top to bottom, for the first member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirst","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getFirst","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirst","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":757,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group, from top to bottom, for the nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstNth","since":"3.6.0","params":[{"type":{"names":["integer"]},"description":"The nth matching Group member to search for.","name":"nth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getFirstNth","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirstNth","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":783,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group for the last member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getLast","since":"3.6.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getLast","scope":"instance","inherits":"Phaser.GameObjects.Group#getLast","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":808,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the Group for the last nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\nassigns `x` and `y`, and returns the member.\n\nIf no matching member is found and `createIfNull` is true and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getLastNth","since":"3.6.0","params":[{"type":{"names":["integer"]},"description":"The nth matching Group member to search for.","name":"nth"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"The {@link Phaser.GameObjects.GameObject#active} value to match.","name":"state"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first matching group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getLastNth","scope":"instance","inherits":"Phaser.GameObjects.Group#getLastNth","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":937,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\nassigns `x` and `y`, and returns the member.\n\nIf no inactive member is found and the group isn't full then it will create a new Game Object using `x`, `y`, `key`, `frame`, and `visible`.\nThe new Game Object will have its active state set to `true`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"nullable":true,"description":"The first inactive group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#get","scope":"instance","inherits":"Phaser.GameObjects.Group#get","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":961,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `true`,\nassigns `x` and `y`, and returns the member.\n\nIf no active member is found and `createIfNull` is `true` and the group isn't full then it will create a new one using `x`, `y`, `key`, `frame`, and `visible`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstAlive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"description":"The first active group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getFirstAlive","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirstAlive","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":985,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\nassigns `x` and `y`, and returns the member.\n\nIf no inactive member is found and `createIfNull` is `true` and the group isn't full then it will create a new one using `x`, `y`, `key`, `frame`, and `visible`.\nThe new Game Object will have an active state set to `true`.\nUnless a new member is created, `key`, `frame`, and `visible` are ignored.","kind":"function","name":"getFirstDead","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Create a new Game Object if no matching members are found, using the following arguments.","name":"createIfNull"},{"type":{"names":["number"]},"optional":true,"description":"The horizontal position of the Game Object in the world.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The vertical position of the Game Object in the world.","name":"y"},{"type":{"names":["string"]},"optional":true,"defaultvalue":"defaultKey","description":"The texture key assigned to a new Game Object (if one is created).","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"defaultvalue":"defaultFrame","description":"A texture frame assigned to a new Game Object (if one is created).","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).","name":"visible"}],"returns":[{"type":{"names":["any"]},"description":"The first inactive group member, or a newly created member, or null."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getFirstDead","scope":"instance","inherits":"Phaser.GameObjects.Group#getFirstDead","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1010,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"{@link Phaser.GameObjects.Components.Animation#play Plays} an animation for all members of this group.","kind":"function","name":"playAnimation","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["string"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#playAnimation","scope":"instance","inherits":"Phaser.GameObjects.Group#playAnimation","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1028,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Whether this group's size at its {@link Phaser.GameObjects.Group#maxSize maximum}.","kind":"function","name":"isFull","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"True if the number of members equals {@link Phaser.GameObjects.Group#maxSize}."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#isFull","scope":"instance","inherits":"Phaser.GameObjects.Group#isFull","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1048,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Counts the number of active (or inactive) group members.","kind":"function","name":"countActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Count active (true) or inactive (false) group members.","name":"value"}],"returns":[{"type":{"names":["integer"]},"description":"The number of group members with an active state matching the `active` argument."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#countActive","scope":"instance","inherits":"Phaser.GameObjects.Group#countActive","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1075,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Counts the number of in-use (active) group members.","kind":"function","name":"getTotalUsed","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"The number of group members with an active state of true."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getTotalUsed","scope":"instance","inherits":"Phaser.GameObjects.Group#getTotalUsed","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"The difference of {@link Phaser.GameObjects.Group#maxSize} and the number of active group members.\n\nThis represents the number of group members that could be created or reactivated before reaching the size limit.","kind":"function","name":"getTotalFree","since":"3.0.0","returns":[{"type":{"names":["integer"]},"description":"maxSize minus the number of active group numbers; or a large number (if maxSize is -1)."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#getTotalFree","scope":"instance","inherits":"Phaser.GameObjects.Group#getTotalFree","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the property as defined in `key` of each group member to the given value.","kind":"function","name":"propertyValueSet","since":"3.21.0","params":[{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#propertyValueSet","scope":"instance","inherits":"Phaser.GameObjects.Group#propertyValueSet","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the property as defined in `key` of each group member.","kind":"function","name":"propertyValueInc","since":"3.21.0","params":[{"type":{"names":["string"]},"description":"The property to be updated.","name":"key"},{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#propertyValueInc","scope":"instance","inherits":"Phaser.GameObjects.Group#propertyValueInc","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1148,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the x of each group member.","kind":"function","name":"setX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setX","scope":"instance","inherits":"Phaser.GameObjects.Group#setX","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the y of each group member.","kind":"function","name":"setY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setY","scope":"instance","inherits":"Phaser.GameObjects.Group#setY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the x, y of each group member.","kind":"function","name":"setXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the `x` property to.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to set the `y` property to. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setXY","scope":"instance","inherits":"Phaser.GameObjects.Group#setXY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1204,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the x of each group member.","kind":"function","name":"incX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#incX","scope":"instance","inherits":"Phaser.GameObjects.Group#incX","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1222,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the y of each group member.","kind":"function","name":"incY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `y` property.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#incY","scope":"instance","inherits":"Phaser.GameObjects.Group#incY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1240,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Adds the given value to the x, y of each group member.","kind":"function","name":"incXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `x` property.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The amount to be added to the `y` property. If `undefined` or `null` it uses the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `x` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `y` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#incXY","scope":"instance","inherits":"Phaser.GameObjects.Group#incXY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1260,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Iterate through the group members changing the position of each element to be that of the element that came before\nit in the array (or after it if direction = 1)\n\nThe first group member position is set to x/y.","kind":"function","name":"shiftPosition","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The x coordinate to place the first item in the array at.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate to place the first item in the array at.","name":"y"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"The iteration direction. 0 = first to last and 1 = last to first.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#shiftPosition","scope":"instance","inherits":"Phaser.GameObjects.Group#shiftPosition","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1282,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the angle of each group member.","kind":"function","name":"angle","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the angle to, in degrees.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#angle","scope":"instance","inherits":"Phaser.GameObjects.Group#angle","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1300,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the rotation of each group member.","kind":"function","name":"rotate","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the rotation to, in radians.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#rotate","scope":"instance","inherits":"Phaser.GameObjects.Group#rotate","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Rotates each group member around the given point by the given angle.","kind":"function","name":"rotateAround","since":"3.21.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#rotateAround","scope":"instance","inherits":"Phaser.GameObjects.Group#rotateAround","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1336,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Rotates each group member around the given point by the given angle and distance.","kind":"function","name":"rotateAroundDistance","since":"3.21.0","params":[{"type":{"names":["Phaser.Types.Math.Vector2Like"]},"description":"Any object with public `x` and `y` properties.","name":"point"},{"type":{"names":["number"]},"description":"The angle to rotate by, in radians.","name":"angle"},{"type":{"names":["number"]},"description":"The distance from the point of rotation in pixels.","name":"distance"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#rotateAroundDistance","scope":"instance","inherits":"Phaser.GameObjects.Group#rotateAroundDistance","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1355,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the alpha of each group member.","kind":"function","name":"setAlpha","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the alpha to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Group#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the tint of each group member.","kind":"function","name":"setTint","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The tint being applied to top-left corner of item. If other parameters are given no value, this tint will be applied to whole item.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to top-right corner of item.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-left corner of item.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The tint to be applied to the bottom-right corner of item.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setTint","scope":"instance","inherits":"Phaser.GameObjects.Group#setTint","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1393,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the originX, originY of each group member.","kind":"function","name":"setOrigin","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the `originX` property to.","name":"originX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to set the `originY` property to. If `undefined` or `null` it uses the `originX` value.","name":"originY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `originY` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Group#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1413,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleX of each group member.","kind":"function","name":"scaleX","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#scaleX","scope":"instance","inherits":"Phaser.GameObjects.Group#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1431,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleY of each group member.","kind":"function","name":"scaleY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#scaleY","scope":"instance","inherits":"Phaser.GameObjects.Group#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1449,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the scaleX, scaleY of each group member.","kind":"function","name":"scaleXY","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to be added to the `scaleX` property.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The amount to be added to the `scaleY` property. If `undefined` or `null` it uses the `scaleX` value.","name":"scaleY"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleX` amount, multiplied by the iteration counter.","name":"stepX"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `scaleY` amount, multiplied by the iteration counter.","name":"stepY"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#scaleXY","scope":"instance","inherits":"Phaser.GameObjects.Group#scaleXY","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1469,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the depth of each group member.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"This is added to the `value` amount, multiplied by the iteration counter.","name":"step"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Group#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1487,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the blendMode of each group member.","kind":"function","name":"setBlendMode","since":"3.21.0","params":[{"type":{"names":["number"]},"description":"The amount to set the property to.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Group#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1504,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Passes all group members to the Input Manager to enable them for input with identical areas and callbacks.","kind":"function","name":"setHitArea","since":"3.21.0","params":[{"type":{"names":["*"]},"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"hitArea"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"hitAreaCallback"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setHitArea","scope":"instance","inherits":"Phaser.GameObjects.Group#setHitArea","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1522,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Shuffles the group members in place.","kind":"function","name":"shuffle","since":"3.21.0","returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#shuffle","scope":"instance","inherits":"Phaser.GameObjects.Group#shuffle","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Deactivates a member of this group.","kind":"function","name":"kill","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A member of this group.","name":"gameObject"}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#kill","scope":"instance","inherits":"Phaser.GameObjects.Group#kill","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1553,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Deactivates and hides a member of this group.","kind":"function","name":"killAndHide","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"A member of this group.","name":"gameObject"}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#killAndHide","scope":"instance","inherits":"Phaser.GameObjects.Group#killAndHide","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1570,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Sets the visible of each group member.","kind":"function","name":"setVisible","since":"3.21.0","params":[{"type":{"names":["boolean"]},"description":"The value to set the property to.","name":"value"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"An optional offset to start searching from within the items array.","name":"index"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":1,"description":"The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.","name":"direction"}],"returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Group#setVisible","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1589,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Toggles (flips) the visible state of each member of this group.","kind":"function","name":"toggleVisible","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.Group"]},"description":"This Group object."}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#toggleVisible","scope":"instance","inherits":"Phaser.GameObjects.Group#toggleVisible","inherited":true,"___s":true},{"meta":{"filename":"Group.js","lineno":1604,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/group"},"description":"Empties this group and removes it from the Scene.\n\nDoes not call {@link Phaser.GameObjects.Group#removeCallback}.","kind":"function","name":"destroy","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Also {@link Phaser.GameObjects.GameObject#destroy} each group member.","name":"destroyChildren"}],"memberof":"Phaser.Physics.Arcade.StaticGroup","longname":"Phaser.Physics.Arcade.StaticGroup#destroy","scope":"instance","inherits":"Phaser.GameObjects.Group#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Arcade.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Arcade.World","longname":"Phaser.Physics.Arcade.World#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal acceleration of this body.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setAccelerationX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationX","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical acceleration of this body.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setAccelerationY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationY","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical acceleration of this body.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal acceleration to apply.","name":"x"},{"type":{"names":["number"]},"description":"The amount of vertical acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setAcceleration","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAcceleration","inherited":true,"___s":true},{"meta":{"filename":"BodyScale.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the size of the physics body.","kind":"function","name":"setBodySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the body in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height of the body in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setBodySize","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyScale#setBodySize","inherited":true,"___s":true},{"meta":{"filename":"BodyScale.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the scale of the physics body.","kind":"function","name":"setBodyScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of the body.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The vertical scale of the body. If not given, will use the horizontal scale value.","name":"scaleY"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setBodyScale","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyScale#setBodyScale","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"getBodyType","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#getBodyType","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#getBodyType","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setTypeNone","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeNone","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":46,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setTypeA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeA","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setTypeB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeB","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the impact physics bounce, or restitution, value.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 (no rebound) and 1 (full rebound)","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setBounce","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the minimum velocity the body is allowed to be moving to be considered for rebound.","kind":"function","name":"setMinBounceVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum allowed velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setMinBounceVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Bounce#setMinBounceVelocity","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The bounce, or restitution, value of this body.\nA value between 0 (no rebound) and 1 (full rebound)","name":"bounce","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#bounce","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Bounce#bounce","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setAvsB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setAvsB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setAvsB","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setBvsA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setBvsA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setBvsA","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setCheckAgainstNone","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstNone","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setCheckAgainstA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstA","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setCheckAgainstB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstB","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"checkAgainst","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#checkAgainst","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#checkAgainst","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":29,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollideCallback","since":"3.0.0","params":[{"type":{"names":["CollideCallback"]},"description":"[description]","name":"callback"},{"type":{"names":["*"]},"description":"[description]","name":"scope"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setCollideCallback","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setCollideCallback","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollidesNever","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setCollidesNever","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setCollidesNever","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setLiteCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setLiteCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setLiteCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setPassiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setPassiveCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setPassiveCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setActiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setActiveCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setActiveCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":112,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFixedCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setFixedCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setFixedCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"collides","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#collides","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Collides#collides","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"[description]","name":"showBody"},{"type":{"names":["boolean"]},"description":"[description]","name":"showVelocity"},{"type":{"names":["number"]},"description":"[description]","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setDebug","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Debug#setDebug","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setDebugBodyColor","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Debug#setDebugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#debugShowBody","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugShowBody","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":75,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#debugShowVelocity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugShowVelocity","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#debugBodyColor","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setFrictionX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFrictionX","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setFrictionY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFrictionY","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setFriction","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setGravity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Gravity#setGravity","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"gravity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#gravity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Gravity#gravity","inherited":true,"___s":true},{"meta":{"filename":"Offset.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setOffset","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Offset#setOffset","inherited":true,"___s":true},{"meta":{"filename":"SetGameObject.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGameObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"[description]","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"[description]","name":"sync"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setGameObject","scope":"instance","inherits":"Phaser.Physics.Impact.Components.SetGameObject#setGameObject","inherited":true,"___s":true},{"meta":{"filename":"SetGameObject.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"syncGameObject","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#syncGameObject","scope":"instance","inherits":"Phaser.Physics.Impact.Components.SetGameObject#syncGameObject","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical velocities of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the maximum velocity this body can travel at.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The maximum allowed horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The maximum allowed vertical velocity. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactBody","longname":"Phaser.Physics.Impact.ImpactBody#setMaxVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setMaxVelocity","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#clearAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopRight","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#setBlendMode","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#depth","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#setDepth","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipX","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlip","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#resetFlip","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getRightCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBounds","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originX","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originY","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginX","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginY","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#pipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#initPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#setPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#resetPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#getPipelineName","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#width","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#height","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayWidth","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayHeight","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSizeToFrame","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSize","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setDisplaySize","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#texture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#frame","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#isCropped","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setTexture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setFrame","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#clearTint","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTint","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopRight","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomRight","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tint","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#isTinted","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#x","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#y","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#z","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#w","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scale","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleX","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleY","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#angle","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#rotation","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRandomPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRotation","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setAngle","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setScale","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setX","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setY","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setZ","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setW","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getParentRotation","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"Acceleration.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal acceleration of this body.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setAccelerationX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationX","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical acceleration of this body.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setAccelerationY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationY","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical acceleration of this body.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal acceleration to apply.","name":"x"},{"type":{"names":["number"]},"description":"The amount of vertical acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setAcceleration","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAcceleration","inherited":true,"___s":true},{"meta":{"filename":"BodyScale.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the size of the physics body.","kind":"function","name":"setBodySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the body in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height of the body in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setBodySize","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyScale#setBodySize","inherited":true,"___s":true},{"meta":{"filename":"BodyScale.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the scale of the physics body.","kind":"function","name":"setBodyScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of the body.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The vertical scale of the body. If not given, will use the horizontal scale value.","name":"scaleY"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setBodyScale","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyScale#setBodyScale","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"getBodyType","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#getBodyType","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#getBodyType","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setTypeNone","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeNone","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":46,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setTypeA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeA","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setTypeB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeB","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the impact physics bounce, or restitution, value.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 (no rebound) and 1 (full rebound)","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setBounce","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the minimum velocity the body is allowed to be moving to be considered for rebound.","kind":"function","name":"setMinBounceVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum allowed velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setMinBounceVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Bounce#setMinBounceVelocity","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The bounce, or restitution, value of this body.\nA value between 0 (no rebound) and 1 (full rebound)","name":"bounce","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#bounce","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Bounce#bounce","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setAvsB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setAvsB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setAvsB","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setBvsA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setBvsA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setBvsA","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setCheckAgainstNone","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstNone","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setCheckAgainstA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstA","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setCheckAgainstB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstB","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"checkAgainst","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#checkAgainst","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#checkAgainst","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":29,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollideCallback","since":"3.0.0","params":[{"type":{"names":["CollideCallback"]},"description":"[description]","name":"callback"},{"type":{"names":["*"]},"description":"[description]","name":"scope"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setCollideCallback","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setCollideCallback","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollidesNever","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setCollidesNever","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setCollidesNever","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setLiteCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setLiteCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setLiteCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setPassiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setPassiveCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setPassiveCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setActiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setActiveCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setActiveCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":112,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFixedCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFixedCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setFixedCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"collides","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#collides","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Collides#collides","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"[description]","name":"showBody"},{"type":{"names":["boolean"]},"description":"[description]","name":"showVelocity"},{"type":{"names":["number"]},"description":"[description]","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setDebug","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Debug#setDebug","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setDebugBodyColor","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Debug#setDebugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#debugShowBody","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugShowBody","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":75,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#debugShowVelocity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugShowVelocity","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#debugBodyColor","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFrictionX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFrictionX","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFrictionY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFrictionY","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setFriction","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setGravity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Gravity#setGravity","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"gravity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#gravity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Gravity#gravity","inherited":true,"___s":true},{"meta":{"filename":"Offset.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setOffset","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Offset#setOffset","inherited":true,"___s":true},{"meta":{"filename":"SetGameObject.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGameObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"[description]","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"[description]","name":"sync"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setGameObject","scope":"instance","inherits":"Phaser.Physics.Impact.Components.SetGameObject#setGameObject","inherited":true,"___s":true},{"meta":{"filename":"SetGameObject.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"syncGameObject","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#syncGameObject","scope":"instance","inherits":"Phaser.Physics.Impact.Components.SetGameObject#syncGameObject","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical velocities of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the maximum velocity this body can travel at.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The maximum allowed horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The maximum allowed vertical velocity. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactImage"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactImage","longname":"Phaser.Physics.Impact.ImpactImage#setMaxVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setMaxVelocity","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"The Animation Controller of this Sprite.","name":"anims","type":{"names":["Phaser.GameObjects.Components.Animation"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#anims","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Sprite#anims","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Start playing the given animation.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If an animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#play","scope":"instance","inherits":"Phaser.GameObjects.Sprite#play","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Build a JSON representation of this Sprite.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#toJSON","scope":"instance","inherits":"Phaser.GameObjects.Sprite#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#clearAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopRight","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#setBlendMode","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#depth","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#setDepth","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipX","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlip","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#resetFlip","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getRightCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBounds","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originX","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originY","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginX","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginY","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#pipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#initPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#setPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#resetPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#getPipelineName","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#width","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#height","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayWidth","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayHeight","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSizeToFrame","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSize","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setDisplaySize","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#texture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#frame","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#isCropped","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setTexture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setFrame","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#clearTint","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTint","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopRight","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomRight","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tint","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#isTinted","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#x","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#y","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#z","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#w","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scale","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleX","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleY","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#angle","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#rotation","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRandomPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRotation","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setAngle","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setScale","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setX","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setY","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setZ","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setW","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getParentRotation","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"Acceleration.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal acceleration of this body.","kind":"function","name":"setAccelerationX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setAccelerationX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationX","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical acceleration of this body.","kind":"function","name":"setAccelerationY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setAccelerationY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAccelerationY","inherited":true,"___s":true},{"meta":{"filename":"Acceleration.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical acceleration of this body.","kind":"function","name":"setAcceleration","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The amount of horizontal acceleration to apply.","name":"x"},{"type":{"names":["number"]},"description":"The amount of vertical acceleration to apply.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setAcceleration","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Acceleration#setAcceleration","inherited":true,"___s":true},{"meta":{"filename":"BodyScale.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the size of the physics body.","kind":"function","name":"setBodySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the body in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"width","description":"The height of the body in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setBodySize","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyScale#setBodySize","inherited":true,"___s":true},{"meta":{"filename":"BodyScale.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the scale of the physics body.","kind":"function","name":"setBodyScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of the body.","name":"scaleX"},{"type":{"names":["number"]},"optional":true,"description":"The vertical scale of the body. If not given, will use the horizontal scale value.","name":"scaleY"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setBodyScale","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyScale#setBodyScale","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"getBodyType","since":"3.0.0","returns":[{"type":{"names":["number"]},"description":"[description]"}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#getBodyType","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#getBodyType","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setTypeNone","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeNone","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":46,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setTypeA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeA","inherited":true,"___s":true},{"meta":{"filename":"BodyType.js","lineno":61,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setTypeB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setTypeB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.BodyType#setTypeB","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the impact physics bounce, or restitution, value.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A value between 0 (no rebound) and 1 (full rebound)","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setBounce","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the minimum velocity the body is allowed to be moving to be considered for rebound.","kind":"function","name":"setMinBounceVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The minimum allowed velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setMinBounceVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Bounce#setMinBounceVelocity","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"The bounce, or restitution, value of this body.\nA value between 0 (no rebound) and 1 (full rebound)","name":"bounce","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#bounce","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Bounce#bounce","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setAvsB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setAvsB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setAvsB","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setBvsA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setBvsA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setBvsA","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstNone","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setCheckAgainstNone","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstNone","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstA","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setCheckAgainstA","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstA","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCheckAgainstB","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setCheckAgainstB","scope":"instance","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstB","inherited":true,"___s":true},{"meta":{"filename":"CheckAgainst.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"checkAgainst","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#checkAgainst","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.CheckAgainst#checkAgainst","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":29,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollideCallback","since":"3.0.0","params":[{"type":{"names":["CollideCallback"]},"description":"[description]","name":"callback"},{"type":{"names":["*"]},"description":"[description]","name":"scope"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setCollideCallback","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setCollideCallback","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setCollidesNever","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setCollidesNever","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setCollidesNever","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setLiteCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setLiteCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setLiteCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setPassiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setPassiveCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setPassiveCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":97,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setActiveCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setActiveCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setActiveCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":112,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFixedCollision","since":"3.6.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFixedCollision","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Collides#setFixedCollision","inherited":true,"___s":true},{"meta":{"filename":"Collides.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"collides","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#collides","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Collides#collides","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebug","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"[description]","name":"showBody"},{"type":{"names":["boolean"]},"description":"[description]","name":"showVelocity"},{"type":{"names":["number"]},"description":"[description]","name":"bodyColor"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setDebug","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Debug#setDebug","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setDebugBodyColor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setDebugBodyColor","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Debug#setDebugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowBody","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#debugShowBody","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugShowBody","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":75,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugShowVelocity","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#debugShowVelocity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugShowVelocity","inherited":true,"___s":true},{"meta":{"filename":"Debug.js","lineno":96,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"debugBodyColor","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#debugBodyColor","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Debug#debugBodyColor","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFrictionX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFrictionX","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFrictionY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFrictionY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFrictionY","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setFriction","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGravity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setGravity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Gravity#setGravity","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","name":"gravity","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#gravity","scope":"instance","kind":"member","inherits":"Phaser.Physics.Impact.Components.Gravity#gravity","inherited":true,"___s":true},{"meta":{"filename":"Offset.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setOffset","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"[description]","name":"x"},{"type":{"names":["number"]},"description":"[description]","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"[description]","name":"height"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setOffset","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Offset#setOffset","inherited":true,"___s":true},{"meta":{"filename":"SetGameObject.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"setGameObject","since":"3.0.0","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"[description]","name":"gameObject"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"[description]","name":"sync"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setGameObject","scope":"instance","inherits":"Phaser.Physics.Impact.Components.SetGameObject#setGameObject","inherited":true,"___s":true},{"meta":{"filename":"SetGameObject.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"[description]","kind":"function","name":"syncGameObject","since":"3.0.0","returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#syncGameObject","scope":"instance","inherits":"Phaser.Physics.Impact.Components.SetGameObject#syncGameObject","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":50,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the horizontal and vertical velocities of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/impact/components"},"description":"Sets the maximum velocity this body can travel at.","kind":"function","name":"setMaxVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The maximum allowed horizontal velocity.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The maximum allowed vertical velocity. If not given, defaults to the horizontal value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.ImpactSprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Impact.ImpactSprite","longname":"Phaser.Physics.Impact.ImpactSprite#setMaxVelocity","scope":"instance","inherits":"Phaser.Physics.Impact.Components.Velocity#setMaxVelocity","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Impact.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Impact.World","longname":"Phaser.Physics.Impact.World#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#clearAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopRight","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#setBlendMode","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#depth","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#setDepth","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipX","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlip","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#resetFlip","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getRightCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBounds","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originX","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originY","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginX","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginY","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#pipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#initPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#setPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#resetPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#getPipelineName","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#width","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#height","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayWidth","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayHeight","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSizeToFrame","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSize","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setDisplaySize","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#texture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#frame","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#isCropped","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setTexture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setFrame","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#clearTint","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTint","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopRight","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomRight","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tint","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#isTinted","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#x","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#y","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#z","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#w","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scale","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleX","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleY","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#angle","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#rotation","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRandomPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRotation","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setAngle","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setScale","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setX","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setY","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setZ","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setW","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getParentRotation","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the restitution on the physics object.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setBounce","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\nTwo bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\ncategories are included in their collision masks (see {@link #setCollidesWith}).","kind":"function","name":"setCollisionCategory","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique category bitfield.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setCollisionCategory","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollisionCategory","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\nthey will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\nIf two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\nthey will never collide.","kind":"function","name":"setCollisionGroup","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique group index.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setCollisionGroup","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollisionGroup","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\ncollide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\nand `(categoryB & maskA) !== 0` are both true.","kind":"function","name":"setCollidesWith","since":"3.0.0","params":[{"type":{"names":["number","Array."]},"description":"A unique category bitfield, or an array of them.","name":"categories"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setCollidesWith","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollidesWith","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollide","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body starts colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setOnCollide","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollide","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideEnd","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body stops colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setOnCollideEnd","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideEnd","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideActive","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke for the duration of this body colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setOnCollideActive","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideActive","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideWith","since":"3.22.0","params":[{"type":{"names":["MatterJS.Body","Array."]},"description":"The body, or an array of bodies, to test for collisions with.","name":"body"},{"type":{"names":["function"]},"description":"The callback to invoke when this body collides with the given body or bodies.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setOnCollideWith","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideWith","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Applies a force to a body.","kind":"function","name":"applyForce","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#applyForce","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#applyForce","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":38,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Applies a force to a body from a given position.","kind":"function","name":"applyForceFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The position in which the force comes from.","name":"position"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#applyForceFrom","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#applyForceFrom","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the forward position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrust","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#thrust","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrust","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the left position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustLeft","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#thrustLeft","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrustLeft","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":102,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the right position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustRight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#thrustRight","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrustRight","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the back position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustBack","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#thrustBack","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrustBack","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets new friction values for this Game Object's Matter Body.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.","name":"air"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.","name":"fstatic"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFriction","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new air resistance for this Game Object's Matter Body.\nA value of 0 means the Body will never slow as it moves through space.\nThe higher the value, the faster a Body slows when moving through space.","kind":"function","name":"setFrictionAir","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new air resistance for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFrictionAir","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFrictionAir","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new static friction for this Game Object's Matter Body.\nA value of 0 means the Body will never \"stick\" when it is nearly stationary.\nThe higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.","kind":"function","name":"setFrictionStatic","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new static friction for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFrictionStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFrictionStatic","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A togglable function for ignoring world gravity in real-time on the current body.","kind":"function","name":"setIgnoreGravity","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to true to ignore the effect of world gravity, or false to not ignore it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setIgnoreGravity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the mass of the Game Object's Matter Body.","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setMass","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Mass#setMass","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets density of the body.","kind":"function","name":"setDensity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new density of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setDensity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Mass#setDensity","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The body's center of mass.\n\nCalling this creates a new `Vector2 each time to avoid mutation.\n\nIf you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.","name":"centerOfMass","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.10.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The center of mass."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#centerOfMass","scope":"instance","kind":"member","inherits":"Phaser.Physics.Matter.Components.Mass#centerOfMass","inherited":true,"___s":true},{"meta":{"filename":"Sensor.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body belonging to this Game Object to be a sensor.\nSensors trigger collision events, but don't react with colliding body physically.","kind":"function","name":"setSensor","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as a sensor, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSensor","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sensor#setSensor","inherited":true,"___s":true},{"meta":{"filename":"Sensor.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Is the body belonging to this Game Object a sensor or not?","kind":"function","name":"isSensor","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is a sensor, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#isSensor","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sensor#isSensor","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":23,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on a Game Object to a rectangle.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setRectangle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setRectangle","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setRectangle","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on a Game Object to a circle.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setCircle","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setCircle","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":62,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on the Game Object to a polygon shape.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setPolygon","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number of sides the polygon will have.","name":"sides"},{"type":{"names":["number"]},"description":"The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setPolygon","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setPolygon","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on the Game Object to a trapezoid shape.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setTrapezoid","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the trapezoid Body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the trapezoid Body.","name":"height"},{"type":{"names":["number"]},"description":"The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.","name":"slope"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setTrapezoid","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setTrapezoid","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set this Game Object to use the given existing Matter Body.\n\nThe body is first removed from the world before being added to this Game Object.","kind":"function","name":"setExistingBody","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Body this Game Object should use.","name":"body"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setExistingBody","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setExistingBody","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set this Game Object to create and use a new Body based on the configuration object given.\n\nCalling this method resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setBody","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Physics.Matter.MatterSetBodyConfig"]},"description":"Either a string, such as `circle`, or a Matter Set Body Configuration object.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setBody","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setBody","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets this Body to sleep.","kind":"function","name":"setToSleep","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setToSleep","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setToSleep","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Wakes this Body if asleep.","kind":"function","name":"setAwake","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setAwake","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setAwake","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).","kind":"function","name":"setSleepThreshold","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSleepThreshold","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepThreshold","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enable sleep and wake events for this body.\n\nBy default when a body goes to sleep, or wakes up, it will not emit any events.\n\nThe events are emitted by the Matter World instance and can be listened to via\nthe `SLEEP_START` and `SLEEP_END` events.","kind":"function","name":"setSleepEvents","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` if you want the sleep start event to be emitted for this body.","name":"start"},{"type":{"names":["boolean"]},"description":"`true` if you want the sleep end event to be emitted for this body.","name":"end"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSleepEvents","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepEvents","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":88,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep Start event for this body.","kind":"function","name":"setSleepStartEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSleepStartEvent","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep End event for this body.","kind":"function","name":"setSleepEndEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setSleepEndEvent","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent","inherited":true,"___s":true},{"meta":{"filename":"Static.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Changes the physics body to be either static `true` or dynamic `false`.","kind":"function","name":"setStatic","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as being static, or `false` to make it dynamic.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Static#setStatic","inherited":true,"___s":true},{"meta":{"filename":"Static.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Returns `true` if the body is static, otherwise `false` for a dynamic body.","kind":"function","name":"isStatic","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is static, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#isStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Static#isStatic","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":239,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Setting fixed rotation sets the Body inertia to Infinity, which stops it\nfrom being able to rotate when forces are applied to it.","kind":"function","name":"setFixedRotation","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Image"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setFixedRotation","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Transform#setFixedRotation","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the angular velocity of the body instantly.\nPosition, angle, force etc. are unchanged.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setAngularVelocity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setAngularVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets both the horizontal and vertical velocity of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value, it can be either positive or negative. If not given, it will be the same as the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Image","longname":"Phaser.Physics.Matter.Image#setVelocity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":89,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"The Animation Controller of this Sprite.","name":"anims","type":{"names":["Phaser.GameObjects.Components.Animation"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#anims","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Sprite#anims","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Start playing the given animation.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The string-based key of the animation to play.","name":"key"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If an animation is already playing then ignore this call.","name":"ignoreIfPlaying"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Optionally start the animation playing from this frame index.","name":"startFrame"}],"returns":[{"type":{"names":["Phaser.GameObjects.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#play","scope":"instance","inherits":"Phaser.GameObjects.Sprite#play","inherited":true,"___s":true},{"meta":{"filename":"Sprite.js","lineno":139,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/sprite"},"description":"Build a JSON representation of this Sprite.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#toJSON","scope":"instance","inherits":"Phaser.GameObjects.Sprite#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This GameObject."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":545,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Destroys this Game Object removing it from the Display List and Update List and\nsevering all ties to parent resources.\n\nAlso removes itself from the Input Manager and Physics Manager if previously enabled.\n\nUse this to remove a Game Object from your game if you don't ever plan to use it again.\nAs long as no reference to it exists within your own code it should become free for\ngarbage collection by the browser.\n\nIf you just want to temporarily disable an object then look at using the\nGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.","kind":"function","name":"destroy","fires":["Phaser.GameObjects.Events#event:DESTROY"],"since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Is this Game Object being destroyed as the result of a Scene shutdown?","name":"fromScene"}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#destroy","scope":"instance","inherits":"Phaser.GameObjects.GameObject#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#clearAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#setAlpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alpha","___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaTopRight","___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#blendMode","___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"overrides":"Phaser.GameObjects.Components.BlendMode#setBlendMode","___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#depth","___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"overrides":"Phaser.GameObjects.Components.Depth#setDepth","___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipX","___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#flipY","___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#toggleFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipX","___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlipY","___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#setFlip","___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"overrides":"Phaser.GameObjects.Components.Flip#resetFlip","___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getTopRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getRightCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBottomRight","___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"overrides":"Phaser.GameObjects.Components.GetBounds#getBounds","___s":true},{"meta":{"filename":"Mask.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Mask this Game Object is using during render.","name":"mask","type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#mask","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Mask#mask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the mask that this Game Object will use to render with.\n\nThe mask must have been previously created and can be either a GeometryMask or a BitmapMask.\nNote: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.\n\nIf a mask is already set on this Game Object it will be immediately replaced.\n\nMasks are positioned in global space and are not relative to the Game Object to which they\nare applied. The reason for this is that multiple Game Objects can all share the same mask.\n\nMasks have no impact on physics or input detection. They are purely a rendering component\nthat allows you to limit what is visible during the render pass.","kind":"function","name":"setMask","since":"3.6.2","params":[{"type":{"names":["Phaser.Display.Masks.BitmapMask","Phaser.Display.Masks.GeometryMask"]},"description":"The mask this Game Object will use when rendering.","name":"mask"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#setMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears the mask that this Game Object was using.","kind":"function","name":"clearMask","since":"3.6.2","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Destroy the mask before clearing it?","name":"destroyMask"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#clearMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#clearMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":80,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Bitmap Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a renderable Game Object.\nA renderable Game Object is one that uses a texture to render with, such as an\nImage, Sprite, Render Texture or BitmapText.\n\nIf you do not provide a renderable object, and this Game Object has a texture,\nit will use itself as the object. This means you can call this method to create\na Bitmap Mask from any renderable Game Object.","kind":"function","name":"createBitmapMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"optional":true,"description":"A renderable Game Object that uses a texture, such as a Sprite.","name":"renderable"}],"returns":[{"type":{"names":["Phaser.Display.Masks.BitmapMask"]},"description":"This Bitmap Mask that was created."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#createBitmapMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createBitmapMask","inherited":true,"___s":true},{"meta":{"filename":"Mask.js","lineno":110,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Creates and returns a Geometry Mask. This mask can be used by any Game Object,\nincluding this one.\n\nTo create the mask you need to pass in a reference to a Graphics Game Object.\n\nIf you do not provide a graphics object, and this Game Object is an instance\nof a Graphics object, then it will use itself to create the mask.\n\nThis means you can call this method to create a Geometry Mask from any Graphics Game Object.","kind":"function","name":"createGeometryMask","since":"3.6.2","params":[{"type":{"names":["Phaser.GameObjects.Graphics"]},"optional":true,"description":"A Graphics Game Object. The geometry within it will be used as the mask.","name":"graphics"}],"returns":[{"type":{"names":["Phaser.Display.Masks.GeometryMask"]},"description":"This Geometry Mask that was created."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#createGeometryMask","scope":"instance","inherits":"Phaser.GameObjects.Components.Mask#createGeometryMask","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originX","___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#originY","___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginX","___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#displayOriginY","___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"overrides":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#pipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#initPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#setPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#resetPipeline","___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"overrides":"Phaser.GameObjects.Components.Pipeline#getPipelineName","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"overrides":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","___s":true},{"meta":{"filename":"Size.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#width","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#width","___s":true},{"meta":{"filename":"Size.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#height","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#height","___s":true},{"meta":{"filename":"Size.js","lineno":53,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayWidth","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayWidth","___s":true},{"meta":{"filename":"Size.js","lineno":78,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Size#displayHeight","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#displayHeight","___s":true},{"meta":{"filename":"Size.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the size of this Game Object to be that of the given Frame.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSizeToFrame","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The frame to base the size of this Game Object on.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSizeToFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSizeToFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSizeToFrame","___s":true},{"meta":{"filename":"Size.js","lineno":131,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setSize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setSize","___s":true},{"meta":{"filename":"Size.js","lineno":158,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.Size#setDisplaySize","inherited":true,"overrides":"Phaser.GameObjects.Components.Size#setDisplaySize","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture this Game Object is using to render with.","name":"texture","type":{"names":["Phaser.Textures.Texture","Phaser.Textures.CanvasTexture"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#texture","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#texture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#texture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The Texture Frame this Game Object is using to render with.","name":"frame","type":{"names":["Phaser.Textures.Frame"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#frame","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#frame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#frame","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"A boolean flag indicating if this Game Object is being cropped or not.\nYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\nEqually, calling `setCrop` with no arguments will reset the crop and disable it.","name":"isCropped","type":{"names":["boolean"]},"since":"3.11.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#isCropped","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.TextureCrop#isCropped","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#isCropped","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":48,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Applies a crop to a texture based Game Object, such as a Sprite or Image.\n\nThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\n\nCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\nchanges what is shown when rendered.\n\nThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\n\nTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\nhalf of it, you could call `setCrop(0, 0, 400, 600)`.\n\nIt is also scaled to match the Game Object scale automatically. Therefore a crop rect of 100x50 would crop\nan area of 200x100 when applied to a Game Object that had a scale factor of 2.\n\nYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\n\nCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\n\nYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\nthe renderer to skip several internal calculations.","kind":"function","name":"setCrop","since":"3.11.0","params":[{"type":{"names":["number","Phaser.Geom.Rectangle"]},"optional":true,"description":"The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.","name":"x"},{"type":{"names":["number"]},"optional":true,"description":"The y coordinate to start the crop from.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the crop rectangle in pixels.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the crop rectangle in pixels.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setCrop","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setCrop","inherited":true,"___s":true},{"meta":{"filename":"TextureCrop.js","lineno":106,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the texture and frame this Game Object will use to render with.\n\nTextures are referenced by their string-based keys, as stored in the Texture Manager.","kind":"function","name":"setTexture","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the texture to be used, as stored in the Texture Manager.","name":"key"},{"type":{"names":["string","integer"]},"optional":true,"description":"The name or index of the frame within the Texture.","name":"frame"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setTexture","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setTexture","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setTexture","___s":true},{"meta":{"filename":"TextureCrop.js","lineno":126,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the frame this Game Object will use to render with.\n\nThe Frame has to belong to the current Texture being used.\n\nIt can be either a string or an index.\n\nCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\nIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.","kind":"function","name":"setFrame","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"description":"The name or index of the frame within the Texture.","name":"frame"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the size of the Game Object?","name":"updateSize"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should this call adjust the origin of the Game Object?","name":"updateOrigin"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.TextureCrop#setFrame","inherited":true,"overrides":"Phaser.GameObjects.Components.Texture#setFrame","___s":true},{"meta":{"filename":"Tint.js","lineno":83,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Fill or additive?","name":"tintFill","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.11.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tintFill","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all tint values associated with this Game Object.\n\nImmediately sets the color values back to 0xffffff and the tint type to 'additive',\nwhich results in no visible change to the texture.","kind":"function","name":"clearTint","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#clearTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#clearTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#clearTint","___s":true},{"meta":{"filename":"Tint.js","lineno":114,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets an additive tint on this Game Object.\n\nThe tint works by taking the pixel color values from the Game Objects texture, and then\nmultiplying it by the color value of the tint. You can provide either one color value,\nin which case the whole Game Object will be tinted in that color. Or you can provide a color\nper corner. The colors are blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being an additive tint to a fill based tint set the property `tintFill` to `true`.","kind":"function","name":"setTint","since":"3.0.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setTint","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTint","___s":true},{"meta":{"filename":"Tint.js","lineno":164,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets a fill-based tint on this Game Object.\n\nUnlike an additive tint, a fill-tint literally replaces the pixel colors from the texture\nwith those in the tint. You can use this for effects such as making a player flash 'white'\nif hit by something. You can provide either one color value, in which case the whole\nGame Object will be rendered in that color. Or you can provide a color per corner. The colors\nare blended together across the extent of the Game Object.\n\nTo modify the tint color once set, either call this method again with new values or use the\n`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight,\n`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\n\nTo remove a tint call `clearTint`.\n\nTo swap this from being a fill-tint to an additive tint set the property `tintFill` to `false`.","kind":"function","name":"setTintFill","since":"3.11.0","params":[{"type":{"names":["integer"]},"optional":true,"defaultvalue":"0xffffff","description":"The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.","name":"topLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the top-right of the Game Object.","name":"topRight"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-left of the Game Object.","name":"bottomLeft"},{"type":{"names":["integer"]},"optional":true,"description":"The tint being applied to the bottom-right of the Game Object.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setTintFill","scope":"instance","inherits":"Phaser.GameObjects.Components.Tint#setTintFill","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#setTintFill","___s":true},{"meta":{"filename":"Tint.js","lineno":201,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tintTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintTopRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tintTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintTopRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintTopRight","___s":true},{"meta":{"filename":"Tint.js","lineno":249,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomLeft","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tintBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomLeft","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomLeft","___s":true},{"meta":{"filename":"Tint.js","lineno":273,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"tintBottomRight","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tintBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tintBottomRight","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tintBottomRight","___s":true},{"meta":{"filename":"Tint.js","lineno":297,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The tint value being applied to the whole of the Game Object.\nThis property is a setter-only. Use the properties `tintTopLeft` etc to read the current tint value.","name":"tint","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#tint","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#tint","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#tint","___s":true},{"meta":{"filename":"Tint.js","lineno":314,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Does this Game Object have a tint applied to it or not?","name":"isTinted","type":{"names":["boolean"]},"readonly":true,"since":"3.11.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#isTinted","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Tint#isTinted","inherited":true,"overrides":"Phaser.GameObjects.Components.Tint#isTinted","___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#x","___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#y","___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#z","___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#w","___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scale","___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleX","___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#scaleY","___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#angle","___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#rotation","___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRandomPosition","___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setRotation","___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setAngle","___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setScale","___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setX","___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setY","___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setZ","___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#setW","___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"overrides":"Phaser.GameObjects.Components.Transform#getParentRotation","___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#visible","___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object instance."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"overrides":"Phaser.GameObjects.Components.Visible#setVisible","___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the restitution on the physics object.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setBounce","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\nTwo bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\ncategories are included in their collision masks (see {@link #setCollidesWith}).","kind":"function","name":"setCollisionCategory","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique category bitfield.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setCollisionCategory","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollisionCategory","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\nthey will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\nIf two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\nthey will never collide.","kind":"function","name":"setCollisionGroup","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique group index.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setCollisionGroup","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollisionGroup","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\ncollide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\nand `(categoryB & maskA) !== 0` are both true.","kind":"function","name":"setCollidesWith","since":"3.0.0","params":[{"type":{"names":["number","Array."]},"description":"A unique category bitfield, or an array of them.","name":"categories"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setCollidesWith","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollidesWith","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollide","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body starts colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setOnCollide","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollide","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideEnd","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body stops colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setOnCollideEnd","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideEnd","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideActive","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke for the duration of this body colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setOnCollideActive","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideActive","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideWith","since":"3.22.0","params":[{"type":{"names":["MatterJS.Body","Array."]},"description":"The body, or an array of bodies, to test for collisions with.","name":"body"},{"type":{"names":["function"]},"description":"The callback to invoke when this body collides with the given body or bodies.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setOnCollideWith","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideWith","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Applies a force to a body.","kind":"function","name":"applyForce","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#applyForce","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#applyForce","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":38,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Applies a force to a body from a given position.","kind":"function","name":"applyForceFrom","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The position in which the force comes from.","name":"position"},{"type":{"names":["Phaser.Math.Vector2"]},"description":"A Vector that specifies the force to apply.","name":"force"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#applyForceFrom","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#applyForceFrom","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":56,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the forward position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrust","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#thrust","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrust","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the left position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustLeft","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#thrustLeft","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrustLeft","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":102,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the right position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustRight","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#thrustRight","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrustRight","inherited":true,"___s":true},{"meta":{"filename":"Force.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Apply thrust to the back position of the body.\n\nUse very small values, such as 0.1, depending on the mass and required speed.","kind":"function","name":"thrustBack","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A speed value to be applied to a directional force.","name":"speed"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#thrustBack","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Force#thrustBack","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets new friction values for this Game Object's Matter Body.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.","name":"air"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.","name":"fstatic"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFriction","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new air resistance for this Game Object's Matter Body.\nA value of 0 means the Body will never slow as it moves through space.\nThe higher the value, the faster a Body slows when moving through space.","kind":"function","name":"setFrictionAir","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new air resistance for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFrictionAir","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFrictionAir","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new static friction for this Game Object's Matter Body.\nA value of 0 means the Body will never \"stick\" when it is nearly stationary.\nThe higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.","kind":"function","name":"setFrictionStatic","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new static friction for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFrictionStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFrictionStatic","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A togglable function for ignoring world gravity in real-time on the current body.","kind":"function","name":"setIgnoreGravity","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to true to ignore the effect of world gravity, or false to not ignore it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setIgnoreGravity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the mass of the Game Object's Matter Body.","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setMass","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Mass#setMass","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets density of the body.","kind":"function","name":"setDensity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new density of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setDensity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Mass#setDensity","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The body's center of mass.\n\nCalling this creates a new `Vector2 each time to avoid mutation.\n\nIf you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.","name":"centerOfMass","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.10.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The center of mass."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#centerOfMass","scope":"instance","kind":"member","inherits":"Phaser.Physics.Matter.Components.Mass#centerOfMass","inherited":true,"___s":true},{"meta":{"filename":"Sensor.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body belonging to this Game Object to be a sensor.\nSensors trigger collision events, but don't react with colliding body physically.","kind":"function","name":"setSensor","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as a sensor, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSensor","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sensor#setSensor","inherited":true,"___s":true},{"meta":{"filename":"Sensor.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Is the body belonging to this Game Object a sensor or not?","kind":"function","name":"isSensor","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is a sensor, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#isSensor","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sensor#isSensor","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":23,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on a Game Object to a rectangle.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setRectangle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setRectangle","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setRectangle","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on a Game Object to a circle.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setCircle","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The radius of the circle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setCircle","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setCircle","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":62,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on the Game Object to a polygon shape.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setPolygon","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The number of sides the polygon will have.","name":"sides"},{"type":{"names":["number"]},"description":"The \"radius\" of the polygon, i.e. the distance from its center to any vertex. This is also the radius of its circumcircle.","name":"radius"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setPolygon","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setPolygon","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body on the Game Object to a trapezoid shape.\n\nCalling this methods resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setTrapezoid","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The width of the trapezoid Body.","name":"width"},{"type":{"names":["number"]},"description":"The height of the trapezoid Body.","name":"height"},{"type":{"names":["number"]},"description":"The slope of the trapezoid. 0 creates a rectangle, while 1 creates a triangle. Positive values make the top side shorter, while negative values make the bottom side shorter.","name":"slope"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setTrapezoid","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setTrapezoid","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":103,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set this Game Object to use the given existing Matter Body.\n\nThe body is first removed from the world before being added to this Game Object.","kind":"function","name":"setExistingBody","since":"3.0.0","params":[{"type":{"names":["MatterJS.BodyType"]},"description":"The Body this Game Object should use.","name":"body"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Should the body be immediately added to the World?","name":"addToWorld"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setExistingBody","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setExistingBody","inherited":true,"___s":true},{"meta":{"filename":"SetBody.js","lineno":175,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set this Game Object to create and use a new Body based on the configuration object given.\n\nCalling this method resets previous properties you may have set on the body, including\nplugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.","kind":"function","name":"setBody","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Physics.Matter.MatterSetBodyConfig"]},"description":"Either a string, such as `circle`, or a Matter Set Body Configuration object.","name":"config"},{"type":{"names":["Phaser.Types.Physics.Matter.MatterBodyConfig"]},"optional":true,"description":"An optional Body configuration object that is used to set initial Body properties on creation.","name":"options"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setBody","scope":"instance","inherits":"Phaser.Physics.Matter.Components.SetBody#setBody","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets this Body to sleep.","kind":"function","name":"setToSleep","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setToSleep","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setToSleep","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Wakes this Body if asleep.","kind":"function","name":"setAwake","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setAwake","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setAwake","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).","kind":"function","name":"setSleepThreshold","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSleepThreshold","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepThreshold","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enable sleep and wake events for this body.\n\nBy default when a body goes to sleep, or wakes up, it will not emit any events.\n\nThe events are emitted by the Matter World instance and can be listened to via\nthe `SLEEP_START` and `SLEEP_END` events.","kind":"function","name":"setSleepEvents","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` if you want the sleep start event to be emitted for this body.","name":"start"},{"type":{"names":["boolean"]},"description":"`true` if you want the sleep end event to be emitted for this body.","name":"end"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSleepEvents","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepEvents","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":88,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep Start event for this body.","kind":"function","name":"setSleepStartEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSleepStartEvent","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep End event for this body.","kind":"function","name":"setSleepEndEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setSleepEndEvent","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent","inherited":true,"___s":true},{"meta":{"filename":"Static.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Changes the physics body to be either static `true` or dynamic `false`.","kind":"function","name":"setStatic","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as being static, or `false` to make it dynamic.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Static#setStatic","inherited":true,"___s":true},{"meta":{"filename":"Static.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Returns `true` if the body is static, otherwise `false` for a dynamic body.","kind":"function","name":"isStatic","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is static, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#isStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Static#isStatic","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":239,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Setting fixed rotation sets the Body inertia to Infinity, which stops it\nfrom being able to rotate when forces are applied to it.","kind":"function","name":"setFixedRotation","since":"3.0.0","returns":[{"type":{"names":["Phaser.Physics.Matter.Sprite"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setFixedRotation","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Transform#setFixedRotation","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the angular velocity of the body instantly.\nPosition, angle, force etc. are unchanged.","kind":"function","name":"setAngularVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The angular velocity.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setAngularVelocity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setAngularVelocity","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the horizontal velocity of the physics body.","kind":"function","name":"setVelocityX","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setVelocityX","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setVelocityX","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets vertical velocity of the physics body.","kind":"function","name":"setVelocityY","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The vertical velocity value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setVelocityY","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setVelocityY","inherited":true,"___s":true},{"meta":{"filename":"Velocity.js","lineno":73,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets both the horizontal and vertical velocity of the physics body.","kind":"function","name":"setVelocity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal velocity value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical velocity value, it can be either positive or negative. If not given, it will be the same as the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.Sprite","longname":"Phaser.Physics.Matter.Sprite#setVelocity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Velocity#setVelocity","inherited":true,"___s":true},{"meta":{"filename":"Bounce.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the restitution on the physics object.","kind":"function","name":"setBounce","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"A Number that defines the restitution (elasticity) of the body. The value is always positive and is in the range (0, 1). A value of 0 means collisions may be perfectly inelastic and no bouncing may occur. A value of 0.8 means the body may bounce back with approximately 80% of its kinetic energy. Note that collision response is based on pairs of bodies, and that restitution values are combined with the following formula: `Math.max(bodyA.restitution, bodyB.restitution)`","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setBounce","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Bounce#setBounce","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31.\nTwo bodies with different collision groups (see {@link #setCollisionGroup}) will only collide if their collision\ncategories are included in their collision masks (see {@link #setCollidesWith}).","kind":"function","name":"setCollisionCategory","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique category bitfield.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setCollisionCategory","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollisionCategory","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values,\nthey will collide according to the usual rules (see {@link #setCollisionCategory} and {@link #setCollisionGroup}).\nIf two Matter Bodies have the same positive value, they will always collide; if they have the same negative value,\nthey will never collide.","kind":"function","name":"setCollisionGroup","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"Unique group index.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setCollisionGroup","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollisionGroup","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only\ncollide if each one includes the other's category in its mask based on a bitwise AND, i.e. `(categoryA & maskB) !== 0`\nand `(categoryB & maskA) !== 0` are both true.","kind":"function","name":"setCollidesWith","since":"3.0.0","params":[{"type":{"names":["number","Array."]},"description":"A unique category bitfield, or an array of them.","name":"categories"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setCollidesWith","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setCollidesWith","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":87,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollide","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body starts colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setOnCollide","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollide","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideEnd","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke when this body stops colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setOnCollideEnd","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideEnd","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":127,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideActive","since":"3.22.0","params":[{"type":{"names":["function"]},"description":"The callback to invoke for the duration of this body colliding with another.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setOnCollideActive","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideActive","inherited":true,"___s":true},{"meta":{"filename":"Collision.js","lineno":147,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The callback is sent a reference to the other body, along with a `Phaser.Types.Physics.Matter.MatterCollisionData` object.\n\nThis does not change the bodies collision category, group or filter. Those must be set in addition\nto the callback.","kind":"function","name":"setOnCollideWith","since":"3.22.0","params":[{"type":{"names":["MatterJS.Body","Array."]},"description":"The body, or an array of bodies, to test for collisions with.","name":"body"},{"type":{"names":["function"]},"description":"The callback to invoke when this body collides with the given body or bodies.","name":"callback"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setOnCollideWith","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Collision#setOnCollideWith","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets new friction values for this Game Object's Matter Body.","kind":"function","name":"setFriction","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.","name":"value"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.","name":"air"},{"type":{"names":["number"]},"optional":true,"description":"If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never \"stick\" when it is nearly stationary.","name":"fstatic"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setFriction","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFriction","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":44,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new air resistance for this Game Object's Matter Body.\nA value of 0 means the Body will never slow as it moves through space.\nThe higher the value, the faster a Body slows when moving through space.","kind":"function","name":"setFrictionAir","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new air resistance for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setFrictionAir","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFrictionAir","inherited":true,"___s":true},{"meta":{"filename":"Friction.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets a new static friction for this Game Object's Matter Body.\nA value of 0 means the Body will never \"stick\" when it is nearly stationary.\nThe higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.","kind":"function","name":"setFrictionStatic","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new static friction for the Body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setFrictionStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Friction#setFrictionStatic","inherited":true,"___s":true},{"meta":{"filename":"Gravity.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"A togglable function for ignoring world gravity in real-time on the current body.","kind":"function","name":"setIgnoreGravity","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"Set to true to ignore the effect of world gravity, or false to not ignore it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setIgnoreGravity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":18,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the mass of the Game Object's Matter Body.","kind":"function","name":"setMass","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new mass of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setMass","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Mass#setMass","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":35,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets density of the body.","kind":"function","name":"setDensity","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new density of the body.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setDensity","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Mass#setDensity","inherited":true,"___s":true},{"meta":{"filename":"Mass.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"The body's center of mass.\n\nCalling this creates a new `Vector2 each time to avoid mutation.\n\nIf you only need to read the value and won't change it, you can get it from `GameObject.body.centerOfMass`.","name":"centerOfMass","type":{"names":["Phaser.Math.Vector2"]},"readonly":true,"since":"3.10.0","returns":[{"type":{"names":["Phaser.Math.Vector2"]},"description":"The center of mass."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#centerOfMass","scope":"instance","kind":"member","inherits":"Phaser.Physics.Matter.Components.Mass#centerOfMass","inherited":true,"___s":true},{"meta":{"filename":"Sensor.js","lineno":15,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Set the body belonging to this Game Object to be a sensor.\nSensors trigger collision events, but don't react with colliding body physically.","kind":"function","name":"setSensor","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as a sensor, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setSensor","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sensor#setSensor","inherited":true,"___s":true},{"meta":{"filename":"Sensor.js","lineno":33,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Is the body belonging to this Game Object a sensor or not?","kind":"function","name":"isSensor","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is a sensor, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#isSensor","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sensor#isSensor","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":19,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets this Body to sleep.","kind":"function","name":"setToSleep","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setToSleep","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setToSleep","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":32,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Wakes this Body if asleep.","kind":"function","name":"setAwake","since":"3.22.0","returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setAwake","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setAwake","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Sets the number of updates in which this body must have near-zero velocity before it is set as sleeping (if sleeping is enabled by the engine).","kind":"function","name":"setSleepThreshold","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":60,"description":"A `Number` that defines the number of updates in which this body must have near-zero velocity before it is set as sleeping.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setSleepThreshold","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepThreshold","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enable sleep and wake events for this body.\n\nBy default when a body goes to sleep, or wakes up, it will not emit any events.\n\nThe events are emitted by the Matter World instance and can be listened to via\nthe `SLEEP_START` and `SLEEP_END` events.","kind":"function","name":"setSleepEvents","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` if you want the sleep start event to be emitted for this body.","name":"start"},{"type":{"names":["boolean"]},"description":"`true` if you want the sleep end event to be emitted for this body.","name":"end"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setSleepEvents","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepEvents","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":88,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep Start event for this body.","kind":"function","name":"setSleepStartEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setSleepStartEvent","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepStartEvent","inherited":true,"___s":true},{"meta":{"filename":"Sleep.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Enables or disables the Sleep End event for this body.","kind":"function","name":"setSleepEndEvent","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to enable the sleep event, or `false` to disable it.","name":"value"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.TileBody"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setSleepEndEvent","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Sleep#setSleepEndEvent","inherited":true,"___s":true},{"meta":{"filename":"Static.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Changes the physics body to be either static `true` or dynamic `false`.","kind":"function","name":"setStatic","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"`true` to set the body as being static, or `false` to make it dynamic.","name":"value"}],"returns":[{"type":{"names":["Phaser.GameObjects.GameObject"]},"description":"This Game Object."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#setStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Static#setStatic","inherited":true,"___s":true},{"meta":{"filename":"Static.js","lineno":34,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/physics/matter-js/components"},"description":"Returns `true` if the body is static, otherwise `false` for a dynamic body.","kind":"function","name":"isStatic","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the body is static, otherwise `false`."}],"memberof":"Phaser.Physics.Matter.TileBody","longname":"Phaser.Physics.Matter.TileBody#isStatic","scope":"instance","inherits":"Phaser.Physics.Matter.Components.Static#isStatic","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Physics.Matter.World"]},"description":"`this`."}],"memberof":"Phaser.Physics.Matter.World","longname":"Phaser.Physics.Matter.World#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BasePlugin.js","lineno":49,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The PluginManager calls this method on a Global Plugin when the plugin is first instantiated.\nIt will never be called again on this instance.\nIn here you can set-up whatever you need for this plugin to run.\nIf a plugin is set to automatically start then `BasePlugin.start` will be called immediately after this.\nOn a Scene Plugin, this method is never called. Use {@link Phaser.Plugins.ScenePlugin#boot} instead.","kind":"function","name":"init","since":"3.8.0","params":[{"type":{"names":["any"]},"optional":true,"nullable":true,"description":"A value specified by the user, if any, from the `data` property of the plugin's configuration object (if started at game boot) or passed in the PluginManager's `install` method (if started manually).","name":"data"}],"memberof":"Phaser.Plugins.ScenePlugin","longname":"Phaser.Plugins.ScenePlugin#init","scope":"instance","inherits":"Phaser.Plugins.BasePlugin#init","inherited":true,"___s":true},{"meta":{"filename":"BasePlugin.js","lineno":65,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The PluginManager calls this method on a Global Plugin when the plugin is started.\nIf a plugin is stopped, and then started again, this will get called again.\nTypically called immediately after `BasePlugin.init`.\nOn a Scene Plugin, this method is never called.","kind":"function","name":"start","since":"3.8.0","memberof":"Phaser.Plugins.ScenePlugin","longname":"Phaser.Plugins.ScenePlugin#start","scope":"instance","inherits":"Phaser.Plugins.BasePlugin#start","inherited":true,"___s":true},{"meta":{"filename":"BasePlugin.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/plugins"},"description":"The PluginManager calls this method on a Global Plugin when the plugin is stopped.\nThe game code has requested that your plugin stop doing whatever it does.\nIt is now considered as 'inactive' by the PluginManager.\nHandle that process here (i.e. stop listening for events, etc)\nIf the plugin is started again then `BasePlugin.start` will be called again.\nOn a Scene Plugin, this method is never called.","kind":"function","name":"stop","since":"3.8.0","memberof":"Phaser.Plugins.ScenePlugin","longname":"Phaser.Plugins.ScenePlugin#stop","scope":"instance","inherits":"Phaser.Plugins.BasePlugin#stop","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Name of the Pipeline. Used for identifying","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#name","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#name","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The Game which owns this WebGL Pipeline.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#game","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#game","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The canvas which this WebGL Pipeline renders to.","name":"view","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#view","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#view","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Used to store the current game resolution","name":"resolution","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#resolution","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#resolution","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Width of the current viewport","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#width","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#width","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Height of the current viewport","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#height","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#height","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL context this WebGL Pipeline uses.","name":"gl","type":{"names":["WebGLRenderingContext"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#gl","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#gl","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"How many vertices have been fed to the current pipeline.","name":"vertexCount","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The limit of vertices that the pipeline can hold","name":"vertexCapacity","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexCapacity","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL Renderer which owns this WebGL Pipeline.","name":"renderer","type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#renderer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#renderer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Raw byte buffer of vertices.","name":"vertexData","type":{"names":["ArrayBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexData","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexData","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL vertex buffer object.","name":"vertexBuffer","type":{"names":["WebGLBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexBuffer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL program","name":"program","type":{"names":["WebGLProgram"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#program","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#program","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Array of objects that describe the vertex attributes","name":"attributes","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#attributes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#attributes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The size in bytes of the vertex","name":"vertexSize","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexSize","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexSize","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The primitive topology which the pipeline will use to submit draw calls","name":"topology","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#topology","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#topology","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":201,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Uint8 view to the vertex raw buffer. Used for uploading vertex buffer resources\nto the GPU.","name":"bytes","type":{"names":["Uint8Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#bytes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bytes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"This will store the amount of components of 32 bit length","name":"vertexComponentCount","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexComponentCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexComponentCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is flushing the contents to the GPU.\nWhen the variable is set the flush function will be locked.","name":"flushLocked","type":{"names":["boolean"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#flushLocked","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#flushLocked","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":230,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is active or not for this frame only.\nReset in the onRender method.","name":"active","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#active","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#active","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called when the Game has fully booted and the Renderer has finished setting up.\n\nBy this stage all Game level systems are now in place and you can perform any final\ntasks that the pipeline may need that relied on game systems such as the Texture Manager.","kind":"function","name":"boot","since":"3.11.0","memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#boot","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#boot","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Adds a description of vertex attribute to the pipeline","kind":"function","name":"addAttribute","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"Name of the vertex attribute","name":"name"},{"type":{"names":["integer"]},"description":"Vertex component size","name":"size"},{"type":{"names":["integer"]},"description":"Type of the attribute","name":"type"},{"type":{"names":["boolean"]},"description":"Is the value normalized to a range","name":"normalized"},{"type":{"names":["integer"]},"description":"Byte offset to the beginning of the first element in the vertex","name":"offset"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#addAttribute","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#addAttribute","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":285,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Check if the current batch of vertices is full.","kind":"function","name":"shouldFlush","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the current batch should be flushed, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#shouldFlush","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds the pipeline resources, including programs, vertex buffers and binds attributes","kind":"function","name":"bind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#bind","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bind","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":374,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before each frame is rendered, but after the canvas has been cleared.","kind":"function","name":"onPreRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onPreRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPreRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":388,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before a Scene's Camera is rendered.","kind":"function","name":"onRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene being rendered.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Scene Camera being rendered with.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":405,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called after each frame has been completely rendered and snapshots have been taken.","kind":"function","name":"onPostRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onPostRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPostRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":419,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Uploads the vertex data and emits a draw call\nfor the current batch of vertices.","kind":"function","name":"flush","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#flush","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#flush","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":454,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes all object references in this WebGL Pipeline and removes its program from the WebGL context.","kind":"function","name":"destroy","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#destroy","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#destroy","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new value of the `float` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec2` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec3` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec3` uniform.","name":"y"},{"type":{"names":["number"]},"description":"The new Z component of the `vec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":533,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["number"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["number"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["number"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat1v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":572,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat2v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat3v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setFloat4v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new value of the `int` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setInt1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":644,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec2` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setInt2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":663,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec3` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec3` uniform.","name":"y"},{"type":{"names":["integer"]},"description":"The new Z component of the `ivec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setInt3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["integer"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["integer"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["integer"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setInt4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":704,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat2` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setMatrix2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat3` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setMatrix3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Should the matrix be transpose","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"Matrix data","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#setMatrix4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Name of the Pipeline. Used for identifying","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#name","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#name","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The Game which owns this WebGL Pipeline.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#game","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#game","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The canvas which this WebGL Pipeline renders to.","name":"view","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#view","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#view","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Used to store the current game resolution","name":"resolution","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#resolution","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#resolution","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Width of the current viewport","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#width","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#width","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Height of the current viewport","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#height","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#height","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL context this WebGL Pipeline uses.","name":"gl","type":{"names":["WebGLRenderingContext"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#gl","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#gl","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"How many vertices have been fed to the current pipeline.","name":"vertexCount","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The limit of vertices that the pipeline can hold","name":"vertexCapacity","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexCapacity","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL Renderer which owns this WebGL Pipeline.","name":"renderer","type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#renderer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#renderer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Raw byte buffer of vertices.","name":"vertexData","type":{"names":["ArrayBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexData","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexData","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL vertex buffer object.","name":"vertexBuffer","type":{"names":["WebGLBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexBuffer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL program","name":"program","type":{"names":["WebGLProgram"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#program","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#program","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Array of objects that describe the vertex attributes","name":"attributes","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#attributes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#attributes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The size in bytes of the vertex","name":"vertexSize","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexSize","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexSize","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The primitive topology which the pipeline will use to submit draw calls","name":"topology","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#topology","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#topology","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":201,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Uint8 view to the vertex raw buffer. Used for uploading vertex buffer resources\nto the GPU.","name":"bytes","type":{"names":["Uint8Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#bytes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bytes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"This will store the amount of components of 32 bit length","name":"vertexComponentCount","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexComponentCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexComponentCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is flushing the contents to the GPU.\nWhen the variable is set the flush function will be locked.","name":"flushLocked","type":{"names":["boolean"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#flushLocked","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#flushLocked","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":230,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is active or not for this frame only.\nReset in the onRender method.","name":"active","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#active","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#active","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called when the Game has fully booted and the Renderer has finished setting up.\n\nBy this stage all Game level systems are now in place and you can perform any final\ntasks that the pipeline may need that relied on game systems such as the Texture Manager.","kind":"function","name":"boot","since":"3.11.0","memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#boot","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#boot","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Adds a description of vertex attribute to the pipeline","kind":"function","name":"addAttribute","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"Name of the vertex attribute","name":"name"},{"type":{"names":["integer"]},"description":"Vertex component size","name":"size"},{"type":{"names":["integer"]},"description":"Type of the attribute","name":"type"},{"type":{"names":["boolean"]},"description":"Is the value normalized to a range","name":"normalized"},{"type":{"names":["integer"]},"description":"Byte offset to the beginning of the first element in the vertex","name":"offset"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#addAttribute","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#addAttribute","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":285,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Check if the current batch of vertices is full.","kind":"function","name":"shouldFlush","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the current batch should be flushed, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#shouldFlush","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds the pipeline resources, including programs, vertex buffers and binds attributes","kind":"function","name":"bind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#bind","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bind","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":374,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before each frame is rendered, but after the canvas has been cleared.","kind":"function","name":"onPreRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onPreRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPreRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":388,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before a Scene's Camera is rendered.","kind":"function","name":"onRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Scene"]},"description":"The Scene being rendered.","name":"scene"},{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Scene Camera being rendered with.","name":"camera"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":405,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called after each frame has been completely rendered and snapshots have been taken.","kind":"function","name":"onPostRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onPostRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPostRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":454,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes all object references in this WebGL Pipeline and removes its program from the WebGL context.","kind":"function","name":"destroy","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#destroy","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#destroy","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new value of the `float` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec2` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec3` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec3` uniform.","name":"y"},{"type":{"names":["number"]},"description":"The new Z component of the `vec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":533,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["number"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["number"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["number"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat1v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":572,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat2v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat3v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setFloat4v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new value of the `int` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setInt1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":644,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec2` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setInt2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":663,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec3` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec3` uniform.","name":"y"},{"type":{"names":["integer"]},"description":"The new Z component of the `ivec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setInt3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["integer"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["integer"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["integer"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setInt4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":704,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat2` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setMatrix2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat3` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setMatrix3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Should the matrix be transpose","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"Matrix data","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setMatrix4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Float32 view of the array buffer containing the pipeline's vertices.","name":"vertexViewF32","type":{"names":["Float32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexViewF32","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexViewF32","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":106,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Uint32 view of the array buffer containing the pipeline's vertices.","name":"vertexViewU32","type":{"names":["Uint32Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexViewU32","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexViewU32","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":115,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Size of the batch.","name":"maxQuads","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#maxQuads","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#maxQuads","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":124,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Collection of batch information","name":"batches","type":{"names":["array"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batches","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batches","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":266,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Called every time the pipeline needs to be used.\nIt binds all necessary resources.","kind":"function","name":"onBind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#onBind","scope":"instance","overrides":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onBind","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onBind","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":284,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Resizes this pipeline and updates the projection.","kind":"function","name":"resize","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The new width.","name":"width"},{"type":{"names":["number"]},"description":"The new height.","name":"height"},{"type":{"names":["number"]},"description":"The resolution.","name":"resolution"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#resize","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#resize","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":305,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Assigns a texture to the current batch. If a different texture is already set it creates a new batch object.","kind":"function","name":"setTexture2D","since":"3.1.0","params":[{"type":{"names":["WebGLTexture"]},"optional":true,"description":"WebGLTexture that will be assigned to the current batch. If not given uses blankTexture.","name":"texture"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline"]},"description":"This pipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setTexture2D","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setTexture2D","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":329,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Checks if the current batch has the same texture and texture unit, or if we need to create a new batch.","kind":"function","name":"requireTextureBatch","since":"3.16.0","params":[{"type":{"names":["WebGLTexture"]},"description":"WebGLTexture that will be assigned to the current batch. If not given uses blankTexture.","name":"texture"},{"type":{"names":["integer"]},"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline needs to create a new batch, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#requireTextureBatch","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#requireTextureBatch","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":356,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Creates a new batch object and pushes it to a batch array.\nThe batch object contains information relevant to the current \nvertex batch like the offset in the vertex buffer, vertex count and \nthe textures used by that batch.","kind":"function","name":"pushBatch","since":"3.1.0","params":[{"type":{"names":["WebGLTexture"]},"description":"Optional WebGLTexture that will be assigned to the created batch.","name":"texture"},{"type":{"names":["integer"]},"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#pushBatch","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#pushBatch","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":392,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Uploads the vertex data and emits a draw call for the current batch of vertices.","kind":"function","name":"flush","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#flush","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#flush","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":659,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the vertices data into the batch and flushes if full.\n\nAssumes 6 vertices in the following arrangement:\n\n```\n0----3\n|\\ B|\n| \\ |\n| \\ |\n| A \\|\n| \\\n1----2\n```\n\nWhere tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3","kind":"function","name":"batchQuad","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The top-left x position.","name":"x0"},{"type":{"names":["number"]},"description":"The top-left y position.","name":"y0"},{"type":{"names":["number"]},"description":"The bottom-left x position.","name":"x1"},{"type":{"names":["number"]},"description":"The bottom-left y position.","name":"y1"},{"type":{"names":["number"]},"description":"The bottom-right x position.","name":"x2"},{"type":{"names":["number"]},"description":"The bottom-right y position.","name":"y2"},{"type":{"names":["number"]},"description":"The top-right x position.","name":"x3"},{"type":{"names":["number"]},"description":"The top-right y position.","name":"y3"},{"type":{"names":["number"]},"description":"UV u0 value.","name":"u0"},{"type":{"names":["number"]},"description":"UV v0 value.","name":"v0"},{"type":{"names":["number"]},"description":"UV u1 value.","name":"u1"},{"type":{"names":["number"]},"description":"UV v1 value.","name":"v1"},{"type":{"names":["number"]},"description":"The top-left tint color value.","name":"tintTL"},{"type":{"names":["number"]},"description":"The top-right tint color value.","name":"tintTR"},{"type":{"names":["number"]},"description":"The bottom-left tint color value.","name":"tintBL"},{"type":{"names":["number"]},"description":"The bottom-right tint color value.","name":"tintBR"},{"type":{"names":["number","boolean"]},"description":"The tint effect for the shader to use.","name":"tintEffect"},{"type":{"names":["WebGLTexture"]},"optional":true,"description":"WebGLTexture that will be assigned to the current batch if a flush occurs.","name":"texture"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if this method caused the batch to flush, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchQuad","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchQuad","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":766,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the vertices data into the batch and flushes if full.\n\nAssumes 3 vertices in the following arrangement:\n\n```\n0\n|\\\n| \\\n| \\\n| \\\n| \\\n1-----2\n```","kind":"function","name":"batchTri","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"The bottom-left x position.","name":"x1"},{"type":{"names":["number"]},"description":"The bottom-left y position.","name":"y1"},{"type":{"names":["number"]},"description":"The bottom-right x position.","name":"x2"},{"type":{"names":["number"]},"description":"The bottom-right y position.","name":"y2"},{"type":{"names":["number"]},"description":"The top-right x position.","name":"x3"},{"type":{"names":["number"]},"description":"The top-right y position.","name":"y3"},{"type":{"names":["number"]},"description":"UV u0 value.","name":"u0"},{"type":{"names":["number"]},"description":"UV v0 value.","name":"v0"},{"type":{"names":["number"]},"description":"UV u1 value.","name":"u1"},{"type":{"names":["number"]},"description":"UV v1 value.","name":"v1"},{"type":{"names":["number"]},"description":"The top-left tint color value.","name":"tintTL"},{"type":{"names":["number"]},"description":"The top-right tint color value.","name":"tintTR"},{"type":{"names":["number"]},"description":"The bottom-left tint color value.","name":"tintBL"},{"type":{"names":["number","boolean"]},"description":"The tint effect for the shader to use.","name":"tintEffect"},{"type":{"names":["WebGLTexture"]},"optional":true,"description":"WebGLTexture that will be assigned to the current batch if a flush occurs.","name":"texture"},{"type":{"names":["integer"]},"optional":true,"defaultvalue":0,"description":"Texture unit to which the texture needs to be bound.","name":"unit"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if this method caused the batch to flush, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchTri","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTri","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1030,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds a Texture Frame into the batch for rendering.","kind":"function","name":"batchTextureFrame","since":"3.12.0","params":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The Texture Frame to be rendered.","name":"frame"},{"type":{"names":["number"]},"description":"The horizontal position to render the texture at.","name":"x"},{"type":{"names":["number"]},"description":"The vertical position to render the texture at.","name":"y"},{"type":{"names":["number"]},"description":"The tint color.","name":"tint"},{"type":{"names":["number"]},"description":"The alpha value.","name":"alpha"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The Transform Matrix to use for the texture.","name":"transformMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A parent Transform Matrix.","name":"parentTransformMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchTextureFrame","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTextureFrame","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1088,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a filled rectangle into the vertex batch.\nRectangle has no transform values and isn't transformed into the local space.\nUsed for directly batching untransformed rectangles, such as Camera background colors.","kind":"function","name":"drawFillRect","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Horizontal top left coordinate of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"Vertical top left coordinate of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["number"]},"description":"Color of the rectangle to draw.","name":"color"},{"type":{"names":["number"]},"description":"Alpha value of the rectangle to draw.","name":"alpha"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#drawFillRect","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#drawFillRect","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1115,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a filled rectangle into the vertex batch.\nRectangle factors in the given transform matrices before adding to the batch.","kind":"function","name":"batchFillRect","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Horizontal top left coordinate of the rectangle.","name":"x"},{"type":{"names":["number"]},"description":"Vertical top left coordinate of the rectangle.","name":"y"},{"type":{"names":["number"]},"description":"Width of the rectangle.","name":"width"},{"type":{"names":["number"]},"description":"Height of the rectangle.","name":"height"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchFillRect","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchFillRect","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1166,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a filled triangle into the vertex batch.\nTriangle factors in the given transform matrices before adding to the batch.","kind":"function","name":"batchFillTriangle","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Point 0 x coordinate.","name":"x0"},{"type":{"names":["number"]},"description":"Point 0 y coordinate.","name":"y0"},{"type":{"names":["number"]},"description":"Point 1 x coordinate.","name":"x1"},{"type":{"names":["number"]},"description":"Point 1 y coordinate.","name":"y1"},{"type":{"names":["number"]},"description":"Point 2 x coordinate.","name":"x2"},{"type":{"names":["number"]},"description":"Point 2 y coordinate.","name":"y2"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchFillTriangle","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchFillTriangle","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Pushes a stroked triangle into the vertex batch.\nTriangle factors in the given transform matrices before adding to the batch.\nThe triangle is created from 3 lines and drawn using the `batchStrokePath` method.","kind":"function","name":"batchStrokeTriangle","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"Point 0 x coordinate.","name":"x0"},{"type":{"names":["number"]},"description":"Point 0 y coordinate.","name":"y0"},{"type":{"names":["number"]},"description":"Point 1 x coordinate.","name":"x1"},{"type":{"names":["number"]},"description":"Point 1 y coordinate.","name":"y1"},{"type":{"names":["number"]},"description":"Point 2 x coordinate.","name":"x2"},{"type":{"names":["number"]},"description":"Point 2 y coordinate.","name":"y2"},{"type":{"names":["number"]},"description":"The width of the line in pixels.","name":"lineWidth"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchStrokeTriangle","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchStrokeTriangle","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the given path to the vertex batch for rendering.\n\nIt works by taking the array of path data and then passing it through Earcut, which\ncreates a list of polygons. Each polygon is then added to the batch.\n\nThe path is always automatically closed because it's filled.","kind":"function","name":"batchFillPath","since":"3.12.0","params":[{"type":{"names":["array"]},"description":"Collection of points that represent the path.","name":"path"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchFillPath","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchFillPath","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1335,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Adds the given path to the vertex batch for rendering.\n\nIt works by taking the array of path data and calling `batchLine` for each section\nof the path.\n\nThe path is optionally closed at the end.","kind":"function","name":"batchStrokePath","since":"3.12.0","params":[{"type":{"names":["array"]},"description":"Collection of points that represent the path.","name":"path"},{"type":{"names":["number"]},"description":"The width of the line segments in pixels.","name":"lineWidth"},{"type":{"names":["boolean"]},"description":"Indicates if the path should be closed or left open.","name":"pathOpen"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The current transform.","name":"currentMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The parent transform.","name":"parentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchStrokePath","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchStrokePath","inherited":true,"___s":true},{"meta":{"filename":"TextureTintPipeline.js","lineno":1383,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl/pipelines"},"description":"Creates a quad and adds it to the vertex batch based on the given line values.","kind":"function","name":"batchLine","since":"3.12.0","params":[{"type":{"names":["number"]},"description":"X coordinate to the start of the line","name":"ax"},{"type":{"names":["number"]},"description":"Y coordinate to the start of the line","name":"ay"},{"type":{"names":["number"]},"description":"X coordinate to the end of the line","name":"bx"},{"type":{"names":["number"]},"description":"Y coordinate to the end of the line","name":"by"},{"type":{"names":["number"]},"description":"Width of the start of the line","name":"aLineWidth"},{"type":{"names":["number"]},"description":"Width of the end of the line","name":"bLineWidth"},{"type":{"names":["Float32Array"]},"description":"Parent matrix, generally used by containers","name":"currentMatrix"}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchLine","scope":"instance","inherits":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchLine","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":56,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Name of the Pipeline. Used for identifying","name":"name","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#name","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#name","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":65,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The Game which owns this WebGL Pipeline.","name":"game","type":{"names":["Phaser.Game"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#game","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#game","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":74,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The canvas which this WebGL Pipeline renders to.","name":"view","type":{"names":["HTMLCanvasElement"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#view","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#view","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Used to store the current game resolution","name":"resolution","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#resolution","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#resolution","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":92,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Width of the current viewport","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#width","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#width","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":101,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Height of the current viewport","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#height","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#height","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":110,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL context this WebGL Pipeline uses.","name":"gl","type":{"names":["WebGLRenderingContext"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#gl","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#gl","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":119,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"How many vertices have been fed to the current pipeline.","name":"vertexCount","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":129,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The limit of vertices that the pipeline can hold","name":"vertexCapacity","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexCapacity","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":138,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The WebGL Renderer which owns this WebGL Pipeline.","name":"renderer","type":{"names":["Phaser.Renderer.WebGL.WebGLRenderer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#renderer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#renderer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":147,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Raw byte buffer of vertices.","name":"vertexData","type":{"names":["ArrayBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexData","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexData","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":156,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL vertex buffer object.","name":"vertexBuffer","type":{"names":["WebGLBuffer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexBuffer","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":165,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The handle to a WebGL program","name":"program","type":{"names":["WebGLProgram"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#program","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#program","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":174,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Array of objects that describe the vertex attributes","name":"attributes","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#attributes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#attributes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":183,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The size in bytes of the vertex","name":"vertexSize","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexSize","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexSize","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":192,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"The primitive topology which the pipeline will use to submit draw calls","name":"topology","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#topology","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#topology","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":201,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Uint8 view to the vertex raw buffer. Used for uploading vertex buffer resources\nto the GPU.","name":"bytes","type":{"names":["Uint8Array"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#bytes","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bytes","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":211,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"This will store the amount of components of 32 bit length","name":"vertexComponentCount","type":{"names":["integer"]},"since":"3.0.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#vertexComponentCount","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#vertexComponentCount","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":220,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is flushing the contents to the GPU.\nWhen the variable is set the flush function will be locked.","name":"flushLocked","type":{"names":["boolean"]},"since":"3.1.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#flushLocked","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#flushLocked","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":230,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Indicates if the current pipeline is active or not for this frame only.\nReset in the onRender method.","name":"active","type":{"names":["boolean"]},"since":"3.10.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#active","scope":"instance","kind":"member","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#active","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":241,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called when the Game has fully booted and the Renderer has finished setting up.\n\nBy this stage all Game level systems are now in place and you can perform any final\ntasks that the pipeline may need that relied on game systems such as the Texture Manager.","kind":"function","name":"boot","since":"3.11.0","memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#boot","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#boot","inherited":true,"overrides":"Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#boot","___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":254,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Adds a description of vertex attribute to the pipeline","kind":"function","name":"addAttribute","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"Name of the vertex attribute","name":"name"},{"type":{"names":["integer"]},"description":"Vertex component size","name":"size"},{"type":{"names":["integer"]},"description":"Type of the attribute","name":"type"},{"type":{"names":["boolean"]},"description":"Is the value normalized to a range","name":"normalized"},{"type":{"names":["integer"]},"description":"Byte offset to the beginning of the first element in the vertex","name":"offset"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#addAttribute","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#addAttribute","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":285,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Check if the current batch of vertices is full.","kind":"function","name":"shouldFlush","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the current batch should be flushed, otherwise `false`."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#shouldFlush","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Binds the pipeline resources, including programs, vertex buffers and binds attributes","kind":"function","name":"bind","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#bind","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#bind","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":374,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called before each frame is rendered, but after the canvas has been cleared.","kind":"function","name":"onPreRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#onPreRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPreRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":405,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Called after each frame has been completely rendered and snapshots have been taken.","kind":"function","name":"onPostRender","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#onPostRender","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#onPostRender","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":454,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Removes all object references in this WebGL Pipeline and removes its program from the WebGL context.","kind":"function","name":"destroy","since":"3.0.0","returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#destroy","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#destroy","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":476,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new value of the `float` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":494,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec2` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":513,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"The new X component of the `vec3` uniform.","name":"x"},{"type":{"names":["number"]},"description":"The new Y component of the `vec3` uniform.","name":"y"},{"type":{"names":["number"]},"description":"The new Z component of the `vec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":533,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["number"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["number"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["number"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["number"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":554,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat1v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat1v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat1v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":572,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat2v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat2v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat2v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":590,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat3v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat3v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat3v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":608,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setFloat4v","since":"3.13.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["Float32Array"]},"description":"The new value to be used for the uniform variable.","name":"arr"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setFloat4v","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setFloat4v","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":626,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt1","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new value of the `int` uniform.","name":"x"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setInt1","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt1","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":644,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec2` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec2` uniform.","name":"y"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setInt2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":663,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"The new X component of the `ivec3` uniform.","name":"x"},{"type":{"names":["integer"]},"description":"The new Y component of the `ivec3` uniform.","name":"y"},{"type":{"names":["integer"]},"description":"The new Z component of the `ivec3` uniform.","name":"z"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setInt3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":683,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setInt4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["integer"]},"description":"X component of the uniform","name":"x"},{"type":{"names":["integer"]},"description":"Y component of the uniform","name":"y"},{"type":{"names":["integer"]},"description":"Z component of the uniform","name":"z"},{"type":{"names":["integer"]},"description":"W component of the uniform","name":"w"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setInt4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setInt4","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":704,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix2","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat2` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setMatrix2","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix2","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":723,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix3","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Whether to transpose the matrix. Should be `false`.","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"The new values for the `mat3` uniform.","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setMatrix3","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix3","inherited":true,"___s":true},{"meta":{"filename":"WebGLPipeline.js","lineno":742,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/renderer/webgl"},"description":"Set a uniform value of the current pipeline program.","kind":"function","name":"setMatrix4","since":"3.2.0","params":[{"type":{"names":["string"]},"description":"The name of the uniform to look-up and modify.","name":"name"},{"type":{"names":["boolean"]},"description":"Should the matrix be transpose","name":"transpose"},{"type":{"names":["Float32Array"]},"description":"Matrix data","name":"matrix"}],"returns":[{"type":{"names":["Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline"]},"description":"This WebGLPipeline instance."}],"memberof":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline","longname":"Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#setMatrix4","scope":"instance","inherits":"Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"`this`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"`this`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"`this`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"`this`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"`this`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Scale.ScaleManager"]},"description":"`this`."}],"memberof":"Phaser.Scale.ScaleManager","longname":"Phaser.Scale.ScaleManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSound","longname":"Phaser.Sound.BaseSound#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.BaseSoundManager","longname":"Phaser.Sound.BaseSoundManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Asset key for the sound.","name":"key","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#key","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#key","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently playing.","name":"isPlaying","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#isPlaying","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#isPlaying","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently paused.","name":"isPaused","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#isPaused","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#isPaused","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A property that holds the value of sound's actual playback rate,\nafter its rate and detune values has been combined with global\nrate and detune values.","name":"totalRate","type":{"names":["number"]},"defaultvalue":"1","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#totalRate","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#totalRate","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A value representing the duration, in seconds.\nIt could be total sound duration or a marker duration.","name":"duration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#duration","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#duration","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"The total duration of the sound in seconds.","name":"totalDuration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#totalDuration","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#totalDuration","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Object containing markers definitions.","name":"markers","type":{"names":["Object."]},"defaultvalue":"{}","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#markers","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#markers","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Currently playing marker.\n'null' if whole sound is playing.","name":"currentMarker","type":{"names":["Phaser.Types.Sound.SoundMarker"]},"defaultvalue":"null","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#currentMarker","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#currentMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\nThis allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.","kind":"function","name":"addMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was added successfully."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#addMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#addMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Updates previously added marker.","kind":"function","name":"updateMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object with updated values.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was updated successfully."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#updateMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#updateMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a marker from the sound.","kind":"function","name":"removeMarker","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the marker to remove.","name":"markerName"}],"returns":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"nullable":true,"description":"Removed marker object or 'null' if there was no marker with provided name."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#removeMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#removeMarker","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSound","longname":"Phaser.Sound.HTML5AudioSound#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to game.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#game","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#game","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to the JSON Cache, as used by Audio Sprites.","name":"jsonCache","type":{"names":["Phaser.Cache.BaseCache"]},"readonly":true,"since":"3.7.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#jsonCache","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#jsonCache","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sounds should be paused when game looses focus,\nfor instance when user switches to another tab/program/app.","name":"pauseOnBlur","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#pauseOnBlur","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#pauseOnBlur","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Mobile devices require sounds to be triggered from an explicit user action,\nsuch as a tap, before any sound can be loaded/played on a web page.\nSet to true if the audio system is currently locked awaiting user interaction.","name":"locked","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#locked","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#locked","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new audio sprite sound into the sound manager.\nAudio Sprites are a combination of audio files and a JSON configuration.\nThe JSON follows the format of that created by https://github.com/tonistiigi/audiosprite","kind":"function","name":"addAudioSprite","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound","Phaser.Sound.WebAudioSound"]},"description":"The new audio sprite sound instance."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#addAudioSprite","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#addAudioSprite","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new sound to the sound manager and plays it.\nThe sound will be automatically removed (destroyed) once playback ends.\nThis lets you play a new sound on the fly without the need to keep a reference to it.","kind":"function","name":"play","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig","Phaser.Types.Sound.SoundMarker"]},"optional":true,"description":"An optional additional object containing settings to be applied to the sound. It could be either config or marker object.","name":"extra"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#play","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#play","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Enables playing audio sprite sound on the fly without the need to keep a reference to it.\nSound will auto destroy once its playback ends.","kind":"function","name":"playAudioSprite","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["string"]},"description":"The name of the sound sprite to play.","name":"spriteName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the audio sprite sound started playing successfully."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#playAudioSprite","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#playAudioSprite","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a sound from the sound manager.\nThe removed sound is destroyed before removal.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The sound object to remove.","name":"sound"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the sound was removed successfully, otherwise false."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#remove","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#remove","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes all sounds from the sound manager that have an asset key matching the given value.\nThe removed sounds are destroyed before removal.","kind":"function","name":"removeByKey","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key to match when removing sound objects.","name":"key"}],"returns":[{"type":{"names":["number"]},"description":"The number of matching sound objects that were removed."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#removeByKey","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#removeByKey","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Pauses all the sounds in the game.","kind":"function","name":"pauseAll","fires":["Phaser.Sound.Events#event:PAUSE_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#pauseAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#pauseAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Resumes all the sounds in the game.","kind":"function","name":"resumeAll","fires":["Phaser.Sound.Events#event:RESUME_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#resumeAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#resumeAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Stops all the sounds in the game.","kind":"function","name":"stopAll","fires":["Phaser.Sound.Events#event:STOP_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#stopAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#stopAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global playback rate at which all the sounds will be played.\n\nFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","kind":"function","name":"setRate","fires":["Phaser.Sound.Events#event:GLOBAL_RATE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"Global playback rate at which all the sounds will be played.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#setRate","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#setRate","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global playback rate at which all the sounds will be played.\nValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audio's playback speed.","name":"rate","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#rate","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#rate","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","kind":"function","name":"setDetune","fires":["Phaser.Sound.Events#event:GLOBAL_DETUNE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#setDetune","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#setDetune","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"detune","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#detune","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#detune","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.HTML5AudioSoundManager","longname":"Phaser.Sound.HTML5AudioSoundManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Asset key for the sound.","name":"key","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#key","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#key","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently playing.","name":"isPlaying","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#isPlaying","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#isPlaying","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently paused.","name":"isPaused","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#isPaused","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#isPaused","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A property that holds the value of sound's actual playback rate,\nafter its rate and detune values has been combined with global\nrate and detune values.","name":"totalRate","type":{"names":["number"]},"defaultvalue":"1","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#totalRate","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#totalRate","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A value representing the duration, in seconds.\nIt could be total sound duration or a marker duration.","name":"duration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#duration","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#duration","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"The total duration of the sound in seconds.","name":"totalDuration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#totalDuration","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#totalDuration","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Object containing markers definitions.","name":"markers","type":{"names":["Object."]},"defaultvalue":"{}","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#markers","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#markers","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Currently playing marker.\n'null' if whole sound is playing.","name":"currentMarker","type":{"names":["Phaser.Types.Sound.SoundMarker"]},"defaultvalue":"null","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#currentMarker","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#currentMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\nThis allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.","kind":"function","name":"addMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was added successfully."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#addMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#addMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Updates previously added marker.","kind":"function","name":"updateMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object with updated values.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was updated successfully."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#updateMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#updateMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a marker from the sound.","kind":"function","name":"removeMarker","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the marker to remove.","name":"markerName"}],"returns":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"nullable":true,"description":"Removed marker object or 'null' if there was no marker with provided name."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#removeMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#removeMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":283,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Play this sound, or a marked section of it.\nIt always plays the sound from the start. If you want to start playback from a specific time\nyou can set 'seek' setting of the config object, provided to this call, to that value.","kind":"function","name":"play","since":"3.0.0","params":[{"type":{"names":["string","Phaser.Types.Sound.SoundConfig"]},"optional":true,"defaultvalue":"''","description":"If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.","name":"markerName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#play","scope":"instance","inherits":"Phaser.Sound.BaseSound#play","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":342,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Pauses the sound.","kind":"function","name":"pause","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was paused successfully."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#pause","scope":"instance","inherits":"Phaser.Sound.BaseSound#pause","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":363,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Resumes the sound.","kind":"function","name":"resume","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was resumed successfully."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#resume","scope":"instance","inherits":"Phaser.Sound.BaseSound#resume","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Stop playing this sound.","kind":"function","name":"stop","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"Whether the sound was stopped successfully."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#stop","scope":"instance","inherits":"Phaser.Sound.BaseSound#stop","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":465,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Destroys this sound and all associated events and marks it for removal from the sound manager.","kind":"function","name":"destroy","fires":["Phaser.Sound.Events#event:DESTROY"],"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#destroy","scope":"instance","inherits":"Phaser.Sound.BaseSound#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSound","longname":"Phaser.Sound.NoAudioSound#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to game.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#game","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#game","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to the JSON Cache, as used by Audio Sprites.","name":"jsonCache","type":{"names":["Phaser.Cache.BaseCache"]},"readonly":true,"since":"3.7.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#jsonCache","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#jsonCache","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":73,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global mute setting.","name":"mute","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#mute","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#mute","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":83,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global volume setting.","name":"volume","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#volume","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#volume","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sounds should be paused when game looses focus,\nfor instance when user switches to another tab/program/app.","name":"pauseOnBlur","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#pauseOnBlur","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#pauseOnBlur","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Mobile devices require sounds to be triggered from an explicit user action,\nsuch as a tap, before any sound can be loaded/played on a web page.\nSet to true if the audio system is currently locked awaiting user interaction.","name":"locked","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#locked","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#locked","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":170,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new sound into the sound manager.","kind":"function","name":"add","override":true,"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The new sound instance."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#add","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#add","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new audio sprite sound into the sound manager.\nAudio Sprites are a combination of audio files and a JSON configuration.\nThe JSON follows the format of that created by https://github.com/tonistiigi/audiosprite","kind":"function","name":"addAudioSprite","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound","Phaser.Sound.WebAudioSound"]},"description":"The new audio sprite sound instance."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#addAudioSprite","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#addAudioSprite","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new sound to the sound manager and plays it.\nThe sound will be automatically removed (destroyed) once playback ends.\nThis lets you play a new sound on the fly without the need to keep a reference to it.","kind":"function","name":"play","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig","Phaser.Types.Sound.SoundMarker"]},"optional":true,"description":"An optional additional object containing settings to be applied to the sound. It could be either config or marker object.","name":"extra"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#play","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#play","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Enables playing audio sprite sound on the fly without the need to keep a reference to it.\nSound will auto destroy once its playback ends.","kind":"function","name":"playAudioSprite","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["string"]},"description":"The name of the sound sprite to play.","name":"spriteName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the audio sprite sound started playing successfully."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#playAudioSprite","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#playAudioSprite","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a sound from the sound manager.\nThe removed sound is destroyed before removal.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The sound object to remove.","name":"sound"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the sound was removed successfully, otherwise false."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#remove","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#remove","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes all sounds from the sound manager that have an asset key matching the given value.\nThe removed sounds are destroyed before removal.","kind":"function","name":"removeByKey","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key to match when removing sound objects.","name":"key"}],"returns":[{"type":{"names":["number"]},"description":"The number of matching sound objects that were removed."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#removeByKey","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#removeByKey","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Pauses all the sounds in the game.","kind":"function","name":"pauseAll","fires":["Phaser.Sound.Events#event:PAUSE_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#pauseAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#pauseAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Resumes all the sounds in the game.","kind":"function","name":"resumeAll","fires":["Phaser.Sound.Events#event:RESUME_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#resumeAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#resumeAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Stops all the sounds in the game.","kind":"function","name":"stopAll","fires":["Phaser.Sound.Events#event:STOP_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#stopAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#stopAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Destroys all the sounds in the game and all associated events.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#destroy","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#destroy","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global playback rate at which all the sounds will be played.\n\nFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","kind":"function","name":"setRate","fires":["Phaser.Sound.Events#event:GLOBAL_RATE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"Global playback rate at which all the sounds will be played.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#setRate","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#setRate","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global playback rate at which all the sounds will be played.\nValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audio's playback speed.","name":"rate","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#rate","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#rate","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","kind":"function","name":"setDetune","fires":["Phaser.Sound.Events#event:GLOBAL_DETUNE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#setDetune","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#setDetune","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"detune","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#detune","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#detune","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.NoAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.NoAudioSoundManager","longname":"Phaser.Sound.NoAudioSoundManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":48,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Asset key for the sound.","name":"key","type":{"names":["string"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#key","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#key","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":58,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently playing.","name":"isPlaying","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#isPlaying","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#isPlaying","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":69,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sound is currently paused.","name":"isPaused","type":{"names":["boolean"]},"defaultvalue":"false","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#isPaused","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#isPaused","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":80,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A property that holds the value of sound's actual playback rate,\nafter its rate and detune values has been combined with global\nrate and detune values.","name":"totalRate","type":{"names":["number"]},"defaultvalue":"1","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#totalRate","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#totalRate","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"A value representing the duration, in seconds.\nIt could be total sound duration or a marker duration.","name":"duration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#duration","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#duration","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":104,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"The total duration of the sound in seconds.","name":"totalDuration","type":{"names":["number"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#totalDuration","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#totalDuration","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":148,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Object containing markers definitions.","name":"markers","type":{"names":["Object."]},"defaultvalue":"{}","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#markers","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#markers","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":159,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Currently playing marker.\n'null' if whole sound is playing.","name":"currentMarker","type":{"names":["Phaser.Types.Sound.SoundMarker"]},"defaultvalue":"null","readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#currentMarker","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSound#currentMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":183,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.\nThis allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.","kind":"function","name":"addMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was added successfully."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#addMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#addMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Updates previously added marker.","kind":"function","name":"updateMarker","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"description":"Marker object with updated values.","name":"marker"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the marker was updated successfully."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#updateMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#updateMarker","inherited":true,"___s":true},{"meta":{"filename":"BaseSound.js","lineno":259,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a marker from the sound.","kind":"function","name":"removeMarker","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the marker to remove.","name":"markerName"}],"returns":[{"type":{"names":["Phaser.Types.Sound.SoundMarker"]},"nullable":true,"description":"Removed marker object or 'null' if there was no marker with provided name."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#removeMarker","scope":"instance","inherits":"Phaser.Sound.BaseSound#removeMarker","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSound"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSound","longname":"Phaser.Sound.WebAudioSound#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":42,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to game.","name":"game","type":{"names":["Phaser.Game"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#game","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#game","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":52,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Local reference to the JSON Cache, as used by Audio Sprites.","name":"jsonCache","type":{"names":["Phaser.Cache.BaseCache"]},"readonly":true,"since":"3.7.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#jsonCache","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#jsonCache","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":93,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Flag indicating if sounds should be paused when game looses focus,\nfor instance when user switches to another tab/program/app.","name":"pauseOnBlur","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#pauseOnBlur","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#pauseOnBlur","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":126,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Mobile devices require sounds to be triggered from an explicit user action,\nsuch as a tap, before any sound can be loaded/played on a web page.\nSet to true if the audio system is currently locked awaiting user interaction.","name":"locked","type":{"names":["boolean"]},"readonly":true,"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#locked","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#locked","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":184,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new audio sprite sound into the sound manager.\nAudio Sprites are a combination of audio files and a JSON configuration.\nThe JSON follows the format of that created by https://github.com/tonistiigi/audiosprite","kind":"function","name":"addAudioSprite","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["Phaser.Sound.HTML5AudioSound","Phaser.Sound.WebAudioSound"]},"description":"The new audio sprite sound instance."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#addAudioSprite","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#addAudioSprite","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":229,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Adds a new sound to the sound manager and plays it.\nThe sound will be automatically removed (destroyed) once playback ends.\nThis lets you play a new sound on the fly without the need to keep a reference to it.","kind":"function","name":"play","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["Phaser.Types.Sound.SoundConfig","Phaser.Types.Sound.SoundMarker"]},"optional":true,"description":"An optional additional object containing settings to be applied to the sound. It could be either config or marker object.","name":"extra"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the sound started playing successfully."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#play","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#play","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":268,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Enables playing audio sprite sound on the fly without the need to keep a reference to it.\nSound will auto destroy once its playback ends.","kind":"function","name":"playAudioSprite","listens":["Phaser.Sound.Events#event:COMPLETE"],"since":"3.0.0","params":[{"type":{"names":["string"]},"description":"Asset key for the sound.","name":"key"},{"type":{"names":["string"]},"description":"The name of the sound sprite to play.","name":"spriteName"},{"type":{"names":["Phaser.Types.Sound.SoundConfig"]},"optional":true,"description":"An optional config object containing default sound settings.","name":"config"}],"returns":[{"type":{"names":["boolean"]},"description":"Whether the audio sprite sound started playing successfully."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#playAudioSprite","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#playAudioSprite","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":291,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes a sound from the sound manager.\nThe removed sound is destroyed before removal.","kind":"function","name":"remove","since":"3.0.0","params":[{"type":{"names":["Phaser.Sound.BaseSound"]},"description":"The sound object to remove.","name":"sound"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the sound was removed successfully, otherwise false."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#remove","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#remove","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":318,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Removes all sounds from the sound manager that have an asset key matching the given value.\nThe removed sounds are destroyed before removal.","kind":"function","name":"removeByKey","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key to match when removing sound objects.","name":"key"}],"returns":[{"type":{"names":["number"]},"description":"The number of matching sound objects that were removed."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#removeByKey","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#removeByKey","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Pauses all the sounds in the game.","kind":"function","name":"pauseAll","fires":["Phaser.Sound.Events#event:PAUSE_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#pauseAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#pauseAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":367,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Resumes all the sounds in the game.","kind":"function","name":"resumeAll","fires":["Phaser.Sound.Events#event:RESUME_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#resumeAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#resumeAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Stops all the sounds in the game.","kind":"function","name":"stopAll","fires":["Phaser.Sound.Events#event:STOP_ALL"],"since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#stopAll","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#stopAll","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":516,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global playback rate at which all the sounds will be played.\n\nFor example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audios playback speed.","kind":"function","name":"setRate","fires":["Phaser.Sound.Events#event:GLOBAL_RATE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"Global playback rate at which all the sounds will be played.","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#setRate","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#setRate","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":537,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global playback rate at which all the sounds will be played.\nValue of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed\nand 2.0 doubles the audio's playback speed.","name":"rate","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#rate","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#rate","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":568,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Sets the global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","kind":"function","name":"setDetune","fires":["Phaser.Sound.Events#event:GLOBAL_DETUNE"],"since":"3.3.0","params":[{"type":{"names":["number"]},"description":"The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"value"}],"returns":[{"type":{"names":["Phaser.Sound.BaseSoundManager"]},"description":"This Sound Manager."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#setDetune","scope":"instance","inherits":"Phaser.Sound.BaseSoundManager#setDetune","inherited":true,"___s":true},{"meta":{"filename":"BaseSoundManager.js","lineno":587,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/sound"},"description":"Global detuning of all sounds in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).\nThe range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).","name":"detune","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#detune","scope":"instance","kind":"member","inherits":"Phaser.Sound.BaseSoundManager#detune","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Sound.WebAudioSoundManager"]},"description":"`this`."}],"memberof":"Phaser.Sound.WebAudioSoundManager","longname":"Phaser.Sound.WebAudioSoundManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"`this`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"`this`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"`this`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"`this`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"`this`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Structs.ProcessQueue"]},"description":"`this`."}],"memberof":"Phaser.Structs.ProcessQueue","longname":"Phaser.Structs.ProcessQueue#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":50,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"A reference to the Texture Manager this Texture belongs to.","name":"manager","type":{"names":["Phaser.Textures.TextureManager"]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#manager","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#manager","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The unique string-based key of this Texture.","name":"key","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#key","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#key","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":68,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An array of TextureSource instances.\nThese are unique to this Texture and contain the actual Image (or Canvas) data.","name":"source","type":{"names":["Array."]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#source","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#source","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":78,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"An array of TextureSource data instances.\nUsed to store additional data images, such as normal maps or specular maps.","name":"dataSource","type":{"names":["array"]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#dataSource","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#dataSource","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":88,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"A key-value object pair associating the unique Frame keys with the Frames objects.","name":"frames","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#frames","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#frames","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":97,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Any additional data that was set in the source JSON (if any),\nor any extra data you'd like to store relating to this texture","name":"customData","type":{"names":["object"]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#customData","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#customData","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The name of the first frame of the Texture.","name":"firstFrame","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#firstFrame","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#firstFrame","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":116,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"The total number of Frames in this Texture, including the `__BASE` frame.\n\nA Texture will always contain at least 1 frame because every Texture contains a `__BASE` frame by default,\nin addition to any extra frames that have been added to it, such as when parsing a Sprite Sheet or Texture Atlas.","name":"frameTotal","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#frameTotal","scope":"instance","kind":"member","inherits":"Phaser.Textures.Texture#frameTotal","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a new Frame to this Texture.\n\nA Frame is a rectangular region of a TextureSource with a unique index or string-based key.\n\nThe name given must be unique within this Texture. If it already exists, this method will return `null`.","kind":"function","name":"add","since":"3.0.0","params":[{"type":{"names":["integer","string"]},"description":"The name of this Frame. The name is unique within the Texture.","name":"name"},{"type":{"names":["integer"]},"description":"The index of the TextureSource that this Frame is a part of.","name":"sourceIndex"},{"type":{"names":["number"]},"description":"The x coordinate of the top-left of this Frame.","name":"x"},{"type":{"names":["number"]},"description":"The y coordinate of the top-left of this Frame.","name":"y"},{"type":{"names":["number"]},"description":"The width of this Frame.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Frame.","name":"height"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"nullable":true,"description":"The Frame that was added to this Texture, or `null` if the given name already exists."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#add","scope":"instance","inherits":"Phaser.Textures.Texture#add","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":180,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Removes the given Frame from this Texture. The Frame is destroyed immediately.\n\nAny Game Objects using this Frame should stop using it _before_ you remove it,\nas it does not happen automatically.","kind":"function","name":"remove","since":"3.19.0","params":[{"type":{"names":["string"]},"description":"The key of the Frame to remove.","name":"name"}],"returns":[{"type":{"names":["boolean"]},"description":"True if a Frame with the matching key was removed from this Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#remove","scope":"instance","inherits":"Phaser.Textures.Texture#remove","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":209,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Checks to see if a Frame matching the given key exists within this Texture.","kind":"function","name":"has","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The key of the Frame to check for.","name":"name"}],"returns":[{"type":{"names":["boolean"]},"description":"True if a Frame with the matching key exists in this Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#has","scope":"instance","inherits":"Phaser.Textures.Texture#has","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":224,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Gets a Frame from this Texture based on either the key or the index of the Frame.\n\nIn a Texture Atlas Frames are typically referenced by a key.\nIn a Sprite Sheet Frames are referenced by an index.\nPassing no value for the name returns the base texture.","kind":"function","name":"get","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from this Texture.","name":"name"}],"returns":[{"type":{"names":["Phaser.Textures.Frame"]},"description":"The Texture Frame."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#get","scope":"instance","inherits":"Phaser.Textures.Texture#get","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":258,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Takes the given TextureSource and returns the index of it within this Texture.\nIf it's not in this Texture, it returns -1.\nUnless this Texture has multiple TextureSources, such as with a multi-atlas, this\nmethod will always return zero or -1.","kind":"function","name":"getTextureSourceIndex","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.TextureSource"]},"description":"The TextureSource to check.","name":"source"}],"returns":[{"type":{"names":["integer"]},"description":"The index of the TextureSource within this Texture, or -1 if not in this Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getTextureSourceIndex","scope":"instance","inherits":"Phaser.Textures.Texture#getTextureSourceIndex","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":284,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns an array of all the Frames in the given TextureSource.","kind":"function","name":"getFramesFromTextureSource","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The index of the TextureSource to get the Frames from.","name":"sourceIndex"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Include the `__BASE` Frame in the output array?","name":"includeBase"}],"returns":[{"type":{"names":["Array."]},"description":"An array of Texture Frames."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getFramesFromTextureSource","scope":"instance","inherits":"Phaser.Textures.Texture#getFramesFromTextureSource","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":319,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Returns an array with all of the names of the Frames in this Texture.\n\nUseful if you want to randomly assign a Frame to a Game Object, as you can\npick a random element from the returned array.","kind":"function","name":"getFrameNames","since":"3.0.0","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Include the `__BASE` Frame in the output array?","name":"includeBase"}],"returns":[{"type":{"names":["Array."]},"description":"An array of all Frame names in this Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getFrameNames","scope":"instance","inherits":"Phaser.Textures.Texture#getFrameNames","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":351,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Given a Frame name, return the source image it uses to render with.\n\nThis will return the actual DOM Image or Canvas element.","kind":"function","name":"getSourceImage","since":"3.0.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from this Texture.","name":"name"}],"returns":[{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Phaser.GameObjects.RenderTexture"]},"description":"The DOM Image, Canvas Element or Render Texture."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getSourceImage","scope":"instance","inherits":"Phaser.Textures.Texture#getSourceImage","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":384,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Given a Frame name, return the data source image it uses to render with.\nYou can use this to get the normal map for an image for example.\n\nThis will return the actual DOM Image.","kind":"function","name":"getDataSourceImage","since":"3.7.0","params":[{"type":{"names":["string","integer"]},"optional":true,"description":"The string-based name, or integer based index, of the Frame to get from this Texture.","name":"name"}],"returns":[{"type":{"names":["HTMLImageElement","HTMLCanvasElement"]},"description":"The DOM Image or Canvas Element."}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#getDataSourceImage","scope":"instance","inherits":"Phaser.Textures.Texture#getDataSourceImage","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":421,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Adds a data source image to this Texture.\n\nAn example of a data source image would be a normal map, where all of the Frames for this Texture\nequally apply to the normal map.","kind":"function","name":"setDataSource","since":"3.0.0","params":[{"type":{"names":["HTMLImageElement","HTMLCanvasElement","Array.","Array."]},"description":"The source image.","name":"data"}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#setDataSource","scope":"instance","inherits":"Phaser.Textures.Texture#setDataSource","inherited":true,"___s":true},{"meta":{"filename":"Texture.js","lineno":447,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/textures"},"description":"Sets the Filter Mode for this Texture.\n\nThe mode can be either Linear, the default, or Nearest.\n\nFor pixel-art you should use Nearest.\n\nThe mode applies to the entire Texture, not just a specific Frame of it.","kind":"function","name":"setFilter","since":"3.0.0","params":[{"type":{"names":["Phaser.Textures.FilterMode"]},"description":"The Filter Mode.","name":"filterMode"}],"memberof":"Phaser.Textures.CanvasTexture","longname":"Phaser.Textures.CanvasTexture#setFilter","scope":"instance","inherits":"Phaser.Textures.Texture#setFilter","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"`this`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"`this`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"`this`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"`this`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"`this`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Textures.TextureManager"]},"description":"`this`."}],"memberof":"Phaser.Textures.TextureManager","longname":"Phaser.Textures.TextureManager#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.Tile"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.Tile","longname":"Phaser.Tilemaps.Tile#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.DynamicTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.DynamicTilemapLayer","longname":"Phaser.Tilemaps.DynamicTilemapLayer#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":49,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A textual representation of this Game Object, i.e. `sprite`.\nUsed internally by Phaser but is available for your own custom classes to populate.","name":"type","type":{"names":["string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#type","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#type","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":59,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The current state of this Game Object.\n\nPhaser itself will never modify this value, although plugins may do so.\n\nUse this property to track the state of a Game Object during its lifetime. For example, it could change from\na state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\nin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","name":"state","type":{"names":["integer","string"]},"since":"3.16.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#state","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#state","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":75,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The parent Container of this Game Object, if it has one.","name":"parentContainer","type":{"names":["Phaser.GameObjects.Container"]},"since":"3.4.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#parentContainer","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#parentContainer","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":84,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The name of this Game Object.\nEmpty by default and never populated by Phaser, this is left for developers to use.","name":"name","type":{"names":["string"]},"defaultvalue":"''","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#name","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#name","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":95,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The active state of this Game Object.\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\nAn active object is one which is having its logic and internal systems updated.","name":"active","type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#active","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#active","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":107,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The Tab Index of the Game Object.\nReserved for future use by plugins and the Input Manager.","name":"tabIndex","type":{"names":["integer"]},"defaultvalue":"-1","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#tabIndex","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#tabIndex","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":118,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A Data Manager.\nIt allows you to store, query and get key/value paired information specific to this Game Object.\n`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.","name":"data","type":{"names":["Phaser.Data.DataManager"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#data","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#data","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":130,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\nIf those components are not used by your custom class then you can use this bitmask as you wish.","name":"renderFlags","type":{"names":["integer"]},"defaultvalue":"15","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#renderFlags","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#renderFlags","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":142,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"A bitmask that controls if this Game Object is drawn by a Camera or not.\nNot usually set directly, instead call `Camera.ignore`, however you can\nset this property directly using the Camera.id property:","examples":["this.cameraFilter |= camera.id"],"name":"cameraFilter","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#cameraFilter","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#cameraFilter","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":157,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\nNot usually set directly. Instead call `GameObject.setInteractive()`.","name":"input","type":{"names":["Phaser.Types.Input.InteractiveObject"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#input","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#input","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":168,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.","name":"body","type":{"names":["object","Phaser.Physics.Arcade.Body","Phaser.Physics.Impact.Body"]},"nullable":true,"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#body","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#body","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":178,"columnno":8,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\nThis includes calls that may come from a Group, Container or the Scene itself.\nWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\nresponsible for managing references to and from this Game Object.","name":"ignoreDestroy","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.5.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#ignoreDestroy","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.GameObject#ignoreDestroy","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":195,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `active` property of this Game Object and returns this Game Object for further chaining.\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.","kind":"function","name":"setActive","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"True if this Game Object should be set as active, false if not.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setActive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setActive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":213,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the `name` property of this Game Object and returns this Game Object for further chaining.\nThe `name` property is not populated by Phaser and is presented for your own use.","kind":"function","name":"setName","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name to be given to this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setName","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setName","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":231,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Sets the current state of this Game Object.\n\nPhaser itself will never modify the State of a Game Object, although plugins may do so.\n\nFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\nThe state value should typically be an integer (ideally mapped to a constant\nin your game code), but could also be a string. It is recommended to keep it light and simple.\nIf you need to store complex data about your Game Object, look at using the Data Component instead.","kind":"function","name":"setState","since":"3.16.0","params":[{"type":{"names":["integer","string"]},"description":"The state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setState","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setState","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":255,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Adds a Data Manager component to this Game Object.","kind":"function","name":"setDataEnabled","since":"3.0.0","see":["Phaser.Data.DataManager"],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setDataEnabled","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setDataEnabled","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":274,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Allows you to store a key value pair within this Game Objects Data Manager.\n\nIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\nbefore setting the value.\n\nIf the key doesn't already exist in the Data Manager then it is created.\n\n```javascript\nsprite.setData('name', 'Red Gem Stone');\n```\n\nYou can also pass in an object of key value pairs as the first argument:\n\n```javascript\nsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\n```\n\nTo get a value back again you can call `getData`:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr you can access the value directly via the `values` property, where it works like any other variable:\n\n```javascript\nsprite.data.values.gold += 50;\n```\n\nWhen the value is first set, a `setdata` event is emitted from this Game Object.\n\nIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\nFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\nThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\n\nPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\nThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.","kind":"function","name":"setData","since":"3.0.0","params":[{"type":{"names":["string","object"]},"description":"The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.","name":"key"},{"type":{"names":["*"]},"optional":true,"description":"The value to set for the given key. If an object is provided as the key this argument is ignored.","name":"data"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":333,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\n\nYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\n\n```javascript\nsprite.getData('gold');\n```\n\nOr access the value directly:\n\n```javascript\nsprite.data.values.gold;\n```\n\nYou can also pass in an array of keys, in which case an array of values will be returned:\n\n```javascript\nsprite.getData([ 'gold', 'armor', 'health' ]);\n```\n\nThis approach is useful for destructuring arrays in ES6.","kind":"function","name":"getData","since":"3.0.0","params":[{"type":{"names":["string","Array."]},"description":"The key of the value to retrieve, or an array of keys.","name":"key"}],"returns":[{"type":{"names":["*"]},"description":"The value belonging to the given key, or an array of values, the order of which will match the input array."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getData","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getData","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":373,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Pass this Game Object to the Input Manager to enable it for Input.\n\nInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\nfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\ninput detection.\n\nIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\nthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\nshape for it to use.\n\nYou can also provide an Input Configuration Object as the only argument to this method.","kind":"function","name":"setInteractive","since":"3.0.0","params":[{"type":{"names":["Phaser.Types.Input.InputConfiguration","any"]},"optional":true,"description":"Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.","name":"shape"},{"type":{"names":["Phaser.Types.Input.HitAreaCallback"]},"optional":true,"description":"A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.","name":"callback"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Should this Game Object be treated as a drop zone target?","name":"dropZone"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#setInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":402,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will disable it.\n\nAn object that is disabled for input stops processing or being considered for\ninput events, but can be turned back on again at any time by simply calling\n`setInteractive()` with no arguments provided.\n\nIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.","kind":"function","name":"disableInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#disableInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#disableInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":426,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"If this Game Object has previously been enabled for input, this will queue it\nfor removal, causing it to no longer be interactive. The removal happens on\nthe next game step, it is not immediate.\n\nThe Interactive Object that was assigned to this Game Object will be destroyed,\nremoved from the Input Manager and cleared from this Game Object.\n\nIf you wish to re-enable this Game Object at a later date you will need to\nre-create its InteractiveObject by calling `setInteractive` again.\n\nIf you wish to only temporarily stop an object from receiving input then use\n`disableInteractive` instead, as that toggles the interactive state, where-as\nthis erases it completely.\n\nIf you wish to resize a hit area, don't remove and then set it as being\ninteractive. Instead, access the hitarea object directly and resize the shape\nbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\nshape is a Rectangle, which it is by default.)","kind":"function","name":"removeInteractive","since":"3.7.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This GameObject."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#removeInteractive","scope":"instance","inherits":"Phaser.GameObjects.GameObject#removeInteractive","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":460,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"To be overridden by custom GameObjects. Allows base objects to be used in a Pool.","kind":"function","name":"update","since":"3.0.0","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"description":"args","name":"args"}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#update","scope":"instance","inherits":"Phaser.GameObjects.GameObject#update","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":472,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns a JSON representation of the Game Object.","kind":"function","name":"toJSON","since":"3.0.0","returns":[{"type":{"names":["Phaser.Types.GameObjects.JSONGameObject"]},"description":"A JSON representation of the Game Object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#toJSON","scope":"instance","inherits":"Phaser.GameObjects.GameObject#toJSON","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":485,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Compares the renderMask with the renderFlags to see if this Game Object will render or not.\nAlso checks the Game Object against the given Cameras exclusion list.","kind":"function","name":"willRender","since":"3.0.0","params":[{"type":{"names":["Phaser.Cameras.Scene2D.Camera"]},"description":"The Camera to check against this Game Object.","name":"camera"}],"returns":[{"type":{"names":["boolean"]},"description":"True if the Game Object should be rendered, otherwise false."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#willRender","scope":"instance","inherits":"Phaser.GameObjects.GameObject#willRender","inherited":true,"___s":true},{"meta":{"filename":"GameObject.js","lineno":501,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects"},"description":"Returns an array containing the display list index of either this Game Object, or if it has one,\nits parent Container. It then iterates up through all of the parent containers until it hits the\nroot of the display list (which is index 0 in the returned array).\n\nUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\nthis Game Object and all of its ancestors.","kind":"function","name":"getIndexList","since":"3.4.0","returns":[{"type":{"names":["Array."]},"description":"An array of display list position indexes."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getIndexList","scope":"instance","inherits":"Phaser.GameObjects.GameObject#getIndexList","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"`this`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Clears all alpha values associated with this Game Object.\n\nImmediately sets the alpha levels back to 1 (fully opaque).","kind":"function","name":"clearAlpha","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#clearAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#clearAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":92,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\nAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\n\nIf your game is running under WebGL you can optionally specify four different alpha values, each of which\ncorrespond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.","kind":"function","name":"setAlpha","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"description":"The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.","name":"topLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the top-right of the Game Object. WebGL only.","name":"topRight"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-left of the Game Object. WebGL only.","name":"bottomLeft"},{"type":{"names":["number"]},"optional":true,"description":"The alpha value used for the bottom-right of the Game Object. WebGL only.","name":"bottomRight"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setAlpha","scope":"instance","inherits":"Phaser.GameObjects.Components.Alpha#setAlpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":129,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value of the Game Object.\n\nThis is a global value, impacting the entire Game Object, not just a region of it.","name":"alpha","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#alpha","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alpha","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#alphaTopLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the top-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaTopRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#alphaTopRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaTopRight","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":227,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-left of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomLeft","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#alphaBottomLeft","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"Alpha.js","lineno":257,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The alpha value starting from the bottom-right of the Game Object.\nThis value is interpolated from the corner to the center of the Game Object.","name":"alphaBottomRight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#alphaBottomRight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Alpha#alphaBottomRight","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency of which blend modes\nare used.","name":"blendMode","type":{"names":["Phaser.BlendModes","string"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#blendMode","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.BlendMode#blendMode","inherited":true,"___s":true},{"meta":{"filename":"BlendMode.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the Blend Mode being used by this Game Object.\n\nThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\n\nUnder WebGL only the following Blend Modes are available:\n\n* ADD\n* MULTIPLY\n* SCREEN\n* ERASE (only works when rendering to a framebuffer, like a Render Texture)\n\nCanvas has more available depending on browser support.\n\nYou can also create your own custom Blend Modes in WebGL.\n\nBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\non support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\nreasons try to be careful about the construction of your Scene and the frequency in which blend modes\nare used.","kind":"function","name":"setBlendMode","since":"3.0.0","params":[{"type":{"names":["string","Phaser.BlendModes"]},"description":"The BlendMode value. Either a string or a CONST.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setBlendMode","scope":"instance","inherits":"Phaser.GameObjects.Components.BlendMode#setBlendMode","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) width of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayWidth` property.","name":"width","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#width","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#width","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The native (un-scaled) height of this Game Object.\n\nChanging this value will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or use\nthe `displayHeight` property.","name":"height","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#height","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#height","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed width of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayWidth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#displayWidth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayWidth","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The displayed height of this Game Object.\n\nThis value takes into account the scale factor.\n\nSetting this value will adjust the Game Object's scale property.","name":"displayHeight","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#displayHeight","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ComputedSize#displayHeight","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":93,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the internal size of this Game Object, as used for frame or physics body creation.\n\nThis will not change the size that the Game Object is rendered in-game.\nFor that you need to either set the scale of the Game Object (`setScale`) or call the\n`setDisplaySize` method, which is the same thing as changing the scale but allows you\nto do so by giving pixel values.\n\nIf you have enabled this Game Object for input, changing the size will _not_ change the\nsize of the hit area. To do this you should adjust the `input.hitArea` object directly.","kind":"function","name":"setSize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setSize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setSize","inherited":true,"___s":true},{"meta":{"filename":"ComputedSize.js","lineno":120,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display size of this Game Object.\n\nCalling this will adjust the scale.","kind":"function","name":"setDisplaySize","since":"3.4.0","params":[{"type":{"names":["number"]},"description":"The width of this Game Object.","name":"width"},{"type":{"names":["number"]},"description":"The height of this Game Object.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setDisplaySize","scope":"instance","inherits":"Phaser.GameObjects.Components.ComputedSize#setDisplaySize","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","name":"depth","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#depth","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Depth#depth","inherited":true,"___s":true},{"meta":{"filename":"Depth.js","lineno":58,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The depth of this Game Object within the Scene.\n\nThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\nof Game Objects, without actually moving their position in the display list.\n\nThe depth starts from zero (the default value) and increases from that point. A Game Object with a higher depth\nvalue will always render in front of one with a lower value.\n\nSetting the depth will queue a depth sort event within the Scene.","kind":"function","name":"setDepth","since":"3.0.0","params":[{"type":{"names":["integer"]},"description":"The depth of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setDepth","scope":"instance","inherits":"Phaser.GameObjects.Components.Depth#setDepth","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontally flipped state of the Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipX","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#flipX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertically flipped state of the Game Object.\n\nA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","name":"flipY","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#flipY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Flip#flipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":45,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"toggleFlipX","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#toggleFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Toggles the vertical flipped state of this Game Object.","kind":"function","name":"toggleFlipY","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#toggleFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#toggleFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":79,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal flipped state of this Game Object.\n\nA Game Object that is flipped horizontally will render inversed on the horizontal axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlipX","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setFlipX","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipX","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the vertical flipped state of this Game Object.","kind":"function","name":"setFlipY","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The flipped state. `false` for no flip, or `true` to be flipped.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setFlipY","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlipY","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":117,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the horizontal and vertical flipped state of this Game Object.\n\nA Game Object that is flipped will render inversed on the flipped axis.\nFlipping always takes place from the middle of the texture and does not impact the scale value.\nIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.","kind":"function","name":"setFlip","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"x"},{"type":{"names":["boolean"]},"description":"The horizontal flipped state. `false` for no flip, or `true` to be flipped.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#setFlip","inherited":true,"___s":true},{"meta":{"filename":"Flip.js","lineno":140,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.","kind":"function","name":"resetFlip","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#resetFlip","scope":"instance","inherits":"Phaser.GameObjects.Components.Flip#resetFlip","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":54,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getCenter","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTopLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":101,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTopCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":125,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the top-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getTopRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getTopRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getTopRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":149,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the left-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getLeftCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getLeftCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getLeftCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":173,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the right-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getRightCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getRightCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getRightCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":197,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomLeft","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getBottomLeft","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomLeft","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":221,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-center coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomCenter","since":"3.18.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getBottomCenter","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomCenter","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":245,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\nThe returned point is calculated in local space and does not factor in any parent containers","kind":"function","name":"getBottomRight","since":"3.0.0","params":[{"type":{"names":["Phaser.Math.Vector2","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Vector2 will be created.","name":"output"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?","name":"includeParent"}],"returns":[{"type":{"names":["Phaser.Math.Vector2","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getBottomRight","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBottomRight","inherited":true,"___s":true},{"meta":{"filename":"GetBounds.js","lineno":269,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the bounds of this Game Object, regardless of origin.\nThe values are stored and returned in a Rectangle, or Rectangle-like, object.","kind":"function","name":"getBounds","since":"3.0.0","params":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"optional":true,"description":"An object to store the values in. If not provided a new Rectangle will be created.","name":"output"}],"returns":[{"type":{"names":["Phaser.Geom.Rectangle","object"]},"description":"The values stored in the output object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getBounds","scope":"instance","inherits":"Phaser.GameObjects.Components.GetBounds#getBounds","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":30,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the left of the Game Object.","name":"originX","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#originX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":43,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical origin of this Game Object.\nThe origin maps the relationship between the size and position of the Game Object.\nThe default value is 0.5, meaning all Game Objects are positioned based on their center.\nSetting the value to 0 means the position now relates to the top of the Game Object.","name":"originY","type":{"names":["number"]},"defaultvalue":"0.5","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#originY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#originY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":60,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginX","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#displayOriginX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginX","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":84,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical display origin of this Game Object.\nThe origin is a normalized value between 0 and 1.\nThe displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.","name":"displayOriginY","type":{"names":["number"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#displayOriginY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Origin#displayOriginY","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":108,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object.\n\nThe values are given in the range 0 to 1.","kind":"function","name":"setOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0.5,"description":"The horizontal origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":132,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the origin of this Game Object based on the Pivot values in its Frame.","kind":"function","name":"setOriginFromFrame","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setOriginFromFrame","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setOriginFromFrame","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":155,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the display origin of this Game Object.\nThe difference between this and setting the origin is that you can use pixel values for setting the display origin.","kind":"function","name":"setDisplayOrigin","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The horizontal display origin value.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical display origin value. If not defined it will be set to the value of `x`.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#setDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Origin.js","lineno":178,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Updates the Display Origin cached values internally stored on this Game Object.\nYou don't usually call this directly, but it is exposed for edge-cases where you may.","kind":"function","name":"updateDisplayOrigin","since":"3.0.0","returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#updateDisplayOrigin","scope":"instance","inherits":"Phaser.GameObjects.Components.Origin#updateDisplayOrigin","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":17,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The initial WebGL pipeline of this Game Object.","name":"defaultPipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#defaultPipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#defaultPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":28,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The current WebGL pipeline of this Game Object.","name":"pipeline","type":{"names":["Phaser.Renderer.WebGL.WebGLPipeline"]},"defaultvalue":"null","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#pipeline","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Pipeline#pipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the initial WebGL Pipeline of this Game Object.\nThis should only be called during the instantiation of the Game Object.","kind":"function","name":"initPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"optional":true,"defaultvalue":"TextureTintPipeline","description":"The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.","name":"pipelineName"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#initPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#initPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":68,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the active WebGL Pipeline of this Game Object.","kind":"function","name":"setPipeline","since":"3.0.0","params":[{"type":{"names":["string"]},"description":"The name of the pipeline to set on this Game Object.","name":"pipelineName"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#setPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":91,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Resets the WebGL Pipeline of this Game Object back to the default it was created with.","kind":"function","name":"resetPipeline","since":"3.0.0","returns":[{"type":{"names":["boolean"]},"description":"`true` if the pipeline was set successfully, otherwise `false`."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#resetPipeline","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#resetPipeline","inherited":true,"___s":true},{"meta":{"filename":"Pipeline.js","lineno":107,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the name of the WebGL Pipeline this Game Object is currently using.","kind":"function","name":"getPipelineName","since":"3.0.0","returns":[{"type":{"names":["string"]},"description":"The string-based name of the pipeline being used by this Game Object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getPipelineName","scope":"instance","inherits":"Phaser.GameObjects.Components.Pipeline#getPipelineName","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The x position of this Game Object.","name":"x","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#x","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#x","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":67,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The y position of this Game Object.","name":"y","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#y","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#y","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":77,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#depth} instead.","name":"z","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#z","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#z","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":90,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The w position of this Game Object.","name":"w","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#w","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#w","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":100,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\nto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\n\nUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\nisn't the case, use the `scaleX` or `scaleY` properties instead.","name":"scale","type":{"names":["number"]},"defaultvalue":"1","since":"3.18.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#scale","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":136,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scale of this Game Object.","name":"scaleX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#scaleX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":167,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scale of this Game Object.","name":"scaleY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#scaleY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#scaleY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":198,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object as expressed in degrees.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in radians, see the `rotation` property instead.","name":"angle","type":{"names":["integer"]},"defaultvalue":"0","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#angle","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#angle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":225,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The angle of this Game Object in radians.\n\nPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\nand -90 is up.\n\nIf you prefer to work in degrees, see the `angle` property instead.","name":"rotation","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#rotation","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Transform#rotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":252,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object.","kind":"function","name":"setPosition","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The y position of this Game Object. If not set it will use the `x` value.","name":"y"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"z"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"w"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":280,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the position of this Game Object to be a random position within the confines of\nthe given area.\n\nIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\n\nThe position does not factor in the size of this Game Object, meaning that only the origin is\nguaranteed to be within the area.","kind":"function","name":"setRandomPosition","since":"3.8.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of the top-left of the random area.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of the top-left of the random area.","name":"y"},{"type":{"names":["number"]},"optional":true,"description":"The width of the random area.","name":"width"},{"type":{"names":["number"]},"optional":true,"description":"The height of the random area.","name":"height"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setRandomPosition","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRandomPosition","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":312,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the rotation of this Game Object.","kind":"function","name":"setRotation","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in radians.","name":"radians"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setRotation","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":331,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the angle of this Game Object.","kind":"function","name":"setAngle","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The rotation of this Game Object, in degrees.","name":"degrees"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setAngle","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setAngle","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":350,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scale of this Game Object.","kind":"function","name":"setScale","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scale of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scale of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setScale","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setScale","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":372,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the x position of this Game Object.","kind":"function","name":"setX","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The x position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setX","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setX","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":391,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the y position of this Game Object.","kind":"function","name":"setY","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The y position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setY","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setY","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":410,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the z position of this Game Object.\n\nNote: The z position does not control the rendering order of 2D Game Objects. Use\n{@link Phaser.GameObjects.Components.Depth#setDepth} instead.","kind":"function","name":"setZ","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The z position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setZ","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setZ","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":432,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the w position of this Game Object.","kind":"function","name":"setW","since":"3.0.0","params":[{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The w position of this Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setW","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#setW","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":451,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the local transform matrix for this Game Object.","kind":"function","name":"getLocalTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getLocalTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getLocalTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":468,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the world transform matrix for this Game Object, factoring in any parent Containers.","kind":"function","name":"getWorldTransformMatrix","since":"3.4.0","params":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"The matrix to populate with the values from this Game Object.","name":"tempMatrix"},{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"optional":true,"description":"A temporary matrix to hold parent values during the calculations.","name":"parentMatrix"}],"returns":[{"type":{"names":["Phaser.GameObjects.Components.TransformMatrix"]},"description":"The populated Transform Matrix."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getWorldTransformMatrix","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getWorldTransformMatrix","inherited":true,"___s":true},{"meta":{"filename":"Transform.js","lineno":505,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Gets the sum total rotation of all of this Game Objects parent Containers.\n\nThe returned value is in radians and will be zero if this Game Object has no parent container.","kind":"function","name":"getParentRotation","since":"3.18.0","returns":[{"type":{"names":["number"]},"description":"The sum total rotation, in radians, of all parent containers of this Game Object."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#getParentRotation","scope":"instance","inherits":"Phaser.GameObjects.Components.Transform#getParentRotation","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The visible state of the Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","name":"visible","type":{"names":["boolean"]},"since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#visible","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.Visible#visible","inherited":true,"___s":true},{"meta":{"filename":"Visible.js","lineno":63,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the visibility of this Game Object.\n\nAn invisible Game Object will skip rendering, but will still process update logic.","kind":"function","name":"setVisible","since":"3.0.0","params":[{"type":{"names":["boolean"]},"description":"The visible state of the Game Object.","name":"value"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setVisible","scope":"instance","inherits":"Phaser.GameObjects.Components.Visible#setVisible","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":16,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The horizontal scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorX","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#scrollFactorX","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorX","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":40,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"The vertical scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","name":"scrollFactorY","type":{"names":["number"]},"defaultvalue":"1","since":"3.0.0","memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#scrollFactorY","scope":"instance","kind":"member","inherits":"Phaser.GameObjects.Components.ScrollFactor#scrollFactorY","inherited":true,"___s":true},{"meta":{"filename":"ScrollFactor.js","lineno":64,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/gameobjects/components"},"description":"Sets the scroll factor of this Game Object.\n\nThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\n\nWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\nIt does not change the Game Objects actual position values.\n\nA value of 1 means it will move exactly in sync with a camera.\nA value of 0 means it will not move at all, even if the camera moves.\nOther values control the degree to which the camera movement is mapped to this Game Object.\n\nPlease be aware that scroll factor values other than 1 are not taken in to consideration when\ncalculating physics collisions. Bodies always collide based on their world position, but changing\nthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\nthem from physics bodies if not accounted for in your code.","kind":"function","name":"setScrollFactor","since":"3.0.0","params":[{"type":{"names":["number"]},"description":"The horizontal scroll factor of this Game Object.","name":"x"},{"type":{"names":["number"]},"optional":true,"defaultvalue":"x","description":"The vertical scroll factor of this Game Object. If not set it will use the `x` value.","name":"y"}],"returns":[{"type":{"names":["Phaser.Tilemaps.StaticTilemapLayer"]},"description":"This Game Object instance."}],"memberof":"Phaser.Tilemaps.StaticTilemapLayer","longname":"Phaser.Tilemaps.StaticTilemapLayer#setScrollFactor","scope":"instance","inherits":"Phaser.GameObjects.Components.ScrollFactor#setScrollFactor","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Tweens.Timeline"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Timeline","longname":"Phaser.Tweens.Timeline#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":42,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#destroy","scope":"instance","inherits":"Phaser.Events.EventEmitter#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.Tweens.Tween"]},"description":"`this`."}],"memberof":"Phaser.Tweens.Tween","longname":"Phaser.Tweens.Tween#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":31,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"shutdown","since":"3.0.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#shutdown","scope":"instance","inherits":"Phaser.Events.EventEmitter#shutdown","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":42,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Removes all listeners.","kind":"function","name":"destroy","since":"3.0.0","memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#destroy","scope":"instance","inherits":"Phaser.Events.EventEmitter#destroy","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":55,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return an array listing the events for which the emitter has registered listeners.","kind":"function","name":"eventNames","since":"3.0.0","returns":[{"type":{"names":["Array.<(string|symbol)>"]}}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#eventNames","scope":"instance","inherits":"Phaser.Events.EventEmitter#eventNames","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":64,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the listeners registered for a given event.","kind":"function","name":"listeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Array."]},"description":"The registered listeners."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#listeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#listeners","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":75,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Return the number of listeners listening to a given event.","kind":"function","name":"listenerCount","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["number"]},"description":"The number of listeners."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#listenerCount","scope":"instance","inherits":"Phaser.Events.EventEmitter#listenerCount","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":86,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Calls each of the listeners registered for a given event.","kind":"function","name":"emit","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["*"]},"optional":true,"variable":true,"description":"Additional arguments that will be passed to the event handler.","name":"args"}],"returns":[{"type":{"names":["boolean"]},"description":"`true` if the event had listeners, else `false`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#emit","scope":"instance","inherits":"Phaser.Events.EventEmitter#emit","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":98,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"on","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#on","scope":"instance","inherits":"Phaser.Events.EventEmitter#on","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":111,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a listener for a given event.","kind":"function","name":"addListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#addListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#addListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":124,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Add a one-time listener for a given event.","kind":"function","name":"once","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"description":"The listener function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"defaultvalue":"this","description":"The context to invoke the listener with.","name":"context"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#once","scope":"instance","inherits":"Phaser.Events.EventEmitter#once","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":137,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"removeListener","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#removeListener","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeListener","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":151,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove the listeners of a given event.","kind":"function","name":"off","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"description":"The event name.","name":"event"},{"type":{"names":["function"]},"optional":true,"description":"Only remove the listeners that match this function.","name":"fn"},{"type":{"names":["*"]},"optional":true,"description":"Only remove the listeners that have this context.","name":"context"},{"type":{"names":["boolean"]},"optional":true,"description":"Only remove one-time listeners.","name":"once"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#off","scope":"instance","inherits":"Phaser.Events.EventEmitter#off","inherited":true,"___s":true},{"meta":{"filename":"EventEmitter.js","lineno":165,"columnno":0,"path":"/home/arian/Documents/Phaser/phaser/src/events"},"description":"Remove all listeners, or those of the specified event.","kind":"function","name":"removeAllListeners","since":"3.0.0","params":[{"type":{"names":["string","symbol"]},"optional":true,"description":"The event name.","name":"event"}],"returns":[{"type":{"names":["Phaser.FacebookInstantGamesLeaderboard"]},"description":"`this`."}],"memberof":"Phaser.FacebookInstantGamesLeaderboard","longname":"Phaser.FacebookInstantGamesLeaderboard#removeAllListeners","scope":"instance","inherits":"Phaser.Events.EventEmitter#removeAllListeners","inherited":true,"___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is not centered within the parent by Phaser.\nYou can still center it yourself via CSS.","name":"NO_CENTER","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.NO_CENTER","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":38,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is centered both horizontally and vertically within the parent.\nTo do this, the parent has to have a bounds that can be calculated and not be empty.\n\nCentering is achieved by setting the margin left and top properties of the\ngame canvas, and does not factor in any other CSS styles you may have applied.","name":"CENTER_BOTH","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.CENTER_BOTH","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":52,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is centered horizontally within the parent.\nTo do this, the parent has to have a bounds that can be calculated and not be empty.\n\nCentering is achieved by setting the margin left and top properties of the\ngame canvas, and does not factor in any other CSS styles you may have applied.","name":"CENTER_HORIZONTALLY","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.CENTER_HORIZONTALLY","scope":"static","___s":true},{"meta":{"filename":"CENTER_CONST.js","lineno":66,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas is centered both vertically within the parent.\nTo do this, the parent has to have a bounds that can be calculated and not be empty.\n\nCentering is achieved by setting the margin left and top properties of the\ngame canvas, and does not factor in any other CSS styles you may have applied.","name":"CENTER_VERTICALLY","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.CENTER_VERTICALLY","scope":"static","___s":true},{"meta":{"filename":"ORIENTATION_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"A landscape orientation.","name":"LANDSCAPE","type":{"names":["string"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.LANDSCAPE","scope":"static","___s":true},{"meta":{"filename":"ORIENTATION_CONST.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"A portrait orientation.","name":"PORTRAIT","type":{"names":["string"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.PORTRAIT","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"No scaling happens at all. The canvas is set to the size given in the game config and Phaser doesn't change it\nagain from that point on. If you change the canvas size, either via CSS, or directly via code, then you need\nto call the Scale Managers `resize` method to give the new dimensions, or input events will stop working.","name":"NONE","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.NONE","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":39,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The height is automatically adjusted based on the width.","name":"WIDTH_CONTROLS_HEIGHT","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.WIDTH_CONTROLS_HEIGHT","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":49,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The width is automatically adjusted based on the height.","name":"HEIGHT_CONTROLS_WIDTH","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.HEIGHT_CONTROLS_WIDTH","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":59,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The width and height are automatically adjusted to fit inside the given target area,\nwhile keeping the aspect ratio. Depending on the aspect ratio there may be some space\ninside the area which is not covered.","name":"FIT","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.FIT","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":71,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The width and height are automatically adjusted to make the size cover the entire target\narea while keeping the aspect ratio. This may extend further out than the target size.","name":"ENVELOP","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.ENVELOP","scope":"static","___s":true},{"meta":{"filename":"SCALE_MODE_CONST.js","lineno":82,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The Canvas is resized to fit all available _parent_ space, regardless of aspect ratio.","name":"RESIZE","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.RESIZE","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":27,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas will not be zoomed by Phaser.","name":"NO_ZOOM","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.NO_ZOOM","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":37,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas will be 2x zoomed by Phaser.","name":"ZOOM_2X","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.ZOOM_2X","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":47,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"The game canvas will be 4x zoomed by Phaser.","name":"ZOOM_4X","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.ZOOM_4X","scope":"static","___s":true},{"meta":{"filename":"ZOOM_CONST.js","lineno":57,"columnno":4,"path":"/home/arian/Documents/Phaser/phaser/src/scale/const"},"description":"Calculate the zoom value based on the maximum multiplied game size that will\nfit into the parent, or browser window if no parent is set.","name":"MAX_ZOOM","type":{"names":["integer"]},"kind":"constant","since":"3.16.0","memberof":"Phaser.Scale","longname":"Phaser.Scale.MAX_ZOOM","scope":"static","___s":true}]} \ No newline at end of file diff --git a/source/v2/phasereditor/phasereditor.scene.ui/META-INF/MANIFEST.MF b/source/v2/phasereditor/phasereditor.scene.ui/META-INF/MANIFEST.MF index 95d1fa146..d2bbc1a1e 100644 --- a/source/v2/phasereditor/phasereditor.scene.ui/META-INF/MANIFEST.MF +++ b/source/v2/phasereditor/phasereditor.scene.ui/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: Phaser Editor - Scene Editor UI Bundle-SymbolicName: phasereditor.scene.ui;singleton:=true -Bundle-Version: 2.1.4.20191016 +Bundle-Version: 2.1.6.20200120 Bundle-Activator: phasereditor.scene.ui.Activator Bundle-Vendor: Arian Fornaris Require-Bundle: org.eclipse.ui, diff --git a/source/v2/releng/configuration/pom.xml b/source/v2/releng/configuration/pom.xml index 883ce1a53..189e72f8d 100644 --- a/source/v2/releng/configuration/pom.xml +++ b/source/v2/releng/configuration/pom.xml @@ -6,31 +6,29 @@ pom - 1.3.0 + 1.6.0 UTF-8 11 11 - - - + http://localhost/repo-mirror/eclipse-release http://localhost/repo-mirror/eclipse-license http://localhost/repo-mirror/tm-repository-4.5.101-SNAPSHOT http://localhost/repo-mirror/eclipse-cdt-9.7.2 - +--> http://localhost/repo-mirror/chromium-cef/ http://localhost/repo-mirror/chromium-swt/